Skip to content

Latest commit

 

History

History
3306 lines (2078 loc) · 163 KB

provider.python.md

File metadata and controls

3306 lines (2078 loc) · 163 KB
Raw

provider Submodule

Constructs

AzurermProvider

Represents a {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs azurerm}.

Initializers 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProvider(
  scope: Construct,
  id: str,
  alias: str = None,
  auxiliary_tenant_ids: typing.List[str] = None,
  client_certificate: str = None,
  client_certificate_password: str = None,
  client_certificate_path: str = None,
  client_id: str = None,
  client_id_file_path: str = None,
  client_secret: str = None,
  client_secret_file_path: str = None,
  disable_correlation_request_id: typing.Union[bool, IResolvable] = None,
  disable_terraform_partner_id: typing.Union[bool, IResolvable] = None,
  environment: str = None,
  features: typing.Union[IResolvable, typing.List[AzurermProviderFeatures]] = None,
  metadata_host: str = None,
  msi_endpoint: str = None,
  oidc_request_token: str = None,
  oidc_request_url: str = None,
  oidc_token: str = None,
  oidc_token_file_path: str = None,
  partner_id: str = None,
  resource_provider_registrations: str = None,
  resource_providers_to_register: typing.List[str] = None,
  skip_provider_registration: typing.Union[bool, IResolvable] = None,
  storage_use_azuread: typing.Union[bool, IResolvable] = None,
  subscription_id: str = None,
  tenant_id: str = None,
  use_aks_workload_identity: typing.Union[bool, IResolvable] = None,
  use_cli: typing.Union[bool, IResolvable] = None,
  use_msi: typing.Union[bool, IResolvable] = None,
  use_oidc: typing.Union[bool, IResolvable] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
alias str Alias name.
auxiliary_tenant_ids typing.List[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#auxiliary_tenant_ids AzurermProvider#auxiliary_tenant_ids}.
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_id_file_path str The path to a file containing 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.
client_secret_file_path str The path to a file containing the Client Secret which should be used.
disable_correlation_request_id typing.Union[bool, cdktf.IResolvable] This will disable the x-ms-correlation-request-id header.
disable_terraform_partner_id typing.Union[bool, cdktf.IResolvable] 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.
features typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeatures]] features block.
metadata_host str The Hostname which should be used for the Azure Metadata Service.
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.
oidc_request_url str The URL for the OIDC provider from which to request an ID token.
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.
resource_provider_registrations str The set of Resource Providers which should be automatically registered for the subscription.
resource_providers_to_register typing.List[str] A list of Resource Providers to explicitly register for the subscription, in addition to those specified by the resource_provider_registrations property.
skip_provider_registration typing.Union[bool, cdktf.IResolvable] Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
storage_use_azuread typing.Union[bool, cdktf.IResolvable] Should the AzureRM Provider use Azure AD Authentication when accessing the Storage Data Plane APIs?
subscription_id str The Subscription ID which should be used.
tenant_id str The Tenant ID which should be used.
use_aks_workload_identity typing.Union[bool, cdktf.IResolvable] Allow Azure AKS Workload Identity to be used for Authentication.
use_cli typing.Union[bool, cdktf.IResolvable] Allow Azure CLI to be used for Authentication.
use_msi typing.Union[bool, cdktf.IResolvable] Allow Managed Service Identity to be used for Authentication.
use_oidc typing.Union[bool, cdktf.IResolvable] Allow OpenID Connect to be used for authentication.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

aliasOptional
  • Type: str

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#alias AzurermProvider#alias}

auxiliary_tenant_idsOptional
  • Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#auxiliary_tenant_ids AzurermProvider#auxiliary_tenant_ids}.

client_certificateOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_certificate AzurermProvider#client_certificate}

client_certificate_passwordOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_certificate_password AzurermProvider#client_certificate_password}

client_certificate_pathOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_certificate_path AzurermProvider#client_certificate_path}

client_idOptional
  • Type: str

The Client ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_id AzurermProvider#client_id}

client_id_file_pathOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_id_file_path AzurermProvider#client_id_file_path}

client_secretOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_secret AzurermProvider#client_secret}

client_secret_file_pathOptional
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_secret_file_path AzurermProvider#client_secret_file_path}

disable_correlation_request_idOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#disable_correlation_request_id AzurermProvider#disable_correlation_request_id}

disable_terraform_partner_idOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#disable_terraform_partner_id AzurermProvider#disable_terraform_partner_id}

environmentOptional
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#environment AzurermProvider#environment}

featuresOptional

features block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#features AzurermProvider#features}

metadata_hostOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#metadata_host AzurermProvider#metadata_host}

msi_endpointOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#msi_endpoint AzurermProvider#msi_endpoint}

oidc_request_tokenOptional
  • Type: str

The bearer token for the request to the OIDC provider.

For use when authenticating as a Service Principal using OpenID Connect.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#oidc_request_token AzurermProvider#oidc_request_token}

oidc_request_urlOptional
  • Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#oidc_request_url AzurermProvider#oidc_request_url}

oidc_tokenOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#oidc_token AzurermProvider#oidc_token}

oidc_token_file_pathOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#oidc_token_file_path AzurermProvider#oidc_token_file_path}

partner_idOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#partner_id AzurermProvider#partner_id}

resource_provider_registrationsOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#resource_provider_registrations AzurermProvider#resource_provider_registrations}

resource_providers_to_registerOptional
  • Type: typing.List[str]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#resource_providers_to_register AzurermProvider#resource_providers_to_register}

skip_provider_registrationOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#skip_provider_registration AzurermProvider#skip_provider_registration}

storage_use_azureadOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#storage_use_azuread AzurermProvider#storage_use_azuread}

subscription_idOptional
  • Type: str

