@pulumi/azuredevops
Version:
A Pulumi package for creating and managing Azure DevOps.
167 lines (166 loc) • 6.89 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manage a file path pattern repository policy within Azure DevOps project.
*
* ## Example Usage
*
* ```typescript
* 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 Pulumi",
* });
* const exampleGit = new azuredevops.Git("example", {
* projectId: example.id,
* name: "Example Repository",
* initialization: {
* initType: "Clean",
* },
* });
* const exampleRepositoryPolicyFilePathPattern = new azuredevops.RepositoryPolicyFilePathPattern("example", {
* projectId: example.id,
* enabled: true,
* blocking: true,
* filepathPatterns: [
* "*.go",
* "/home/test/*.ts",
* ],
* repositoryIds: [exampleGit.id],
* });
* ```
*
* # Set project level repository policy
* ```typescript
* 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 Pulumi",
* });
* const examplep = new azuredevops.RepositoryPolicyFilePathPattern("examplep", {
* projectId: example.id,
* enabled: true,
* blocking: true,
* filepathPatterns: [
* "*.go",
* "/home/test/*.ts",
* ],
* });
* ```
*
* ## Relevant Links
*
* - [Azure DevOps Service REST API 7.0 - Policy Configurations](https://docs.microsoft.com/en-us/rest/api/azure/devops/policy/configurations?view=azure-devops-rest-7.0)
*
* ## Import
*
* Azure DevOps repository policies can be imported using the projectID/policyID or projectName/policyID:
*
* ```sh
* $ pulumi import azuredevops:index/repositoryPolicyFilePathPattern:RepositoryPolicyFilePathPattern example 00000000-0000-0000-0000-000000000000/0
* ```
*/
export declare class RepositoryPolicyFilePathPattern extends pulumi.CustomResource {
/**
* Get an existing RepositoryPolicyFilePathPattern resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RepositoryPolicyFilePathPatternState, opts?: pulumi.CustomResourceOptions): RepositoryPolicyFilePathPattern;
/**
* Returns true if the given object is an instance of RepositoryPolicyFilePathPattern. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is RepositoryPolicyFilePathPattern;
/**
* A flag indicating if the policy should be blocking. Defaults to `true`.
*/
readonly blocking: pulumi.Output<boolean | undefined>;
/**
* A flag indicating if the policy should be enabled. Defaults to `true`.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* Block pushes from introducing file paths that match the following patterns. Exact paths begin with "/". You can specify exact paths and wildcards. You can also specify multiple paths using ";" as a separator. Paths prefixed with "!" are excluded. Order is important.
*/
readonly filepathPatterns: pulumi.Output<string[]>;
/**
* The ID of the project in which the policy will be created.
*/
readonly projectId: pulumi.Output<string>;
/**
* Control whether the policy is enabled for the repository or the project. If `repositoryIds` not configured, the policy will be set to the project.
*/
readonly repositoryIds: pulumi.Output<string[] | undefined>;
/**
* Create a RepositoryPolicyFilePathPattern resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: RepositoryPolicyFilePathPatternArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RepositoryPolicyFilePathPattern resources.
*/
export interface RepositoryPolicyFilePathPatternState {
/**
* A flag indicating if the policy should be blocking. Defaults to `true`.
*/
blocking?: pulumi.Input<boolean>;
/**
* A flag indicating if the policy should be enabled. Defaults to `true`.
*/
enabled?: pulumi.Input<boolean>;
/**
* Block pushes from introducing file paths that match the following patterns. Exact paths begin with "/". You can specify exact paths and wildcards. You can also specify multiple paths using ";" as a separator. Paths prefixed with "!" are excluded. Order is important.
*/
filepathPatterns?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of the project in which the policy will be created.
*/
projectId?: pulumi.Input<string>;
/**
* Control whether the policy is enabled for the repository or the project. If `repositoryIds` not configured, the policy will be set to the project.
*/
repositoryIds?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a RepositoryPolicyFilePathPattern resource.
*/
export interface RepositoryPolicyFilePathPatternArgs {
/**
* A flag indicating if the policy should be blocking. Defaults to `true`.
*/
blocking?: pulumi.Input<boolean>;
/**
* A flag indicating if the policy should be enabled. Defaults to `true`.
*/
enabled?: pulumi.Input<boolean>;
/**
* Block pushes from introducing file paths that match the following patterns. Exact paths begin with "/". You can specify exact paths and wildcards. You can also specify multiple paths using ";" as a separator. Paths prefixed with "!" are excluded. Order is important.
*/
filepathPatterns: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of the project in which the policy will be created.
*/
projectId: pulumi.Input<string>;
/**
* Control whether the policy is enabled for the repository or the project. If `repositoryIds` not configured, the policy will be set to the project.
*/
repositoryIds?: pulumi.Input<pulumi.Input<string>[]>;
}