@pulumi/azuredevops
Version:
A Pulumi package for creating and managing Azure DevOps.
137 lines • 6.16 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.ServiceendpointCheckmarxOne = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Manages a Checkmarx One service endpoint within Azure DevOps. Using this service endpoint requires you to install: [Checkmarx AST](https://marketplace.visualstudio.com/items?itemName=checkmarx.checkmarx-ast-azure-plugin)
*
* ## Example Usage
*
* ### Authorize with API Key
*
* ```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 exampleServiceendpointCheckmarxOne = new azuredevops.ServiceendpointCheckmarxOne("example", {
* projectId: example.id,
* serviceEndpointName: "Example Checkmarx One",
* serverUrl: "https://server.com",
* apiKey: "apikey",
* });
* ```
*
* ### Authorize with Client ID and Secret
*
* ```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 exampleServiceendpointCheckmarxOne = new azuredevops.ServiceendpointCheckmarxOne("example", {
* projectId: example.id,
* serviceEndpointName: "Example Checkmarx One",
* serverUrl: "https://server.com",
* clientId: "clientid",
* clientSecret: "secret",
* authorizationUrl: "https://authurl.com",
* });
* ```
*
* ## Relevant Links
*
* - [Azure DevOps Service REST API 7.0 - Service Endpoints](https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints?view=azure-devops-rest-7.0)
*
* ## Import
*
* Azure DevOps Service Endpoint Check Marx One can be imported using **projectID/serviceEndpointID** or **projectName/serviceEndpointID**
*
* ```sh
* $ pulumi import azuredevops:index/serviceendpointCheckmarxOne:ServiceendpointCheckmarxOne example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
* ```
*/
class ServiceendpointCheckmarxOne extends pulumi.CustomResource {
/**
* Get an existing ServiceendpointCheckmarxOne 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 ServiceendpointCheckmarxOne(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of ServiceendpointCheckmarxOne. 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'] === ServiceendpointCheckmarxOne.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["apiKey"] = state?.apiKey;
resourceInputs["authorization"] = state?.authorization;
resourceInputs["authorizationUrl"] = state?.authorizationUrl;
resourceInputs["clientId"] = state?.clientId;
resourceInputs["clientSecret"] = state?.clientSecret;
resourceInputs["description"] = state?.description;
resourceInputs["projectId"] = state?.projectId;
resourceInputs["serverUrl"] = state?.serverUrl;
resourceInputs["serviceEndpointName"] = state?.serviceEndpointName;
}
else {
const args = argsOrState;
if (args?.projectId === undefined && !opts.urn) {
throw new Error("Missing required property 'projectId'");
}
if (args?.serverUrl === undefined && !opts.urn) {
throw new Error("Missing required property 'serverUrl'");
}
if (args?.serviceEndpointName === undefined && !opts.urn) {
throw new Error("Missing required property 'serviceEndpointName'");
}
resourceInputs["apiKey"] = args?.apiKey ? pulumi.secret(args.apiKey) : undefined;
resourceInputs["authorizationUrl"] = args?.authorizationUrl;
resourceInputs["clientId"] = args?.clientId;
resourceInputs["clientSecret"] = args?.clientSecret ? pulumi.secret(args.clientSecret) : undefined;
resourceInputs["description"] = args?.description;
resourceInputs["projectId"] = args?.projectId;
resourceInputs["serverUrl"] = args?.serverUrl;
resourceInputs["serviceEndpointName"] = args?.serviceEndpointName;
resourceInputs["authorization"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["apiKey", "clientSecret"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(ServiceendpointCheckmarxOne.__pulumiType, name, resourceInputs, opts);
}
}
exports.ServiceendpointCheckmarxOne = ServiceendpointCheckmarxOne;
/** @internal */
ServiceendpointCheckmarxOne.__pulumiType = 'azuredevops:index/serviceendpointCheckmarxOne:ServiceendpointCheckmarxOne';
//# sourceMappingURL=serviceendpointCheckmarxOne.js.map