1. Packages
  2. Sonarqube Provider
  3. API Docs
  4. getAlmGithub
Viewing docs for sonarqube 0.16.19
published on Friday, Mar 20, 2026 by jdamata
sonarqube logo
Viewing docs for sonarqube 0.16.19
published on Friday, Mar 20, 2026 by jdamata

    Use this data source to get a GitHub ALM definition.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sonarqube from "@pulumi/sonarqube";
    
    const example = sonarqube.getAlmGithub({
        key: "my-github-key",
    });
    
    import pulumi
    import pulumi_sonarqube as sonarqube
    
    example = sonarqube.get_alm_github(key="my-github-key")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sonarqube/sonarqube"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sonarqube.LookupAlmGithub(ctx, &sonarqube.LookupAlmGithubArgs{
    			Key: "my-github-key",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Sonarqube = Pulumi.Sonarqube;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Sonarqube.GetAlmGithub.Invoke(new()
        {
            Key = "my-github-key",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sonarqube.SonarqubeFunctions;
    import com.pulumi.sonarqube.inputs.GetAlmGithubArgs;
    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 = SonarqubeFunctions.getAlmGithub(GetAlmGithubArgs.builder()
                .key("my-github-key")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: sonarqube:getAlmGithub
          arguments:
            key: my-github-key
    

    Using getAlmGithub

    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 getAlmGithub(args: GetAlmGithubArgs, opts?: InvokeOptions): Promise<GetAlmGithubResult>
    function getAlmGithubOutput(args: GetAlmGithubOutputArgs, opts?: InvokeOptions): Output<GetAlmGithubResult>
    def get_alm_github(id: Optional[str] = None,
                       key: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetAlmGithubResult
    def get_alm_github_output(id: Optional[pulumi.Input[str]] = None,
                       key: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetAlmGithubResult]
    func LookupAlmGithub(ctx *Context, args *LookupAlmGithubArgs, opts ...InvokeOption) (*LookupAlmGithubResult, error)
    func LookupAlmGithubOutput(ctx *Context, args *LookupAlmGithubOutputArgs, opts ...InvokeOption) LookupAlmGithubResultOutput

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

    public static class GetAlmGithub 
    {
        public static Task<GetAlmGithubResult> InvokeAsync(GetAlmGithubArgs args, InvokeOptions? opts = null)
        public static Output<GetAlmGithubResult> Invoke(GetAlmGithubInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAlmGithubResult> getAlmGithub(GetAlmGithubArgs args, InvokeOptions options)
    public static Output<GetAlmGithubResult> getAlmGithub(GetAlmGithubArgs args, InvokeOptions options)
    
    fn::invoke:
      function: sonarqube:index/getAlmGithub:getAlmGithub
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Key string
    Unique key of the GitHub instance setting.
    Id string
    The ID of this resource.
    Key string
    Unique key of the GitHub instance setting.
    Id string
    The ID of this resource.
    key String
    Unique key of the GitHub instance setting.
    id String
    The ID of this resource.
    key string
    Unique key of the GitHub instance setting.
    id string
    The ID of this resource.
    key str
    Unique key of the GitHub instance setting.
    id str
    The ID of this resource.
    key String
    Unique key of the GitHub instance setting.
    id String
    The ID of this resource.

    getAlmGithub Result

    The following output properties are available:

    AppId string
    GitHub App ID.
    ClientId string
    GitHub App Client ID.
    Id string
    The ID of this resource.
    Key string
    Unique key of the GitHub instance setting.
    Url string
    GitHub API URL.
    AppId string
    GitHub App ID.
    ClientId string
    GitHub App Client ID.
    Id string
    The ID of this resource.
    Key string
    Unique key of the GitHub instance setting.
    Url string
    GitHub API URL.
    appId String
    GitHub App ID.
    clientId String
    GitHub App Client ID.
    id String
    The ID of this resource.
    key String
    Unique key of the GitHub instance setting.
    url String
    GitHub API URL.
    appId string
    GitHub App ID.
    clientId string
    GitHub App Client ID.
    id string
    The ID of this resource.
    key string
    Unique key of the GitHub instance setting.
    url string
    GitHub API URL.
    app_id str
    GitHub App ID.
    client_id str
    GitHub App Client ID.
    id str
    The ID of this resource.
    key str
    Unique key of the GitHub instance setting.
    url str
    GitHub API URL.
    appId String
    GitHub App ID.
    clientId String
    GitHub App Client ID.
    id String
    The ID of this resource.
    key String
    Unique key of the GitHub instance setting.
    url String
    GitHub API URL.

    Package Details

    Repository
    sonarqube jdamata/terraform-provider-sonarqube
    License
    Notes
    This Pulumi package is based on the sonarqube Terraform Provider.
    sonarqube logo
    Viewing docs for sonarqube 0.16.19
    published on Friday, Mar 20, 2026 by jdamata
      Try Pulumi Cloud free. Your team will thank you.