Docs Packages
  1. Packages
  2. AzureDevOps
  3. API Docs
  4. CheckExclusiveLock
Azure DevOps v3.0.0 published on Friday, Mar 15, 2024 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.CheckExclusiveLock

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.0.0 published on Friday, Mar 15, 2024 by Pulumi
pulumi/pulumi-azuredevops

    Manages a Exclusive Lock Check.

    Adding an exclusive lock will only allow a single stage to utilize this resource at a time. If multiple stages are waiting on the lock, only the latest will run. All others will be canceled.

    Example Usage

    Add Exclusive Lock to an environment

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

const exampleProject = new azuredevops.Project("exampleProject", {});
const exampleServiceEndpointGeneric = new azuredevops.ServiceEndpointGeneric("exampleServiceEndpointGeneric", {
    projectId: exampleProject.id,
    serverUrl: "https://some-server.example.com",
    username: "username",
    password: "password",
    serviceEndpointName: "Example Generic",
    description: "Managed by Terraform",
});
const exampleCheckExclusiveLock = new azuredevops.CheckExclusiveLock("exampleCheckExclusiveLock", {
    projectId: exampleProject.id,
    targetResourceId: exampleServiceEndpointGeneric.id,
    targetResourceType: "endpoint",
    timeout: 43200,
});

    import pulumi
import pulumi_azuredevops as azuredevops

example_project = azuredevops.Project("exampleProject")
example_service_endpoint_generic = azuredevops.ServiceEndpointGeneric("exampleServiceEndpointGeneric",
    project_id=example_project.id,
    server_url="https://some-server.example.com",
    username="username",
    password="password",
    service_endpoint_name="Example Generic",
    description="Managed by Terraform")
example_check_exclusive_lock = azuredevops.CheckExclusiveLock("exampleCheckExclusiveLock",
    project_id=example_project.id,
    target_resource_id=example_service_endpoint_generic.id,
    target_resource_type="endpoint",
    timeout=43200)

    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 {
		exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", nil)
		if err != nil {
			return err
		}
		exampleServiceEndpointGeneric, err := azuredevops.NewServiceEndpointGeneric(ctx, "exampleServiceEndpointGeneric", &azuredevops.ServiceEndpointGenericArgs{
			ProjectId:           exampleProject.ID(),
			ServerUrl:           pulumi.String("https://some-server.example.com"),
			Username:            pulumi.String("username"),
			Password:            pulumi.String("password"),
			ServiceEndpointName: pulumi.String("Example Generic"),
			Description:         pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewCheckExclusiveLock(ctx, "exampleCheckExclusiveLock", &azuredevops.CheckExclusiveLockArgs{
			ProjectId:          exampleProject.ID(),
			TargetResourceId:   exampleServiceEndpointGeneric.ID(),
			TargetResourceType: pulumi.String("endpoint"),
			Timeout:            pulumi.Int(43200),
		})
		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 exampleProject = new AzureDevOps.Project("exampleProject");

    var exampleServiceEndpointGeneric = new AzureDevOps.ServiceEndpointGeneric("exampleServiceEndpointGeneric", new()
    {
        ProjectId = exampleProject.Id,
        ServerUrl = "https://some-server.example.com",
        Username = "username",
        Password = "password",
        ServiceEndpointName = "Example Generic",
        Description = "Managed by Terraform",
    });

    var exampleCheckExclusiveLock = new AzureDevOps.CheckExclusiveLock("exampleCheckExclusiveLock", new()
    {
        ProjectId = exampleProject.Id,
        TargetResourceId = exampleServiceEndpointGeneric.Id,
        TargetResourceType = "endpoint",
        Timeout = 43200,
    });

});

    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.ServiceEndpointGeneric;
import com.pulumi.azuredevops.ServiceEndpointGenericArgs;
import com.pulumi.azuredevops.CheckExclusiveLock;
import com.pulumi.azuredevops.CheckExclusiveLockArgs;
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 exampleProject = new Project("exampleProject");

        var exampleServiceEndpointGeneric = new ServiceEndpointGeneric("exampleServiceEndpointGeneric", ServiceEndpointGenericArgs.builder()        
            .projectId(exampleProject.id())
            .serverUrl("https://some-server.example.com")
            .username("username")
            .password("password")
            .serviceEndpointName("Example Generic")
            .description("Managed by Terraform")
            .build());

        var exampleCheckExclusiveLock = new CheckExclusiveLock("exampleCheckExclusiveLock", CheckExclusiveLockArgs.builder()        
            .projectId(exampleProject.id())
            .targetResourceId(exampleServiceEndpointGeneric.id())
            .targetResourceType("endpoint")
            .timeout(43200)
            .build());

    }
}

    resources:
  exampleProject:
    type: azuredevops:Project
  exampleServiceEndpointGeneric:
    type: azuredevops:ServiceEndpointGeneric
    properties:
      projectId: ${exampleProject.id}
      serverUrl: https://some-server.example.com
      username: username
      password: password
      serviceEndpointName: Example Generic
      description: Managed by Terraform
  exampleCheckExclusiveLock:
    type: azuredevops:CheckExclusiveLock
    properties:
      projectId: ${exampleProject.id}
      targetResourceId: ${exampleServiceEndpointGeneric.id}
      targetResourceType: endpoint
      timeout: 43200

    Protect an environment

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

