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.
service_endpoint¶
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azuredevops repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azuredevops repo.
- class
pulumi_azuredevops.service_endpoint.AzureRM(resource_name, opts=None, authorization=None, azurerm_spn_tenantid=None, azurerm_subscription_id=None, azurerm_subscription_name=None, credentials=None, description=None, project_id=None, resource_group=None, service_endpoint_name=None, __props__=None, __name__=None, __opts__=None)¶ Manages Manual or Automatic AzureRM service endpoint within Azure DevOps.
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
import pulumi import pulumi_azuredevops as azuredevops project = azuredevops.core.Project("project", project_name="Sample Project", visibility="private", version_control="Git", work_item_template="Agile") endpointazure = azuredevops.service_endpoint.AzureRM("endpointazure", project_id=project.id, service_endpoint_name="TestServiceRM", credentials={ "serviceprincipalid": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx", "serviceprincipalkey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", }, azurerm_spn_tenantid="xxxxxxx-xxxx-xxx-xxxxx-xxxxxxxx", azurerm_subscription_id="xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx", azurerm_subscription_name="Sample Subscription")
import pulumi import pulumi_azuredevops as azuredevops project = azuredevops.core.Project("project", project_name="Sample Project", visibility="private", version_control="Git", work_item_template="Agile") endpointazure = azuredevops.service_endpoint.AzureRM("endpointazure", project_id=project.id, service_endpoint_name="TestServiceRM", azurerm_spn_tenantid="xxxxxxx-xxxx-xxx-xxxxx-xxxxxxxx", azurerm_subscription_id="xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx", azurerm_subscription_name="Microsoft Azure DEMO")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
azurerm_spn_tenantid (pulumi.Input[str]) – The tenant id if the service principal.
azurerm_subscription_id (pulumi.Input[str]) – The subscription Id of the Azure targets.
azurerm_subscription_name (pulumi.Input[str]) – The subscription Name of the targets.
credentials (pulumi.Input[dict]) – A
credentialsblock.project_id (pulumi.Input[str]) – The project ID or project name.
resource_group (pulumi.Input[str]) – The resource group used for scope of automatic service endpoint.
service_endpoint_name (pulumi.Input[str]) – The Service Endpoint name.
The credentials object supports the following:
serviceprincipalid(pulumi.Input[str]) - The service principal application Idserviceprincipalkey(pulumi.Input[str]) - The service principal secret.serviceprincipalkeyHash(pulumi.Input[str])
azurerm_spn_tenantid: pulumi.Output[str] = None¶The tenant id if the service principal.
azurerm_subscription_id: pulumi.Output[str] = None¶The subscription Id of the Azure targets.
azurerm_subscription_name: pulumi.Output[str] = None¶The subscription Name of the targets.
credentials: pulumi.Output[dict] = None¶A
credentialsblock.serviceprincipalid(str) - The service principal application Idserviceprincipalkey(str) - The service principal secret.serviceprincipalkeyHash(str)
project_id: pulumi.Output[str] = None¶The project ID or project name.
resource_group: pulumi.Output[str] = None¶The resource group used for scope of automatic service endpoint.
service_endpoint_name: pulumi.Output[str] = None¶The Service Endpoint name.
- static
get(resource_name, id, opts=None, authorization=None, azurerm_spn_tenantid=None, azurerm_subscription_id=None, azurerm_subscription_name=None, credentials=None, description=None, project_id=None, resource_group=None, service_endpoint_name=None)¶ Get an existing AzureRM resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
azurerm_spn_tenantid (pulumi.Input[str]) – The tenant id if the service principal.
azurerm_subscription_id (pulumi.Input[str]) – The subscription Id of the Azure targets.
azurerm_subscription_name (pulumi.Input[str]) – The subscription Name of the targets.
credentials (pulumi.Input[dict]) – A
credentialsblock.project_id (pulumi.Input[str]) – The project ID or project name.
resource_group (pulumi.Input[str]) – The resource group used for scope of automatic service endpoint.
service_endpoint_name (pulumi.Input[str]) – The Service Endpoint name.
The credentials object supports the following:
serviceprincipalid(pulumi.Input[str]) - The service principal application Idserviceprincipalkey(pulumi.Input[str]) - The service principal secret.serviceprincipalkeyHash(pulumi.Input[str])
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_azuredevops.service_endpoint.BitBucket(resource_name, opts=None, authorization=None, description=None, password=None, project_id=None, service_endpoint_name=None, username=None, __props__=None, __name__=None, __opts__=None)¶ Manages a Bitbucket service endpoint within Azure DevOps.
import pulumi import pulumi_azuredevops as azuredevops project = azuredevops.core.Project("project", project_name="Sample Project", visibility="private", version_control="Git", work_item_template="Agile") serviceendpoint = azuredevops.service_endpoint.BitBucket("serviceendpoint", project_id=project.id, username="xxxx", password="xxxx", service_endpoint_name="test-bitbucket", description="test")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
password (pulumi.Input[str]) – Bitbucket account password.
project_id (pulumi.Input[str]) – The project ID or project name.
service_endpoint_name (pulumi.Input[str]) – The Service Endpoint name.
username (pulumi.Input[str]) – Bitbucket account username.
password: pulumi.Output[str] = None¶Bitbucket account password.
password_hash: pulumi.Output[str] = None¶A bcrypted hash of the attribute ‘password’
project_id: pulumi.Output[str] = None¶The project ID or project name.
service_endpoint_name: pulumi.Output[str] = None¶The Service Endpoint name.
username: pulumi.Output[str] = None¶Bitbucket account username.
- static
get(resource_name, id, opts=None, authorization=None, description=None, password=None, password_hash=None, project_id=None, service_endpoint_name=None, username=None)¶ Get an existing BitBucket resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
password (pulumi.Input[str]) – Bitbucket account password.
password_hash (pulumi.Input[str]) – A bcrypted hash of the attribute ‘password’
project_id (pulumi.Input[str]) – The project ID or project name.
service_endpoint_name (pulumi.Input[str]) – The Service Endpoint name.
username (pulumi.Input[str]) – Bitbucket account username.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_azuredevops.service_endpoint.DockerRegistry(resource_name, opts=None, authorization=None, description=None, docker_email=None, docker_password=None, docker_registry=None, docker_username=None, project_id=None, registry_type=None, service_endpoint_name=None, __props__=None, __name__=None, __opts__=None)¶ Manages a Docker Registry service endpoint within Azure DevOps.
import pulumi import pulumi_azuredevops as azuredevops project = azuredevops.core.Project("project", project_name="Sample Project", visibility="private", version_control="Git", work_item_template="Agile") # dockerhub registry service connection dockerhubregistry = azuredevops.service_endpoint.DockerRegistry("dockerhubregistry", project_id=project.id, service_endpoint_name="Sample Docker Hub", docker_username="sample", docker_email="email@example.com", docker_password="12345", registry_type="DockerHub") # other docker registry service connection otherregistry = azuredevops.service_endpoint.DockerRegistry("otherregistry", project_id=project.id, service_endpoint_name="Sample Docker Registry", docker_registry="https://sample.azurecr.io/v1", docker_username="sample", docker_password="12345", registry_type="Others")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The name you will use to refer to this service connection in task inputs.
docker_email (pulumi.Input[str]) – The email for Docker account user.
docker_password (pulumi.Input[str]) – The password for the account user identified above.
docker_registry (pulumi.Input[str]) – The URL of the Docker registry. (Default: “https://index.docker.io/v1/”)
docker_username (pulumi.Input[str]) – The identifier of the Docker account user.
project_id (pulumi.Input[str]) – The project ID or project name.
registry_type (pulumi.Input[str]) – Can be “DockerHub” or “Others” (Default “DockerHub”)
service_endpoint_name (pulumi.Input[str]) – The name you will use to refer to this service connection in task inputs.
description: pulumi.Output[str] = None¶The name you will use to refer to this service connection in task inputs.
docker_email: pulumi.Output[str] = None¶The email for Docker account user.
docker_password: pulumi.Output[str] = None¶The password for the account user identified above.
docker_password_hash: pulumi.Output[str] = None¶A bcrypted hash of the attribute ‘docker_password’
docker_registry: pulumi.Output[str] = None¶The URL of the Docker registry. (Default: “https://index.docker.io/v1/”)
docker_username: pulumi.Output[str] = None¶The identifier of the Docker account user.
project_id: pulumi.Output[str] = None¶The project ID or project name.
registry_type: pulumi.Output[str] = None¶Can be “DockerHub” or “Others” (Default “DockerHub”)
service_endpoint_name: pulumi.Output[str] = None¶The name you will use to refer to this service connection in task inputs.
- static
get(resource_name, id, opts=None, authorization=None, description=None, docker_email=None, docker_password=None, docker_password_hash=None, docker_registry=None, docker_username=None, project_id=None, registry_type=None, service_endpoint_name=None)¶ Get an existing DockerRegistry resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The name you will use to refer to this service connection in task inputs.
docker_email (pulumi.Input[str]) – The email for Docker account user.
docker_password (pulumi.Input[str]) – The password for the account user identified above.
docker_password_hash (pulumi.Input[str]) – A bcrypted hash of the attribute ‘docker_password’
docker_registry (pulumi.Input[str]) – The URL of the Docker registry. (Default: “https://index.docker.io/v1/”)
docker_username (pulumi.Input[str]) – The identifier of the Docker account user.
project_id (pulumi.Input[str]) – The project ID or project name.
registry_type (pulumi.Input[str]) – Can be “DockerHub” or “Others” (Default “DockerHub”)
service_endpoint_name (pulumi.Input[str]) – The name you will use to refer to this service connection in task inputs.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_azuredevops.service_endpoint.GitHub(resource_name, opts=None, auth_oauth=None, auth_personal=None, authorization=None, description=None, project_id=None, service_endpoint_name=None, __props__=None, __name__=None, __opts__=None)¶ Manages a GitHub service endpoint within Azure DevOps.
import pulumi import pulumi_azuredevops as azuredevops project = azuredevops.core.Project("project", project_name="Sample Project", visibility="private", version_control="Git", work_item_template="Agile") serviceendpoint_gh1 = azuredevops.service_endpoint.GitHub("serviceendpointGh1", project_id=project.id, service_endpoint_name="Sample GithHub Personal Access Token", auth_personal={ "personalAccessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", })
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
auth_oauth (pulumi.Input[dict]) – An
auth_oauthblock as documented below. Allows connecting using an Oauth token.auth_personal (pulumi.Input[dict]) – An
auth_personalblock as documented below. Allows connecting using a personal access token.project_id (pulumi.Input[str]) – The project ID or project name.
service_endpoint_name (pulumi.Input[str]) – The Service Endpoint name.
The auth_oauth object supports the following:
oauthConfigurationId(pulumi.Input[str])
The auth_personal object supports the following:
personalAccessToken(pulumi.Input[str]) - The Personal Access Token for Github.personalAccessTokenHash(pulumi.Input[str])
auth_oauth: pulumi.Output[dict] = None¶An
auth_oauthblock as documented below. Allows connecting using an Oauth token.oauthConfigurationId(str)
auth_personal: pulumi.Output[dict] = None¶An
auth_personalblock as documented below. Allows connecting using a personal access token.personalAccessToken(str) - The Personal Access Token for Github.personalAccessTokenHash(str)
project_id: pulumi.Output[str] = None¶The project ID or project name.
service_endpoint_name: pulumi.Output[str] = None¶The Service Endpoint name.
- static
get(resource_name, id, opts=None, auth_oauth=None, auth_personal=None, authorization=None, description=None, project_id=None, service_endpoint_name=None)¶ Get an existing GitHub resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
auth_oauth (pulumi.Input[dict]) – An
auth_oauthblock as documented below. Allows connecting using an Oauth token.auth_personal (pulumi.Input[dict]) – An
auth_personalblock as documented below. Allows connecting using a personal access token.project_id (pulumi.Input[str]) – The project ID or project name.
service_endpoint_name (pulumi.Input[str]) – The Service Endpoint name.
The auth_oauth object supports the following:
oauthConfigurationId(pulumi.Input[str])
The auth_personal object supports the following:
personalAccessToken(pulumi.Input[str]) - The Personal Access Token for Github.personalAccessTokenHash(pulumi.Input[str])
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_azuredevops.service_endpoint.Kubernetes(resource_name, opts=None, apiserver_url=None, authorization=None, authorization_type=None, azure_subscriptions=None, description=None, kubeconfigs=None, project_id=None, service_accounts=None, service_endpoint_name=None, __props__=None, __name__=None, __opts__=None)¶ Manages a Kubernetes service endpoint within Azure DevOps.
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
apiserver_url (pulumi.Input[str]) – The Service Endpoint description.
authorization_type (pulumi.Input[str]) – The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
azure_subscriptions (pulumi.Input[list]) – The configuration for authorization_type=”AzureSubscription”.
kubeconfigs (pulumi.Input[list]) – The configuration for authorization_type=”Kubeconfig”.
project_id (pulumi.Input[str]) – The project ID or project name.
service_accounts (pulumi.Input[list]) – The configuration for authorization_type=”ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.
service_endpoint_name (pulumi.Input[str]) – The Service Endpoint name.
The azure_subscriptions object supports the following:
azureEnvironment(pulumi.Input[str]) - Azure environment refers to whether the public cloud offering or domestic (government) clouds are being used. Currently, only the public cloud is supported. The value must be AzureCloud. This is also the default-value.clusterName(pulumi.Input[str]) - The name of the Kubernetes cluster.namespace(pulumi.Input[str]) - The Kubernetes namespace. Default value is “default”.resourcegroupId(pulumi.Input[str]) - The resource group id, to which the Kubernetes cluster is deployed.subscriptionId(pulumi.Input[str]) - The id of the Azure subscription.subscriptionName(pulumi.Input[str]) - The name of the Azure subscription.tenantId(pulumi.Input[str]) - The id of the tenant used by the subscription.
The kubeconfigs object supports the following:
acceptUntrustedCerts(pulumi.Input[bool]) - Set this option to allow clients to accept a self-signed certificate.clusterContext(pulumi.Input[str]) - Context within the kubeconfig file that is to be used for identifying the cluster. Default value is the current-context set in kubeconfig.kubeConfig(pulumi.Input[str]) - The content of the kubeconfig in yaml notation to be used to communicate with the API-Server of Kubernetes.kubeConfigHash(pulumi.Input[str])
The service_accounts object supports the following:
caCert(pulumi.Input[str]) - The certificate from a Kubernetes secret object.caCertHash(pulumi.Input[str])token(pulumi.Input[str]) - The token from a Kubernetes secret object.tokenHash(pulumi.Input[str])
apiserver_url: pulumi.Output[str] = None¶The Service Endpoint description.
The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
azure_subscriptions: pulumi.Output[list] = None¶The configuration for authorization_type=”AzureSubscription”.
azureEnvironment(str) - Azure environment refers to whether the public cloud offering or domestic (government) clouds are being used. Currently, only the public cloud is supported. The value must be AzureCloud. This is also the default-value.clusterName(str) - The name of the Kubernetes cluster.namespace(str) - The Kubernetes namespace. Default value is “default”.resourcegroupId(str) - The resource group id, to which the Kubernetes cluster is deployed.subscriptionId(str) - The id of the Azure subscription.subscriptionName(str) - The name of the Azure subscription.tenantId(str) - The id of the tenant used by the subscription.
kubeconfigs: pulumi.Output[list] = None¶The configuration for authorization_type=”Kubeconfig”.
acceptUntrustedCerts(bool) - Set this option to allow clients to accept a self-signed certificate.clusterContext(str) - Context within the kubeconfig file that is to be used for identifying the cluster. Default value is the current-context set in kubeconfig.kubeConfig(str) - The content of the kubeconfig in yaml notation to be used to communicate with the API-Server of Kubernetes.kubeConfigHash(str)
project_id: pulumi.Output[str] = None¶The project ID or project name.
service_accounts: pulumi.Output[list] = None¶The configuration for authorization_type=”ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.
caCert(str) - The certificate from a Kubernetes secret object.caCertHash(str)token(str) - The token from a Kubernetes secret object.tokenHash(str)
service_endpoint_name: pulumi.Output[str] = None¶The Service Endpoint name.
- static
get(resource_name, id, opts=None, apiserver_url=None, authorization=None, authorization_type=None, azure_subscriptions=None, description=None, kubeconfigs=None, project_id=None, service_accounts=None, service_endpoint_name=None)¶ Get an existing Kubernetes resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
apiserver_url (pulumi.Input[str]) – The Service Endpoint description.
authorization_type (pulumi.Input[str]) – The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
azure_subscriptions (pulumi.Input[list]) – The configuration for authorization_type=”AzureSubscription”.
kubeconfigs (pulumi.Input[list]) – The configuration for authorization_type=”Kubeconfig”.
project_id (pulumi.Input[str]) – The project ID or project name.
service_accounts (pulumi.Input[list]) – The configuration for authorization_type=”ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.
service_endpoint_name (pulumi.Input[str]) – The Service Endpoint name.
The azure_subscriptions object supports the following:
azureEnvironment(pulumi.Input[str]) - Azure environment refers to whether the public cloud offering or domestic (government) clouds are being used. Currently, only the public cloud is supported. The value must be AzureCloud. This is also the default-value.clusterName(pulumi.Input[str]) - The name of the Kubernetes cluster.namespace(pulumi.Input[str]) - The Kubernetes namespace. Default value is “default”.resourcegroupId(pulumi.Input[str]) - The resource group id, to which the Kubernetes cluster is deployed.subscriptionId(pulumi.Input[str]) - The id of the Azure subscription.subscriptionName(pulumi.Input[str]) - The name of the Azure subscription.tenantId(pulumi.Input[str]) - The id of the tenant used by the subscription.
The kubeconfigs object supports the following:
acceptUntrustedCerts(pulumi.Input[bool]) - Set this option to allow clients to accept a self-signed certificate.clusterContext(pulumi.Input[str]) - Context within the kubeconfig file that is to be used for identifying the cluster. Default value is the current-context set in kubeconfig.kubeConfig(pulumi.Input[str]) - The content of the kubeconfig in yaml notation to be used to communicate with the API-Server of Kubernetes.kubeConfigHash(pulumi.Input[str])
The service_accounts object supports the following:
caCert(pulumi.Input[str]) - The certificate from a Kubernetes secret object.caCertHash(pulumi.Input[str])token(pulumi.Input[str]) - The token from a Kubernetes secret object.tokenHash(pulumi.Input[str])
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str