1. Packages
  2. AzureDevOps
  3. API Docs
  4. Provider
Azure DevOps v3.1.1 published on Monday, May 20, 2024 by Pulumi

azuredevops.Provider

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.1.1 published on Monday, May 20, 2024 by Pulumi

    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,
                 client_certificate: Optional[str] = None,
                 client_certificate_password: Optional[str] = None,
                 client_certificate_path: Optional[str] = None,
                 client_id: Optional[str] = None,
                 client_id_apply: Optional[str] = None,
                 client_id_plan: Optional[str] = None,
                 client_secret: Optional[str] = None,
                 client_secret_path: Optional[str] = None,
                 oidc_audience: Optional[str] = None,
                 oidc_request_token: Optional[str] = None,
                 oidc_request_url: Optional[str] = None,
                 oidc_tfc_tag: 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,
                 tenant_id_apply: Optional[str] = None,
                 tenant_id_plan: Optional[str] = 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

    The Provider resource accepts the following input properties:

    ClientCertificate string
    Base64 encoded certificate to use to authenticate to the service principal.
    ClientCertificatePassword string
    Password for a client certificate password.
    ClientCertificatePath string
    Path to a certificate to use to authenticate to the service principal.
    ClientId string
    The service principal client or managed service principal id which should be used.
    ClientIdApply string
    ClientIdPlan string
    ClientSecret string
    Client secret for authenticating to a service principal.
    ClientSecretPath string
    Path to a file containing a client secret for authenticating to a service principal.
    OidcAudience string
    Set the audience when requesting OIDC tokens.
    OidcRequestToken string
    The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
    OidcRequestUrl string
    The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
    OidcTfcTag string
    OidcToken string
    OIDC token to authenticate as a service principal.
    OidcTokenFilePath string
    OIDC token from file to authenticate as a service principal.
    OrgServiceUrl string
    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
    PersonalAccessToken string
    The personal access token which should be used.
    TenantId string
    The service principal tenant id which should be used.
    TenantIdApply string
    TenantIdPlan string
    UseMsi bool
    Use an Azure Managed Service Identity.
    UseOidc bool
    Use an OIDC token to authenticate to a service principal.
    ClientCertificate string
    Base64 encoded certificate to use to authenticate to the service principal.
    ClientCertificatePassword string
    Password for a client certificate password.
    ClientCertificatePath string
    Path to a certificate to use to authenticate to the service principal.
    ClientId string
    The service principal client or managed service principal id which should be used.
    ClientIdApply string
    ClientIdPlan string
    ClientSecret string
    Client secret for authenticating to a service principal.
    ClientSecretPath string
    Path to a file containing a client secret for authenticating to a service principal.
    OidcAudience string
    Set the audience when requesting OIDC tokens.
    OidcRequestToken string
    The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
    OidcRequestUrl string
    The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
    OidcTfcTag string
    OidcToken string
    OIDC token to authenticate as a service principal.
    OidcTokenFilePath string
    OIDC token from file to authenticate as a service principal.
    OrgServiceUrl string
    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
    PersonalAccessToken string
    The personal access token which should be used.
    TenantId string
    The service principal tenant id which should be used.
    TenantIdApply string
    TenantIdPlan string
    UseMsi bool
    Use an Azure Managed Service Identity.
    UseOidc bool
    Use an OIDC token to authenticate to a service principal.
    clientCertificate String
    Base64 encoded certificate to use to authenticate to the service principal.
    clientCertificatePassword String
    Password for a client certificate password.
    clientCertificatePath String
    Path to a certificate to use to authenticate to the service principal.
    clientId String
    The service principal client or managed service principal id which should be used.
    clientIdApply String
    clientIdPlan String
    clientSecret String
    Client secret for authenticating to a service principal.
    clientSecretPath String
    Path to a file containing a client secret for authenticating to a service principal.
    oidcAudience String
    Set the audience when requesting OIDC tokens.
    oidcRequestToken String
    The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
    oidcRequestUrl String
    The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
    oidcTfcTag String
    oidcToken String
    OIDC token to authenticate as a service principal.
    oidcTokenFilePath String
    OIDC token from file to authenticate as a service principal.
    orgServiceUrl String
    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
    personalAccessToken String
    The personal access token which should be used.
    tenantId String
    The service principal tenant id which should be used.
    tenantIdApply String
    tenantIdPlan String
    useMsi Boolean
    Use an Azure Managed Service Identity.
    useOidc Boolean
    Use an OIDC token to authenticate to a service principal.
    clientCertificate string
    Base64 encoded certificate to use to authenticate to the service principal.
    clientCertificatePassword string
    Password for a client certificate password.
    clientCertificatePath string
    Path to a certificate to use to authenticate to the service principal.
    clientId string
    The service principal client or managed service principal id which should be used.
    clientIdApply string
    clientIdPlan string
    clientSecret string
    Client secret for authenticating to a service principal.
    clientSecretPath string
    Path to a file containing a client secret for authenticating to a service principal.
    oidcAudience string
    Set the audience when requesting OIDC tokens.
    oidcRequestToken string
    The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
    oidcRequestUrl string
    The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
    oidcTfcTag string
    oidcToken string
    OIDC token to authenticate as a service principal.
    oidcTokenFilePath string
    OIDC token from file to authenticate as a service principal.
    orgServiceUrl string
    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
    personalAccessToken string
    The personal access token which should be used.
    tenantId string
    The service principal tenant id which should be used.
    tenantIdApply string
    tenantIdPlan string
    useMsi boolean
    Use an Azure Managed Service Identity.
    useOidc boolean
    Use an OIDC token to authenticate to a service principal.
    client_certificate str
    Base64 encoded certificate to use to authenticate to the service principal.
    client_certificate_password str
    Password for a client certificate password.
    client_certificate_path str
    Path to a certificate to use to authenticate to the service principal.
    client_id str
    The service principal client or managed service principal id which should be used.
    client_id_apply str
    client_id_plan str
    client_secret str
    Client secret for authenticating to a service principal.
    client_secret_path str
    Path to a file containing a client secret for authenticating to a service principal.
    oidc_audience str
    Set the audience when requesting OIDC tokens.
    oidc_request_token str
    The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
    oidc_request_url str
    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_tfc_tag str
    oidc_token str
    OIDC token to authenticate as a service principal.
    oidc_token_file_path str
    OIDC token from file to authenticate as a service principal.
    org_service_url str
    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_token str
    The personal access token which should be used.
    tenant_id str
    The service principal tenant id which should be used.
    tenant_id_apply str
    tenant_id_plan str
    use_msi bool
    Use an Azure Managed Service Identity.
    use_oidc bool
    Use an OIDC token to authenticate to a service principal.
    clientCertificate String
    Base64 encoded certificate to use to authenticate to the service principal.
    clientCertificatePassword String
    Password for a client certificate password.
    clientCertificatePath String
    Path to a certificate to use to authenticate to the service principal.
    clientId String
    The service principal client or managed service principal id which should be used.
    clientIdApply String
    clientIdPlan String
    clientSecret String
    Client secret for authenticating to a service principal.
    clientSecretPath String
    Path to a file containing a client secret for authenticating to a service principal.
    oidcAudience String
    Set the audience when requesting OIDC tokens.
    oidcRequestToken String
    The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.
    oidcRequestUrl String
    The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.
    oidcTfcTag String
    oidcToken String
    OIDC token to authenticate as a service principal.
    oidcTokenFilePath String
    OIDC token from file to authenticate as a service principal.
    orgServiceUrl String
    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
    personalAccessToken String
    The personal access token which should be used.
    tenantId String
    The service principal tenant id which should be used.
    tenantIdApply String
    tenantIdPlan String
    useMsi Boolean
    Use an Azure Managed Service Identity.
    useOidc Boolean
    Use an OIDC token to authenticate to a service principal.

    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.

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Azure DevOps v3.1.1 published on Monday, May 20, 2024 by Pulumi