sonarqube 0.16.14, Apr 14 25

sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata

sonarqube.AlmGithub

Explore with Pulumi AI

sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as sonarqube from "@pulumi/sonarqube";

const github_alm = new sonarqube.AlmGithub("github-alm", {
    appId: "12345",
    clientId: "56789",
    clientSecret: "secret",
    key: "myalm",
    privateKey: "myprivate_key",
    url: "https://api.github.com",
    webhookSecret: "mysecret",
});

import pulumi
import pulumi_sonarqube as sonarqube

github_alm = sonarqube.AlmGithub("github-alm",
    app_id="12345",
    client_id="56789",
    client_secret="secret",
    key="myalm",
    private_key="myprivate_key",
    url="https://api.github.com",
    webhook_secret="mysecret")

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.NewAlmGithub(ctx, "github-alm", &sonarqube.AlmGithubArgs{
			AppId:         pulumi.String("12345"),
			ClientId:      pulumi.String("56789"),
			ClientSecret:  pulumi.String("secret"),
			Key:           pulumi.String("myalm"),
			PrivateKey:    pulumi.String("myprivate_key"),
			Url:           pulumi.String("https://api.github.com"),
			WebhookSecret: pulumi.String("mysecret"),
		})
		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 github_alm = new Sonarqube.AlmGithub("github-alm", new()
    {
        AppId = "12345",
        ClientId = "56789",
        ClientSecret = "secret",
        Key = "myalm",
        PrivateKey = "myprivate_key",
        Url = "https://api.github.com",
        WebhookSecret = "mysecret",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sonarqube.AlmGithub;
import com.pulumi.sonarqube.AlmGithubArgs;
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) {
        var github_alm = new AlmGithub("github-alm", AlmGithubArgs.builder()
            .appId("12345")
            .clientId("56789")
            .clientSecret("secret")
            .key("myalm")
            .privateKey("myprivate_key")
            .url("https://api.github.com")
            .webhookSecret("mysecret")
            .build());

    }
}

resources:
  github-alm:
    type: sonarqube:AlmGithub
    properties:
      appId: '12345'
      clientId: '56789'
      clientSecret: secret
      key: myalm
      privateKey: myprivate_key
      url: https://api.github.com
      webhookSecret: mysecret

Create AlmGithub Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AlmGithub(name: string, args: AlmGithubArgs, opts?: CustomResourceOptions);

