@pulumi/azuredevops
Version:
A Pulumi package for creating and managing Azure DevOps.
189 lines (188 loc) • 7.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Manages a JFrog Distribution V2 service endpoint within an Azure DevOps organization.
*
* > **Note:** Using this service endpoint requires you to first install [JFrog Extension](https://marketplace.visualstudio.com/items?itemName=JFrog.jfrog-azure-devops-extension).
*
* ## 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 exampleServiceendpointJfrogDistributionV2 = new azuredevops.ServiceendpointJfrogDistributionV2("example", {
* projectId: example.id,
* serviceEndpointName: "Example JFrog Distribution V2",
* description: "Managed by Pulumi",
* url: "https://artifactory.my.com",
* authenticationToken: {
* token: "0000000000000000000000000000000000000000",
* },
* });
* ```
* Alternatively a username and password may be used.
*
* ```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 exampleServiceendpointJfrogDistributionV2 = new azuredevops.ServiceendpointJfrogDistributionV2("example", {
* projectId: example.id,
* serviceEndpointName: "Example JFrog Distribution V2",
* description: "Managed by Pulumi",
* url: "https://artifactory.my.com",
* authenticationBasic: {
* username: "username",
* password: "password",
* },
* });
* ```
*
* ## Relevant Links
*
* * [Azure DevOps Service Connections](https://docs.microsoft.com/en-us/azure/devops/pipelines/library/service-endpoints?view=azure-devops&tabs=yaml)
* * [Artifactory User Token](https://docs.artifactory.org/latest/user-guide/user-token/)
*
* ## Import
*
* Azure DevOps JFrog Distribution V2 Service Endpoint can be imported using the **projectID/serviceEndpointID**, e.g.
*
* ```sh
* $ pulumi import azuredevops:index/serviceendpointJfrogDistributionV2:ServiceendpointJfrogDistributionV2 example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
* ```
*/
export declare class ServiceendpointJfrogDistributionV2 extends pulumi.CustomResource {
/**
* Get an existing ServiceendpointJfrogDistributionV2 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?: ServiceendpointJfrogDistributionV2State, opts?: pulumi.CustomResourceOptions): ServiceendpointJfrogDistributionV2;
/**
* Returns true if the given object is an instance of ServiceendpointJfrogDistributionV2. 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 ServiceendpointJfrogDistributionV2;
/**
* An `authenticationBasic` block as documented below.
*/
readonly authenticationBasic: pulumi.Output<outputs.ServiceendpointJfrogDistributionV2AuthenticationBasic | undefined>;
/**
* An `authenticationToken` block as documented below.
*/
readonly authenticationToken: pulumi.Output<outputs.ServiceendpointJfrogDistributionV2AuthenticationToken | undefined>;
readonly authorization: pulumi.Output<{
[key: string]: string;
}>;
/**
* The Service Endpoint description.
*/
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>;
/**
* URL of the Artifactory server to connect with.
*
* > **NOTE:** URL should not end in a slash character.
*/
readonly url: pulumi.Output<string>;
/**
* Create a ServiceendpointJfrogDistributionV2 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: ServiceendpointJfrogDistributionV2Args, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServiceendpointJfrogDistributionV2 resources.
*/
export interface ServiceendpointJfrogDistributionV2State {
/**
* An `authenticationBasic` block as documented below.
*/
authenticationBasic?: pulumi.Input<inputs.ServiceendpointJfrogDistributionV2AuthenticationBasic>;
/**
* An `authenticationToken` block as documented below.
*/
authenticationToken?: pulumi.Input<inputs.ServiceendpointJfrogDistributionV2AuthenticationToken>;
authorization?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The Service Endpoint description.
*/
description?: pulumi.Input<string>;
/**
* The ID of the project.
*/
projectId?: pulumi.Input<string>;
/**
* The Service Endpoint name.
*/
serviceEndpointName?: pulumi.Input<string>;
/**
* URL of the Artifactory server to connect with.
*
* > **NOTE:** URL should not end in a slash character.
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ServiceendpointJfrogDistributionV2 resource.
*/
export interface ServiceendpointJfrogDistributionV2Args {
/**
* An `authenticationBasic` block as documented below.
*/
authenticationBasic?: pulumi.Input<inputs.ServiceendpointJfrogDistributionV2AuthenticationBasic>;
/**
* An `authenticationToken` block as documented below.
*/
authenticationToken?: pulumi.Input<inputs.ServiceendpointJfrogDistributionV2AuthenticationToken>;
/**
* The Service Endpoint description.
*/
description?: pulumi.Input<string>;
/**
* The ID of the project.
*/
projectId: pulumi.Input<string>;
/**
* The Service Endpoint name.
*/
serviceEndpointName: pulumi.Input<string>;
/**
* URL of the Artifactory server to connect with.
*
* > **NOTE:** URL should not end in a slash character.
*/
url: pulumi.Input<string>;
}