1. Packages
  2. GitHub
  3. API Docs
  4. getRepositoryAutolinkReferences
GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi

github.getRepositoryAutolinkReferences

Explore with Pulumi AI

github logo
GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi

    Use this data source to retrieve autolink references for a repository.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const example = github.getRepositoryAutolinkReferences({
        repository: "example-repository",
    });
    
    import pulumi
    import pulumi_github as github
    
    example = github.get_repository_autolink_references(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.GetRepositoryAutolinkReferences(ctx, &github.GetRepositoryAutolinkReferencesArgs{
    			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.GetRepositoryAutolinkReferences.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.GetRepositoryAutolinkReferencesArgs;
    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.getRepositoryAutolinkReferences(GetRepositoryAutolinkReferencesArgs.builder()
                .repository("example-repository")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: github:getRepositoryAutolinkReferences
          Arguments:
            repository: example-repository
    

    Using getRepositoryAutolinkReferences

    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 getRepositoryAutolinkReferences(args: GetRepositoryAutolinkReferencesArgs, opts?: InvokeOptions): Promise<GetRepositoryAutolinkReferencesResult>
    function getRepositoryAutolinkReferencesOutput(args: GetRepositoryAutolinkReferencesOutputArgs, opts?: InvokeOptions): Output<GetRepositoryAutolinkReferencesResult>
    def get_repository_autolink_references(repository: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetRepositoryAutolinkReferencesResult
    def get_repository_autolink_references_output(repository: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetRepositoryAutolinkReferencesResult]
    func GetRepositoryAutolinkReferences(ctx *Context, args *GetRepositoryAutolinkReferencesArgs, opts ...InvokeOption) (*GetRepositoryAutolinkReferencesResult, error)
    func GetRepositoryAutolinkReferencesOutput(ctx *Context, args *GetRepositoryAutolinkReferencesOutputArgs, opts ...InvokeOption) GetRepositoryAutolinkReferencesResultOutput

    > Note: This function is named GetRepositoryAutolinkReferences in the Go SDK.

    public static class GetRepositoryAutolinkReferences 
    {
        public static Task<GetRepositoryAutolinkReferencesResult> InvokeAsync(GetRepositoryAutolinkReferencesArgs args, InvokeOptions? opts = null)
        public static Output<GetRepositoryAutolinkReferencesResult> Invoke(GetRepositoryAutolinkReferencesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRepositoryAutolinkReferencesResult> getRepositoryAutolinkReferences(GetRepositoryAutolinkReferencesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: github:index/getRepositoryAutolinkReferences:getRepositoryAutolinkReferences
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Repository string
    Name of the repository to retrieve the autolink references from.
    Repository string
    Name of the repository to retrieve the autolink references from.
    repository String
    Name of the repository to retrieve the autolink references from.
    repository string
    Name of the repository to retrieve the autolink references from.
    repository str
    Name of the repository to retrieve the autolink references from.
    repository String
    Name of the repository to retrieve the autolink references from.

    getRepositoryAutolinkReferences Result

    The following output properties are available:

    AutolinkReferences List<GetRepositoryAutolinkReferencesAutolinkReference>
    The list of this repository's autolink references. Each element of autolink_references has the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Repository string
    AutolinkReferences []GetRepositoryAutolinkReferencesAutolinkReference
    The list of this repository's autolink references. Each element of autolink_references has the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Repository string
    autolinkReferences List<GetRepositoryAutolinkReferencesAutolinkReference>
    The list of this repository's autolink references. Each element of autolink_references has the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    repository String
    autolinkReferences GetRepositoryAutolinkReferencesAutolinkReference[]
    The list of this repository's autolink references. Each element of autolink_references has the following attributes:
    id string
    The provider-assigned unique ID for this managed resource.
    repository string
    autolink_references Sequence[GetRepositoryAutolinkReferencesAutolinkReference]
    The list of this repository's autolink references. Each element of autolink_references has the following attributes:
    id str
    The provider-assigned unique ID for this managed resource.
    repository str
    autolinkReferences List<Property Map>
    The list of this repository's autolink references. Each element of autolink_references has the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    repository String

    Supporting Types

    GetRepositoryAutolinkReferencesAutolinkReference

    IsAlphanumeric bool
    True if alphanumeric.
    KeyPrefix string
    Key prefix.
    TargetUrlTemplate string
    Target url template.
    IsAlphanumeric bool
    True if alphanumeric.
    KeyPrefix string
    Key prefix.
    TargetUrlTemplate string
    Target url template.
    isAlphanumeric Boolean
    True if alphanumeric.
    keyPrefix String
    Key prefix.
    targetUrlTemplate String
    Target url template.
    isAlphanumeric boolean
    True if alphanumeric.
    keyPrefix string
    Key prefix.
    targetUrlTemplate string
    Target url template.
    is_alphanumeric bool
    True if alphanumeric.
    key_prefix str
    Key prefix.
    target_url_template str
    Target url template.
    isAlphanumeric Boolean
    True if alphanumeric.
    keyPrefix String
    Key prefix.
    targetUrlTemplate String
    Target url template.

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi