Azure DevOps v3.9.0, Apr 22 25

Azure DevOps v3.9.0 published on Tuesday, Apr 22, 2025 by Pulumi

azuredevops.CheckRequiredTemplate

Explore with Pulumi AI

Azure DevOps v3.9.0 published on Tuesday, Apr 22, 2025 by Pulumi

Example Usage

Protect a service connection

TypeScript
Python
Go
C#
Java
YAML

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

const example = new azuredevops.Project("example", {name: "Example Project"});
const exampleServiceEndpointGeneric = new azuredevops.ServiceEndpointGeneric("example", {
    projectId: example.id,
    serverUrl: "https://some-server.example.com",
    username: "username",
    password: "password",
    serviceEndpointName: "Example Generic",
    description: "Managed by Pulumi",
});
const exampleCheckRequiredTemplate = new azuredevops.CheckRequiredTemplate("example", {
    projectId: example.id,
    targetResourceId: exampleServiceEndpointGeneric.id,
    targetResourceType: "endpoint",
    requiredTemplates: [{
        repositoryType: "azuregit",
        repositoryName: "project/repository",
        repositoryRef: "refs/heads/main",
        templatePath: "template/path.yml",
    }],
});

import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example", name="Example Project")
example_service_endpoint_generic = azuredevops.ServiceEndpointGeneric("example",
    project_id=example.id,
    server_url="https://some-server.example.com",
    username="username",
    password="password",
    service_endpoint_name="Example Generic",
    description="Managed by Pulumi")
example_check_required_template = azuredevops.CheckRequiredTemplate("example",
    project_id=example.id,
    target_resource_id=example_service_endpoint_generic.id,
    target_resource_type="endpoint",
    required_templates=[{
        "repository_type": "azuregit",
        "repository_name": "project/repository",
        "repository_ref": "refs/heads/main",
        "template_path": "template/path.yml",
    }])

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"),
		})
		if err != nil {
			return err
		}
		exampleServiceEndpointGeneric, err := azuredevops.NewServiceEndpointGeneric(ctx, "example", &azuredevops.ServiceEndpointGenericArgs{
			ProjectId:           example.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 Pulumi"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewCheckRequiredTemplate(ctx, "example", &azuredevops.CheckRequiredTemplateArgs{
			ProjectId:          example.ID(),
			TargetResourceId:   exampleServiceEndpointGeneric.ID(),
			TargetResourceType: pulumi.String("endpoint"),
			RequiredTemplates: azuredevops.CheckRequiredTemplateRequiredTemplateArray{
				&azuredevops.CheckRequiredTemplateRequiredTemplateArgs{
					RepositoryType: pulumi.String("azuregit"),
					RepositoryName: pulumi.String("project/repository"),
					RepositoryRef:  pulumi.String("refs/heads/main"),
					TemplatePath:   pulumi.String("template/path.yml"),
				},
			},
		})
		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",
    });

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

    var exampleCheckRequiredTemplate = new AzureDevOps.CheckRequiredTemplate("example", new()
    {
        ProjectId = example.Id,
        TargetResourceId = exampleServiceEndpointGeneric.Id,
        TargetResourceType = "endpoint",
        RequiredTemplates = new[]
        {
            new AzureDevOps.Inputs.CheckRequiredTemplateRequiredTemplateArgs
            {
                RepositoryType = "azuregit",
                RepositoryName = "project/repository",
                RepositoryRef = "refs/heads/main",
                TemplatePath = "template/path.yml",
            },
        },
    });

});

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.ServiceEndpointGeneric;
import com.pulumi.azuredevops.ServiceEndpointGenericArgs;
import com.pulumi.azuredevops.CheckRequiredTemplate;
import com.pulumi.azuredevops.CheckRequiredTemplateArgs;
import com.pulumi.azuredevops.inputs.CheckRequiredTemplateRequiredTemplateArgs;
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")
            .build());

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

        var exampleCheckRequiredTemplate = new CheckRequiredTemplate("exampleCheckRequiredTemplate", CheckRequiredTemplateArgs.builder()
            .projectId(example.id())
            .targetResourceId(exampleServiceEndpointGeneric.id())
            .targetResourceType("endpoint")
            .requiredTemplates(CheckRequiredTemplateRequiredTemplateArgs.builder()
                .repositoryType("azuregit")
                .repositoryName("project/repository")
                .repositoryRef("refs/heads/main")
                .templatePath("template/path.yml")
                .build())
            .build());

    }
}

resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
  exampleServiceEndpointGeneric:
    type: azuredevops:ServiceEndpointGeneric
    name: example
    properties:
      projectId: ${example.id}
      serverUrl: https://some-server.example.com
      username: username
      password: password
      serviceEndpointName: Example Generic
      description: Managed by Pulumi
  exampleCheckRequiredTemplate:
    type: azuredevops:CheckRequiredTemplate
    name: example
    properties:
      projectId: ${example.id}
      targetResourceId: ${exampleServiceEndpointGeneric.id}
      targetResourceType: endpoint
      requiredTemplates:
        - repositoryType: azuregit
          repositoryName: project/repository
          repositoryRef: refs/heads/main
          templatePath: template/path.yml

Protect an environment

TypeScript
Python
Go
C#
Java
YAML

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

const example = new azuredevops.Project("example", {name: "Example Project"});
const exampleEnvironment = new azuredevops.Environment("example", {
    projectId: example.id,
    name: "Example Environment",
});
const exampleCheckRequiredTemplate = new azuredevops.CheckRequiredTemplate("example", {
    projectId: example.id,
    targetResourceId: exampleEnvironment.id,
    targetResourceType: "environment",
    requiredTemplates: [
        {
            repositoryName: "project/repository",
            repositoryRef: "refs/heads/main",
            templatePath: "template/path.yml",
        },
        {
            repositoryName: "project/repository",
            repositoryRef: "refs/heads/main",
            templatePath: "template/alternate-path.yml",
        },
    ],
});

import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example", name="Example Project")
example_environment = azuredevops.Environment("example",
    project_id=example.id,
    name="Example Environment")
example_check_required_template = azuredevops.CheckRequiredTemplate("example",
    project_id=example.id,
    target_resource_id=example_environment.id,
    target_resource_type="environment",
    required_templates=[
        {
            "repository_name": "project/repository",
            "repository_ref": "refs/heads/main",
            "template_path": "template/path.yml",
        },
        {
            "repository_name": "project/repository",
            "repository_ref": "refs/heads/main",
            "template_path": "template/alternate-path.yml",
        },
    ])

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"),
		})
		if err != nil {
			return err
		}
		exampleEnvironment, err := azuredevops.NewEnvironment(ctx, "example", &azuredevops.EnvironmentArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Example Environment"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewCheckRequiredTemplate(ctx, "example", &azuredevops.CheckRequiredTemplateArgs{
			ProjectId:          example.ID(),
			TargetResourceId:   exampleEnvironment.ID(),
			TargetResourceType: pulumi.String("environment"),
			RequiredTemplates: azuredevops.CheckRequiredTemplateRequiredTemplateArray{
				&azuredevops.CheckRequiredTemplateRequiredTemplateArgs{
					RepositoryName: pulumi.String("project/repository"),
					RepositoryRef:  pulumi.String("refs/heads/main"),
					TemplatePath:   pulumi.String("template/path.yml"),
				},
				&azuredevops.CheckRequiredTemplateRequiredTemplateArgs{
					RepositoryName: pulumi.String("project/repository"),
					RepositoryRef:  pulumi.String("refs/heads/main"),
					TemplatePath:   pulumi.String("template/alternate-path.yml"),
				},
			},
		})
		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",
    });

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

    var exampleCheckRequiredTemplate = new AzureDevOps.CheckRequiredTemplate("example", new()
    {
        ProjectId = example.Id,
        TargetResourceId = exampleEnvironment.Id,
        TargetResourceType = "environment",
        RequiredTemplates = new[]
        {
            new AzureDevOps.Inputs.CheckRequiredTemplateRequiredTemplateArgs
            {
                RepositoryName = "project/repository",
                RepositoryRef = "refs/heads/main",
                TemplatePath = "template/path.yml",
            },
            new AzureDevOps.Inputs.CheckRequiredTemplateRequiredTemplateArgs
            {
                RepositoryName = "project/repository",
                RepositoryRef = "refs/heads/main",
                TemplatePath = "template/alternate-path.yml",
            },
        },
    });

});

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.Environment;
import com.pulumi.azuredevops.EnvironmentArgs;
import com.pulumi.azuredevops.CheckRequiredTemplate;
import com.pulumi.azuredevops.CheckRequiredTemplateArgs;
import com.pulumi.azuredevops.inputs.CheckRequiredTemplateRequiredTemplateArgs;
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")
            .build());

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

        var exampleCheckRequiredTemplate = new CheckRequiredTemplate("exampleCheckRequiredTemplate", CheckRequiredTemplateArgs.builder()
            .projectId(example.id())
            .targetResourceId(exampleEnvironment.id())
            .targetResourceType("environment")
            .requiredTemplates(            
                CheckRequiredTemplateRequiredTemplateArgs.builder()
                    .repositoryName("project/repository")
                    .repositoryRef("refs/heads/main")
                    .templatePath("template/path.yml")
                    .build(),
                CheckRequiredTemplateRequiredTemplateArgs.builder()
                    .repositoryName("project/repository")
                    .repositoryRef("refs/heads/main")
                    .templatePath("template/alternate-path.yml")
                    .build())
            .build());

    }
}

resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
  exampleEnvironment:
    type: azuredevops:Environment
    name: example
    properties:
      projectId: ${example.id}
      name: Example Environment
  exampleCheckRequiredTemplate:
    type: azuredevops:CheckRequiredTemplate
    name: example
    properties:
      projectId: ${example.id}
      targetResourceId: ${exampleEnvironment.id}
      targetResourceType: environment
      requiredTemplates:
        - repositoryName: project/repository
          repositoryRef: refs/heads/main
          templatePath: template/path.yml
        - repositoryName: project/repository
          repositoryRef: refs/heads/main
          templatePath: template/alternate-path.yml

Create CheckRequiredTemplate Resource

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

new CheckRequiredTemplate(name: string, args: CheckRequiredTemplateArgs, opts?: CustomResourceOptions);

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

@overload
def CheckRequiredTemplate(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          project_id: Optional[str] = None,
                          required_templates: Optional[Sequence[CheckRequiredTemplateRequiredTemplateArgs]] = None,
                          target_resource_id: Optional[str] = None,
                          target_resource_type: Optional[str] = None)

func NewCheckRequiredTemplate(ctx *Context, name string, args CheckRequiredTemplateArgs, opts ...ResourceOption) (*CheckRequiredTemplate, error)

public CheckRequiredTemplate(string name, CheckRequiredTemplateArgs args, CustomResourceOptions? opts = null)

public CheckRequiredTemplate(String name, CheckRequiredTemplateArgs args)
public CheckRequiredTemplate(String name, CheckRequiredTemplateArgs args, CustomResourceOptions options)

type: azuredevops:CheckRequiredTemplate
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 CheckRequiredTemplateArgs: 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 CheckRequiredTemplateArgs: 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 CheckRequiredTemplateArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args CheckRequiredTemplateArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var checkRequiredTemplateResource = new AzureDevOps.CheckRequiredTemplate("checkRequiredTemplateResource", new()
{
    ProjectId = "string",
    RequiredTemplates = new[]
    {
        new AzureDevOps.Inputs.CheckRequiredTemplateRequiredTemplateArgs
        {
            RepositoryName = "string",
            RepositoryRef = "string",
            TemplatePath = "string",
            RepositoryType = "string",
        },
    },
    TargetResourceId = "string",
    TargetResourceType = "string",
});

example, err := azuredevops.NewCheckRequiredTemplate(ctx, "checkRequiredTemplateResource", &azuredevops.CheckRequiredTemplateArgs{
	ProjectId: pulumi.String("string"),
	RequiredTemplates: azuredevops.CheckRequiredTemplateRequiredTemplateArray{
		&azuredevops.CheckRequiredTemplateRequiredTemplateArgs{
			RepositoryName: pulumi.String("string"),
			RepositoryRef:  pulumi.String("string"),
			TemplatePath:   pulumi.String("string"),
			RepositoryType: pulumi.String("string"),
		},
	},
	TargetResourceId:   pulumi.String("string"),
	TargetResourceType: pulumi.String("string"),
})