The Subscription ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#subscription_id AzurermProvider#subscription_id}

tenant_idOptional
  • Type: str

The Tenant ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#tenant_id AzurermProvider#tenant_id}

use_aks_workload_identityOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Allow Azure AKS Workload Identity to be used for Authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#use_aks_workload_identity AzurermProvider#use_aks_workload_identity}

use_cliOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Allow Azure CLI to be used for Authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#use_cli AzurermProvider#use_cli}

use_msiOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Allow Managed Service Identity to be used for Authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#use_msi AzurermProvider#use_msi}

use_oidcOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Allow OpenID Connect to be used for authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#use_oidc AzurermProvider#use_oidc}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
reset_alias No description.
reset_auxiliary_tenant_ids No description.
reset_client_certificate No description.
reset_client_certificate_password No description.
reset_client_certificate_path No description.
reset_client_id No description.
reset_client_id_file_path No description.
reset_client_secret No description.
reset_client_secret_file_path No description.
reset_disable_correlation_request_id No description.
reset_disable_terraform_partner_id No description.
reset_environment No description.
reset_features No description.
reset_metadata_host No description.
reset_msi_endpoint No description.
reset_oidc_request_token No description.
reset_oidc_request_url No description.
reset_oidc_token No description.
reset_oidc_token_file_path No description.
reset_partner_id No description.
reset_resource_provider_registrations No description.
reset_resource_providers_to_register No description.
reset_skip_provider_registration No description.
reset_storage_use_azuread No description.
reset_subscription_id No description.
reset_tenant_id No description.
reset_use_aks_workload_identity No description.
reset_use_cli No description.
reset_use_msi No description.
reset_use_oidc No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

reset_alias 
def reset_alias() -> None
reset_auxiliary_tenant_ids 
def reset_auxiliary_tenant_ids() -> None
reset_client_certificate 
def reset_client_certificate() -> None
reset_client_certificate_password 
def reset_client_certificate_password() -> None
reset_client_certificate_path 
def reset_client_certificate_path() -> None
reset_client_id 
def reset_client_id() -> None
reset_client_id_file_path 
def reset_client_id_file_path() -> None
reset_client_secret 
def reset_client_secret() -> None
reset_client_secret_file_path 
def reset_client_secret_file_path() -> None
reset_disable_correlation_request_id 
def reset_disable_correlation_request_id() -> None
reset_disable_terraform_partner_id 
def reset_disable_terraform_partner_id() -> None
reset_environment 
def reset_environment() -> None
reset_features 
def reset_features() -> None
reset_metadata_host 
def reset_metadata_host() -> None
reset_msi_endpoint 
def reset_msi_endpoint() -> None
reset_oidc_request_token 
def reset_oidc_request_token() -> None
reset_oidc_request_url 
def reset_oidc_request_url() -> None
reset_oidc_token 
def reset_oidc_token() -> None
reset_oidc_token_file_path 
def reset_oidc_token_file_path() -> None
reset_partner_id 
def reset_partner_id() -> None
reset_resource_provider_registrations 
def reset_resource_provider_registrations() -> None
reset_resource_providers_to_register 
def reset_resource_providers_to_register() -> None
reset_skip_provider_registration 
def reset_skip_provider_registration() -> None
reset_storage_use_azuread 
def reset_storage_use_azuread() -> None
reset_subscription_id 
def reset_subscription_id() -> None
reset_tenant_id 
def reset_tenant_id() -> None
reset_use_aks_workload_identity 
def reset_use_aks_workload_identity() -> None
reset_use_cli 
def reset_use_cli() -> None
reset_use_msi 
def reset_use_msi() -> None
reset_use_oidc 
def reset_use_oidc() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_provider No description.
generate_config_for_import Generates CDKTF code for importing a AzurermProvider resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProvider.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProvider.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_provider 
from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProvider.is_terraform_provider(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProvider.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a AzurermProvider resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the AzurermProvider to import.

import_from_idRequired
  • Type: str

The id of the existing AzurermProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the AzurermProvider to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
meta_attributes typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
terraform_provider_source str No description.
alias str No description.
alias_input str No description.
auxiliary_tenant_ids_input typing.List[str] No description.
client_certificate_input str No description.
client_certificate_password_input str No description.
client_certificate_path_input str No description.
client_id_file_path_input str No description.
client_id_input str No description.
client_secret_file_path_input str No description.
client_secret_input str No description.
disable_correlation_request_id_input typing.Union[bool, cdktf.IResolvable] No description.
disable_terraform_partner_id_input typing.Union[bool, cdktf.IResolvable] No description.
environment_input str No description.
features_input typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeatures]] No description.
metadata_host_input str No description.
msi_endpoint_input str No description.
oidc_request_token_input str No description.
oidc_request_url_input str No description.
oidc_token_file_path_input str No description.
oidc_token_input str No description.
partner_id_input str No description.
resource_provider_registrations_input str No description.
resource_providers_to_register_input typing.List[str] No description.
skip_provider_registration_input typing.Union[bool, cdktf.IResolvable] No description.
storage_use_azuread_input typing.Union[bool, cdktf.IResolvable] No description.
subscription_id_input str No description.
tenant_id_input str No description.
use_aks_workload_identity_input typing.Union[bool, cdktf.IResolvable] No description.
use_cli_input typing.Union[bool, cdktf.IResolvable] No description.
use_msi_input typing.Union[bool, cdktf.IResolvable] No description.
use_oidc_input typing.Union[bool, cdktf.IResolvable] No description.
auxiliary_tenant_ids typing.List[str] No description.
client_certificate str No description.
client_certificate_password str No description.
client_certificate_path str No description.
client_id str No description.
client_id_file_path str No description.
client_secret str No description.
client_secret_file_path str No description.
disable_correlation_request_id typing.Union[bool, cdktf.IResolvable] No description.
disable_terraform_partner_id typing.Union[bool, cdktf.IResolvable] No description.
environment str No description.
features typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeatures]] No description.
metadata_host str No description.
msi_endpoint str No description.
oidc_request_token str No description.
oidc_request_url str No description.
oidc_token str No description.
oidc_token_file_path str No description.
partner_id str No description.
resource_provider_registrations str No description.
resource_providers_to_register typing.List[str] No description.
skip_provider_registration typing.Union[bool, cdktf.IResolvable] No description.
storage_use_azuread typing.Union[bool, cdktf.IResolvable] No description.
subscription_id str No description.
tenant_id str No description.
use_aks_workload_identity typing.Union[bool, cdktf.IResolvable] No description.
use_cli typing.Union[bool, cdktf.IResolvable] No description.
use_msi typing.Union[bool, cdktf.IResolvable] No description.
use_oidc typing.Union[bool, cdktf.IResolvable] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
meta_attributesRequired 
meta_attributes: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
terraform_provider_sourceOptional 
terraform_provider_source: str
  • Type: str
