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 a Provider Resource

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

def Provider(resource_name, opts=None, auxiliary_tenant_ids=None, client_certificate_password=None, client_certificate_path=None, client_id=None, client_secret=None, disable_correlation_request_id=None, disable_terraform_partner_id=None, environment=None, features=None, msi_endpoint=None, partner_id=None, skip_credentials_validation=None, skip_provider_registration=None, storage_use_azuread=None, subscription_id=None, tenant_id=None, use_msi=None, __props__=None);

func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)

public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Provider resource accepts the following input properties:

AuxiliaryTenantIds List<string>
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, german, and china. Defaults to public.
Features ProviderFeaturesArgs
MsiEndpoint string: The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
PartnerId string: A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
SkipCredentialsValidation bool: This will cause the AzureRM Provider to skip verifying the credentials being used are valid.
SkipProviderRegistration bool: Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they’re not already registered?
StorageUseAzuread bool: Should the AzureRM Provider use AzureAD to access the Storage Data Plane API’s?
SubscriptionId string: The Subscription ID which should be used.
TenantId string: The Tenant ID which should be used.
UseMsi bool: Allowed Managed Service Identity be used for Authentication.

AuxiliaryTenantIds []string
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, german, and china. Defaults to public.
Features ProviderFeatures
MsiEndpoint string: The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
PartnerId string: A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
SkipCredentialsValidation bool: This will cause the AzureRM Provider to skip verifying the credentials being used are valid.
SkipProviderRegistration bool: Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they’re not already registered?
StorageUseAzuread bool: Should the AzureRM Provider use AzureAD to access the Storage Data Plane API’s?
SubscriptionId string: The Subscription ID which should be used.
TenantId string: The Tenant ID which should be used.
UseMsi bool: Allowed Managed Service Identity be used for Authentication.

auxiliaryTenantIds string[]
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, german, and china. Defaults to public.
features ProviderFeatures
msiEndpoint string: The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
partnerId string: A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
skipCredentialsValidation boolean: This will cause the AzureRM Provider to skip verifying the credentials being used are valid.
skipProviderRegistration boolean: Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they’re not already registered?
storageUseAzuread boolean: Should the AzureRM Provider use AzureAD to access the Storage Data Plane API’s?
subscriptionId string: The Subscription ID which should be used.
tenantId string: The Tenant ID which should be used.
useMsi boolean: Allowed Managed Service Identity be used for Authentication.

auxiliary_tenant_ids List[str]
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, german, and china. Defaults to public.
features Dict[ProviderFeatures]
msi_endpoint str: The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
partner_id str: A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
skip_credentials_validation bool: This will cause the AzureRM Provider to skip verifying the credentials being used are valid.
skip_provider_registration bool: Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they’re not already registered?
storage_use_azuread bool: Should the AzureRM Provider use AzureAD to access the Storage Data Plane API’s?
subscription_id str: The Subscription ID which should be used.
tenant_id str: The Tenant ID which should be used.
use_msi bool: Allowed Managed Service Identity be used for Authentication.