1. Packages
  2. Github Provider
  3. API Docs
  4. getRepositoryCustomProperties
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",
});
Copy
import pulumi
import pulumi_github as github

example = github.get_repository_custom_properties(repository="example-repository")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: github:getRepositoryCustomProperties
      arguments:
        repository: example-repository
Copy

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>
Copy
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]
Copy
func GetRepositoryCustomProperties(ctx *Context, args *GetRepositoryCustomPropertiesArgs, opts ...InvokeOption) (*GetRepositoryCustomPropertiesResult, error)
func GetRepositoryCustomPropertiesOutput(ctx *Context, args *GetRepositoryCustomPropertiesOutputArgs, opts ...InvokeOption) GetRepositoryCustomPropertiesResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetRepositoryCustomPropertiesResult> getRepositoryCustomProperties(GetRepositoryCustomPropertiesArgs args, InvokeOptions options)
public static Output<GetRepositoryCustomPropertiesResult> getRepositoryCustomProperties(GetRepositoryCustomPropertiesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: github:index/getRepositoryCustomProperties:getRepositoryCustomProperties
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Repository This property is required. string
Name of the repository to retrieve the custom properties from.
Repository This property is required. string
Name of the repository to retrieve the custom properties from.
repository This property is required. String
Name of the repository to retrieve the custom properties from.
repository This property is required. string
Name of the repository to retrieve the custom properties from.
repository This property is required. str
Name of the repository to retrieve the custom properties from.
repository This property is required. 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<GetRepositoryCustomPropertiesProperty>
The list of this repository's custom properties. Each element of property has the following attributes:
Repository string
Id string
The provider-assigned unique ID for this managed resource.
Properties []GetRepositoryCustomPropertiesProperty
The list of this repository's custom properties. Each element of property has the following attributes:
Repository string
id String
The provider-assigned unique ID for this managed resource.
properties List<GetRepositoryCustomPropertiesProperty>
The list of this repository's custom properties. Each element of property has the following attributes:
repository String
id string
The provider-assigned unique ID for this managed resource.
properties GetRepositoryCustomPropertiesProperty[]
The list of this repository's custom properties. Each element of property has the following attributes:
repository string
id str
The provider-assigned unique ID for this managed resource.
properties Sequence[GetRepositoryCustomPropertiesProperty]
The list of this repository's custom properties. Each element of property has 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 property has the following attributes:
repository String

Supporting Types

GetRepositoryCustomPropertiesProperty

PropertyName This property is required. string
Name of the property
PropertyValues This property is required. List<string>
Value of the property
PropertyName This property is required. string
Name of the property
PropertyValues This property is required. []string
Value of the property
propertyName This property is required. String
Name of the property
propertyValues This property is required. List<String>
Value of the property
propertyName This property is required. string
Name of the property
propertyValues This property is required. string[]
Value of the property
property_name This property is required. str
Name of the property
property_values This property is required. Sequence[str]
Value of the property
propertyName This property is required. String
Name of the property
propertyValues This property is required. 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 github Terraform Provider.