Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sonarqube Provider
  3. API Docs
  4. AlmGitlab
sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata
jdamata/terraform-provider-sonarqube

sonarqube.AlmGitlab

Explore with Pulumi AI

sonarqube logo
sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata
jdamata/terraform-provider-sonarqube

    Provides a Sonarqube GitLab Alm/Devops Platform Integration resource. This can be used to create and manage a Alm/Devops Platform Integration for GitLab.

    Example Usage

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

const gitlab_alm = new sonarqube.AlmGitlab("gitlab-alm", {
    key: "myalm",
    personalAccessToken: "my_personal_access_token",
    url: "https://gitlab.com/api/v4",
});

    import pulumi
import pulumi_sonarqube as sonarqube

gitlab_alm = sonarqube.AlmGitlab("gitlab-alm",
    key="myalm",
    personal_access_token="my_personal_access_token",
    url="https://gitlab.com/api/v4")

    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.NewAlmGitlab(ctx, "gitlab-alm", &sonarqube.AlmGitlabArgs{
			Key:                 pulumi.String("myalm"),
			PersonalAccessToken: pulumi.String("my_personal_access_token"),
			Url:                 pulumi.String("https://gitlab.com/api/v4"),
		})
		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 gitlab_alm = new Sonarqube.AlmGitlab("gitlab-alm", new()
    {
        Key = "myalm",
        PersonalAccessToken = "my_personal_access_token",
        Url = "https://gitlab.com/api/v4",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sonarqube.AlmGitlab;
import com.pulumi.sonarqube.AlmGitlabArgs;
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 gitlab_alm = new AlmGitlab("gitlab-alm", AlmGitlabArgs.builder()
            .key("myalm")
            .personalAccessToken("my_personal_access_token")
            .url("https://gitlab.com/api/v4")
            .build());

    }
}

    resources:
  gitlab-alm:
    type: sonarqube:AlmGitlab
    properties:
      key: myalm
      personalAccessToken: my_personal_access_token
      url: https://gitlab.com/api/v4

    Create AlmGitlab Resource

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

    Constructor syntax

    new AlmGitlab(name: string, args: AlmGitlabArgs, opts?: CustomResourceOptions);
    @overload