aliasOptional 
alias: str
  • Type: str
alias_inputOptional 
alias_input: str
  • Type: str
auxiliary_tenant_ids_inputOptional 
auxiliary_tenant_ids_input: typing.List[str]
  • Type: typing.List[str]
client_certificate_inputOptional 
client_certificate_input: str
  • Type: str
client_certificate_password_inputOptional 
client_certificate_password_input: str
  • Type: str
client_certificate_path_inputOptional 
client_certificate_path_input: str
  • Type: str
client_id_file_path_inputOptional 
client_id_file_path_input: str
  • Type: str
client_id_inputOptional 
client_id_input: str
  • Type: str
client_secret_file_path_inputOptional 
client_secret_file_path_input: str
  • Type: str
client_secret_inputOptional 
client_secret_input: str
  • Type: str
disable_correlation_request_id_inputOptional 
disable_correlation_request_id_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
disable_terraform_partner_id_inputOptional 
disable_terraform_partner_id_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
environment_inputOptional 
environment_input: str
  • Type: str
features_inputOptional 
features_input: typing.Union[IResolvable, typing.List[AzurermProviderFeatures]]
metadata_host_inputOptional 
metadata_host_input: str
  • Type: str
msi_endpoint_inputOptional 
msi_endpoint_input: str
  • Type: str
oidc_request_token_inputOptional 
oidc_request_token_input: str
  • Type: str
oidc_request_url_inputOptional 
oidc_request_url_input: str
  • Type: str
oidc_token_file_path_inputOptional 
oidc_token_file_path_input: str
  • Type: str
oidc_token_inputOptional 
oidc_token_input: str
  • Type: str
partner_id_inputOptional 
partner_id_input: str
  • Type: str
resource_provider_registrations_inputOptional 
resource_provider_registrations_input: str
  • Type: str
resource_providers_to_register_inputOptional 
resource_providers_to_register_input: typing.List[str]
  • Type: typing.List[str]
skip_provider_registration_inputOptional 
skip_provider_registration_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
storage_use_azuread_inputOptional 
storage_use_azuread_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
subscription_id_inputOptional 
subscription_id_input: str
  • Type: str
tenant_id_inputOptional 
tenant_id_input: str
  • Type: str
use_aks_workload_identity_inputOptional 
use_aks_workload_identity_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
use_cli_inputOptional 
use_cli_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
use_msi_inputOptional 
use_msi_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
use_oidc_inputOptional 
use_oidc_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
auxiliary_tenant_idsOptional 
auxiliary_tenant_ids: typing.List[str]
  • Type: typing.List[str]
client_certificateOptional 
client_certificate: str
  • Type: str
client_certificate_passwordOptional 
client_certificate_password: str
  • Type: str
client_certificate_pathOptional 
client_certificate_path: str
  • Type: str
client_idOptional 
client_id: str
  • Type: str
client_id_file_pathOptional 
client_id_file_path: str
  • Type: str
client_secretOptional 
client_secret: str
  • Type: str
client_secret_file_pathOptional 
client_secret_file_path: str
  • Type: str
disable_correlation_request_idOptional 
disable_correlation_request_id: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
disable_terraform_partner_idOptional 
disable_terraform_partner_id: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
environmentOptional 
environment: str
  • Type: str
featuresOptional 
features: typing.Union[IResolvable, typing.List[AzurermProviderFeatures]]
metadata_hostOptional 
metadata_host: str
  • Type: str
msi_endpointOptional 
msi_endpoint: str
  • Type: str
oidc_request_tokenOptional 
oidc_request_token: str
  • Type: str
oidc_request_urlOptional 
oidc_request_url: str
  • Type: str
oidc_tokenOptional 
oidc_token: str
  • Type: str
oidc_token_file_pathOptional 
oidc_token_file_path: str
  • Type: str
partner_idOptional 
partner_id: str
  • Type: str
resource_provider_registrationsOptional 
resource_provider_registrations: str
  • Type: str
resource_providers_to_registerOptional 
resource_providers_to_register: typing.List[str]
  • Type: typing.List[str]
skip_provider_registrationOptional 
skip_provider_registration: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
storage_use_azureadOptional 
storage_use_azuread: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
subscription_idOptional 
subscription_id: str
  • Type: str
tenant_idOptional 
tenant_id: str
  • Type: str
use_aks_workload_identityOptional 
use_aks_workload_identity: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
use_cliOptional 
use_cli: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
use_msiOptional 
use_msi: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
use_oidcOptional 
use_oidc: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