@overload
def AlmGithub(resource_name: str,
              args: AlmGithubArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def AlmGithub(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              app_id: Optional[str] = None,
              client_id: Optional[str] = None,
              client_secret: Optional[str] = None,
              key: Optional[str] = None,
              private_key: Optional[str] = None,
              url: Optional[str] = None,
              alm_github_id: Optional[str] = None,
              webhook_secret: Optional[str] = None)

func NewAlmGithub(ctx *Context, name string, args AlmGithubArgs, opts ...ResourceOption) (*AlmGithub, error)

public AlmGithub(string name, AlmGithubArgs args, CustomResourceOptions? opts = null)

public AlmGithub(String name, AlmGithubArgs args)
public AlmGithub(String name, AlmGithubArgs args, CustomResourceOptions options)

type: sonarqube:AlmGithub
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args AlmGithubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AlmGithubArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AlmGithubArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AlmGithubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AlmGithubArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var almGithubResource = new Sonarqube.AlmGithub("almGithubResource", new()
{
    AppId = "string",
    ClientId = "string",
    ClientSecret = "string",
    Key = "string",
    PrivateKey = "string",
    Url = "string",
    AlmGithubId = "string",
    WebhookSecret = "string",
});

example, err := sonarqube.NewAlmGithub(ctx, "almGithubResource", &sonarqube.AlmGithubArgs{
	AppId:         pulumi.String("string"),
	ClientId:      pulumi.String("string"),
	ClientSecret:  pulumi.String("string"),
	Key:           pulumi.String("string"),
	PrivateKey:    pulumi.String("string"),
	Url:           pulumi.String("string"),
	AlmGithubId:   pulumi.String("string"),
	WebhookSecret: pulumi.String("string"),
})

var almGithubResource = new AlmGithub("almGithubResource", AlmGithubArgs.builder()
    .appId("string")
    .clientId("string")
    .clientSecret("string")
    .key("string")
    .privateKey("string")
    .url("string")
    .almGithubId("string")
    .webhookSecret("string")
    .build());

alm_github_resource = sonarqube.AlmGithub("almGithubResource",
    app_id="string",
    client_id="string",
    client_secret="string",
    key="string",
    private_key="string",
    url="string",
    alm_github_id="string",
    webhook_secret="string")

const almGithubResource = new sonarqube.AlmGithub("almGithubResource", {
    appId: "string",
    clientId: "string",
    clientSecret: "string",
    key: "string",
    privateKey: "string",
    url: "string",
    almGithubId: "string",
    webhookSecret: "string",
});

type: sonarqube:AlmGithub
properties:
    almGithubId: string
    appId: string
    clientId: string
    clientSecret: string
    key: string
    privateKey: string
    url: string
    webhookSecret: string

AlmGithub Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AlmGithub resource accepts the following input properties:

AppId string: GitHub App ID. Maximum length: 80
ClientId string: GitHub App Client ID. Maximum length: 80
ClientSecret string: GitHub App Client Secret. Maximum length: 160
Key string: Unique key of the GitHUb instance setting. Maximum length: 200
PrivateKey string: GitHub App private key. Maximum length: 2500
Url string: GitHub API URL. Maximum length: 2000
AlmGithubId string: The ID of this resource.
WebhookSecret string: GitHub App Webhook Secret. Maximum length: 160

AppId string: GitHub App ID. Maximum length: 80
ClientId string: GitHub App Client ID. Maximum length: 80
ClientSecret string: GitHub App Client Secret. Maximum length: 160
Key string: Unique key of the GitHUb instance setting. Maximum length: 200
PrivateKey string: GitHub App private key. Maximum length: 2500
Url string: GitHub API URL. Maximum length: 2000
AlmGithubId string: The ID of this resource.
WebhookSecret string: GitHub App Webhook Secret. Maximum length: 160

appId String: GitHub App ID. Maximum length: 80
clientId String: GitHub App Client ID. Maximum length: 80
clientSecret String: GitHub App Client Secret. Maximum length: 160
key String: Unique key of the GitHUb instance setting. Maximum length: 200
privateKey String: GitHub App private key. Maximum length: 2500
url String: GitHub API URL. Maximum length: 2000
almGithubId String: The ID of this resource.
webhookSecret String: GitHub App Webhook Secret. Maximum length: 160

appId string: GitHub App ID. Maximum length: 80
clientId string: GitHub App Client ID. Maximum length: 80
clientSecret string: GitHub App Client Secret. Maximum length: 160
key string: Unique key of the GitHUb instance setting. Maximum length: 200
privateKey string: GitHub App private key. Maximum length: 2500
url string: GitHub API URL. Maximum length: 2000
almGithubId string: The ID of this resource.
webhookSecret string: GitHub App Webhook Secret. Maximum length: 160

app_id str: GitHub App ID. Maximum length: 80
client_id str: GitHub App Client ID. Maximum length: 80
client_secret str: GitHub App Client Secret. Maximum length: 160
key str: Unique key of the GitHUb instance setting. Maximum length: 200
private_key str: GitHub App private key. Maximum length: 2500
url str: GitHub API URL. Maximum length: 2000
alm_github_id str: The ID of this resource.
webhook_secret str: GitHub App Webhook Secret. Maximum length: 160

appId String: GitHub App ID. Maximum length: 80
clientId String: GitHub App Client ID. Maximum length: 80
clientSecret String: GitHub App Client Secret. Maximum length: 160
key String: Unique key of the GitHUb instance setting. Maximum length: 200
privateKey String: GitHub App private key. Maximum length: 2500
url String: GitHub API URL. Maximum length: 2000
almGithubId String: The ID of this resource.
webhookSecret String: GitHub App Webhook Secret. Maximum length: 160

Outputs

All input properties are implicitly available as output properties. Additionally, the AlmGithub resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing AlmGithub Resource

Get an existing AlmGithub resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AlmGithubState, opts?: CustomResourceOptions): AlmGithub

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alm_github_id: Optional[str] = None,
        app_id: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        key: Optional[str] = None,
        private_key: Optional[str] = None,
        url: Optional[str] = None,
        webhook_secret: Optional[str] = None) -> AlmGithub

