UNPKG

@pulumi/azuredevops

Version:

A Pulumi package for creating and managing Azure DevOps.

140 lines (139 loc) 5.42 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * Configure a comment resolution policy for your branch 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"}); * const exampleGit = new azuredevops.Git("example", { * projectId: example.id, * name: "Example Repository", * initialization: { * initType: "Clean", * }, * }); * const exampleBranchPolicyCommentResolution = new azuredevops.BranchPolicyCommentResolution("example", { * projectId: example.id, * enabled: true, * blocking: true, * settings: { * scopes: [ * { * repositoryId: exampleGit.id, * repositoryRef: exampleGit.defaultBranch, * matchType: "Exact", * }, * { * repositoryId: exampleGit.id, * repositoryRef: "refs/heads/releases", * matchType: "Prefix", * }, * { * matchType: "DefaultBranch", * }, * ], * }, * }); * ``` * * ## Relevant Links * * - [Azure DevOps Service REST API 7.0 - Policy Configurations](https://docs.microsoft.com/en-us/rest/api/azure/devops/policy/configurations/create?view=azure-devops-rest-7.0) * * ## Import * * Azure DevOps Branch Policies can be imported using the project ID and policy configuration ID: * * ```sh * $ pulumi import azuredevops:index/branchPolicyCommentResolution:BranchPolicyCommentResolution example 00000000-0000-0000-0000-000000000000/0 * ``` */ export declare class BranchPolicyCommentResolution extends pulumi.CustomResource { /** * Get an existing BranchPolicyCommentResolution 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?: BranchPolicyCommentResolutionState, opts?: pulumi.CustomResourceOptions): BranchPolicyCommentResolution; /** * Returns true if the given object is an instance of BranchPolicyCommentResolution. 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 BranchPolicyCommentResolution; /** * 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>; /** * The ID of the project in which the policy will be created. */ readonly projectId: pulumi.Output<string>; /** * A `settings` block as defined below. Configuration for the policy. This block must be defined exactly once. */ readonly settings: pulumi.Output<outputs.BranchPolicyCommentResolutionSettings>; /** * Create a BranchPolicyCommentResolution 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: BranchPolicyCommentResolutionArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering BranchPolicyCommentResolution resources. */ export interface BranchPolicyCommentResolutionState { /** * 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>; /** * The ID of the project in which the policy will be created. */ projectId?: pulumi.Input<string>; /** * A `settings` block as defined below. Configuration for the policy. This block must be defined exactly once. */ settings?: pulumi.Input<inputs.BranchPolicyCommentResolutionSettings>; } /** * The set of arguments for constructing a BranchPolicyCommentResolution resource. */ export interface BranchPolicyCommentResolutionArgs { /** * 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>; /** * The ID of the project in which the policy will be created. */ projectId: pulumi.Input<string>; /** * A `settings` block as defined below. Configuration for the policy. This block must be defined exactly once. */ settings: pulumi.Input<inputs.BranchPolicyCommentResolutionSettings>; }