GitHub v6.3.2 published on Friday, Oct 11, 2024 by Pulumi
github.getRepositoryDeployKeys
Explore with Pulumi AI
Use this data source to retrieve all deploy keys of a repository.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = github.getRepositoryDeployKeys({
repository: "example-repository",
});
import pulumi
import pulumi_github as github
example = github.get_repository_deploy_keys(repository="example-repository")
package main
import (
"github.com/pulumi/pulumi-github/sdk/v6/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := github.GetRepositoryDeployKeys(ctx, &github.GetRepositoryDeployKeysArgs{
Repository: "example-repository",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var example = Github.GetRepositoryDeployKeys.Invoke(new()
{
Repository = "example-repository",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.GithubFunctions;
import com.pulumi.github.inputs.GetRepositoryDeployKeysArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = GithubFunctions.getRepositoryDeployKeys(GetRepositoryDeployKeysArgs.builder()
.repository("example-repository")
.build());
}
}
variables:
example:
fn::invoke:
Function: github:getRepositoryDeployKeys
Arguments:
repository: example-repository
Using getRepositoryDeployKeys
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getRepositoryDeployKeys(args: GetRepositoryDeployKeysArgs, opts?: InvokeOptions): Promise<GetRepositoryDeployKeysResult>
function getRepositoryDeployKeysOutput(args: GetRepositoryDeployKeysOutputArgs, opts?: InvokeOptions): Output<GetRepositoryDeployKeysResult>
def get_repository_deploy_keys(repository: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRepositoryDeployKeysResult
def get_repository_deploy_keys_output(repository: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetRepositoryDeployKeysResult]
func GetRepositoryDeployKeys(ctx *Context, args *GetRepositoryDeployKeysArgs, opts ...InvokeOption) (*GetRepositoryDeployKeysResult, error)
func GetRepositoryDeployKeysOutput(ctx *Context, args *GetRepositoryDeployKeysOutputArgs, opts ...InvokeOption) GetRepositoryDeployKeysResultOutput
> Note: This function is named GetRepositoryDeployKeys
in the Go SDK.
public static class GetRepositoryDeployKeys
{
public static Task<GetRepositoryDeployKeysResult> InvokeAsync(GetRepositoryDeployKeysArgs args, InvokeOptions? opts = null)
public static Output<GetRepositoryDeployKeysResult> Invoke(GetRepositoryDeployKeysInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetRepositoryDeployKeysResult> getRepositoryDeployKeys(GetRepositoryDeployKeysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: github:index/getRepositoryDeployKeys:getRepositoryDeployKeys
arguments:
# arguments dictionary
The following arguments are supported:
- Repository string
- Name of the repository to retrieve the branches from.
- Repository string
- Name of the repository to retrieve the branches from.
- repository String
- Name of the repository to retrieve the branches from.
- repository string
- Name of the repository to retrieve the branches from.
- repository str
- Name of the repository to retrieve the branches from.
- repository String
- Name of the repository to retrieve the branches from.
getRepositoryDeployKeys Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Keys
List<Get
Repository Deploy Keys Key> - The list of this repository's deploy keys. Each element of
keys
has the following attributes: - Repository string
- Id string
- The provider-assigned unique ID for this managed resource.
- Keys
[]Get
Repository Deploy Keys Key - The list of this repository's deploy keys. Each element of
keys
has the following attributes: - Repository string
- id String
- The provider-assigned unique ID for this managed resource.
- keys
List<Get
Repository Deploy Keys Key> - The list of this repository's deploy keys. Each element of
keys
has the following attributes: - repository String
- id string
- The provider-assigned unique ID for this managed resource.
- keys
Get
Repository Deploy Keys Key[] - The list of this repository's deploy keys. Each element of
keys
has the following attributes: - repository string
- id str
- The provider-assigned unique ID for this managed resource.
- keys
Sequence[Get
Repository Deploy Keys Key] - The list of this repository's deploy keys. Each element of
keys
has the following attributes: - repository str
- id String
- The provider-assigned unique ID for this managed resource.
- keys List<Property Map>
- The list of this repository's deploy keys. Each element of
keys
has the following attributes: - repository String
Supporting Types
GetRepositoryDeployKeysKey
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
github
Terraform Provider.