1. Packages
  2. AzureDevOps
  3. API Docs
  4. CheckRequiredTemplate
Azure DevOps v3.0.0 published on Friday, Mar 15, 2024 by Pulumi

azuredevops.CheckRequiredTemplate

Explore with Pulumi AI

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

    Manages a Required Template Check.

    Example Usage

    Protect a service connection

    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 exampleCheckRequiredTemplate = new azuredevops.CheckRequiredTemplate("exampleCheckRequiredTemplate", {
        projectId: exampleProject.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_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_required_template = azuredevops.CheckRequiredTemplate("exampleCheckRequiredTemplate",
        project_id=example_project.id,
        target_resource_id=example_service_endpoint_generic.id,
        target_resource_type="endpoint",
        required_templates=[azuredevops.CheckRequiredTemplateRequiredTemplateArgs(
            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 {
    		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.NewCheckRequiredTemplate(ctx, "exampleCheckRequiredTemplate", &azuredevops.CheckRequiredTemplateArgs{
    			ProjectId:          exampleProject.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 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 exampleCheckRequiredTemplate = new AzureDevOps.CheckRequiredTemplate("exampleCheckRequiredTemplate", new()
        {
            ProjectId = exampleProject.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.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 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 exampleCheckRequiredTemplate = new CheckRequiredTemplate("exampleCheckRequiredTemplate", CheckRequiredTemplateArgs.builder()        
                .projectId(exampleProject.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:
      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
      exampleCheckRequiredTemplate:
        type: azuredevops:CheckRequiredTemplate
        properties:
          projectId: ${exampleProject.id}
          targetResourceId: ${exampleServiceEndpointGeneric.id}
          targetResourceType: endpoint
          requiredTemplates:
            - repositoryType: azuregit
              repositoryName: project/repository
              repositoryRef: refs/heads/main
              templatePath: template/path.yml
    

    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 exampleCheckRequiredTemplate = new azuredevops.CheckRequiredTemplate("exampleCheckRequiredTemplate", {
        projectId: exampleProject.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_project = azuredevops.Project("exampleProject")
    example_environment = azuredevops.Environment("exampleEnvironment", project_id=example_project.id)
    example_check_required_template = azuredevops.CheckRequiredTemplate("exampleCheckRequiredTemplate",
        project_id=example_project.id,
        target_resource_id=example_environment.id,
        target_resource_type="environment",
        required_templates=[
            azuredevops.CheckRequiredTemplateRequiredTemplateArgs(
                repository_name="project/repository",
                repository_ref="refs/heads/main",
                template_path="template/path.yml",
            ),
            azuredevops.CheckRequiredTemplateRequiredTemplateArgs(
                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 {
    		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.NewCheckRequiredTemplate(ctx, "exampleCheckRequiredTemplate", &azuredevops.CheckRequiredTemplateArgs{
    			ProjectId:          exampleProject.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 exampleProject = new AzureDevOps.Project("exampleProject");
    
        var exampleEnvironment = new AzureDevOps.Environment("exampleEnvironment", new()
        {
            ProjectId = exampleProject.Id,
        });
    
        var exampleCheckRequiredTemplate = new AzureDevOps.CheckRequiredTemplate("exampleCheckRequiredTemplate", new()
        {
            ProjectId = exampleProject.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.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 exampleProject = new Project("exampleProject");
    
            var exampleEnvironment = new Environment("exampleEnvironment", EnvironmentArgs.builder()        
                .projectId(exampleProject.id())
                .build());
    
            var exampleCheckRequiredTemplate = new CheckRequiredTemplate("exampleCheckRequiredTemplate", CheckRequiredTemplateArgs.builder()        
                .projectId(exampleProject.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:
      exampleProject:
        type: azuredevops:Project
      exampleEnvironment:
        type: azuredevops:Environment
        properties:
          projectId: ${exampleProject.id}
      exampleCheckRequiredTemplate:
        type: azuredevops:CheckRequiredTemplate
        properties:
          projectId: ${exampleProject.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.

    Constructor syntax

    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.

    Example

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

    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=[azuredevops.CheckRequiredTemplateRequiredTemplateArgs(
            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

    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.

    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)
    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 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. Valid values: 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. Valid values: 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. Valid values: 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. Valid values: 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. Valid values: 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. Valid values: 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.
    azuredevops logo
    Azure DevOps v3.0.0 published on Friday, Mar 15, 2024 by Pulumi