UNPKG

@pulumi/azuredevops

Version:

A Pulumi package for creating and managing Azure DevOps.

131 lines (130 loc) 4.68 kB
import * as pulumi from "@pulumi/pulumi"; /** * Manages a Black Duck service endpoint within Azure DevOps. Using this service endpoint requires you to install: [Black Duck Detect](https://marketplace.visualstudio.com/items?itemName=blackduck.blackduck-detect) * * ## 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 exampleServiceendpointBlackDuck = new azuredevops.ServiceendpointBlackDuck("example", { * projectId: example.id, * serverUrl: "https://blackduck.com/", * apiToken: "token", * serviceEndpointName: "Example Black Duck", * 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 Black Duck Service Endpoint can be imported using **projectID/serviceEndpointID** or **projectName/serviceEndpointID** * * ```sh * $ pulumi import azuredevops:index/serviceendpointBlackDuck:ServiceendpointBlackDuck example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000 * ``` */ export declare class ServiceendpointBlackDuck extends pulumi.CustomResource { /** * Get an existing ServiceendpointBlackDuck 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?: ServiceendpointBlackDuckState, opts?: pulumi.CustomResourceOptions): ServiceendpointBlackDuck; /** * Returns true if the given object is an instance of ServiceendpointBlackDuck. 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 ServiceendpointBlackDuck; /** * The API token of the Black Duck Detect. */ readonly apiToken: pulumi.Output<string>; readonly authorization: pulumi.Output<{ [key: string]: string; }>; readonly description: pulumi.Output<string | undefined>; /** * The ID of the project. */ readonly projectId: pulumi.Output<string>; /** * The server URL of the Black Duck Detect. */ readonly serverUrl: pulumi.Output<string>; /** * The Service Endpoint name. */ readonly serviceEndpointName: pulumi.Output<string>; /** * Create a ServiceendpointBlackDuck 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: ServiceendpointBlackDuckArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ServiceendpointBlackDuck resources. */ export interface ServiceendpointBlackDuckState { /** * The API token of the Black Duck Detect. */ apiToken?: pulumi.Input<string>; authorization?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; description?: pulumi.Input<string>; /** * The ID of the project. */ projectId?: pulumi.Input<string>; /** * The server URL of the Black Duck Detect. */ serverUrl?: pulumi.Input<string>; /** * The Service Endpoint name. */ serviceEndpointName?: pulumi.Input<string>; } /** * The set of arguments for constructing a ServiceendpointBlackDuck resource. */ export interface ServiceendpointBlackDuckArgs { /** * The API token of the Black Duck Detect. */ apiToken: pulumi.Input<string>; description?: pulumi.Input<string>; /** * The ID of the project. */ projectId: pulumi.Input<string>; /** * The server URL of the Black Duck Detect. */ serverUrl: pulumi.Input<string>; /** * The Service Endpoint name. */ serviceEndpointName: pulumi.Input<string>; }