1. Docs
  2. Reference
  3. API
  4. @pulumi/azuredevops
  5. ServiceEndpoint

Module ServiceEndpoint

This page documents the language specification for the azuredevops package. If you're looking for help working with the inputs, outputs, or functions of azuredevops resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Others

Resources

Resource AzureRM

class AzureRM extends CustomResource

Manages Manual or Automatic AzureRM service endpoint within Azure DevOps.

Requirements (Manual AzureRM Service Endpoint)

Before to create a service end point in Azure DevOps, you need to create a Service Principal in your Azure subscription.

For detailed steps to create a service principal with Azure cli see the documentation

Example Usage

Manual AzureRM Service Endpoint
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const project = new azuredevops.Core.Project("project", {
    projectName: "Sample Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
});
const endpointazure = new azuredevops.ServiceEndpoint.AzureRM("endpointazure", {
    projectId: project.id,
    serviceEndpointName: "TestServiceRM",
    credentials: {
        serviceprincipalid: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
        serviceprincipalkey: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
    azurermSpnTenantid: "xxxxxxx-xxxx-xxx-xxxxx-xxxxxxxx",
    azurermSubscriptionId: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
    azurermSubscriptionName: "Sample Subscription",
});
Automatic AzureRM Service Endpoint
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const project = new azuredevops.Core.Project("project", {
    projectName: "Sample Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
});
const endpointazure = new azuredevops.ServiceEndpoint.AzureRM("endpointazure", {
    projectId: project.id,
    serviceEndpointName: "TestServiceRM",
    azurermSpnTenantid: "xxxxxxx-xxxx-xxx-xxxxx-xxxxxxxx",
    azurermSubscriptionId: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
    azurermSubscriptionName: "Microsoft Azure DEMO",
});

constructor

new AzureRM(name: string, args: AzureRMArgs, opts?: pulumi.CustomResourceOptions)

Create a AzureRM resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AzureRMState, opts?: pulumi.CustomResourceOptions): AzureRM

Get an existing AzureRM resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AzureRM

Returns true if the given object is an instance of AzureRM. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authorization

public authorization: pulumi.Output<{[key: string]: string}>;

property azurermSpnTenantid

public azurermSpnTenantid: pulumi.Output<string>;

The tenant id if the service principal.

property azurermSubscriptionId

public azurermSubscriptionId: pulumi.Output<string>;

The subscription Id of the Azure targets.

property azurermSubscriptionName

public azurermSubscriptionName: pulumi.Output<string>;

The subscription Name of the targets.

property credentials

public credentials: pulumi.Output<AzureRMCredentials | undefined>;

A credentials block.

property description

public description: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property projectId

public projectId: pulumi.Output<string>;

The project ID or project name.

property resourceGroup

public resourceGroup: pulumi.Output<string | undefined>;

The resource group used for scope of automatic service endpoint.

property serviceEndpointName

public serviceEndpointName: pulumi.Output<string>;

The Service Endpoint name.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource BitBucket

class BitBucket extends CustomResource

Manages a Bitbucket service endpoint within Azure DevOps.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const project = new azuredevops.Core.Project("project", {
    projectName: "Sample Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
});
const serviceendpoint = new azuredevops.ServiceEndpoint.BitBucket("serviceendpoint", {
    projectId: project.id,
    username: "xxxx",
    password: "xxxx",
    serviceEndpointName: "test-bitbucket",
    description: "test",
});

constructor

new BitBucket(name: string, args: BitBucketArgs, opts?: pulumi.CustomResourceOptions)

Create a BitBucket resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BitBucketState, opts?: pulumi.CustomResourceOptions): BitBucket

Get an existing BitBucket resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is BitBucket

Returns true if the given object is an instance of BitBucket. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authorization

public authorization: pulumi.Output<{[key: string]: string}>;

property description

public description: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property password

public password: pulumi.Output<string>;

Bitbucket account password.

property passwordHash

public passwordHash: pulumi.Output<string>;

A bcrypted hash of the attribute ‘password’

property projectId

public projectId: pulumi.Output<string>;

The project ID or project name.

property serviceEndpointName

public serviceEndpointName: pulumi.Output<string>;

The Service Endpoint name.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

Bitbucket account username.

Resource DockerRegistry

class DockerRegistry extends CustomResource

