@pulumi/azuredevops
Version:
A Pulumi package for creating and managing Azure DevOps.
179 lines (178 loc) • 7.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Manages a Visual Studio Marketplace service endpoint within Azure DevOps. Using this service endpoint requires you to install: [Azure DevOps Extension Tasks](https://marketplace.visualstudio.com/items?itemName=ms-devlabs.vsts-developer-tools-build-tasks)
*
* ## Example Usage
*
* ### Authorize with token
* ```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 exampleServiceendpointVisualstudiomarketplace = new azuredevops.ServiceendpointVisualstudiomarketplace("example", {
* projectId: example.id,
* serviceEndpointName: "Example Marketplace",
* url: "https://markpetplace.com",
* authenticationToken: {
* token: "token",
* },
* description: "Managed by Pulumi",
* });
* ```
*
* ### Authorize with username and password
*
* ```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 exampleServiceendpointVisualstudiomarketplace = new azuredevops.ServiceendpointVisualstudiomarketplace("example", {
* projectId: example.id,
* serviceEndpointName: "Example Marketplace",
* url: "https://markpetplace.com",
* authenticationBasic: {
* username: "username",
* password: "password",
* },
* 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 Visual Studio Marketplace Service Endpoint can be imported using **projectID/serviceEndpointID** or **projectName/serviceEndpointID**
*
* ```sh
* $ pulumi import azuredevops:index/serviceendpointVisualstudiomarketplace:ServiceendpointVisualstudiomarketplace example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
* ```
*/
export declare class ServiceendpointVisualstudiomarketplace extends pulumi.CustomResource {
/**
* Get an existing ServiceendpointVisualstudiomarketplace 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?: ServiceendpointVisualstudiomarketplaceState, opts?: pulumi.CustomResourceOptions): ServiceendpointVisualstudiomarketplace;
/**
* Returns true if the given object is an instance of ServiceendpointVisualstudiomarketplace. 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 ServiceendpointVisualstudiomarketplace;
/**
* An `authenticationBasic` block as documented below.
*
* > **NOTE:** `authenticationBasic` and `authenticationToken` conflict with each other, only one is required.
*/
readonly authenticationBasic: pulumi.Output<outputs.ServiceendpointVisualstudiomarketplaceAuthenticationBasic | undefined>;
/**
* An `authenticationToken` block as documented below.
*/
readonly authenticationToken: pulumi.Output<outputs.ServiceendpointVisualstudiomarketplaceAuthenticationToken | undefined>;
readonly authorization: pulumi.Output<{
[key: string]: string;
}>;
readonly description: pulumi.Output<string | undefined>;
/**
* The ID of the project.
*/
readonly projectId: pulumi.Output<string>;
/**
* The Service Endpoint name.
*/
readonly serviceEndpointName: pulumi.Output<string>;
/**
* The server URL for Visual Studio Marketplace.
*/
readonly url: pulumi.Output<string>;
/**
* Create a ServiceendpointVisualstudiomarketplace 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: ServiceendpointVisualstudiomarketplaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServiceendpointVisualstudiomarketplace resources.
*/
export interface ServiceendpointVisualstudiomarketplaceState {
/**
* An `authenticationBasic` block as documented below.
*
* > **NOTE:** `authenticationBasic` and `authenticationToken` conflict with each other, only one is required.
*/
authenticationBasic?: pulumi.Input<inputs.ServiceendpointVisualstudiomarketplaceAuthenticationBasic>;
/**
* An `authenticationToken` block as documented below.
*/
authenticationToken?: pulumi.Input<inputs.ServiceendpointVisualstudiomarketplaceAuthenticationToken>;
authorization?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
/**
* The ID of the project.
*/
projectId?: pulumi.Input<string>;
/**
* The Service Endpoint name.
*/
serviceEndpointName?: pulumi.Input<string>;
/**
* The server URL for Visual Studio Marketplace.
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ServiceendpointVisualstudiomarketplace resource.
*/
export interface ServiceendpointVisualstudiomarketplaceArgs {
/**
* An `authenticationBasic` block as documented below.
*
* > **NOTE:** `authenticationBasic` and `authenticationToken` conflict with each other, only one is required.
*/
authenticationBasic?: pulumi.Input<inputs.ServiceendpointVisualstudiomarketplaceAuthenticationBasic>;
/**
* An `authenticationToken` block as documented below.
*/
authenticationToken?: pulumi.Input<inputs.ServiceendpointVisualstudiomarketplaceAuthenticationToken>;
description?: pulumi.Input<string>;
/**
* The ID of the project.
*/
projectId: pulumi.Input<string>;
/**
* The Service Endpoint name.
*/
serviceEndpointName: pulumi.Input<string>;
/**
* The server URL for Visual Studio Marketplace.
*/
url: pulumi.Input<string>;
}