GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi
github.getRepositoryCustomProperties
Explore with Pulumi AI
Use this data source to retrieve all custom properties of a repository.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = github.getRepositoryCustomProperties({
    repository: "example-repository",
});
import pulumi
import pulumi_github as github
example = github.get_repository_custom_properties(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.GetRepositoryCustomProperties(ctx, &github.GetRepositoryCustomPropertiesArgs{
			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.GetRepositoryCustomProperties.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.GetRepositoryCustomPropertiesArgs;
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.getRepositoryCustomProperties(GetRepositoryCustomPropertiesArgs.builder()
            .repository("example-repository")
            .build());
    }
}
variables:
  example:
    fn::invoke:
      function: github:getRepositoryCustomProperties
      arguments:
        repository: example-repository
Using getRepositoryCustomProperties
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 getRepositoryCustomProperties(args: GetRepositoryCustomPropertiesArgs, opts?: InvokeOptions): Promise<GetRepositoryCustomPropertiesResult>
function getRepositoryCustomPropertiesOutput(args: GetRepositoryCustomPropertiesOutputArgs, opts?: InvokeOptions): Output<GetRepositoryCustomPropertiesResult>def get_repository_custom_properties(repository: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetRepositoryCustomPropertiesResult
def get_repository_custom_properties_output(repository: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetRepositoryCustomPropertiesResult]func GetRepositoryCustomProperties(ctx *Context, args *GetRepositoryCustomPropertiesArgs, opts ...InvokeOption) (*GetRepositoryCustomPropertiesResult, error)
func GetRepositoryCustomPropertiesOutput(ctx *Context, args *GetRepositoryCustomPropertiesOutputArgs, opts ...InvokeOption) GetRepositoryCustomPropertiesResultOutput> Note: This function is named GetRepositoryCustomProperties in the Go SDK.
public static class GetRepositoryCustomProperties 
{
    public static Task<GetRepositoryCustomPropertiesResult> InvokeAsync(GetRepositoryCustomPropertiesArgs args, InvokeOptions? opts = null)
    public static Output<GetRepositoryCustomPropertiesResult> Invoke(GetRepositoryCustomPropertiesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetRepositoryCustomPropertiesResult> getRepositoryCustomProperties(GetRepositoryCustomPropertiesArgs args, InvokeOptions options)
public static Output<GetRepositoryCustomPropertiesResult> getRepositoryCustomProperties(GetRepositoryCustomPropertiesArgs args, InvokeOptions options)
fn::invoke:
  function: github:index/getRepositoryCustomProperties:getRepositoryCustomProperties
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Repository string
- Name of the repository to retrieve the custom properties from.
- Repository string
- Name of the repository to retrieve the custom properties from.
- repository String
- Name of the repository to retrieve the custom properties from.
- repository string
- Name of the repository to retrieve the custom properties from.
- repository str
- Name of the repository to retrieve the custom properties from.
- repository String
- Name of the repository to retrieve the custom properties from.
getRepositoryCustomProperties Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Properties
List<GetRepository Custom Properties Property> 
- The list of this repository's custom properties. Each element of propertyhas the following attributes:
- Repository string
- Id string
- The provider-assigned unique ID for this managed resource.
- Properties
[]GetRepository Custom Properties Property 
- The list of this repository's custom properties. Each element of propertyhas the following attributes:
- Repository string
- id String
- The provider-assigned unique ID for this managed resource.
- properties
List<GetRepository Custom Properties Property> 
- The list of this repository's custom properties. Each element of propertyhas the following attributes:
- repository String
- id string
- The provider-assigned unique ID for this managed resource.
- properties
GetRepository Custom Properties Property[] 
- The list of this repository's custom properties. Each element of propertyhas the following attributes:
- repository string
- id str
- The provider-assigned unique ID for this managed resource.
- properties
Sequence[GetRepository Custom Properties Property] 
- The list of this repository's custom properties. Each element of propertyhas the following attributes:
- repository str
- id String
- The provider-assigned unique ID for this managed resource.
- properties List<Property Map>
- The list of this repository's custom properties. Each element of propertyhas the following attributes:
- repository String
Supporting Types
GetRepositoryCustomPropertiesProperty    
- PropertyName string
- Name of the property
- PropertyValues List<string>
- Value of the property
- PropertyName string
- Name of the property
- PropertyValues []string
- Value of the property
- propertyName String
- Name of the property
- propertyValues List<String>
- Value of the property
- propertyName string
- Name of the property
- propertyValues string[]
- Value of the property
- property_name str
- Name of the property
- property_values Sequence[str]
- Value of the property
- propertyName String
- Name of the property
- propertyValues List<String>
- Value of the property
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the githubTerraform Provider.