var checkRequiredTemplateResource = new CheckRequiredTemplate("checkRequiredTemplateResource", CheckRequiredTemplateArgs.builder()
    .projectId("string")
    .requiredTemplates(CheckRequiredTemplateRequiredTemplateArgs.builder()
        .repositoryName("string")
        .repositoryRef("string")
        .templatePath("string")
        .repositoryType("string")
        .build())
    .targetResourceId("string")
    .targetResourceType("string")
    .build());

check_required_template_resource = azuredevops.CheckRequiredTemplate("checkRequiredTemplateResource",
    project_id="string",
    required_templates=[{
        "repository_name": "string",
        "repository_ref": "string",
        "template_path": "string",
        "repository_type": "string",
    }],
    target_resource_id="string",
    target_resource_type="string")

const checkRequiredTemplateResource = new azuredevops.CheckRequiredTemplate("checkRequiredTemplateResource", {
    projectId: "string",
    requiredTemplates: [{
        repositoryName: "string",
        repositoryRef: "string",
        templatePath: "string",
        repositoryType: "string",
    }],
    targetResourceId: "string",
    targetResourceType: "string",
});

type: azuredevops:CheckRequiredTemplate
properties:
    projectId: string
    requiredTemplates:
        - repositoryName: string
          repositoryRef: string
          repositoryType: string
          templatePath: string
    targetResourceId: string
    targetResourceType: string

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

ProjectId string: The project ID. Changing this forces a new Required Template Check to be created.
RequiredTemplates List<Pulumi.AzureDevOps.Inputs.CheckRequiredTemplateRequiredTemplate>: One or more required_template blocks documented below.
TargetResourceId string: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.

ProjectId string: The project ID. Changing this forces a new Required Template Check to be created.
RequiredTemplates []CheckRequiredTemplateRequiredTemplateArgs: One or more required_template blocks documented below.
TargetResourceId string: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.

projectId String: The project ID. Changing this forces a new Required Template Check to be created.
requiredTemplates List<CheckRequiredTemplateRequiredTemplate>: One or more required_template blocks documented below.
targetResourceId String: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.

projectId string: The project ID. Changing this forces a new Required Template Check to be created.
requiredTemplates CheckRequiredTemplateRequiredTemplate[]: One or more required_template blocks documented below.
targetResourceId string: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.

project_id str: The project ID. Changing this forces a new Required Template Check to be created.
required_templates Sequence[CheckRequiredTemplateRequiredTemplateArgs]: One or more required_template blocks documented below.
target_resource_id str: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.

projectId String: The project ID. Changing this forces a new Required Template Check to be created.
requiredTemplates List<Property Map>: One or more required_template blocks documented below.
targetResourceId String: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.

Outputs

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

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

TypeScript
Python
Go
C#
Java
YAML

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        project_id: Optional[str] = None,
        required_templates: Optional[Sequence[CheckRequiredTemplateRequiredTemplateArgs]] = None,
        target_resource_id: Optional[str] = None,
        target_resource_type: Optional[str] = None,
        version: Optional[int] = None) -> CheckRequiredTemplate

func GetCheckRequiredTemplate(ctx *Context, name string, id IDInput, state *CheckRequiredTemplateState, opts ...ResourceOption) (*CheckRequiredTemplate, error)

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

public static CheckRequiredTemplate get(String name, Output<String> id, CheckRequiredTemplateState state, CustomResourceOptions options)

resources:  _:    type: azuredevops:CheckRequiredTemplate    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:

ProjectId string: The project ID. Changing this forces a new Required Template Check to be created.
RequiredTemplates List<Pulumi.AzureDevOps.Inputs.CheckRequiredTemplateRequiredTemplate>: One or more required_template blocks documented below.
TargetResourceId string: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.
Version int: The version of the check.

ProjectId string: The project ID. Changing this forces a new Required Template Check to be created.
RequiredTemplates []CheckRequiredTemplateRequiredTemplateArgs: One or more required_template blocks documented below.
TargetResourceId string: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.
Version int: The version of the check.

