UNPKG

@pulumi/azuredevops

Version:

A Pulumi package for creating and managing Azure DevOps.

110 lines 5.29 kB
"use strict"; // *** 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.ServiceendpointSnyk = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("./utilities"); /** * Manages a Snyk Security Scan service endpoint within Azure DevOps. Using this service endpoint requires you to install: [Snyk Security Scan](https://marketplace.visualstudio.com/items?itemName=Snyk.snyk-security-scan) * * ## 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 exampleServiceendpointSnyk = new azuredevops.ServiceendpointSnyk("example", { * projectId: example.id, * serverUrl: "https://snyk.io/", * apiToken: "00000000-0000-0000-0000-000000000000", * serviceEndpointName: "Example Snyk", * description: "Managed by Pulumi", * }); * ``` * * ## Relevant Links * * - [Azure DevOps Service REST API 7.0 - Endpoints](https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints?view=azure-devops-rest-7.0) * * ## Import * * Azure DevOps Snyk Service Endpoint can be imported using **projectID/serviceEndpointID** or **projectName/serviceEndpointID** * * ```sh * $ pulumi import azuredevops:index/serviceendpointSnyk:ServiceendpointSnyk example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000 * ``` */ class ServiceendpointSnyk extends pulumi.CustomResource { /** * Get an existing ServiceendpointSnyk 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 ServiceendpointSnyk(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of ServiceendpointSnyk. 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'] === ServiceendpointSnyk.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["apiToken"] = state ? state.apiToken : undefined; resourceInputs["authorization"] = state ? state.authorization : undefined; resourceInputs["description"] = state ? state.description : undefined; resourceInputs["projectId"] = state ? state.projectId : undefined; resourceInputs["serverUrl"] = state ? state.serverUrl : undefined; resourceInputs["serviceEndpointName"] = state ? state.serviceEndpointName : undefined; } else { const args = argsOrState; if ((!args || args.apiToken === undefined) && !opts.urn) { throw new Error("Missing required property 'apiToken'"); } if ((!args || args.projectId === undefined) && !opts.urn) { throw new Error("Missing required property 'projectId'"); } if ((!args || args.serverUrl === undefined) && !opts.urn) { throw new Error("Missing required property 'serverUrl'"); } if ((!args || args.serviceEndpointName === undefined) && !opts.urn) { throw new Error("Missing required property 'serviceEndpointName'"); } resourceInputs["apiToken"] = (args === null || args === void 0 ? void 0 : args.apiToken) ? pulumi.secret(args.apiToken) : undefined; resourceInputs["description"] = args ? args.description : undefined; resourceInputs["projectId"] = args ? args.projectId : undefined; resourceInputs["serverUrl"] = args ? args.serverUrl : undefined; resourceInputs["serviceEndpointName"] = args ? args.serviceEndpointName : undefined; resourceInputs["authorization"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); const secretOpts = { additionalSecretOutputs: ["apiToken"] }; opts = pulumi.mergeOptions(opts, secretOpts); super(ServiceendpointSnyk.__pulumiType, name, resourceInputs, opts); } } exports.ServiceendpointSnyk = ServiceendpointSnyk; /** @internal */ ServiceendpointSnyk.__pulumiType = 'azuredevops:index/serviceendpointSnyk:ServiceendpointSnyk'; //# sourceMappingURL=serviceendpointSnyk.js.map