@pulumi/azuredevops
Version:
A Pulumi package for creating and managing Azure DevOps.
136 lines • 5.53 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.CheckRequiredTemplate = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Manages a Required Template Check.
*
* ## Example Usage
*
* ### Protect a service connection
*
* ```typescript
* 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",
* }],
* });
* ```
*
* ### Protect an environment
*
* ```typescript
* 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
*
* Importing this resource is not supported.
*/
class CheckRequiredTemplate extends pulumi.CustomResource {
/**
* Get an existing CheckRequiredTemplate 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, id, state, opts) {
return new CheckRequiredTemplate(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of CheckRequiredTemplate. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === CheckRequiredTemplate.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["projectId"] = state?.projectId;
resourceInputs["requiredTemplates"] = state?.requiredTemplates;
resourceInputs["targetResourceId"] = state?.targetResourceId;
resourceInputs["targetResourceType"] = state?.targetResourceType;
resourceInputs["version"] = state?.version;
}
else {
const args = argsOrState;
if (args?.projectId === undefined && !opts.urn) {
throw new Error("Missing required property 'projectId'");
}
if (args?.requiredTemplates === undefined && !opts.urn) {
throw new Error("Missing required property 'requiredTemplates'");
}
if (args?.targetResourceId === undefined && !opts.urn) {
throw new Error("Missing required property 'targetResourceId'");
}
if (args?.targetResourceType === undefined && !opts.urn) {
throw new Error("Missing required property 'targetResourceType'");
}
resourceInputs["projectId"] = args?.projectId;
resourceInputs["requiredTemplates"] = args?.requiredTemplates;
resourceInputs["targetResourceId"] = args?.targetResourceId;
resourceInputs["targetResourceType"] = args?.targetResourceType;
resourceInputs["version"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(CheckRequiredTemplate.__pulumiType, name, resourceInputs, opts);
}
}
exports.CheckRequiredTemplate = CheckRequiredTemplate;
/** @internal */
CheckRequiredTemplate.__pulumiType = 'azuredevops:index/checkRequiredTemplate:CheckRequiredTemplate';
//# sourceMappingURL=checkRequiredTemplate.js.map