def AlmGitlab(resource_name: str,
              args: AlmGitlabArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def AlmGitlab(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              key: Optional[str] = None,
              personal_access_token: Optional[str] = None,
              url: Optional[str] = None,
              alm_gitlab_id: Optional[str] = None)
    func NewAlmGitlab(ctx *Context, name string, args AlmGitlabArgs, opts ...ResourceOption) (*AlmGitlab, error)
    public AlmGitlab(string name, AlmGitlabArgs args, CustomResourceOptions? opts = null)
    public AlmGitlab(String name, AlmGitlabArgs args)
public AlmGitlab(String name, AlmGitlabArgs args, CustomResourceOptions options)

    type: sonarqube:AlmGitlab
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 AlmGitlabArgs
    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 AlmGitlabArgs
    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 AlmGitlabArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlmGitlabArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlmGitlabArgs
    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 almGitlabResource = new Sonarqube.AlmGitlab("almGitlabResource", new()
{
    Key = "string",
    PersonalAccessToken = "string",
    Url = "string",
    AlmGitlabId = "string",
});

    example, err := sonarqube.NewAlmGitlab(ctx, "almGitlabResource", &sonarqube.AlmGitlabArgs{
	Key:                 pulumi.String("string"),
	PersonalAccessToken: pulumi.String("string"),
	Url:                 pulumi.String("string"),
	AlmGitlabId:         pulumi.String("string"),
})

    var almGitlabResource = new AlmGitlab("almGitlabResource", AlmGitlabArgs.builder()
    .key("string")
    .personalAccessToken("string")
    .url("string")
    .almGitlabId("string")
    .build());

    alm_gitlab_resource = sonarqube.AlmGitlab("almGitlabResource",
    key="string",
    personal_access_token="string",
    url="string",
    alm_gitlab_id="string")

    const almGitlabResource = new sonarqube.AlmGitlab("almGitlabResource", {
    key: "string",
    personalAccessToken: "string",
    url: "string",
    almGitlabId: "string",
});

    type: sonarqube:AlmGitlab
properties:
    almGitlabId: string
    key: string
    personalAccessToken: string
    url: string

    AlmGitlab 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 AlmGitlab resource accepts the following input properties:

    Key string
    Unique key of the GitLab instance setting. Maximum length: 200
    PersonalAccessToken string
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    Url string
    GitLab API URL. Maximum length: 2000
    AlmGitlabId string
    The ID of this resource.
    Key string
    Unique key of the GitLab instance setting. Maximum length: 200
    PersonalAccessToken string
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    Url string
    GitLab API URL. Maximum length: 2000
    AlmGitlabId string
    The ID of this resource.
    key String
    Unique key of the GitLab instance setting. Maximum length: 200
    personalAccessToken String
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    url String
    GitLab API URL. Maximum length: 2000
    almGitlabId String
    The ID of this resource.
    key string
    Unique key of the GitLab instance setting. Maximum length: 200
    personalAccessToken string
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    url string
    GitLab API URL. Maximum length: 2000
    almGitlabId string
    The ID of this resource.
    key str
    Unique key of the GitLab instance setting. Maximum length: 200
    personal_access_token str
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    url str
    GitLab API URL. Maximum length: 2000
    alm_gitlab_id str
    The ID of this resource.
    key String
    Unique key of the GitLab instance setting. Maximum length: 200
    personalAccessToken String
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    url String
    GitLab API URL. Maximum length: 2000
    almGitlabId String
    The ID of this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AlmGitlab 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 AlmGitlab Resource

    Get an existing AlmGitlab 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?: AlmGitlabState, opts?: CustomResourceOptions): AlmGitlab
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alm_gitlab_id: Optional[str] = None,
        key: Optional[str] = None,
        personal_access_token: Optional[str] = None,
        url: Optional[str] = None) -> AlmGitlab
    func GetAlmGitlab(ctx *Context, name string, id IDInput, state *AlmGitlabState, opts ...ResourceOption) (*AlmGitlab, error)
    public static AlmGitlab Get(string name, Input<string> id, AlmGitlabState? state, CustomResourceOptions? opts = null)
    public static AlmGitlab get(String name, Output<String> id, AlmGitlabState state, CustomResourceOptions options)
    resources:  _:    type: sonarqube:AlmGitlab    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:
    AlmGitlabId string
    The ID of this resource.
    Key string
    Unique key of the GitLab instance setting. Maximum length: 200
    PersonalAccessToken string
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    Url string
    GitLab API URL. Maximum length: 2000
    AlmGitlabId string
    The ID of this resource.
    Key string
    Unique key of the GitLab instance setting. Maximum length: 200
    PersonalAccessToken string
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    Url string
    GitLab API URL. Maximum length: 2000
    almGitlabId String
    The ID of this resource.
    key String
    Unique key of the GitLab instance setting. Maximum length: 200
    personalAccessToken String
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    url String
    GitLab API URL. Maximum length: 2000
    almGitlabId string
    The ID of this resource.
    key string
    Unique key of the GitLab instance setting. Maximum length: 200
    personalAccessToken string
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    url string
    GitLab API URL. Maximum length: 2000
    alm_gitlab_id str
    The ID of this resource.
    key str
    Unique key of the GitLab instance setting. Maximum length: 200
    personal_access_token str
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    url str
    GitLab API URL. Maximum length: 2000
    almGitlabId String
    The ID of this resource.
    key String
    Unique key of the GitLab instance setting. Maximum length: 200
    personalAccessToken String
    GitLab App personal access token with the read_api scope. See this doc for more information. Maximum length: 2000
    url String
    GitLab API URL. Maximum length: 2000

    Package Details

    Repository
    sonarqube jdamata/terraform-provider-sonarqube
    License
    Notes
    This Pulumi package is based on the sonarqube Terraform Provider.
    sonarqube logo
    sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata
    jdamata/terraform-provider-sonarqube