Manages a Docker Registry service endpoint within Azure DevOps.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const project = new azuredevops.Core.Project("project", {
    projectName: "Sample Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
});
// dockerhub registry service connection
const dockerhubregistry = new azuredevops.ServiceEndpoint.DockerRegistry("dockerhubregistry", {
    projectId: project.id,
    serviceEndpointName: "Sample Docker Hub",
    dockerUsername: "sample",
    dockerEmail: "email@example.com",
    dockerPassword: "12345",
    registryType: "DockerHub",
});
// other docker registry service connection
const otherregistry = new azuredevops.ServiceEndpoint.DockerRegistry("otherregistry", {
    projectId: project.id,
    serviceEndpointName: "Sample Docker Registry",
    dockerRegistry: "https://sample.azurecr.io/v1",
    dockerUsername: "sample",
    dockerPassword: "12345",
    registryType: "Others",
});

constructor

new DockerRegistry(name: string, args: DockerRegistryArgs, opts?: pulumi.CustomResourceOptions)

Create a DockerRegistry resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DockerRegistryState, opts?: pulumi.CustomResourceOptions): DockerRegistry

Get an existing DockerRegistry resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DockerRegistry

Returns true if the given object is an instance of DockerRegistry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authorization

public authorization: pulumi.Output<{[key: string]: string}>;

property description

public description: pulumi.Output<string | undefined>;

The name you will use to refer to this service connection in task inputs.

property dockerEmail

public dockerEmail: pulumi.Output<string | undefined>;

The email for Docker account user.

property dockerPassword

public dockerPassword: pulumi.Output<string | undefined>;

The password for the account user identified above.

property dockerPasswordHash

public dockerPasswordHash: pulumi.Output<string>;

A bcrypted hash of the attribute ‘docker_password’

property dockerRegistry

public dockerRegistry: pulumi.Output<string>;

The URL of the Docker registry. (Default: “https://index.docker.io/v1/")

property dockerUsername

public dockerUsername: pulumi.Output<string | undefined>;

The identifier of the Docker account user.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property projectId

public projectId: pulumi.Output<string>;

The project ID or project name.

property registryType

public registryType: pulumi.Output<string>;

Can be “DockerHub” or “Others” (Default “DockerHub”)

property serviceEndpointName

public serviceEndpointName: pulumi.Output<string>;

The name you will use to refer to this service connection in task inputs.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource GitHub

class GitHub extends CustomResource

Manages a GitHub service endpoint within Azure DevOps.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const project = new azuredevops.Core.Project("project", {
    projectName: "Sample Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
});
const serviceendpointGh1 = new azuredevops.ServiceEndpoint.GitHub("serviceendpointGh1", {
    projectId: project.id,
    serviceEndpointName: "Sample GithHub Personal Access Token",
    auth_personal: {
        personalAccessToken: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
});

constructor

new GitHub(name: string, args: GitHubArgs, opts?: pulumi.CustomResourceOptions)

Create a GitHub resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GitHubState, opts?: pulumi.CustomResourceOptions): GitHub

Get an existing GitHub resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GitHub

Returns true if the given object is an instance of GitHub. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authOauth

public authOauth: pulumi.Output<GitHubAuthOauth | undefined>;

An authOauth block as documented below. Allows connecting using an Oauth token.

property authPersonal

public authPersonal: pulumi.Output<GitHubAuthPersonal | undefined>;

An authPersonal block as documented below. Allows connecting using a personal access token.

property authorization

public authorization: pulumi.Output<{[key: string]: string}>;

property description

public description: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property projectId

public projectId: pulumi.Output<string>;

The project ID or project name.

property serviceEndpointName

public serviceEndpointName: pulumi.Output<string>;

The Service Endpoint name.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Kubernetes

class Kubernetes extends CustomResource

# azuredevops.ServiceEndpoint.Kubernetes

Manages a Kubernetes service endpoint within Azure DevOps.

constructor

new Kubernetes(name: string, args: KubernetesArgs, opts?: pulumi.CustomResourceOptions)

Create a Kubernetes resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: KubernetesState, opts?: pulumi.CustomResourceOptions): Kubernetes

Get an existing Kubernetes resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Kubernetes

Returns true if the given object is an instance of Kubernetes. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiserverUrl

public apiserverUrl: pulumi.Output<string>;

The Service Endpoint description.

property authorization

public authorization: pulumi.Output<{[key: string]: string}>;

property authorizationType

public authorizationType: pulumi.Output<string>;

The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.

property azureSubscriptions

public azureSubscriptions: pulumi.Output<KubernetesAzureSubscription[] | undefined>;

The configuration for authorization_type=“AzureSubscription”.

property description

public description: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kubeconfigs

