Azure Classic v5.38.0, Mar 21 23

azure.Provider

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.

Create Provider Resource

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);

@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_secret: Optional[str] = None,
             disable_correlation_request_id: Optional[bool] = None,
             disable_terraform_partner_id: Optional[bool] = None,
             environment: Optional[str] = None,
             features: Optional[ProviderFeaturesArgs] = None,
             metadata_host: Optional[str] = None,
             msi_endpoint: 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,
             partner_id: Optional[str] = None,
             skip_provider_registration: Optional[bool] = None,
             storage_use_azuread: Optional[bool] = None,
             subscription_id: Optional[str] = None,
             tenant_id: Optional[str] = None,
             use_cli: Optional[bool] = None,
             use_msi: Optional[bool] = None,
             use_oidc: Optional[bool] = None)
@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = 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:azure
properties: # The arguments to resource properties.
options: # 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.

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:

AuxiliaryTenantIds List<string>
ClientCertificate string: Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate
ClientCertificatePassword string: The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
ClientCertificatePath string: The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
ClientId string: The Client ID which should be used.
ClientSecret string: The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
DisableCorrelationRequestId bool: This will disable the x-ms-correlation-request-id header.
DisableTerraformPartnerId bool: This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified.
Environment string: The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. It can also be sourced from the following environment variables: AZURE_ENVIRONMENT, ARM_ENVIRONMENT
Features ProviderFeaturesArgs
MetadataHost string: The Hostname which should be used for the Azure Metadata Service. It can also be sourced from the following environment variable: ARM_METADATA_HOSTNAME
MsiEndpoint string: The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
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.
OidcToken string: The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
OidcTokenFilePath string: The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
PartnerId string: A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
SkipProviderRegistration bool: Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered? It can also be sourced from the following environment variable: ARM_SKIP_PROVIDER_REGISTRATION
StorageUseAzuread bool: Should the AzureRM Provider use AzureAD to access the Storage Data Plane API's? It can also be sourced from the following environment variable: ARM_STORAGE_USE_AZUREAD
SubscriptionId string: The Subscription ID which should be used. It can also be sourced from the following environment variable: ARM_SUBSCRIPTION_ID
TenantId string: The Tenant ID which should be used.
UseCli bool: Allow Azure CLI to be used for Authentication.
UseMsi bool: Allow Managed Service Identity to be used for Authentication.
UseOidc bool: Allow OpenID Connect to be used for authentication

AuxiliaryTenantIds []string
ClientCertificate string: Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate
ClientCertificatePassword string: The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
ClientCertificatePath string: The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
ClientId string: The Client ID which should be used.
ClientSecret string: The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
DisableCorrelationRequestId bool: This will disable the x-ms-correlation-request-id header.
DisableTerraformPartnerId bool: This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified.
Environment string: The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. It can also be sourced from the following environment variables: AZURE_ENVIRONMENT, ARM_ENVIRONMENT
Features ProviderFeaturesArgs
MetadataHost string: The Hostname which should be used for the Azure Metadata Service. It can also be sourced from the following environment variable: ARM_METADATA_HOSTNAME
MsiEndpoint string: The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
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.
OidcToken string: The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
OidcTokenFilePath string: The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
PartnerId string: A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
SkipProviderRegistration bool: Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered? It can also be sourced from the following environment variable: ARM_SKIP_PROVIDER_REGISTRATION
StorageUseAzuread bool: Should the AzureRM Provider use AzureAD to access the Storage Data Plane API's? It can also be sourced from the following environment variable: ARM_STORAGE_USE_AZUREAD
SubscriptionId string: The Subscription ID which should be used. It can also be sourced from the following environment variable: ARM_SUBSCRIPTION_ID
TenantId string: The Tenant ID which should be used.
UseCli bool: Allow Azure CLI to be used for Authentication.
UseMsi bool: Allow Managed Service Identity to be used for Authentication.
UseOidc bool: Allow OpenID Connect to be used for authentication

auxiliaryTenantIds List<String>
clientCertificate String: Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate
clientCertificatePassword String: The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
clientCertificatePath String: The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
clientId String: The Client ID which should be used.
clientSecret String: The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
disableCorrelationRequestId Boolean: This will disable the x-ms-correlation-request-id header.
disableTerraformPartnerId Boolean: This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified.
environment String: The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. It can also be sourced from the following environment variables: AZURE_ENVIRONMENT, ARM_ENVIRONMENT
features ProviderFeaturesArgs
metadataHost String: The Hostname which should be used for the Azure Metadata Service. It can also be sourced from the following environment variable: ARM_METADATA_HOSTNAME
msiEndpoint String: The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
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.
oidcToken String: The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
oidcTokenFilePath String: The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
partnerId String: A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
skipProviderRegistration Boolean: Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered? It can also be sourced from the following environment variable: ARM_SKIP_PROVIDER_REGISTRATION
storageUseAzuread Boolean: Should the AzureRM Provider use AzureAD to access the Storage Data Plane API's? It can also be sourced from the following environment variable: ARM_STORAGE_USE_AZUREAD
subscriptionId String: The Subscription ID which should be used. It can also be sourced from the following environment variable: ARM_SUBSCRIPTION_ID
tenantId String: The Tenant ID which should be used.
useCli Boolean: Allow Azure CLI to be used for Authentication.
useMsi Boolean: Allow Managed Service Identity to be used for Authentication.
useOidc Boolean: Allow OpenID Connect to be used for authentication