const exampleProject = new azuredevops.Project("exampleProject", {});
const exampleEnvironment = new azuredevops.Environment("exampleEnvironment", {projectId: exampleProject.id});
const exampleCheckExclusiveLock = new azuredevops.CheckExclusiveLock("exampleCheckExclusiveLock", {
    projectId: exampleProject.id,
    targetResourceId: exampleEnvironment.id,
    targetResourceType: "environment",
    timeout: 43200,
});

    import pulumi
import pulumi_azuredevops as azuredevops

example_project = azuredevops.Project("exampleProject")
example_environment = azuredevops.Environment("exampleEnvironment", project_id=example_project.id)
example_check_exclusive_lock = azuredevops.CheckExclusiveLock("exampleCheckExclusiveLock",
    project_id=example_project.id,
    target_resource_id=example_environment.id,
    target_resource_type="environment",
    timeout=43200)

    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 {
		exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", nil)
		if err != nil {
			return err
		}
		exampleEnvironment, err := azuredevops.NewEnvironment(ctx, "exampleEnvironment", &azuredevops.EnvironmentArgs{
			ProjectId: exampleProject.ID(),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewCheckExclusiveLock(ctx, "exampleCheckExclusiveLock", &azuredevops.CheckExclusiveLockArgs{
			ProjectId:          exampleProject.ID(),
			TargetResourceId:   exampleEnvironment.ID(),
			TargetResourceType: pulumi.String("environment"),
			Timeout:            pulumi.Int(43200),
		})
		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 exampleProject = new AzureDevOps.Project("exampleProject");

    var exampleEnvironment = new AzureDevOps.Environment("exampleEnvironment", new()
    {
        ProjectId = exampleProject.Id,
    });

    var exampleCheckExclusiveLock = new AzureDevOps.CheckExclusiveLock("exampleCheckExclusiveLock", new()
    {
        ProjectId = exampleProject.Id,
        TargetResourceId = exampleEnvironment.Id,
        TargetResourceType = "environment",
        Timeout = 43200,
    });

});

    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.Environment;
import com.pulumi.azuredevops.EnvironmentArgs;
import com.pulumi.azuredevops.CheckExclusiveLock;
import com.pulumi.azuredevops.CheckExclusiveLockArgs;
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 exampleProject = new Project("exampleProject");

        var exampleEnvironment = new Environment("exampleEnvironment", EnvironmentArgs.builder()        
            .projectId(exampleProject.id())
            .build());

        var exampleCheckExclusiveLock = new CheckExclusiveLock("exampleCheckExclusiveLock", CheckExclusiveLockArgs.builder()        
            .projectId(exampleProject.id())
            .targetResourceId(exampleEnvironment.id())
            .targetResourceType("environment")
            .timeout(43200)
            .build());

    }
}

    resources:
  exampleProject:
    type: azuredevops:Project
  exampleEnvironment:
    type: azuredevops:Environment
    properties:
      projectId: ${exampleProject.id}
  exampleCheckExclusiveLock:
    type: azuredevops:CheckExclusiveLock
    properties:
      projectId: ${exampleProject.id}
      targetResourceId: ${exampleEnvironment.id}
      targetResourceType: environment
      timeout: 43200

    Create CheckExclusiveLock Resource

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

    Constructor syntax

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

@overload
def CheckExclusiveLock(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       project_id: Optional[str] = None,
                       target_resource_id: Optional[str] = None,
                       target_resource_type: Optional[str] = None,
                       timeout: Optional[int] = None)
    func NewCheckExclusiveLock(ctx *Context, name string, args CheckExclusiveLockArgs, opts ...ResourceOption) (*CheckExclusiveLock, error)
    public CheckExclusiveLock(string name, CheckExclusiveLockArgs args, CustomResourceOptions? opts = null)
    public CheckExclusiveLock(String name, CheckExclusiveLockArgs args)
