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

github.getGithubApp

Explore with Pulumi AI

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

    Use this data source to retrieve information about an app.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const foobar = github.getGithubApp({
        slug: "foobar",
    });
    
    import pulumi
    import pulumi_github as github
    
    foobar = github.get_github_app(slug="foobar")
    
    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.GetGithubApp(ctx, &github.GetGithubAppArgs{
    			Slug: "foobar",
    		}, 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 foobar = Github.GetGithubApp.Invoke(new()
        {
            Slug = "foobar",
        });
    
    });
    
    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.GetGithubAppArgs;
    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 foobar = GithubFunctions.getGithubApp(GetGithubAppArgs.builder()
                .slug("foobar")
                .build());
    
        }
    }
    
    variables:
      foobar:
        fn::invoke:
          Function: github:getGithubApp
          Arguments:
            slug: foobar
    

    Using getGithubApp

    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 getGithubApp(args: GetGithubAppArgs, opts?: InvokeOptions): Promise<GetGithubAppResult>
    function getGithubAppOutput(args: GetGithubAppOutputArgs, opts?: InvokeOptions): Output<GetGithubAppResult>
    def get_github_app(slug: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetGithubAppResult
    def get_github_app_output(slug: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetGithubAppResult]
    func GetGithubApp(ctx *Context, args *GetGithubAppArgs, opts ...InvokeOption) (*GetGithubAppResult, error)
    func GetGithubAppOutput(ctx *Context, args *GetGithubAppOutputArgs, opts ...InvokeOption) GetGithubAppResultOutput

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

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

    The following arguments are supported:

    Slug string
    The URL-friendly name of your GitHub App.
    Slug string
    The URL-friendly name of your GitHub App.
    slug String
    The URL-friendly name of your GitHub App.
    slug string
    The URL-friendly name of your GitHub App.
    slug str
    The URL-friendly name of your GitHub App.
    slug String
    The URL-friendly name of your GitHub App.

    getGithubApp Result

    The following output properties are available:

    Description string
    The app's description.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The app's full name.
    NodeId string
    The Node ID of the app.
    Slug string
    Description string
    The app's description.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The app's full name.
    NodeId string
    The Node ID of the app.
    Slug string
    description String
    The app's description.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The app's full name.
    nodeId String
    The Node ID of the app.
    slug String
    description string
    The app's description.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The app's full name.
    nodeId string
    The Node ID of the app.
    slug string
    description str
    The app's description.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The app's full name.
    node_id str
    The Node ID of the app.
    slug str
    description String
    The app's description.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The app's full name.
    nodeId String
    The Node ID of the app.
    slug String

    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