func GetAlmGithub(ctx *Context, name string, id IDInput, state *AlmGithubState, opts ...ResourceOption) (*AlmGithub, error)

public static AlmGithub Get(string name, Input<string> id, AlmGithubState? state, CustomResourceOptions? opts = null)

public static AlmGithub get(String name, Output<String> id, AlmGithubState state, CustomResourceOptions options)

resources:  _:    type: sonarqube:AlmGithub    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AlmGithubId string: The ID of this resource.
AppId string: GitHub App ID. Maximum length: 80
ClientId string: GitHub App Client ID. Maximum length: 80
ClientSecret string: GitHub App Client Secret. Maximum length: 160
Key string: Unique key of the GitHUb instance setting. Maximum length: 200
PrivateKey string: GitHub App private key. Maximum length: 2500
Url string: GitHub API URL. Maximum length: 2000
WebhookSecret string: GitHub App Webhook Secret. Maximum length: 160

AlmGithubId string: The ID of this resource.
AppId string: GitHub App ID. Maximum length: 80
ClientId string: GitHub App Client ID. Maximum length: 80
ClientSecret string: GitHub App Client Secret. Maximum length: 160
Key string: Unique key of the GitHUb instance setting. Maximum length: 200
PrivateKey string: GitHub App private key. Maximum length: 2500
Url string: GitHub API URL. Maximum length: 2000
WebhookSecret string: GitHub App Webhook Secret. Maximum length: 160

almGithubId String: The ID of this resource.
appId String: GitHub App ID. Maximum length: 80
clientId String: GitHub App Client ID. Maximum length: 80
clientSecret String: GitHub App Client Secret. Maximum length: 160
key String: Unique key of the GitHUb instance setting. Maximum length: 200
privateKey String: GitHub App private key. Maximum length: 2500
url String: GitHub API URL. Maximum length: 2000
webhookSecret String: GitHub App Webhook Secret. Maximum length: 160

almGithubId string: The ID of this resource.
appId string: GitHub App ID. Maximum length: 80
clientId string: GitHub App Client ID. Maximum length: 80
clientSecret string: GitHub App Client Secret. Maximum length: 160
key string: Unique key of the GitHUb instance setting. Maximum length: 200
privateKey string: GitHub App private key. Maximum length: 2500
url string: GitHub API URL. Maximum length: 2000
webhookSecret string: GitHub App Webhook Secret. Maximum length: 160

alm_github_id str: The ID of this resource.
app_id str: GitHub App ID. Maximum length: 80
client_id str: GitHub App Client ID. Maximum length: 80
client_secret str: GitHub App Client Secret. Maximum length: 160
key str: Unique key of the GitHUb instance setting. Maximum length: 200
private_key str: GitHub App private key. Maximum length: 2500
url str: GitHub API URL. Maximum length: 2000
webhook_secret str: GitHub App Webhook Secret. Maximum length: 160

almGithubId String: The ID of this resource.
appId String: GitHub App ID. Maximum length: 80
clientId String: GitHub App Client ID. Maximum length: 80
clientSecret String: GitHub App Client Secret. Maximum length: 160
key String: Unique key of the GitHUb instance setting. Maximum length: 200
privateKey String: GitHub App private key. Maximum length: 2500
url String: GitHub API URL. Maximum length: 2000
webhookSecret String: GitHub App Webhook Secret. Maximum length: 160

Package Details

Repository: sonarqube jdamata/terraform-provider-sonarqube
License
Notes: This Pulumi package is based on the sonarqube Terraform Provider.

sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata

jdamata/terraform-provider-sonarqube

sonarqube.AlmGithub

On this page

On this page

Example Usage

Create AlmGithub Resource

Constructor syntax

Parameters

Constructor example

AlmGithub Resource Properties

Inputs

Outputs

Look up Existing AlmGithub Resource

Package Details

On this page

On this page