public CheckExclusiveLock(String name, CheckExclusiveLockArgs args, CustomResourceOptions options)

    type: azuredevops:CheckExclusiveLock
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 CheckExclusiveLockArgs
    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 CheckExclusiveLockArgs
    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 CheckExclusiveLockArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CheckExclusiveLockArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CheckExclusiveLockArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var checkExclusiveLockResource = new AzureDevOps.CheckExclusiveLock("checkExclusiveLockResource", new()
{
    ProjectId = "string",
    TargetResourceId = "string",
    TargetResourceType = "string",
    Timeout = 0,
});

    example, err := azuredevops.NewCheckExclusiveLock(ctx, "checkExclusiveLockResource", &azuredevops.CheckExclusiveLockArgs{
	ProjectId:          pulumi.String("string"),
	TargetResourceId:   pulumi.String("string"),
	TargetResourceType: pulumi.String("string"),
	Timeout:            pulumi.Int(0),
})

    var checkExclusiveLockResource = new CheckExclusiveLock("checkExclusiveLockResource", CheckExclusiveLockArgs.builder()        
    .projectId("string")
    .targetResourceId("string")
    .targetResourceType("string")
    .timeout(0)
    .build());

    check_exclusive_lock_resource = azuredevops.CheckExclusiveLock("checkExclusiveLockResource",
    project_id="string",
    target_resource_id="string",
    target_resource_type="string",
    timeout=0)

    const checkExclusiveLockResource = new azuredevops.CheckExclusiveLock("checkExclusiveLockResource", {
    projectId: "string",
    targetResourceId: "string",
    targetResourceType: "string",
    timeout: 0,
});

    type: azuredevops:CheckExclusiveLock
properties:
    projectId: string
    targetResourceId: string
    targetResourceType: string
    timeout: 0

    CheckExclusiveLock Resource Properties

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

    Inputs

    The CheckExclusiveLock resource accepts the following input properties:

    ProjectId string
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    TargetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    TargetResourceType string
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    Timeout int
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    ProjectId string
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    TargetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    TargetResourceType string
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    Timeout int
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    projectId String
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    targetResourceId String
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    targetResourceType String
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    timeout Integer
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    projectId string
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    targetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    targetResourceType string
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    timeout number
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    project_id str
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    target_resource_id str
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    target_resource_type str
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    timeout int
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    projectId String
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    targetResourceId String
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    targetResourceType String
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    timeout Number
    The timeout in minutes for the exclusive lock. Defaults to 43200.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the check.
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the check.
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    The version of the check.
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The version of the check.
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    The version of the check.
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The version of the check.

    Look up Existing CheckExclusiveLock Resource

    Get an existing CheckExclusiveLock 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?: CheckExclusiveLockState, opts?: CustomResourceOptions): CheckExclusiveLock
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        project_id: Optional[str] = None,
        target_resource_id: Optional[str] = None,
        target_resource_type: Optional[str] = None,
        timeout: Optional[int] = None,
        version: Optional[int] = None) -> CheckExclusiveLock
    func GetCheckExclusiveLock(ctx *Context, name string, id IDInput, state *CheckExclusiveLockState, opts ...ResourceOption) (*CheckExclusiveLock, error)
    public static CheckExclusiveLock Get(string name, Input<string> id, CheckExclusiveLockState? state, CustomResourceOptions? opts = null)
    public static CheckExclusiveLock get(String name, Output<String> id, CheckExclusiveLockState 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:
    ProjectId string
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    TargetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    TargetResourceType string
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    Timeout int
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    Version int
    The version of the check.
    ProjectId string
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    TargetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    TargetResourceType string
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    Timeout int
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    Version int
    The version of the check.
    projectId String
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    targetResourceId String
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    targetResourceType String
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    timeout Integer
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    version Integer
    The version of the check.
    projectId string
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    targetResourceId string
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    targetResourceType string
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    timeout number
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    version number
    The version of the check.
    project_id str
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    target_resource_id str
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    target_resource_type str
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    timeout int
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    version int
    The version of the check.
    projectId String
    The project ID. Changing this forces a new Exclusive Lock Check to be created.
    targetResourceId String
    The ID of the resource being protected by the check. Changing this forces a new Exclusive Lock to be created.
    targetResourceType String
    The type of resource being protected by the check. Valid values: endpoint, environment, queue, repository, securefile, variablegroup. Changing this forces a new Exclusive Lock to be created.
    timeout Number
    The timeout in minutes for the exclusive lock. Defaults to 43200.
    version Number
    The version of the check.

    Import

    Importing this resource is not supported.

    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.0.0 published on Friday, Mar 15, 2024 by Pulumi
    pulumi/pulumi-azuredevops