projectId String: The project ID. Changing this forces a new Required Template Check to be created.
requiredTemplates List<CheckRequiredTemplateRequiredTemplate>: One or more required_template blocks documented below.
targetResourceId String: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.
version Integer: The version of the check.

projectId string: The project ID. Changing this forces a new Required Template Check to be created.
requiredTemplates CheckRequiredTemplateRequiredTemplate[]: One or more required_template blocks documented below.
targetResourceId string: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.
version number: The version of the check.

project_id str: The project ID. Changing this forces a new Required Template Check to be created.
required_templates Sequence[CheckRequiredTemplateRequiredTemplateArgs]: One or more required_template blocks documented below.
target_resource_id str: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.
version int: The version of the check.

projectId String: The project ID. Changing this forces a new Required Template Check to be created.
requiredTemplates List<Property Map>: One or more required_template blocks documented below.
targetResourceId String: The ID of the resource being protected by the check. Changing this forces a new Required Template Check 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 Required Template Check to be created.
version Number: The version of the check.

Supporting Types

CheckRequiredTemplateRequiredTemplate
, CheckRequiredTemplateRequiredTemplateArgs

RepositoryName string: The name of the repository storing the template.
RepositoryRef string: The branch in which the template will be referenced.
TemplatePath string: The path to the template yaml.
RepositoryType string: The type of the repository storing the template. Possible values are: azuregit, github, githubenterprise, bitbucket. Defaults to azuregit.

RepositoryName string: The name of the repository storing the template.
RepositoryRef string: The branch in which the template will be referenced.
TemplatePath string: The path to the template yaml.
RepositoryType string: The type of the repository storing the template. Possible values are: azuregit, github, githubenterprise, bitbucket. Defaults to azuregit.

repositoryName String: The name of the repository storing the template.
repositoryRef String: The branch in which the template will be referenced.
templatePath String: The path to the template yaml.
repositoryType String: The type of the repository storing the template. Possible values are: azuregit, github, githubenterprise, bitbucket. Defaults to azuregit.

repositoryName string: The name of the repository storing the template.
repositoryRef string: The branch in which the template will be referenced.
templatePath string: The path to the template yaml.
repositoryType string: The type of the repository storing the template. Possible values are: azuregit, github, githubenterprise, bitbucket. Defaults to azuregit.

repository_name str: The name of the repository storing the template.
repository_ref str: The branch in which the template will be referenced.
template_path str: The path to the template yaml.
repository_type str: The type of the repository storing the template. Possible values are: azuregit, github, githubenterprise, bitbucket. Defaults to azuregit.

repositoryName String: The name of the repository storing the template.
repositoryRef String: The branch in which the template will be referenced.
templatePath String: The path to the template yaml.
repositoryType String: The type of the repository storing the template. Possible values are: azuregit, github, githubenterprise, bitbucket. Defaults to azuregit.

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.

Azure DevOps v3.9.0 published on Tuesday, Apr 22, 2025 by Pulumi

pulumi/pulumi-azuredevops

azuredevops.CheckRequiredTemplate

On this page

On this page

Example Usage

Protect a service connection

Protect an environment

Create CheckRequiredTemplate Resource

Constructor syntax

Parameters

Constructor example

CheckRequiredTemplate Resource Properties

Inputs

Outputs

Look up Existing CheckRequiredTemplate Resource

Supporting Types

CheckRequiredTemplateRequiredTemplate
, CheckRequiredTemplateRequiredTemplateArgs

Import

Package Details

On this page

On this page

azuredevops.CheckRequiredTemplate

On this page

On this page

Example Usage

Protect a service connection

Protect an environment

Create CheckRequiredTemplate Resource

Constructor syntax

Parameters

Constructor example

CheckRequiredTemplate Resource Properties

Inputs

Outputs

Look up Existing CheckRequiredTemplate Resource

Supporting Types

CheckRequiredTemplateRequiredTemplate, CheckRequiredTemplateRequiredTemplateArgs

Import

Package Details

On this page

On this page

CheckRequiredTemplateRequiredTemplate
, CheckRequiredTemplateRequiredTemplateArgs