AzurermProviderConfig

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderConfig(
  alias: str = None,
  auxiliary_tenant_ids: typing.List[str] = None,
  client_certificate: str = None,
  client_certificate_password: str = None,
  client_certificate_path: str = None,
  client_id: str = None,
  client_id_file_path: str = None,
  client_secret: str = None,
  client_secret_file_path: str = None,
  disable_correlation_request_id: typing.Union[bool, IResolvable] = None,
  disable_terraform_partner_id: typing.Union[bool, IResolvable] = None,
  environment: str = None,
  features: typing.Union[IResolvable, typing.List[AzurermProviderFeatures]] = None,
  metadata_host: str = None,
  msi_endpoint: str = None,
  oidc_request_token: str = None,
  oidc_request_url: str = None,
  oidc_token: str = None,
  oidc_token_file_path: str = None,
  partner_id: str = None,
  resource_provider_registrations: str = None,
  resource_providers_to_register: typing.List[str] = None,
  skip_provider_registration: typing.Union[bool, IResolvable] = None,
  storage_use_azuread: typing.Union[bool, IResolvable] = None,
  subscription_id: str = None,
  tenant_id: str = None,
  use_aks_workload_identity: typing.Union[bool, IResolvable] = None,
  use_cli: typing.Union[bool, IResolvable] = None,
  use_msi: typing.Union[bool, IResolvable] = None,
  use_oidc: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
alias str Alias name.
auxiliary_tenant_ids typing.List[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#auxiliary_tenant_ids AzurermProvider#auxiliary_tenant_ids}.
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_id_file_path str The path to a file containing 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.
client_secret_file_path str The path to a file containing the Client Secret which should be used.
disable_correlation_request_id typing.Union[bool, cdktf.IResolvable] This will disable the x-ms-correlation-request-id header.
disable_terraform_partner_id typing.Union[bool, cdktf.IResolvable] 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.
features typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeatures]] features block.
metadata_host str The Hostname which should be used for the Azure Metadata Service.
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.
oidc_request_url str The URL for the OIDC provider from which to request an ID token.
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.
resource_provider_registrations str The set of Resource Providers which should be automatically registered for the subscription.
resource_providers_to_register typing.List[str] A list of Resource Providers to explicitly register for the subscription, in addition to those specified by the resource_provider_registrations property.
skip_provider_registration typing.Union[bool, cdktf.IResolvable] Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
storage_use_azuread typing.Union[bool, cdktf.IResolvable] Should the AzureRM Provider use Azure AD Authentication when accessing the Storage Data Plane APIs?
subscription_id str The Subscription ID which should be used.
tenant_id str The Tenant ID which should be used.
use_aks_workload_identity typing.Union[bool, cdktf.IResolvable] Allow Azure AKS Workload Identity to be used for Authentication.
use_cli typing.Union[bool, cdktf.IResolvable] Allow Azure CLI to be used for Authentication.
use_msi typing.Union[bool, cdktf.IResolvable] Allow Managed Service Identity to be used for Authentication.
use_oidc typing.Union[bool, cdktf.IResolvable] Allow OpenID Connect to be used for authentication.
aliasOptional 
alias: str
  • Type: str

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#alias AzurermProvider#alias}

auxiliary_tenant_idsOptional 
auxiliary_tenant_ids: typing.List[str]
  • Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#auxiliary_tenant_ids AzurermProvider#auxiliary_tenant_ids}.

client_certificateOptional 
client_certificate: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_certificate AzurermProvider#client_certificate}

client_certificate_passwordOptional 
client_certificate_password: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_certificate_password AzurermProvider#client_certificate_password}

client_certificate_pathOptional 
client_certificate_path: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_certificate_path AzurermProvider#client_certificate_path}

client_idOptional 
client_id: str
  • Type: str

The Client ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_id AzurermProvider#client_id}

client_id_file_pathOptional 
client_id_file_path: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_id_file_path AzurermProvider#client_id_file_path}

client_secretOptional 
client_secret: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_secret AzurermProvider#client_secret}

client_secret_file_pathOptional 
client_secret_file_path: str
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#client_secret_file_path AzurermProvider#client_secret_file_path}

disable_correlation_request_idOptional 
disable_correlation_request_id: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#disable_correlation_request_id AzurermProvider#disable_correlation_request_id}

disable_terraform_partner_idOptional 
disable_terraform_partner_id: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#disable_terraform_partner_id AzurermProvider#disable_terraform_partner_id}

environmentOptional 
environment: str
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#environment AzurermProvider#environment}

featuresOptional 
features: typing.Union[IResolvable, typing.List[AzurermProviderFeatures]]

features block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#features AzurermProvider#features}

metadata_hostOptional 
metadata_host: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#metadata_host AzurermProvider#metadata_host}

msi_endpointOptional 
msi_endpoint: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#msi_endpoint AzurermProvider#msi_endpoint}

oidc_request_tokenOptional 
oidc_request_token: str
  • Type: str

The bearer token for the request to the OIDC provider.

For use when authenticating as a Service Principal using OpenID Connect.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#oidc_request_token AzurermProvider#oidc_request_token}

oidc_request_urlOptional 
oidc_request_url: str
  • Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#oidc_request_url AzurermProvider#oidc_request_url}

oidc_tokenOptional 
oidc_token: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#oidc_token AzurermProvider#oidc_token}

oidc_token_file_pathOptional 
oidc_token_file_path: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#oidc_token_file_path AzurermProvider#oidc_token_file_path}

partner_idOptional 
partner_id: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#partner_id AzurermProvider#partner_id}

resource_provider_registrationsOptional 
resource_provider_registrations: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#resource_provider_registrations AzurermProvider#resource_provider_registrations}

resource_providers_to_registerOptional 
resource_providers_to_register: typing.List[str]
  • Type: typing.List[str]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#resource_providers_to_register AzurermProvider#resource_providers_to_register}

