ProviderArgs

data class ProviderArgs(val adoPipelineServiceConnectionId: Output<String>? = null, val auxiliaryTenantIds: Output<List<String>>? = null, val clientCertificate: Output<String>? = null, val clientCertificatePassword: Output<String>? = null, val clientCertificatePath: Output<String>? = null, val clientId: Output<String>? = null, val clientIdFilePath: Output<String>? = null, val clientSecret: Output<String>? = null, val clientSecretFilePath: Output<String>? = null, val disableCorrelationRequestId: Output<Boolean>? = null, val disableTerraformPartnerId: Output<Boolean>? = null, val environment: Output<String>? = null, val features: Output<ProviderFeaturesArgs>? = null, val metadataHost: Output<String>? = null, val msiEndpoint: Output<String>? = null, val oidcRequestToken: Output<String>? = null, val oidcRequestUrl: Output<String>? = null, val oidcToken: Output<String>? = null, val oidcTokenFilePath: Output<String>? = null, val partnerId: Output<String>? = null, val resourceProviderRegistrations: Output<String>? = null, val resourceProvidersToRegisters: Output<List<String>>? = null, val skipProviderRegistration: Output<Boolean>? = null, val storageUseAzuread: Output<Boolean>? = null, val subscriptionId: Output<String>? = null, val tenantId: Output<String>? = null, val useAksWorkloadIdentity: Output<Boolean>? = null, val useCli: Output<Boolean>? = null, val useMsi: Output<Boolean>? = null, val useOidc: Output<Boolean>? = null) : ConvertibleToJava<ProviderArgs>

The provider type for the azurerm 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.

Constructors

Link copied to clipboard
constructor(adoPipelineServiceConnectionId: Output<String>? = null, auxiliaryTenantIds: Output<List<String>>? = null, clientCertificate: Output<String>? = null, clientCertificatePassword: Output<String>? = null, clientCertificatePath: Output<String>? = null, clientId: Output<String>? = null, clientIdFilePath: Output<String>? = null, clientSecret: Output<String>? = null, clientSecretFilePath: Output<String>? = null, disableCorrelationRequestId: Output<Boolean>? = null, disableTerraformPartnerId: Output<Boolean>? = null, environment: Output<String>? = null, features: Output<ProviderFeaturesArgs>? = null, metadataHost: Output<String>? = null, msiEndpoint: Output<String>? = null, oidcRequestToken: Output<String>? = null, oidcRequestUrl: Output<String>? = null, oidcToken: Output<String>? = null, oidcTokenFilePath: Output<String>? = null, partnerId: Output<String>? = null, resourceProviderRegistrations: Output<String>? = null, resourceProvidersToRegisters: Output<List<String>>? = null, skipProviderRegistration: Output<Boolean>? = null, storageUseAzuread: Output<Boolean>? = null, subscriptionId: Output<String>? = null, tenantId: Output<String>? = null, useAksWorkloadIdentity: Output<Boolean>? = null, useCli: Output<Boolean>? = null, useMsi: Output<Boolean>? = null, useOidc: Output<Boolean>? = null)

Properties

Link copied to clipboard

The Azure DevOps Pipeline Service Connection ID.

Link copied to clipboard
val auxiliaryTenantIds: Output<List<String>>? = null
Link copied to clipboard
val clientCertificate: Output<String>? = null

Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate

Link copied to clipboard
val clientCertificatePassword: Output<String>? = null

The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate

Link copied to clipboard
val clientCertificatePath: Output<String>? = null

The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.

Link copied to clipboard
val clientId: Output<String>? = null

The Client ID which should be used.

Link copied to clipboard
val clientIdFilePath: Output<String>? = null

The path to a file containing the Client ID which should be used.

Link copied to clipboard
val clientSecret: Output<String>? = null

The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.

Link copied to clipboard
val clientSecretFilePath: Output<String>? = null

The path to a file containing the Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.

Link copied to clipboard

This will disable the x-ms-correlation-request-id header.

Link copied to clipboard
val disableTerraformPartnerId: Output<Boolean>? = null
Link copied to clipboard
val environment: Output<String>? = null

The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. Not used and should not be specified when metadata_host is specified.

Link copied to clipboard
val features: Output<ProviderFeaturesArgs>? = null
Link copied to clipboard
val metadataHost: Output<String>? = null

The Hostname which should be used for the Azure Metadata Service.

Link copied to clipboard
val msiEndpoint: Output<String>? = null

The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.

Link copied to clipboard
val oidcRequestToken: Output<String>? = null

The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect.

Link copied to clipboard
val oidcRequestUrl: Output<String>? = null

The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect.

Link copied to clipboard
val oidcToken: Output<String>? = null

The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.

Link copied to clipboard
val oidcTokenFilePath: Output<String>? = null

The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.

Link copied to clipboard
val partnerId: Output<String>? = null

A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.

Link copied to clipboard

The set of Resource Providers which should be automatically registered for the subscription.

Link copied to clipboard

A list of Resource Providers to explicitly register for the subscription, in addition to those specified by the resource_provider_registrations property.

Link copied to clipboard
val skipProviderRegistration: Output<Boolean>? = null

Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered?

Link copied to clipboard
val storageUseAzuread: Output<Boolean>? = null

Should the AzureRM Provider use Azure AD Authentication when accessing the Storage Data Plane APIs?

Link copied to clipboard
val subscriptionId: Output<String>? = null

The Subscription ID which should be used.

Link copied to clipboard
val tenantId: Output<String>? = null

The Tenant ID which should be used.

Link copied to clipboard
val useAksWorkloadIdentity: Output<Boolean>? = null

Allow Azure AKS Workload Identity to be used for Authentication.

Link copied to clipboard
val useCli: Output<Boolean>? = null

Allow Azure CLI to be used for Authentication.

Link copied to clipboard
val useMsi: Output<Boolean>? = null

Allow Managed Service Identity to be used for Authentication.

Link copied to clipboard
val useOidc: Output<Boolean>? = null

Allow OpenID Connect to be used for authentication

Functions

Link copied to clipboard
open override fun toJava(): ProviderArgs