provider.md

permalink
/provider/

provider

provider represents the azurerm Terraform provider config.

This package contains functions and utilities for setting up the provider using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• obj features
  • fn new()
  • obj features.api_management
    • fn new()
  • obj features.app_configuration
    • fn new()
  • obj features.application_insights
    • fn new()
  • obj features.cognitive_account
    • fn new()
  • obj features.key_vault
    • fn new()
  • obj features.log_analytics_workspace
    • fn new()
  • obj features.managed_disk
    • fn new()
  • obj features.resource_group
    • fn new()
  • obj features.subscription
    • fn new()
  • obj features.template_deployment
    • fn new()
  • obj features.virtual_machine
    • fn new()
  • obj features.virtual_machine_scale_set
    • fn new()

Fields

fn new

new()

azurerm.provider.new injects a new azurerm Terraform provider block into the root module document.

Optionally, this inserts the provider into the required_providers terraform sub block if the src and/or version parameters are set.

Args:

• auxiliary_tenant_ids (list): Set the auxiliary_tenant_ids field on the resulting provider block. When null, the auxiliary_tenant_ids field will be omitted from the resulting object.
• client_certificate (string): Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate When null, the client_certificate field will be omitted from the resulting object.
• client_certificate_password (string): The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate When null, the client_certificate_password field will be omitted from the resulting object.
• client_certificate_path (string): The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate. When null, the client_certificate_path field will be omitted from the resulting object.
• client_id (string): The Client ID which should be used. When null, the client_id field will be omitted from the resulting object.
• client_id_file_path (string): The path to a file containing the Client ID which should be used. When null, the client_id_file_path field will be omitted from the resulting object.
• client_secret (string): The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret. When null, the client_secret field will be omitted from the resulting object.
• client_secret_file_path (string): 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. When null, the client_secret_file_path field will be omitted from the resulting object.
• disable_correlation_request_id (bool): This will disable the x-ms-correlation-request-id header. When null, the disable_correlation_request_id field will be omitted from the resulting object.
• disable_terraform_partner_id (bool): This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified. When null, the disable_terraform_partner_id field will be omitted from the resulting object.
• environment (string): The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. When null, the environment field will be omitted from the resulting object.
• metadata_host (string): The Hostname which should be used for the Azure Metadata Service. When null, the metadata_host field will be omitted from the resulting object.
• msi_endpoint (string): The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically. When null, the msi_endpoint field will be omitted from the resulting object.
• oidc_request_token (string): The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect. When null, the oidc_request_token field will be omitted from the resulting object.
• oidc_request_url (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. When null, the oidc_request_url field will be omitted from the resulting object.
• oidc_token (string): The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect. When null, the oidc_token field will be omitted from the resulting object.
• oidc_token_file_path (string): The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect. When null, the oidc_token_file_path field will be omitted from the resulting object.
• partner_id (string): A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution. When null, the partner_id field will be omitted from the resulting object.
• skip_provider_registration (bool): Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered? When null, the skip_provider_registration field will be omitted from the resulting object.
• storage_use_azuread (bool): Should the AzureRM Provider use AzureAD to access the Storage Data Plane API's? When null, the storage_use_azuread field will be omitted from the resulting object.
• subscription_id (string): The Subscription ID which should be used. When null, the subscription_id field will be omitted from the resulting object.
• tenant_id (string): The Tenant ID which should be used. When null, the tenant_id field will be omitted from the resulting object.
• use_cli (bool): Allow Azure CLI to be used for Authentication. When null, the use_cli field will be omitted from the resulting object.
• use_msi (bool): Allow Managed Service Identity to be used for Authentication. When null, the use_msi field will be omitted from the resulting object.
• use_oidc (bool): Allow OpenID Connect to be used for authentication When null, the use_oidc field will be omitted from the resulting object.
• features (list[obj]): Set the features field on the resulting provider block. When null, the features sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.provider.features.new constructor.
• alias (string): The provider alias to set for this instance of the provider block. When null, the alias field will be omitted from the resulting provider block.
• src (string): The provider source to set on the resulting required_providers block. If src or version is set and is not null, a required_providers block and entry for the provider will be injected into the document.
• version (string): The provider version to set on the resulting required_providers block. If src or version is set and is not null, a required_providers block and entry for the provider will be injected into the document.

Returns:

• A mixin object that injects the new provider (and optionally, required_providers block) into the root Terraform configuration.

fn newAttrs

newAttrs()

azurerm.provider. constructs a new object with attributes and blocks configured for the azurerm Terraform provider.

Unlike azurerm.provider.new, this function will not inject the provider block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withProvider function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• auxiliary_tenant_ids (list): Set the auxiliary_tenant_ids field on the resulting object. When null, the auxiliary_tenant_ids field will be omitted from the resulting object.
• client_certificate (string): Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate When null, the client_certificate field will be omitted from the resulting object.
• client_certificate_password (string): The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate When null, the client_certificate_password field will be omitted from the resulting object.
• client_certificate_path (string): The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate. When null, the client_certificate_path field will be omitted from the resulting object.
• client_id (string): The Client ID which should be used. When null, the client_id field will be omitted from the resulting object.
• client_id_file_path (string): The path to a file containing the Client ID which should be used. When null, the client_id_file_path field will be omitted from the resulting object.
• client_secret (string): The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret. When null, the client_secret field will be omitted from the resulting object.
• client_secret_file_path (string): 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. When null, the client_secret_file_path field will be omitted from the resulting object.
• disable_correlation_request_id (bool): This will disable the x-ms-correlation-request-id header. When null, the disable_correlation_request_id field will be omitted from the resulting object.
• disable_terraform_partner_id (bool): This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified. When null, the disable_terraform_partner_id field will be omitted from the resulting object.
• environment (string): The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. When null, the environment field will be omitted from the resulting object.
• metadata_host (string): The Hostname which should be used for the Azure Metadata Service. When null, the metadata_host field will be omitted from the resulting object.
• msi_endpoint (string): The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically. When null, the msi_endpoint field will be omitted from the resulting object.
• oidc_request_token (string): The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect. When null, the oidc_request_token field will be omitted from the resulting object.
• oidc_request_url (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. When null, the oidc_request_url field will be omitted from the resulting object.
• oidc_token (string): The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect. When null, the oidc_token field will be omitted from the resulting object.
• oidc_token_file_path (string): The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect. When null, the oidc_token_file_path field will be omitted from the resulting object.
• partner_id (string): A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution. When null, the partner_id field will be omitted from the resulting object.
• skip_provider_registration (bool): Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered? When null, the skip_provider_registration field will be omitted from the resulting object.
• storage_use_azuread (bool): Should the AzureRM Provider use AzureAD to access the Storage Data Plane API's? When null, the storage_use_azuread field will be omitted from the resulting object.
• subscription_id (string): The Subscription ID which should be used. When null, the subscription_id field will be omitted from the resulting object.
• tenant_id (string): The Tenant ID which should be used. When null, the tenant_id field will be omitted from the resulting object.
• use_cli (bool): Allow Azure CLI to be used for Authentication. When null, the use_cli field will be omitted from the resulting object.
• use_msi (bool): Allow Managed Service Identity to be used for Authentication. When null, the use_msi field will be omitted from the resulting object.
• use_oidc (bool): Allow OpenID Connect to be used for authentication When null, the use_oidc field will be omitted from the resulting object.
• features (list[obj]): Set the features field on the resulting object. When null, the features sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.provider.features.new constructor.

Returns:

• An attribute object that can be used with tf.withProvider to construct a new azurerm provider configuration into the root Terraform configuration.

obj features

fn features.new

new()

azurerm.features.new constructs a new object with attributes and blocks configured for the features Terraform sub block.

Args:

• api_management (list[obj]): Set the api_management field on the resulting object. When null, the api_management sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.api_management.new constructor.
• app_configuration (list[obj]): Set the app_configuration field on the resulting object. When null, the app_configuration sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.app_configuration.new constructor.
• application_insights (list[obj]): Set the application_insights field on the resulting object. When null, the application_insights sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.application_insights.new constructor.
• cognitive_account (list[obj]): Set the cognitive_account field on the resulting object. When null, the cognitive_account sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.cognitive_account.new constructor.
• key_vault (list[obj]): Set the key_vault field on the resulting object. When null, the key_vault sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.key_vault.new constructor.
• log_analytics_workspace (list[obj]): Set the log_analytics_workspace field on the resulting object. When null, the log_analytics_workspace sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.log_analytics_workspace.new constructor.
• managed_disk (list[obj]): Set the managed_disk field on the resulting object. When null, the managed_disk sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.managed_disk.new constructor.
• resource_group (list[obj]): Set the resource_group field on the resulting object. When null, the resource_group sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.resource_group.new constructor.
• subscription (list[obj]): Set the subscription field on the resulting object. When null, the subscription sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.subscription.new constructor.
• template_deployment (list[obj]): Set the template_deployment field on the resulting object. When null, the template_deployment sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.template_deployment.new constructor.
• virtual_machine (list[obj]): Set the virtual_machine field on the resulting object. When null, the virtual_machine sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.virtual_machine.new constructor.
• virtual_machine_scale_set (list[obj]): Set the virtual_machine_scale_set field on the resulting object. When null, the virtual_machine_scale_set sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azurerm.features.virtual_machine_scale_set.new constructor.

Returns:

• An attribute object that represents the features sub block.

obj features.api_management

fn features.api_management.new

new()

azurerm.features.api_management.new constructs a new object with attributes and blocks configured for the api_management Terraform sub block.

Args:

• purge_soft_delete_on_destroy (bool): Set the purge_soft_delete_on_destroy field on the resulting object. When null, the purge_soft_delete_on_destroy field will be omitted from the resulting object.
• recover_soft_deleted (bool): Set the recover_soft_deleted field on the resulting object. When null, the recover_soft_deleted field will be omitted from the resulting object.

Returns:

• An attribute object that represents the api_management sub block.

obj features.app_configuration

fn features.app_configuration.new

new()

azurerm.features.app_configuration.new constructs a new object with attributes and blocks configured for the app_configuration Terraform sub block.

Args:

• purge_soft_delete_on_destroy (bool): Set the purge_soft_delete_on_destroy field on the resulting object. When null, the purge_soft_delete_on_destroy field will be omitted from the resulting object.
• recover_soft_deleted (bool): Set the recover_soft_deleted field on the resulting object. When null, the recover_soft_deleted field will be omitted from the resulting object.

Returns:

• An attribute object that represents the app_configuration sub block.

obj features.application_insights

fn features.application_insights.new

new()

azurerm.features.application_insights.new constructs a new object with attributes and blocks configured for the application_insights Terraform sub block.

Args:

• disable_generated_rule (bool): Set the disable_generated_rule field on the resulting object. When null, the disable_generated_rule field will be omitted from the resulting object.

Returns:

• An attribute object that represents the application_insights sub block.

obj features.cognitive_account

fn features.cognitive_account.new

new()

azurerm.features.cognitive_account.new constructs a new object with attributes and blocks configured for the cognitive_account Terraform sub block.

Args:

• purge_soft_delete_on_destroy (bool): Set the purge_soft_delete_on_destroy field on the resulting object. When null, the purge_soft_delete_on_destroy field will be omitted from the resulting object.

Returns:

• An attribute object that represents the cognitive_account sub block.

obj features.key_vault

fn features.key_vault.new

new()

azurerm.features.key_vault.new constructs a new object with attributes and blocks configured for the key_vault Terraform sub block.

Args:

• purge_soft_delete_on_destroy (bool): When enabled soft-deleted azurerm_key_vault resources will be permanently deleted (e.g purged), when destroyed When null, the purge_soft_delete_on_destroy field will be omitted from the resulting object.
• purge_soft_deleted_certificates_on_destroy (bool): When enabled soft-deleted azurerm_key_vault_certificate resources will be permanently deleted (e.g purged), when destroyed When null, the purge_soft_deleted_certificates_on_destroy field will be omitted from the resulting object.
• purge_soft_deleted_hardware_security_modules_on_destroy (bool): When enabled soft-deleted azurerm_key_vault_managed_hardware_security_module resources will be permanently deleted (e.g purged), when destroyed When null, the purge_soft_deleted_hardware_security_modules_on_destroy field will be omitted from the resulting object.
• purge_soft_deleted_keys_on_destroy (bool): When enabled soft-deleted azurerm_key_vault_key resources will be permanently deleted (e.g purged), when destroyed When null, the purge_soft_deleted_keys_on_destroy field will be omitted from the resulting object.
• purge_soft_deleted_secrets_on_destroy (bool): When enabled soft-deleted azurerm_key_vault_secret resources will be permanently deleted (e.g purged), when destroyed When null, the purge_soft_deleted_secrets_on_destroy field will be omitted from the resulting object.
• recover_soft_deleted_certificates (bool): When enabled soft-deleted azurerm_key_vault_certificate resources will be restored, instead of creating new ones When null, the recover_soft_deleted_certificates field will be omitted from the resulting object.
• recover_soft_deleted_key_vaults (bool): When enabled soft-deleted azurerm_key_vault resources will be restored, instead of creating new ones When null, the recover_soft_deleted_key_vaults field will be omitted from the resulting object.
• recover_soft_deleted_keys (bool): When enabled soft-deleted azurerm_key_vault_key resources will be restored, instead of creating new ones When null, the recover_soft_deleted_keys field will be omitted from the resulting object.
• recover_soft_deleted_secrets (bool): When enabled soft-deleted azurerm_key_vault_secret resources will be restored, instead of creating new ones When null, the recover_soft_deleted_secrets field will be omitted from the resulting object.

Returns:

• An attribute object that represents the key_vault sub block.

obj features.log_analytics_workspace

fn features.log_analytics_workspace.new

new()

azurerm.features.log_analytics_workspace.new constructs a new object with attributes and blocks configured for the log_analytics_workspace Terraform sub block.

Args:

• permanently_delete_on_destroy (bool): Set the permanently_delete_on_destroy field on the resulting object. When null, the permanently_delete_on_destroy field will be omitted from the resulting object.

Returns:

• An attribute object that represents the log_analytics_workspace sub block.

obj features.managed_disk

fn features.managed_disk.new

new()

azurerm.features.managed_disk.new constructs a new object with attributes and blocks configured for the managed_disk Terraform sub block.

Args:

• expand_without_downtime (bool): Set the expand_without_downtime field on the resulting object. When null, the expand_without_downtime field will be omitted from the resulting object.

Returns:

• An attribute object that represents the managed_disk sub block.

obj features.resource_group

fn features.resource_group.new

new()

azurerm.features.resource_group.new constructs a new object with attributes and blocks configured for the resource_group Terraform sub block.

Args:

• prevent_deletion_if_contains_resources (bool): Set the prevent_deletion_if_contains_resources field on the resulting object. When null, the prevent_deletion_if_contains_resources field will be omitted from the resulting object.

Returns:

• An attribute object that represents the resource_group sub block.

obj features.subscription

fn features.subscription.new

new()

azurerm.features.subscription.new constructs a new object with attributes and blocks configured for the subscription Terraform sub block.

Args:

• prevent_cancellation_on_destroy (bool): Set the prevent_cancellation_on_destroy field on the resulting object. When null, the prevent_cancellation_on_destroy field will be omitted from the resulting object.

Returns:

• An attribute object that represents the subscription sub block.

obj features.template_deployment

fn features.template_deployment.new

new()

azurerm.features.template_deployment.new constructs a new object with attributes and blocks configured for the template_deployment Terraform sub block.

Args:

• delete_nested_items_during_deletion (bool): Set the delete_nested_items_during_deletion field on the resulting object.

Returns:

• An attribute object that represents the template_deployment sub block.

obj features.virtual_machine

fn features.virtual_machine.new

new()

azurerm.features.virtual_machine.new constructs a new object with attributes and blocks configured for the virtual_machine Terraform sub block.

Args:

• delete_os_disk_on_deletion (bool): Set the delete_os_disk_on_deletion field on the resulting object. When null, the delete_os_disk_on_deletion field will be omitted from the resulting object.
• graceful_shutdown (bool): Set the graceful_shutdown field on the resulting object. When null, the graceful_shutdown field will be omitted from the resulting object.
• skip_shutdown_and_force_delete (bool): Set the skip_shutdown_and_force_delete field on the resulting object. When null, the skip_shutdown_and_force_delete field will be omitted from the resulting object.

Returns:

• An attribute object that represents the virtual_machine sub block.

obj features.virtual_machine_scale_set

fn features.virtual_machine_scale_set.new

new()

azurerm.features.virtual_machine_scale_set.new constructs a new object with attributes and blocks configured for the virtual_machine_scale_set Terraform sub block.

Args:

• force_delete (bool): Set the force_delete field on the resulting object. When null, the force_delete field will be omitted from the resulting object.
• roll_instances_when_required (bool): Set the roll_instances_when_required field on the resulting object. When null, the roll_instances_when_required field will be omitted from the resulting object.
• scale_to_zero_before_deletion (bool): Set the scale_to_zero_before_deletion field on the resulting object. When null, the scale_to_zero_before_deletion field will be omitted from the resulting object.

Returns:

• An attribute object that represents the virtual_machine_scale_set sub block.