skip_provider_registrationOptional 
skip_provider_registration: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#skip_provider_registration AzurermProvider#skip_provider_registration}

storage_use_azureadOptional 
storage_use_azuread: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#storage_use_azuread AzurermProvider#storage_use_azuread}

subscription_idOptional 
subscription_id: str
  • Type: str

The Subscription ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#subscription_id AzurermProvider#subscription_id}

tenant_idOptional 
tenant_id: str
  • Type: str

The Tenant ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#tenant_id AzurermProvider#tenant_id}

use_aks_workload_identityOptional 
use_aks_workload_identity: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Allow Azure AKS Workload Identity to be used for Authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#use_aks_workload_identity AzurermProvider#use_aks_workload_identity}

use_cliOptional 
use_cli: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Allow Azure CLI to be used for Authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#use_cli AzurermProvider#use_cli}

use_msiOptional 
use_msi: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Allow Managed Service Identity to be used for Authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#use_msi AzurermProvider#use_msi}

use_oidcOptional 
use_oidc: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Allow OpenID Connect to be used for authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#use_oidc AzurermProvider#use_oidc}

AzurermProviderFeatures

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeatures(
  api_management: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesApiManagement]] = None,
  app_configuration: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesAppConfiguration]] = None,
  application_insights: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesApplicationInsights]] = None,
  cognitive_account: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesCognitiveAccount]] = None,
  key_vault: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesKeyVault]] = None,
  log_analytics_workspace: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesLogAnalyticsWorkspace]] = None,
  machine_learning: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesMachineLearning]] = None,
  managed_disk: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesManagedDisk]] = None,
  netapp: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesNetapp]] = None,
  postgresql_flexible_server: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesPostgresqlFlexibleServer]] = None,
  recovery_service: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesRecoveryService]] = None,
  recovery_services_vaults: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesRecoveryServicesVaults]] = None,
  resource_group: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesResourceGroup]] = None,
  storage: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesStorage]] = None,
  subscription: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesSubscription]] = None,
  template_deployment: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesTemplateDeployment]] = None,
  virtual_machine: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesVirtualMachine]] = None,
  virtual_machine_scale_set: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesVirtualMachineScaleSet]] = None
)

Properties

Name Type Description
api_management typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesApiManagement]] api_management block.
app_configuration typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesAppConfiguration]] app_configuration block.
application_insights typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesApplicationInsights]] application_insights block.
cognitive_account typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesCognitiveAccount]] cognitive_account block.
key_vault typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesKeyVault]] key_vault block.
log_analytics_workspace typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesLogAnalyticsWorkspace]] log_analytics_workspace block.
machine_learning typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesMachineLearning]] machine_learning block.
managed_disk typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesManagedDisk]] managed_disk block.
netapp typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesNetapp]] netapp block.
postgresql_flexible_server typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesPostgresqlFlexibleServer]] postgresql_flexible_server block.
recovery_service typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesRecoveryService]] recovery_service block.
recovery_services_vaults typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesRecoveryServicesVaults]] recovery_services_vaults block.
resource_group typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesResourceGroup]] resource_group block.
storage typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesStorage]] storage block.
subscription typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesSubscription]] subscription block.
template_deployment typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesTemplateDeployment]] template_deployment block.
virtual_machine typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesVirtualMachine]] virtual_machine block.
virtual_machine_scale_set typing.Union[cdktf.IResolvable, typing.List[AzurermProviderFeaturesVirtualMachineScaleSet]] virtual_machine_scale_set block.
api_managementOptional 
api_management: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesApiManagement]]

api_management block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#api_management AzurermProvider#api_management}

app_configurationOptional 
app_configuration: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesAppConfiguration]]

app_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#app_configuration AzurermProvider#app_configuration}

application_insightsOptional 
application_insights: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesApplicationInsights]]

application_insights block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#application_insights AzurermProvider#application_insights}

cognitive_accountOptional 
cognitive_account: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesCognitiveAccount]]

cognitive_account block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#cognitive_account AzurermProvider#cognitive_account}

key_vaultOptional 
key_vault: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesKeyVault]]

key_vault block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#key_vault AzurermProvider#key_vault}

log_analytics_workspaceOptional 
log_analytics_workspace: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesLogAnalyticsWorkspace]]

log_analytics_workspace block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#log_analytics_workspace AzurermProvider#log_analytics_workspace}

machine_learningOptional 
machine_learning: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesMachineLearning]]

machine_learning block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#machine_learning AzurermProvider#machine_learning}

managed_diskOptional 
managed_disk: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesManagedDisk]]

managed_disk block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#managed_disk AzurermProvider#managed_disk}

netappOptional 
netapp: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesNetapp]]

netapp block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#netapp AzurermProvider#netapp}

postgresql_flexible_serverOptional 
postgresql_flexible_server: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesPostgresqlFlexibleServer]]

postgresql_flexible_server block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#postgresql_flexible_server AzurermProvider#postgresql_flexible_server}

recovery_serviceOptional 
recovery_service: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesRecoveryService]]

recovery_service block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recovery_service AzurermProvider#recovery_service}

recovery_services_vaultsOptional 
recovery_services_vaults: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesRecoveryServicesVaults]]

recovery_services_vaults block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recovery_services_vaults AzurermProvider#recovery_services_vaults}

resource_groupOptional 
resource_group: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesResourceGroup]]

resource_group block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#resource_group AzurermProvider#resource_group}

storageOptional 
storage: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesStorage]]

storage block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#storage AzurermProvider#storage}

subscriptionOptional 
subscription: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesSubscription]]

subscription block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#subscription AzurermProvider#subscription}

template_deploymentOptional 
template_deployment: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesTemplateDeployment]]

template_deployment block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#template_deployment AzurermProvider#template_deployment}