public kubeconfigs: pulumi.Output<KubernetesKubeconfig[] | undefined>;

The configuration for authorization_type=“Kubeconfig”.

property projectId

public projectId: pulumi.Output<string>;

The project ID or project name.

property serviceAccounts

public serviceAccounts: pulumi.Output<KubernetesServiceAccount[] | undefined>;

The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.

property serviceEndpointName

public serviceEndpointName: pulumi.Output<string>;

The Service Endpoint name.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface AzureRMArgs

interface AzureRMArgs

The set of arguments for constructing a AzureRM resource.

property authorization

authorization?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property azurermSpnTenantid

azurermSpnTenantid: pulumi.Input<string>;

The tenant id if the service principal.

property azurermSubscriptionId

azurermSubscriptionId: pulumi.Input<string>;

The subscription Id of the Azure targets.

property azurermSubscriptionName

azurermSubscriptionName: pulumi.Input<string>;

The subscription Name of the targets.

property credentials

credentials?: pulumi.Input<AzureRMCredentials>;

A credentials block.

property description

description?: pulumi.Input<string>;

property projectId

projectId: pulumi.Input<string>;

The project ID or project name.

property resourceGroup

resourceGroup?: pulumi.Input<string>;

The resource group used for scope of automatic service endpoint.

property serviceEndpointName

serviceEndpointName: pulumi.Input<string>;

The Service Endpoint name.

interface AzureRMState

interface AzureRMState

Input properties used for looking up and filtering AzureRM resources.

property authorization

authorization?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property azurermSpnTenantid

azurermSpnTenantid?: pulumi.Input<string>;

The tenant id if the service principal.

property azurermSubscriptionId

azurermSubscriptionId?: pulumi.Input<string>;

The subscription Id of the Azure targets.

property azurermSubscriptionName

azurermSubscriptionName?: pulumi.Input<string>;

The subscription Name of the targets.

property credentials

credentials?: pulumi.Input<AzureRMCredentials>;

A credentials block.

property description

description?: pulumi.Input<string>;

property projectId

projectId?: pulumi.Input<string>;

The project ID or project name.

property resourceGroup

resourceGroup?: pulumi.Input<string>;

The resource group used for scope of automatic service endpoint.

property serviceEndpointName

serviceEndpointName?: pulumi.Input<string>;

The Service Endpoint name.

interface BitBucketArgs

interface BitBucketArgs

The set of arguments for constructing a BitBucket resource.

property authorization

authorization?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property description

description?: pulumi.Input<string>;

property password

password: pulumi.Input<string>;

Bitbucket account password.

property projectId

projectId: pulumi.Input<string>;

The project ID or project name.

property serviceEndpointName

serviceEndpointName: pulumi.Input<string>;

The Service Endpoint name.

property username

username: pulumi.Input<string>;

Bitbucket account username.

interface BitBucketState

interface BitBucketState

Input properties used for looking up and filtering BitBucket resources.

property authorization

authorization?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property description

description?: pulumi.Input<string>;

property password

password?: pulumi.Input<string>;

Bitbucket account password.

property passwordHash

passwordHash?: pulumi.Input<string>;

A bcrypted hash of the attribute ‘password’

property projectId

projectId?: pulumi.Input<string>;

The project ID or project name.

property serviceEndpointName

serviceEndpointName?: pulumi.Input<string>;

The Service Endpoint name.

property username

username?: pulumi.Input<string>;

Bitbucket account username.

interface DockerRegistryArgs

interface DockerRegistryArgs

The set of arguments for constructing a DockerRegistry resource.

property authorization

authorization?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property description

description?: pulumi.Input<string>;

The name you will use to refer to this service connection in task inputs.

property dockerEmail

dockerEmail?: pulumi.Input<string>;

The email for Docker account user.

property dockerPassword

dockerPassword?: pulumi.Input<string>;

The password for the account user identified above.

property dockerRegistry

dockerRegistry: pulumi.Input<string>;

