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

azuredevops.RepositoryPolicyCheckCredentials

Explore with Pulumi AI

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

    Manage a credentials check repository policy within Azure DevOps project. Block pushes that introduce files, folders, or branch names that include platform reserved names or incompatible characters.

    If both project and project policy are enabled, the project policy has high priority.

    Example Usage

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

const example = new azuredevops.Project("example", {
    name: "Example Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
    description: "Managed by Terraform",
});
const exampleGit = new azuredevops.Git("example", {
    projectId: example.id,
    name: "Example Repository",
    initialization: {
        initType: "Clean",
    },
});
const exampleRepositoryPolicyCheckCredentials = new azuredevops.RepositoryPolicyCheckCredentials("example", {
    projectId: example.id,
    enabled: true,
    blocking: true,
    repositoryIds: [exampleGit.id],
});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example",
    name="Example Project",
    visibility="private",
    version_control="Git",
    work_item_template="Agile",
    description="Managed by Terraform")
example_git = azuredevops.Git("example",
    project_id=example.id,
    name="Example Repository",
    initialization={
        "init_type": "Clean",
    })
example_repository_policy_check_credentials = azuredevops.RepositoryPolicyCheckCredentials("example",
    project_id=example.id,
    enabled=True,
    blocking=True,
    repository_ids=[example_git.id])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuredevops.NewProject(ctx, "example", &azuredevops.ProjectArgs{
			Name:             pulumi.String("Example Project"),
			Visibility:       pulumi.String("private"),
			VersionControl:   pulumi.String("Git"),
			WorkItemTemplate: pulumi.String("Agile"),
			Description:      pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		exampleGit, err := azuredevops.NewGit(ctx, "example", &azuredevops.GitArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Example Repository"),
			Initialization: &azuredevops.GitInitializationArgs{
				InitType: pulumi.String("Clean"),
			},
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewRepositoryPolicyCheckCredentials(ctx, "example", &azuredevops.RepositoryPolicyCheckCredentialsArgs{
			ProjectId: example.ID(),
			Enabled:   pulumi.Bool(true),
			Blocking:  pulumi.Bool(true),
			RepositoryIds: pulumi.StringArray{
				exampleGit.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

    var exampleGit = new AzureDevOps.Git("example", new()
    {
        ProjectId = example.Id,
        Name = "Example Repository",
        Initialization = new AzureDevOps.Inputs.GitInitializationArgs
        {
            InitType = "Clean",
        },
    });

    var exampleRepositoryPolicyCheckCredentials = new AzureDevOps.RepositoryPolicyCheckCredentials("example", new()
    {
        ProjectId = example.Id,
        Enabled = true,
        Blocking = true,
        RepositoryIds = new[]
        {
            exampleGit.Id,
        },
    });

});

    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.Git;
import com.pulumi.azuredevops.GitArgs;
import com.pulumi.azuredevops.inputs.GitInitializationArgs;
import com.pulumi.azuredevops.RepositoryPolicyCheckCredentials;
import com.pulumi.azuredevops.RepositoryPolicyCheckCredentialsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Project("example", ProjectArgs.builder()
            .name("Example Project")
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Terraform")
            .build());

        var exampleGit = new Git("exampleGit", GitArgs.builder()
            .projectId(example.id())
            .name("Example Repository")
            .initialization(GitInitializationArgs.builder()
                .initType("Clean")
                .build())
            .build());

        var exampleRepositoryPolicyCheckCredentials = new RepositoryPolicyCheckCredentials("exampleRepositoryPolicyCheckCredentials", RepositoryPolicyCheckCredentialsArgs.builder()
            .projectId(example.id())
            .enabled(true)
            .blocking(true)
            .repositoryIds(exampleGit.id())
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Terraform
  exampleGit:
    type: azuredevops:Git
    name: example
    properties:
      projectId: ${example.id}
      name: Example Repository
      initialization:
        initType: Clean
  exampleRepositoryPolicyCheckCredentials:
    type: azuredevops:RepositoryPolicyCheckCredentials
    name: example
    properties:
      projectId: ${example.id}
      enabled: true
      blocking: true
      repositoryIds:
        - ${exampleGit.id}

    Set project level repository policy

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

const example = new azuredevops.Project("example", {
    name: "Example Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
    description: "Managed by Terraform",
});
const exampleRepositoryPolicyCheckCredentials = new azuredevops.RepositoryPolicyCheckCredentials("example", {
    projectId: example.id,
    enabled: true,
    blocking: true,
});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example",
    name="Example Project",
    visibility="private",
    version_control="Git",
    work_item_template="Agile",
    description="Managed by Terraform")
example_repository_policy_check_credentials = azuredevops.RepositoryPolicyCheckCredentials("example",
    project_id=example.id,
    enabled=True,
    blocking=True)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuredevops.NewProject(ctx, "example", &azuredevops.ProjectArgs{
			Name:             pulumi.String("Example Project"),
			Visibility:       pulumi.String("private"),
			VersionControl:   pulumi.String("Git"),
			WorkItemTemplate: pulumi.String("Agile"),
			Description:      pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewRepositoryPolicyCheckCredentials(ctx, "example", &azuredevops.RepositoryPolicyCheckCredentialsArgs{
			ProjectId: example.ID(),
			Enabled:   pulumi.Bool(true),
			Blocking:  pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

    var exampleRepositoryPolicyCheckCredentials = new AzureDevOps.RepositoryPolicyCheckCredentials("example", new()
    {
        ProjectId = example.Id,
        Enabled = true,
        Blocking = true,
    });

});

    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.RepositoryPolicyCheckCredentials;
import com.pulumi.azuredevops.RepositoryPolicyCheckCredentialsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Project("example", ProjectArgs.builder()
            .name("Example Project")
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Terraform")
            .build());

        var exampleRepositoryPolicyCheckCredentials = new RepositoryPolicyCheckCredentials("exampleRepositoryPolicyCheckCredentials", RepositoryPolicyCheckCredentialsArgs.builder()
            .projectId(example.id())
            .enabled(true)
            .blocking(true)
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Terraform
  exampleRepositoryPolicyCheckCredentials:
    type: azuredevops:RepositoryPolicyCheckCredentials
    name: example
    properties:
      projectId: ${example.id}
      enabled: true
      blocking: true

    Create RepositoryPolicyCheckCredentials Resource

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

    Constructor syntax

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

@overload
def RepositoryPolicyCheckCredentials(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     project_id: Optional[str] = None,
                                     blocking: Optional[bool] = None,
                                     enabled: Optional[bool] = None,
                                     repository_ids: Optional[Sequence[str]] = None)
    func NewRepositoryPolicyCheckCredentials(ctx *Context, name string, args RepositoryPolicyCheckCredentialsArgs, opts ...ResourceOption) (*RepositoryPolicyCheckCredentials, error)
    public RepositoryPolicyCheckCredentials(string name, RepositoryPolicyCheckCredentialsArgs args, CustomResourceOptions? opts = null)
    public RepositoryPolicyCheckCredentials(String name, RepositoryPolicyCheckCredentialsArgs args)
public RepositoryPolicyCheckCredentials(String name, RepositoryPolicyCheckCredentialsArgs args, CustomResourceOptions options)

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

    Constructor example

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

    var repositoryPolicyCheckCredentialsResource = new AzureDevOps.RepositoryPolicyCheckCredentials("repositoryPolicyCheckCredentialsResource", new()
{
    ProjectId = "string",
    Blocking = false,
    Enabled = false,
    RepositoryIds = new[]
    {
        "string",
    },
});

    example, err := azuredevops.NewRepositoryPolicyCheckCredentials(ctx, "repositoryPolicyCheckCredentialsResource", &azuredevops.RepositoryPolicyCheckCredentialsArgs{
	ProjectId: pulumi.String("string"),
	Blocking:  pulumi.Bool(false),
	Enabled:   pulumi.Bool(false),
	RepositoryIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var repositoryPolicyCheckCredentialsResource = new RepositoryPolicyCheckCredentials("repositoryPolicyCheckCredentialsResource", RepositoryPolicyCheckCredentialsArgs.builder()
    .projectId("string")
    .blocking(false)
    .enabled(false)
    .repositoryIds("string")
    .build());

    repository_policy_check_credentials_resource = azuredevops.RepositoryPolicyCheckCredentials("repositoryPolicyCheckCredentialsResource",
    project_id="string",
    blocking=False,
    enabled=False,
    repository_ids=["string"])

    const repositoryPolicyCheckCredentialsResource = new azuredevops.RepositoryPolicyCheckCredentials("repositoryPolicyCheckCredentialsResource", {
    projectId: "string",
    blocking: false,
    enabled: false,
    repositoryIds: ["string"],
});

    type: azuredevops:RepositoryPolicyCheckCredentials
properties:
    blocking: false
    enabled: false
    projectId: string
    repositoryIds:
        - string

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

    ProjectId string
    The ID of the project in which the policy will be created.
    Blocking bool
    A flag indicating if the policy should be blocking. Defaults to true.
    Enabled bool
    A flag indicating if the policy should be enabled. Defaults to true.
    RepositoryIds List<string>
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.
    ProjectId string
    The ID of the project in which the policy will be created.
    Blocking bool
    A flag indicating if the policy should be blocking. Defaults to true.
    Enabled bool
    A flag indicating if the policy should be enabled. Defaults to true.
    RepositoryIds []string
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.
    projectId String
    The ID of the project in which the policy will be created.
    blocking Boolean
    A flag indicating if the policy should be blocking. Defaults to true.
    enabled Boolean
    A flag indicating if the policy should be enabled. Defaults to true.
    repositoryIds List<String>
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.
    projectId string
    The ID of the project in which the policy will be created.
    blocking boolean
    A flag indicating if the policy should be blocking. Defaults to true.
    enabled boolean
    A flag indicating if the policy should be enabled. Defaults to true.
    repositoryIds string[]
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.
    project_id str
    The ID of the project in which the policy will be created.
    blocking bool
    A flag indicating if the policy should be blocking. Defaults to true.
    enabled bool
    A flag indicating if the policy should be enabled. Defaults to true.
    repository_ids Sequence[str]
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.
    projectId String
    The ID of the project in which the policy will be created.
    blocking Boolean
    A flag indicating if the policy should be blocking. Defaults to true.
    enabled Boolean
    A flag indicating if the policy should be enabled. Defaults to true.
    repositoryIds List<String>
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RepositoryPolicyCheckCredentials Resource

    Get an existing RepositoryPolicyCheckCredentials 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?: RepositoryPolicyCheckCredentialsState, opts?: CustomResourceOptions): RepositoryPolicyCheckCredentials
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        blocking: Optional[bool] = None,
        enabled: Optional[bool] = None,
        project_id: Optional[str] = None,
        repository_ids: Optional[Sequence[str]] = None) -> RepositoryPolicyCheckCredentials
    func GetRepositoryPolicyCheckCredentials(ctx *Context, name string, id IDInput, state *RepositoryPolicyCheckCredentialsState, opts ...ResourceOption) (*RepositoryPolicyCheckCredentials, error)
    public static RepositoryPolicyCheckCredentials Get(string name, Input<string> id, RepositoryPolicyCheckCredentialsState? state, CustomResourceOptions? opts = null)
    public static RepositoryPolicyCheckCredentials get(String name, Output<String> id, RepositoryPolicyCheckCredentialsState 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:
    Blocking bool
    A flag indicating if the policy should be blocking. Defaults to true.
    Enabled bool
    A flag indicating if the policy should be enabled. Defaults to true.
    ProjectId string
    The ID of the project in which the policy will be created.
    RepositoryIds List<string>
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.
    Blocking bool
    A flag indicating if the policy should be blocking. Defaults to true.
    Enabled bool
    A flag indicating if the policy should be enabled. Defaults to true.
    ProjectId string
    The ID of the project in which the policy will be created.
    RepositoryIds []string
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.
    blocking Boolean
    A flag indicating if the policy should be blocking. Defaults to true.
    enabled Boolean
    A flag indicating if the policy should be enabled. Defaults to true.
    projectId String
    The ID of the project in which the policy will be created.
    repositoryIds List<String>
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.
    blocking boolean
    A flag indicating if the policy should be blocking. Defaults to true.
    enabled boolean
    A flag indicating if the policy should be enabled. Defaults to true.
    projectId string
    The ID of the project in which the policy will be created.
    repositoryIds string[]
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.
    blocking bool
    A flag indicating if the policy should be blocking. Defaults to true.
    enabled bool
    A flag indicating if the policy should be enabled. Defaults to true.
    project_id str
    The ID of the project in which the policy will be created.
    repository_ids Sequence[str]
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.
    blocking Boolean
    A flag indicating if the policy should be blocking. Defaults to true.
    enabled Boolean
    A flag indicating if the policy should be enabled. Defaults to true.
    projectId String
    The ID of the project in which the policy will be created.
    repositoryIds List<String>
    Control whether the policy is enabled for the repository or the project. If repository_ids not configured, the policy will be set to the project.

    Import

    Azure DevOps repository policies can be imported using the projectID/policyID or projectName/policyID:

    $ pulumi import azuredevops:index/repositoryPolicyCheckCredentials:RepositoryPolicyCheckCredentials example 00000000-0000-0000-0000-000000000000/0

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

    Package Details

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