virtual_machineOptional 
virtual_machine: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesVirtualMachine]]

virtual_machine block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#virtual_machine AzurermProvider#virtual_machine}

virtual_machine_scale_setOptional 
virtual_machine_scale_set: typing.Union[IResolvable, typing.List[AzurermProviderFeaturesVirtualMachineScaleSet]]

virtual_machine_scale_set block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#virtual_machine_scale_set AzurermProvider#virtual_machine_scale_set}

AzurermProviderFeaturesApiManagement

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesApiManagement(
  purge_soft_delete_on_destroy: typing.Union[bool, IResolvable] = None,
  recover_soft_deleted: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
purge_soft_delete_on_destroy typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_delete_on_destroy AzurermProvider#purge_soft_delete_on_destroy}.
recover_soft_deleted typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted AzurermProvider#recover_soft_deleted}.
purge_soft_delete_on_destroyOptional 
purge_soft_delete_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_delete_on_destroy AzurermProvider#purge_soft_delete_on_destroy}.

recover_soft_deletedOptional 
recover_soft_deleted: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted AzurermProvider#recover_soft_deleted}.

AzurermProviderFeaturesAppConfiguration

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesAppConfiguration(
  purge_soft_delete_on_destroy: typing.Union[bool, IResolvable] = None,
  recover_soft_deleted: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
purge_soft_delete_on_destroy typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_delete_on_destroy AzurermProvider#purge_soft_delete_on_destroy}.
recover_soft_deleted typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted AzurermProvider#recover_soft_deleted}.
purge_soft_delete_on_destroyOptional 
purge_soft_delete_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_delete_on_destroy AzurermProvider#purge_soft_delete_on_destroy}.

recover_soft_deletedOptional 
recover_soft_deleted: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted AzurermProvider#recover_soft_deleted}.

AzurermProviderFeaturesApplicationInsights

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesApplicationInsights(
  disable_generated_rule: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
disable_generated_rule typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#disable_generated_rule AzurermProvider#disable_generated_rule}.
disable_generated_ruleOptional 
disable_generated_rule: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#disable_generated_rule AzurermProvider#disable_generated_rule}.

AzurermProviderFeaturesCognitiveAccount

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesCognitiveAccount(
  purge_soft_delete_on_destroy: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
purge_soft_delete_on_destroy typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_delete_on_destroy AzurermProvider#purge_soft_delete_on_destroy}.
purge_soft_delete_on_destroyOptional 
purge_soft_delete_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_delete_on_destroy AzurermProvider#purge_soft_delete_on_destroy}.

AzurermProviderFeaturesKeyVault

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesKeyVault(
  purge_soft_deleted_certificates_on_destroy: typing.Union[bool, IResolvable] = None,
  purge_soft_deleted_hardware_security_module_keys_on_destroy: typing.Union[bool, IResolvable] = None,
  purge_soft_deleted_hardware_security_modules_on_destroy: typing.Union[bool, IResolvable] = None,
  purge_soft_deleted_keys_on_destroy: typing.Union[bool, IResolvable] = None,
  purge_soft_deleted_secrets_on_destroy: typing.Union[bool, IResolvable] = None,
  purge_soft_delete_on_destroy: typing.Union[bool, IResolvable] = None,
  recover_soft_deleted_certificates: typing.Union[bool, IResolvable] = None,
  recover_soft_deleted_hardware_security_module_keys: typing.Union[bool, IResolvable] = None,
  recover_soft_deleted_keys: typing.Union[bool, IResolvable] = None,
  recover_soft_deleted_key_vaults: typing.Union[bool, IResolvable] = None,
  recover_soft_deleted_secrets: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
purge_soft_deleted_certificates_on_destroy typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault_certificate resources will be permanently deleted (e.g purged), when destroyed.
purge_soft_deleted_hardware_security_module_keys_on_destroy typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault_managed_hardware_security_module_key resources will be permanently deleted (e.g purged), when destroyed.
purge_soft_deleted_hardware_security_modules_on_destroy typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault_managed_hardware_security_module resources will be permanently deleted (e.g purged), when destroyed.
purge_soft_deleted_keys_on_destroy typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault_key resources will be permanently deleted (e.g purged), when destroyed.
purge_soft_deleted_secrets_on_destroy typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault_secret resources will be permanently deleted (e.g purged), when destroyed.
purge_soft_delete_on_destroy typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault resources will be permanently deleted (e.g purged), when destroyed.
recover_soft_deleted_certificates typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault_certificate resources will be restored, instead of creating new ones.
recover_soft_deleted_hardware_security_module_keys typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault_managed_hardware_security_module_key resources will be restored, instead of creating new ones.
recover_soft_deleted_keys typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault_key resources will be restored, instead of creating new ones.
recover_soft_deleted_key_vaults typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault resources will be restored, instead of creating new ones.
recover_soft_deleted_secrets typing.Union[bool, cdktf.IResolvable] When enabled soft-deleted azurerm_key_vault_secret resources will be restored, instead of creating new ones.
purge_soft_deleted_certificates_on_destroyOptional 
purge_soft_deleted_certificates_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault_certificate resources will be permanently deleted (e.g purged), when destroyed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_deleted_certificates_on_destroy AzurermProvider#purge_soft_deleted_certificates_on_destroy}

purge_soft_deleted_hardware_security_module_keys_on_destroyOptional 
purge_soft_deleted_hardware_security_module_keys_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault_managed_hardware_security_module_key resources will be permanently deleted (e.g purged), when destroyed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_deleted_hardware_security_module_keys_on_destroy AzurermProvider#purge_soft_deleted_hardware_security_module_keys_on_destroy}

purge_soft_deleted_hardware_security_modules_on_destroyOptional 
purge_soft_deleted_hardware_security_modules_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault_managed_hardware_security_module resources will be permanently deleted (e.g purged), when destroyed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_deleted_hardware_security_modules_on_destroy AzurermProvider#purge_soft_deleted_hardware_security_modules_on_destroy}

purge_soft_deleted_keys_on_destroyOptional 
purge_soft_deleted_keys_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault_key resources will be permanently deleted (e.g purged), when destroyed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_deleted_keys_on_destroy AzurermProvider#purge_soft_deleted_keys_on_destroy}

purge_soft_deleted_secrets_on_destroyOptional 
purge_soft_deleted_secrets_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault_secret resources will be permanently deleted (e.g purged), when destroyed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_deleted_secrets_on_destroy AzurermProvider#purge_soft_deleted_secrets_on_destroy}

purge_soft_delete_on_destroyOptional 
purge_soft_delete_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault resources will be permanently deleted (e.g purged), when destroyed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_delete_on_destroy AzurermProvider#purge_soft_delete_on_destroy}

recover_soft_deleted_certificatesOptional 
recover_soft_deleted_certificates: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault_certificate resources will be restored, instead of creating new ones.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted_certificates AzurermProvider#recover_soft_deleted_certificates}

recover_soft_deleted_hardware_security_module_keysOptional 
recover_soft_deleted_hardware_security_module_keys: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault_managed_hardware_security_module_key resources will be restored, instead of creating new ones.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted_hardware_security_module_keys AzurermProvider#recover_soft_deleted_hardware_security_module_keys}

recover_soft_deleted_keysOptional 
recover_soft_deleted_keys: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault_key resources will be restored, instead of creating new ones.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted_keys AzurermProvider#recover_soft_deleted_keys}

recover_soft_deleted_key_vaultsOptional 
recover_soft_deleted_key_vaults: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault resources will be restored, instead of creating new ones.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted_key_vaults AzurermProvider#recover_soft_deleted_key_vaults}

recover_soft_deleted_secretsOptional 
recover_soft_deleted_secrets: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled soft-deleted azurerm_key_vault_secret resources will be restored, instead of creating new ones.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted_secrets AzurermProvider#recover_soft_deleted_secrets}

AzurermProviderFeaturesLogAnalyticsWorkspace

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesLogAnalyticsWorkspace(
  permanently_delete_on_destroy: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
permanently_delete_on_destroy typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#permanently_delete_on_destroy AzurermProvider#permanently_delete_on_destroy}.
permanently_delete_on_destroyOptional 
permanently_delete_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#permanently_delete_on_destroy AzurermProvider#permanently_delete_on_destroy}.

AzurermProviderFeaturesMachineLearning

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesMachineLearning(
  purge_soft_deleted_workspace_on_destroy: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
purge_soft_deleted_workspace_on_destroy typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_deleted_workspace_on_destroy AzurermProvider#purge_soft_deleted_workspace_on_destroy}.
purge_soft_deleted_workspace_on_destroyOptional 
purge_soft_deleted_workspace_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_soft_deleted_workspace_on_destroy AzurermProvider#purge_soft_deleted_workspace_on_destroy}.

AzurermProviderFeaturesManagedDisk

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesManagedDisk(
  expand_without_downtime: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
expand_without_downtime typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#expand_without_downtime AzurermProvider#expand_without_downtime}.
expand_without_downtimeOptional 
expand_without_downtime: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#expand_without_downtime AzurermProvider#expand_without_downtime}.

AzurermProviderFeaturesNetapp

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesNetapp(
  delete_backups_on_backup_vault_destroy: typing.Union[bool, IResolvable] = None,
  prevent_volume_destruction: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
delete_backups_on_backup_vault_destroy typing.Union[bool, cdktf.IResolvable] When enabled, backups will be deleted when the azurerm_netapp_backup_vault resource is destroyed.
prevent_volume_destruction typing.Union[bool, cdktf.IResolvable] When enabled, the volume will not be destroyed, safeguarding from severe data loss.
delete_backups_on_backup_vault_destroyOptional 
delete_backups_on_backup_vault_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled, backups will be deleted when the azurerm_netapp_backup_vault resource is destroyed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#delete_backups_on_backup_vault_destroy AzurermProvider#delete_backups_on_backup_vault_destroy}

prevent_volume_destructionOptional 
prevent_volume_destruction: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When enabled, the volume will not be destroyed, safeguarding from severe data loss.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#prevent_volume_destruction AzurermProvider#prevent_volume_destruction}

AzurermProviderFeaturesPostgresqlFlexibleServer

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesPostgresqlFlexibleServer(
  restart_server_on_configuration_value_change: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
restart_server_on_configuration_value_change typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#restart_server_on_configuration_value_change AzurermProvider#restart_server_on_configuration_value_change}.
restart_server_on_configuration_value_changeOptional 
restart_server_on_configuration_value_change: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#restart_server_on_configuration_value_change AzurermProvider#restart_server_on_configuration_value_change}.

AzurermProviderFeaturesRecoveryService

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesRecoveryService(
  purge_protected_items_from_vault_on_destroy: typing.Union[bool, IResolvable] = None,
  vm_backup_stop_protection_and_retain_data_on_destroy: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
purge_protected_items_from_vault_on_destroy typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_protected_items_from_vault_on_destroy AzurermProvider#purge_protected_items_from_vault_on_destroy}.
vm_backup_stop_protection_and_retain_data_on_destroy typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#vm_backup_stop_protection_and_retain_data_on_destroy AzurermProvider#vm_backup_stop_protection_and_retain_data_on_destroy}.
purge_protected_items_from_vault_on_destroyOptional 
purge_protected_items_from_vault_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#purge_protected_items_from_vault_on_destroy AzurermProvider#purge_protected_items_from_vault_on_destroy}.

vm_backup_stop_protection_and_retain_data_on_destroyOptional 
vm_backup_stop_protection_and_retain_data_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#vm_backup_stop_protection_and_retain_data_on_destroy AzurermProvider#vm_backup_stop_protection_and_retain_data_on_destroy}.

AzurermProviderFeaturesRecoveryServicesVaults

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesRecoveryServicesVaults(
  recover_soft_deleted_backup_protected_vm: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
recover_soft_deleted_backup_protected_vm typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted_backup_protected_vm AzurermProvider#recover_soft_deleted_backup_protected_vm}.
recover_soft_deleted_backup_protected_vmOptional 
recover_soft_deleted_backup_protected_vm: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#recover_soft_deleted_backup_protected_vm AzurermProvider#recover_soft_deleted_backup_protected_vm}.

AzurermProviderFeaturesResourceGroup

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesResourceGroup(
  prevent_deletion_if_contains_resources: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
prevent_deletion_if_contains_resources typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#prevent_deletion_if_contains_resources AzurermProvider#prevent_deletion_if_contains_resources}.
prevent_deletion_if_contains_resourcesOptional 
prevent_deletion_if_contains_resources: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#prevent_deletion_if_contains_resources AzurermProvider#prevent_deletion_if_contains_resources}.

AzurermProviderFeaturesStorage

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesStorage(
  data_plane_available: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
data_plane_available typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#data_plane_available AzurermProvider#data_plane_available}.
data_plane_availableOptional 
data_plane_available: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#data_plane_available AzurermProvider#data_plane_available}.

AzurermProviderFeaturesSubscription

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesSubscription(
  prevent_cancellation_on_destroy: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
prevent_cancellation_on_destroy typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#prevent_cancellation_on_destroy AzurermProvider#prevent_cancellation_on_destroy}.
prevent_cancellation_on_destroyOptional 
prevent_cancellation_on_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#prevent_cancellation_on_destroy AzurermProvider#prevent_cancellation_on_destroy}.

AzurermProviderFeaturesTemplateDeployment

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesTemplateDeployment(
  delete_nested_items_during_deletion: typing.Union[bool, IResolvable]
)

Properties

Name Type Description
delete_nested_items_during_deletion typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#delete_nested_items_during_deletion AzurermProvider#delete_nested_items_during_deletion}.
delete_nested_items_during_deletionRequired 
delete_nested_items_during_deletion: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#delete_nested_items_during_deletion AzurermProvider#delete_nested_items_during_deletion}.

AzurermProviderFeaturesVirtualMachine

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesVirtualMachine(
  delete_os_disk_on_deletion: typing.Union[bool, IResolvable] = None,
  detach_implicit_data_disk_on_deletion: typing.Union[bool, IResolvable] = None,
  graceful_shutdown: typing.Union[bool, IResolvable] = None,
  skip_shutdown_and_force_delete: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
delete_os_disk_on_deletion typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#delete_os_disk_on_deletion AzurermProvider#delete_os_disk_on_deletion}.
detach_implicit_data_disk_on_deletion typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#detach_implicit_data_disk_on_deletion AzurermProvider#detach_implicit_data_disk_on_deletion}.
graceful_shutdown typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#graceful_shutdown AzurermProvider#graceful_shutdown}.
skip_shutdown_and_force_delete typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#skip_shutdown_and_force_delete AzurermProvider#skip_shutdown_and_force_delete}.
delete_os_disk_on_deletionOptional 
delete_os_disk_on_deletion: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#delete_os_disk_on_deletion AzurermProvider#delete_os_disk_on_deletion}.

detach_implicit_data_disk_on_deletionOptional 
detach_implicit_data_disk_on_deletion: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#detach_implicit_data_disk_on_deletion AzurermProvider#detach_implicit_data_disk_on_deletion}.

graceful_shutdownOptional 
graceful_shutdown: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#graceful_shutdown AzurermProvider#graceful_shutdown}.

skip_shutdown_and_force_deleteOptional 
skip_shutdown_and_force_delete: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#skip_shutdown_and_force_delete AzurermProvider#skip_shutdown_and_force_delete}.

AzurermProviderFeaturesVirtualMachineScaleSet

Initializer 

from cdktf_cdktf_provider_azurerm import provider

provider.AzurermProviderFeaturesVirtualMachineScaleSet(
  force_delete: typing.Union[bool, IResolvable] = None,
  reimage_on_manual_upgrade: typing.Union[bool, IResolvable] = None,
  roll_instances_when_required: typing.Union[bool, IResolvable] = None,
  scale_to_zero_before_deletion: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
force_delete typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#force_delete AzurermProvider#force_delete}.
reimage_on_manual_upgrade typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#reimage_on_manual_upgrade AzurermProvider#reimage_on_manual_upgrade}.
roll_instances_when_required typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#roll_instances_when_required AzurermProvider#roll_instances_when_required}.
scale_to_zero_before_deletion typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#scale_to_zero_before_deletion AzurermProvider#scale_to_zero_before_deletion}.
force_deleteOptional 
force_delete: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#force_delete AzurermProvider#force_delete}.

reimage_on_manual_upgradeOptional 
reimage_on_manual_upgrade: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#reimage_on_manual_upgrade AzurermProvider#reimage_on_manual_upgrade}.

roll_instances_when_requiredOptional 
roll_instances_when_required: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#roll_instances_when_required AzurermProvider#roll_instances_when_required}.

scale_to_zero_before_deletionOptional 
scale_to_zero_before_deletion: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.14.0/docs#scale_to_zero_before_deletion AzurermProvider#scale_to_zero_before_deletion}.