auxiliaryTenantIds string[]
clientCertificate string: Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate
clientCertificatePassword string: The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
clientCertificatePath string: The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
clientId string: The Client ID which should be used.
clientSecret string: The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
disableCorrelationRequestId boolean: This will disable the x-ms-correlation-request-id header.
disableTerraformPartnerId boolean: This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified.
environment string: The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. It can also be sourced from the following environment variables: AZURE_ENVIRONMENT, ARM_ENVIRONMENT
features ProviderFeaturesArgs
metadataHost string: The Hostname which should be used for the Azure Metadata Service. It can also be sourced from the following environment variable: ARM_METADATA_HOSTNAME
msiEndpoint string: The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
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.
oidcToken string: The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
oidcTokenFilePath string: The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
partnerId string: A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
skipProviderRegistration boolean: Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered? It can also be sourced from the following environment variable: ARM_SKIP_PROVIDER_REGISTRATION
storageUseAzuread boolean: Should the AzureRM Provider use AzureAD to access the Storage Data Plane API's? It can also be sourced from the following environment variable: ARM_STORAGE_USE_AZUREAD
subscriptionId string: The Subscription ID which should be used. It can also be sourced from the following environment variable: ARM_SUBSCRIPTION_ID
tenantId string: The Tenant ID which should be used.
useCli boolean: Allow Azure CLI to be used for Authentication.
useMsi boolean: Allow Managed Service Identity to be used for Authentication.
useOidc boolean: Allow OpenID Connect to be used for authentication

auxiliary_tenant_ids Sequence[str]
client_certificate str: Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate
client_certificate_password str: The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
client_certificate_path str: The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
client_id str: The Client ID which should be used.
client_secret str: The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
disable_correlation_request_id bool: This will disable the x-ms-correlation-request-id header.
disable_terraform_partner_id bool: This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified.
environment str: The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. It can also be sourced from the following environment variables: AZURE_ENVIRONMENT, ARM_ENVIRONMENT
features ProviderFeaturesArgs
metadata_host str: The Hostname which should be used for the Azure Metadata Service. It can also be sourced from the following environment variable: ARM_METADATA_HOSTNAME
msi_endpoint str: The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
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_token str: The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
oidc_token_file_path str: The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
partner_id str: A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
skip_provider_registration bool: Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered? It can also be sourced from the following environment variable: ARM_SKIP_PROVIDER_REGISTRATION
storage_use_azuread bool: Should the AzureRM Provider use AzureAD to access the Storage Data Plane API's? It can also be sourced from the following environment variable: ARM_STORAGE_USE_AZUREAD
subscription_id str: The Subscription ID which should be used. It can also be sourced from the following environment variable: ARM_SUBSCRIPTION_ID
tenant_id str: The Tenant ID which should be used.
use_cli bool: Allow Azure CLI to be used for Authentication.
use_msi bool: Allow Managed Service Identity to be used for Authentication.
use_oidc bool: Allow OpenID Connect to be used for authentication

auxiliaryTenantIds List<String>
clientCertificate String: Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate
clientCertificatePassword String: The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
clientCertificatePath String: The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
clientId String: The Client ID which should be used.
clientSecret String: The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
disableCorrelationRequestId Boolean: This will disable the x-ms-correlation-request-id header.
disableTerraformPartnerId Boolean: This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified.
environment String: The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. It can also be sourced from the following environment variables: AZURE_ENVIRONMENT, ARM_ENVIRONMENT
features Property Map
metadataHost String: The Hostname which should be used for the Azure Metadata Service. It can also be sourced from the following environment variable: ARM_METADATA_HOSTNAME
msiEndpoint String: The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
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.
oidcToken String: The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
oidcTokenFilePath String: The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
partnerId String: A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
skipProviderRegistration Boolean: Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered? It can also be sourced from the following environment variable: ARM_SKIP_PROVIDER_REGISTRATION
storageUseAzuread Boolean: Should the AzureRM Provider use AzureAD to access the Storage Data Plane API's? It can also be sourced from the following environment variable: ARM_STORAGE_USE_AZUREAD
subscriptionId String: The Subscription ID which should be used. It can also be sourced from the following environment variable: ARM_SUBSCRIPTION_ID
tenantId String: The Tenant ID which should be used.
useCli Boolean: Allow Azure CLI to be used for Authentication.
useMsi Boolean: Allow Managed Service Identity to be used for Authentication.
useOidc Boolean: Allow OpenID Connect to be used for authentication

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.

Supporting Types

ProviderFeatures

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

azure.Provider

Create Provider Resource

Provider Resource Properties

Inputs

Outputs

Supporting Types

ProviderFeatures

ProviderFeaturesApiManagement

ProviderFeaturesAppConfiguration

ProviderFeaturesApplicationInsights

ProviderFeaturesCognitiveAccount

ProviderFeaturesKeyVault

ProviderFeaturesLogAnalyticsWorkspace

ProviderFeaturesManagedDisk

ProviderFeaturesNetwork

ProviderFeaturesResourceGroup

ProviderFeaturesTemplateDeployment

ProviderFeaturesVirtualMachine

ProviderFeaturesVirtualMachineScaleSet

Package Details

Contents