The URL of the Docker registry. (Default: “https://index.docker.io/v1/")

property dockerUsername

dockerUsername?: pulumi.Input<string>;

The identifier of the Docker account user.

property projectId

projectId: pulumi.Input<string>;

The project ID or project name.

property registryType

registryType: pulumi.Input<string>;

Can be “DockerHub” or “Others” (Default “DockerHub”)

property serviceEndpointName

serviceEndpointName: pulumi.Input<string>;

The name you will use to refer to this service connection in task inputs.

interface DockerRegistryState

interface DockerRegistryState

Input properties used for looking up and filtering DockerRegistry resources.

property authorization

authorization?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property description

description?: pulumi.Input<string>;

The name you will use to refer to this service connection in task inputs.

property dockerEmail

dockerEmail?: pulumi.Input<string>;

The email for Docker account user.

property dockerPassword

dockerPassword?: pulumi.Input<string>;

The password for the account user identified above.

property dockerPasswordHash

dockerPasswordHash?: pulumi.Input<string>;

A bcrypted hash of the attribute ‘docker_password’

property dockerRegistry

dockerRegistry?: pulumi.Input<string>;

The URL of the Docker registry. (Default: “https://index.docker.io/v1/")

property dockerUsername

dockerUsername?: pulumi.Input<string>;

The identifier of the Docker account user.

property projectId

projectId?: pulumi.Input<string>;

The project ID or project name.

property registryType

registryType?: pulumi.Input<string>;

Can be “DockerHub” or “Others” (Default “DockerHub”)

property serviceEndpointName

serviceEndpointName?: pulumi.Input<string>;

The name you will use to refer to this service connection in task inputs.

interface GitHubArgs

interface GitHubArgs

The set of arguments for constructing a GitHub resource.

property authOauth

authOauth?: pulumi.Input<GitHubAuthOauth>;

An authOauth block as documented below. Allows connecting using an Oauth token.

property authPersonal

authPersonal?: pulumi.Input<GitHubAuthPersonal>;

An authPersonal block as documented below. Allows connecting using a personal access token.

property authorization

authorization?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property description

description?: pulumi.Input<string>;

property projectId

projectId: pulumi.Input<string>;

The project ID or project name.

property serviceEndpointName

serviceEndpointName: pulumi.Input<string>;

The Service Endpoint name.

interface GitHubState

interface GitHubState

Input properties used for looking up and filtering GitHub resources.

property authOauth

authOauth?: pulumi.Input<GitHubAuthOauth>;

An authOauth block as documented below. Allows connecting using an Oauth token.

property authPersonal

authPersonal?: pulumi.Input<GitHubAuthPersonal>;

An authPersonal block as documented below. Allows connecting using a personal access token.

property authorization

authorization?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property description

description?: pulumi.Input<string>;

property projectId

projectId?: pulumi.Input<string>;

The project ID or project name.

property serviceEndpointName

serviceEndpointName?: pulumi.Input<string>;

The Service Endpoint name.

interface KubernetesArgs

interface KubernetesArgs

The set of arguments for constructing a Kubernetes resource.

property apiserverUrl

apiserverUrl: pulumi.Input<string>;

The Service Endpoint description.

property authorization

authorization?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property authorizationType

authorizationType: pulumi.Input<string>;

The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.

property azureSubscriptions

azureSubscriptions?: pulumi.Input<pulumi.Input<KubernetesAzureSubscription>[]>;

The configuration for authorization_type=“AzureSubscription”.

property description

description?: pulumi.Input<string>;

property kubeconfigs

kubeconfigs?: pulumi.Input<pulumi.Input<KubernetesKubeconfig>[]>;

The configuration for authorization_type=“Kubeconfig”.

property projectId

projectId: pulumi.Input<string>;

The project ID or project name.

property serviceAccounts

serviceAccounts?: pulumi.Input<pulumi.Input<KubernetesServiceAccount>[]>;

The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.

property serviceEndpointName

serviceEndpointName: pulumi.Input<string>;

The Service Endpoint name.

interface KubernetesState

interface KubernetesState

Input properties used for looking up and filtering Kubernetes resources.

property apiserverUrl

apiserverUrl?: pulumi.Input<string>;

The Service Endpoint description.

property authorization

authorization?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property authorizationType

authorizationType?: pulumi.Input<string>;

The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.

property azureSubscriptions

azureSubscriptions?: pulumi.Input<pulumi.Input<KubernetesAzureSubscription>[]>;

The configuration for authorization_type=“AzureSubscription”.

property description

description?: pulumi.Input<string>;

property kubeconfigs

kubeconfigs?: pulumi.Input<pulumi.Input<KubernetesKubeconfig>[]>;

The configuration for authorization_type=“Kubeconfig”.

property projectId

projectId?: pulumi.Input<string>;

The project ID or project name.

property serviceAccounts

serviceAccounts?: pulumi.Input<pulumi.Input<KubernetesServiceAccount>[]>;

The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.

property serviceEndpointName

serviceEndpointName?: pulumi.Input<string>;

The Service Endpoint name.