Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azuredevops Provider
  3. API Docs
  4. ServiceEndpointSonarQube
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.ServiceEndpointSonarQube

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-azuredevops

    Manages a SonarQube service endpoint within Azure DevOps.

    Example Usage

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

const example = new azuredevops.Project("example", {
    name: "Example Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
    description: "Managed by Terraform",
});
const exampleServiceEndpointSonarQube = new azuredevops.ServiceEndpointSonarQube("example", {
    projectId: example.id,
    serviceEndpointName: "Example SonarQube",
    url: "https://sonarqube.my.com",
    token: "0000000000000000000000000000000000000000",
    description: "Managed by Terraform",
});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example",
    name="Example Project",
    visibility="private",
    version_control="Git",
    work_item_template="Agile",
    description="Managed by Terraform")
example_service_endpoint_sonar_qube = azuredevops.ServiceEndpointSonarQube("example",
    project_id=example.id,
    service_endpoint_name="Example SonarQube",
    url="https://sonarqube.my.com",
    token="0000000000000000000000000000000000000000",
    description="Managed by Terraform")

    package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuredevops.NewProject(ctx, "example", &azuredevops.ProjectArgs{
			Name:             pulumi.String("Example Project"),
			Visibility:       pulumi.String("private"),
			VersionControl:   pulumi.String("Git"),
			WorkItemTemplate: pulumi.String("Agile"),
			Description:      pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewServiceEndpointSonarQube(ctx, "example", &azuredevops.ServiceEndpointSonarQubeArgs{
			ProjectId:           example.ID(),
			ServiceEndpointName: pulumi.String("Example SonarQube"),
			Url:                 pulumi.String("https://sonarqube.my.com"),
			Token:               pulumi.String("0000000000000000000000000000000000000000"),
			Description:         pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var example = new AzureDevOps.Project("example", new()
    {
        Name = "Example Project",
        Visibility = "private",
        VersionControl = "Git",
        WorkItemTemplate = "Agile",
        Description = "Managed by Terraform",
    });

    var exampleServiceEndpointSonarQube = new AzureDevOps.ServiceEndpointSonarQube("example", new()
    {
        ProjectId = example.Id,
        ServiceEndpointName = "Example SonarQube",
        Url = "https://sonarqube.my.com",
        Token = "0000000000000000000000000000000000000000",
        Description = "Managed by Terraform",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.ServiceEndpointSonarQube;
import com.pulumi.azuredevops.ServiceEndpointSonarQubeArgs;
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 example = new Project("example", ProjectArgs.builder()
            .name("Example Project")
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Terraform")
            .build());

        var exampleServiceEndpointSonarQube = new ServiceEndpointSonarQube("exampleServiceEndpointSonarQube", ServiceEndpointSonarQubeArgs.builder()
            .projectId(example.id())
            .serviceEndpointName("Example SonarQube")
            .url("https://sonarqube.my.com")
            .token("0000000000000000000000000000000000000000")
            .description("Managed by Terraform")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Terraform
  exampleServiceEndpointSonarQube:
    type: azuredevops:ServiceEndpointSonarQube
    name: example
    properties:
      projectId: ${example.id}
      serviceEndpointName: Example SonarQube
      url: https://sonarqube.my.com
      token: '0000000000000000000000000000000000000000'
      description: Managed by Terraform

    Create ServiceEndpointSonarQube Resource

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

    Constructor syntax

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

@overload
def ServiceEndpointSonarQube(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             project_id: Optional[str] = None,
                             service_endpoint_name: Optional[str] = None,
                             token: Optional[str] = None,
                             url: Optional[str] = None,
                             authorization: Optional[Mapping[str, str]] = None,
                             description: Optional[str] = None)
    func NewServiceEndpointSonarQube(ctx *Context, name string, args ServiceEndpointSonarQubeArgs, opts ...ResourceOption) (*ServiceEndpointSonarQube, error)
    public ServiceEndpointSonarQube(string name, ServiceEndpointSonarQubeArgs args, CustomResourceOptions? opts = null)
    public ServiceEndpointSonarQube(String name, ServiceEndpointSonarQubeArgs args)
public ServiceEndpointSonarQube(String name, ServiceEndpointSonarQubeArgs args, CustomResourceOptions options)

    type: azuredevops:ServiceEndpointSonarQube
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 ServiceEndpointSonarQubeArgs
    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 ServiceEndpointSonarQubeArgs
    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 ServiceEndpointSonarQubeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceEndpointSonarQubeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceEndpointSonarQubeArgs
    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 serviceEndpointSonarQubeResource = new AzureDevOps.ServiceEndpointSonarQube("serviceEndpointSonarQubeResource", new()
{
    ProjectId = "string",
    ServiceEndpointName = "string",
    Token = "string",
    Url = "string",
    Authorization = 
    {
        { "string", "string" },
    },
    Description = "string",
});

    example, err := azuredevops.NewServiceEndpointSonarQube(ctx, "serviceEndpointSonarQubeResource", &azuredevops.ServiceEndpointSonarQubeArgs{
	ProjectId:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	Token:               pulumi.String("string"),
	Url:                 pulumi.String("string"),
	Authorization: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
})

    var serviceEndpointSonarQubeResource = new ServiceEndpointSonarQube("serviceEndpointSonarQubeResource", ServiceEndpointSonarQubeArgs.builder()
    .projectId("string")
    .serviceEndpointName("string")
    .token("string")
    .url("string")
    .authorization(Map.of("string", "string"))
    .description("string")
    .build());

    service_endpoint_sonar_qube_resource = azuredevops.ServiceEndpointSonarQube("serviceEndpointSonarQubeResource",
    project_id="string",
    service_endpoint_name="string",
    token="string",
    url="string",
    authorization={
        "string": "string",
    },
    description="string")

    const serviceEndpointSonarQubeResource = new azuredevops.ServiceEndpointSonarQube("serviceEndpointSonarQubeResource", {
    projectId: "string",
    serviceEndpointName: "string",
    token: "string",
    url: "string",
    authorization: {
        string: "string",
    },
    description: "string",
});

    type: azuredevops:ServiceEndpointSonarQube
properties:
    authorization:
        string: string
    description: string
    projectId: string
    serviceEndpointName: string
    token: string
    url: string

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

    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Token string
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    Url string
    URL of the SonarQube server to connect with.
    Authorization Dictionary<string, string>
    Description string
    The Service Endpoint description.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Token string
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    Url string
    URL of the SonarQube server to connect with.
    Authorization map[string]string
    Description string
    The Service Endpoint description.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    token String
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    url String
    URL of the SonarQube server to connect with.
    authorization Map<String,String>
    description String
    The Service Endpoint description.
    projectId string
    The ID of the project.
    serviceEndpointName string
    The Service Endpoint name.
    token string
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    url string
    URL of the SonarQube server to connect with.
    authorization {[key: string]: string}
    description string
    The Service Endpoint description.
    project_id str
    The ID of the project.
    service_endpoint_name str
    The Service Endpoint name.
    token str
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    url str
    URL of the SonarQube server to connect with.
    authorization Mapping[str, str]
    description str
    The Service Endpoint description.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    token String
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    url String
    URL of the SonarQube server to connect with.
    authorization Map<String>
    description String
    The Service Endpoint description.

    Outputs

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

    Get an existing ServiceEndpointSonarQube 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?: ServiceEndpointSonarQubeState, opts?: CustomResourceOptions): ServiceEndpointSonarQube
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        project_id: Optional[str] = None,
        service_endpoint_name: Optional[str] = None,
        token: Optional[str] = None,
        url: Optional[str] = None) -> ServiceEndpointSonarQube
    func GetServiceEndpointSonarQube(ctx *Context, name string, id IDInput, state *ServiceEndpointSonarQubeState, opts ...ResourceOption) (*ServiceEndpointSonarQube, error)
    public static ServiceEndpointSonarQube Get(string name, Input<string> id, ServiceEndpointSonarQubeState? state, CustomResourceOptions? opts = null)
    public static ServiceEndpointSonarQube get(String name, Output<String> id, ServiceEndpointSonarQubeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Authorization Dictionary<string, string>
    Description string
    The Service Endpoint description.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Token string
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    Url string
    URL of the SonarQube server to connect with.
    Authorization map[string]string
    Description string
    The Service Endpoint description.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Token string
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    Url string
    URL of the SonarQube server to connect with.
    authorization Map<String,String>
    description String
    The Service Endpoint description.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    token String
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    url String
    URL of the SonarQube server to connect with.
    authorization {[key: string]: string}
    description string
    The Service Endpoint description.
    projectId string
    The ID of the project.
    serviceEndpointName string
    The Service Endpoint name.
    token string
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    url string
    URL of the SonarQube server to connect with.
    authorization Mapping[str, str]
    description str
    The Service Endpoint description.
    project_id str
    The ID of the project.
    service_endpoint_name str
    The Service Endpoint name.
    token str
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    url str
    URL of the SonarQube server to connect with.
    authorization Map<String>
    description String
    The Service Endpoint description.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    token String
    Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
    url String
    URL of the SonarQube server to connect with.

    Import

    Azure DevOps Service Endpoint SonarQube can be imported using the projectID/serviceEndpointID, e.g.

    $ pulumi import azuredevops:index/serviceEndpointSonarQube:ServiceEndpointSonarQube example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
    pulumi/pulumi-azuredevops