azuredevops.Provider
The provider type for the azuredevops package. By default, resources use package-wide configuration
settings, however an explicit Provider instance may be created and passed during resource
construction to achieve fine-grained programmatic control over provider settings. See the
documentation for more information.
Create Provider Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)
@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             auxiliary_tenant_ids: Optional[Sequence[str]] = None,
             client_certificate: Optional[str] = None,
             client_certificate_password: Optional[str] = None,
             client_certificate_path: Optional[str] = None,
             client_id: Optional[str] = None,
             client_id_file_path: Optional[str] = None,
             client_secret: Optional[str] = None,
             client_secret_path: Optional[str] = None,
             oidc_azure_service_connection_id: Optional[str] = None,
             oidc_request_token: Optional[str] = None,
             oidc_request_url: Optional[str] = None,
             oidc_token: Optional[str] = None,
             oidc_token_file_path: Optional[str] = None,
             org_service_url: Optional[str] = None,
             personal_access_token: Optional[str] = None,
             tenant_id: Optional[str] = None,
             use_cli: Optional[bool] = None,
             use_msi: Optional[bool] = None,
             use_oidc: Optional[bool] = None)func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:azuredevops
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Provider Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Provider resource accepts the following input properties:
- AuxiliaryTenant List<string>Ids 
- List of auxiliary Tenant IDs required for multi-tenancy and cross-tenant scenarios.
- ClientCertificate string
- Base64 encoded certificate to use to authenticate to the service principal.
- ClientCertificate stringPassword 
- Password for a client certificate password.
- ClientCertificate stringPath 
- Path to a certificate to use to authenticate to the service principal.
- ClientId string
- The service principal client id which should be used for AAD auth.
- ClientId stringFile Path 
- The path to a file containing the Client ID which should be used.
- ClientSecret string
- Client secret for authenticating to a service principal.
- ClientSecret stringPath 
- Path to a file containing a client secret for authenticating to a service principal.
- OidcAzure stringService Connection Id 
- The Azure Pipelines Service Connection ID to use for authentication.
- OidcRequest stringToken 
- The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
- OidcRequest stringUrl 
- The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
- OidcToken string
- OIDC token to authenticate as a service principal.
- OidcToken stringFile Path 
- OIDC token from file to authenticate as a service principal.
- OrgService stringUrl 
- The url of the Azure DevOps instance which should be used. It can also be sourced from the following environment variable: AZDO_ORG_SERVICE_URL
- PersonalAccess stringToken 
- The personal access token which should be used.
- TenantId string
- The service principal tenant id which should be used for AAD auth.
- UseCli bool
- Use Azure CLI to authenticate. Defaults to true.
- UseMsi bool
- Use an Azure Managed Service Identity. Defaults to false.
- UseOidc bool
- Use an OIDC token to authenticate to a service principal. Defaults to false.
- AuxiliaryTenant []stringIds 
- List of auxiliary Tenant IDs required for multi-tenancy and cross-tenant scenarios.
- ClientCertificate string
- Base64 encoded certificate to use to authenticate to the service principal.
- ClientCertificate stringPassword 
- Password for a client certificate password.
- ClientCertificate stringPath 
- Path to a certificate to use to authenticate to the service principal.
- ClientId string
- The service principal client id which should be used for AAD auth.
- ClientId stringFile Path 
- The path to a file containing the Client ID which should be used.
- ClientSecret string
- Client secret for authenticating to a service principal.
- ClientSecret stringPath 
- Path to a file containing a client secret for authenticating to a service principal.
- OidcAzure stringService Connection Id 
- The Azure Pipelines Service Connection ID to use for authentication.
- OidcRequest stringToken 
- The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
- OidcRequest stringUrl 
- The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
- OidcToken string
- OIDC token to authenticate as a service principal.
- OidcToken stringFile Path 
- OIDC token from file to authenticate as a service principal.
- OrgService stringUrl 
- The url of the Azure DevOps instance which should be used. It can also be sourced from the following environment variable: AZDO_ORG_SERVICE_URL
- PersonalAccess stringToken 
- The personal access token which should be used.
- TenantId string
- The service principal tenant id which should be used for AAD auth.
- UseCli bool
- Use Azure CLI to authenticate. Defaults to true.
- UseMsi bool
- Use an Azure Managed Service Identity. Defaults to false.
- UseOidc bool
- Use an OIDC token to authenticate to a service principal. Defaults to false.
- auxiliaryTenant List<String>Ids 
- List of auxiliary Tenant IDs required for multi-tenancy and cross-tenant scenarios.
- clientCertificate String
- Base64 encoded certificate to use to authenticate to the service principal.
- clientCertificate StringPassword 
- Password for a client certificate password.
- clientCertificate StringPath 
- Path to a certificate to use to authenticate to the service principal.
- clientId String
- The service principal client id which should be used for AAD auth.
- clientId StringFile Path 
- The path to a file containing the Client ID which should be used.
- clientSecret String
- Client secret for authenticating to a service principal.
- clientSecret StringPath 
- Path to a file containing a client secret for authenticating to a service principal.
- oidcAzure StringService Connection Id 
- The Azure Pipelines Service Connection ID to use for authentication.
- oidcRequest StringToken 
- The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
- oidcRequest StringUrl 
- The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
- oidcToken String
- OIDC token to authenticate as a service principal.
- oidcToken StringFile Path 
- OIDC token from file to authenticate as a service principal.
- orgService StringUrl 
- The url of the Azure DevOps instance which should be used. It can also be sourced from the following environment variable: AZDO_ORG_SERVICE_URL
- personalAccess StringToken 
- The personal access token which should be used.
- tenantId String
- The service principal tenant id which should be used for AAD auth.
- useCli Boolean
- Use Azure CLI to authenticate. Defaults to true.
- useMsi Boolean
- Use an Azure Managed Service Identity. Defaults to false.
- useOidc Boolean
- Use an OIDC token to authenticate to a service principal. Defaults to false.
- auxiliaryTenant string[]Ids 
- List of auxiliary Tenant IDs required for multi-tenancy and cross-tenant scenarios.
- clientCertificate string
- Base64 encoded certificate to use to authenticate to the service principal.
- clientCertificate stringPassword 
- Password for a client certificate password.
- clientCertificate stringPath 
- Path to a certificate to use to authenticate to the service principal.
- clientId string
- The service principal client id which should be used for AAD auth.
- clientId stringFile Path 
- The path to a file containing the Client ID which should be used.
- clientSecret string
- Client secret for authenticating to a service principal.
- clientSecret stringPath 
- Path to a file containing a client secret for authenticating to a service principal.
- oidcAzure stringService Connection Id 
- The Azure Pipelines Service Connection ID to use for authentication.
- oidcRequest stringToken 
- The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
- oidcRequest stringUrl 
- The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
- oidcToken string
- OIDC token to authenticate as a service principal.
- oidcToken stringFile Path 
- OIDC token from file to authenticate as a service principal.
- orgService stringUrl 
- The url of the Azure DevOps instance which should be used. It can also be sourced from the following environment variable: AZDO_ORG_SERVICE_URL
- personalAccess stringToken 
- The personal access token which should be used.
- tenantId string
- The service principal tenant id which should be used for AAD auth.
- useCli boolean
- Use Azure CLI to authenticate. Defaults to true.
- useMsi boolean
- Use an Azure Managed Service Identity. Defaults to false.
- useOidc boolean
- Use an OIDC token to authenticate to a service principal. Defaults to false.
- auxiliary_tenant_ Sequence[str]ids 
- List of auxiliary Tenant IDs required for multi-tenancy and cross-tenant scenarios.
- client_certificate str
- Base64 encoded certificate to use to authenticate to the service principal.
- client_certificate_ strpassword 
- Password for a client certificate password.
- client_certificate_ strpath 
- Path to a certificate to use to authenticate to the service principal.
- client_id str
- The service principal client id which should be used for AAD auth.
- client_id_ strfile_ path 
- The path to a file containing the Client ID which should be used.
- client_secret str
- Client secret for authenticating to a service principal.
- client_secret_ strpath 
- Path to a file containing a client secret for authenticating to a service principal.
- oidc_azure_ strservice_ connection_ id 
- The Azure Pipelines Service Connection ID to use for authentication.
- oidc_request_ strtoken 
- The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
- oidc_request_ strurl 
- The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
- oidc_token str
- OIDC token to authenticate as a service principal.
- oidc_token_ strfile_ path 
- OIDC token from file to authenticate as a service principal.
- org_service_ strurl 
- The url of the Azure DevOps instance which should be used. It can also be sourced from the following environment variable: AZDO_ORG_SERVICE_URL
- personal_access_ strtoken 
- The personal access token which should be used.
- tenant_id str
- The service principal tenant id which should be used for AAD auth.
- use_cli bool
- Use Azure CLI to authenticate. Defaults to true.
- use_msi bool
- Use an Azure Managed Service Identity. Defaults to false.
- use_oidc bool
- Use an OIDC token to authenticate to a service principal. Defaults to false.
- auxiliaryTenant List<String>Ids 
- List of auxiliary Tenant IDs required for multi-tenancy and cross-tenant scenarios.
- clientCertificate String
- Base64 encoded certificate to use to authenticate to the service principal.
- clientCertificate StringPassword 
- Password for a client certificate password.
- clientCertificate StringPath 
- Path to a certificate to use to authenticate to the service principal.
- clientId String
- The service principal client id which should be used for AAD auth.
- clientId StringFile Path 
- The path to a file containing the Client ID which should be used.
- clientSecret String
- Client secret for authenticating to a service principal.
- clientSecret StringPath 
- Path to a file containing a client secret for authenticating to a service principal.
- oidcAzure StringService Connection Id 
- The Azure Pipelines Service Connection ID to use for authentication.
- oidcRequest StringToken 
- The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
- oidcRequest StringUrl 
- The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
- oidcToken String
- OIDC token to authenticate as a service principal.
- oidcToken StringFile Path 
- OIDC token from file to authenticate as a service principal.
- orgService StringUrl 
- The url of the Azure DevOps instance which should be used. It can also be sourced from the following environment variable: AZDO_ORG_SERVICE_URL
- personalAccess StringToken 
- The personal access token which should be used.
- tenantId String
- The service principal tenant id which should be used for AAD auth.
- useCli Boolean
- Use Azure CLI to authenticate. Defaults to true.
- useMsi Boolean
- Use an Azure Managed Service Identity. Defaults to false.
- useOidc Boolean
- Use an OIDC token to authenticate to a service principal. Defaults to false.
Outputs
All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Provider Resource Methods
TerraformConfig Method
This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.
Using TerraformConfig
terraformConfig(): Output<Provider.TerraformConfigResult>def terraform_config() -> Output[Provider.Terraform_configResult]func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)public Output<Provider.TerraformConfigResult> TerraformConfig()TerraformConfig Result
- Result Dictionary<string, object>
- Result map[string]interface{}
- result Map<String,Object>
- result {[key: string]: any}
- result Mapping[str, Any]
- result Map<Any>
Package Details
- Repository
- Azure DevOps pulumi/pulumi-azuredevops
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azuredevopsTerraform Provider.
