Python: AzurermBackendConfig - CDK Terrain (CDKTN)

Stores the state as a Blob with the given Key within the Blob Container within the Blob Storage Account. This backend supports state locking and consistency checking with Azure Blob Storage native capabilities. Note: By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting use_microsoft_graph to true. The default for this will change in Terraform 1.2, so that MSAL authentication is used by default. Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/azurerm

Initializer

import cdktn

cdktn.AzurermBackendConfig(
  container_name: str,
  key: str,
  storage_account_name: str,
  access_key: str = None,
  client_certificate_password: str = None,
  client_certificate_path: str = None,
  client_id: str = None,
  client_secret: str = None,
  endpoint: str = None,
  environment: str = 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,
  resource_group_name: str = None,
  sas_token: str = None,
  snapshot: bool = None,
  subscription_id: str = None,
  tenant_id: str = None,
  use_azuread_auth: bool = None,
  use_microsoft_graph: bool = None,
  use_msi: bool = None,
  use_oidc: bool = None
)

Properties

Name	Type	Description
`container_name`	`str`	(Required) The Name of the Storage Container within the Storage Account.
`key`	`str`	(Required) The name of the Blob used to retrieve/store Terraform’s State file inside the Storage Container.
`storage_account_name`	`str`	(Required) The Name of the Storage Account.
`access_key`	`str`	access_key - (Optional) The Access Key used to access the Blob Storage Account.
`client_certificate_password`	`str`	(Optional) The password associated with the Client Certificate specified in client_certificate_path.
`client_certificate_path`	`str`	(Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal.
`client_id`	`str`	(Optional) The Client ID of the Service Principal.
`client_secret`	`str`	(Optional) The Client Secret of the Service Principal.
`endpoint`	`str`	(Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable.
`environment`	`str`	(Optional) The Azure Environment which should be used.
`metadata_host`	`str`	(Optional) The Hostname of the Azure Metadata Service (for example management.azure.com), used to obtain the Cloud Environment when using a Custom Azure Environment. This can also be sourced from the ARM_METADATA_HOSTNAME Environment Variable.).
`msi_endpoint`	`str`	(Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.
`oidc_request_token`	`str`	(Optional) The bearer token for the request to the OIDC provider.
`oidc_request_url`	`str`	(Optional) The URL for the OIDC provider from which to request an ID token.
`oidc_token`	`str`	(Optional) The ID token when authenticating using OpenID Connect (OIDC).
`oidc_token_file_path`	`str`	(Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC).
`resource_group_name`	`str`	(Required) The Name of the Resource Group in which the Storage Account exists.
`sas_token`	`str`	(Optional) The SAS Token used to access the Blob Storage Account.
`snapshot`	`bool`	(Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use?
`subscription_id`	`str`	(Optional) The Subscription ID in which the Storage Account exists.
`tenant_id`	`str`	(Optional) The Tenant ID in which the Subscription exists.
`use_azuread_auth`	`bool`	(Optional) Should AzureAD Authentication be used to access the Blob Storage Account.
`use_microsoft_graph`	`bool`	(Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph?
`use_msi`	`bool`	(Optional) Should Managed Service Identity authentication be used?
`use_oidc`	`bool`	(Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable.

`container_name`^Required

container_name: str

Type: str

(Required) The Name of the Storage Container within the Storage Account.

`key`^Required

key: str

Type: str

(Required) The name of the Blob used to retrieve/store Terraform’s State file inside the Storage Container.

`storage_account_name`^Required

storage_account_name: str

Type: str

(Required) The Name of the Storage Account.

`access_key`^Optional

access_key: str

Type: str

access_key - (Optional) The Access Key used to access the Blob Storage Account. This can also be sourced from the ARM_ACCESS_KEY environment variable.

`client_certificate_password`^Optional

client_certificate_password: str

Type: str

(Optional) The password associated with the Client Certificate specified in client_certificate_path. This can also be sourced from the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable.

`client_certificate_path`^Optional

client_certificate_path: str

Type: str

(Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal. This can also be sourced from the ARM_CLIENT_CERTIFICATE_PATH environment variable.

`client_id`^Optional

client_id: str

Type: str

(Optional) The Client ID of the Service Principal. This can also be sourced from the ARM_CLIENT_ID environment variable.

`client_secret`^Optional

client_secret: str

Type: str

(Optional) The Client Secret of the Service Principal. This can also be sourced from the ARM_CLIENT_SECRET environment variable.

`endpoint`^Optional

endpoint: str

Type: str

(Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable. NOTE: An endpoint should only be configured when using Azure Stack.

`environment`^Optional

environment: str

Type: str

(Optional) The Azure Environment which should be used. This can also be sourced from the ARM_ENVIRONMENT environment variable. Possible values are public, china, german, stack and usgovernment. Defaults to public.

`metadata_host`^Optional

metadata_host: str

Type: str

(Optional) The Hostname of the Azure Metadata Service (for example management.azure.com), used to obtain the Cloud Environment when using a Custom Azure Environment. This can also be sourced from the ARM_METADATA_HOSTNAME Environment Variable.).

`msi_endpoint`^Optional

msi_endpoint: str

Type: str

(Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified. This can also be sourced from the ARM_MSI_ENDPOINT environment variable.

`oidc_request_token`^Optional

oidc_request_token: str

Type: str

(Optional) The bearer token for the request to the OIDC provider. This can also be sourced from the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables.

`oidc_request_url`^Optional

oidc_request_url: str

Type: str

(Optional) The URL for the OIDC provider from which to request an ID token. This can also be sourced from the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables.

`oidc_token`^Optional

oidc_token: str

Type: str

(Optional) The ID token when authenticating using OpenID Connect (OIDC). This can also be sourced from the ARM_OIDC_TOKEN environment variable.

`oidc_token_file_path`^Optional

oidc_token_file_path: str

Type: str

(Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC). This can also be sourced from the ARM_OIDC_TOKEN_FILE_PATH environment variable.

`resource_group_name`^Optional

resource_group_name: str

Type: str

(Required) The Name of the Resource Group in which the Storage Account exists.

`sas_token`^Optional

sas_token: str

Type: str

(Optional) The SAS Token used to access the Blob Storage Account. This can also be sourced from the ARM_SAS_TOKEN environment variable.

`snapshot`^Optional

snapshot: bool

Type: bool

(Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use? Defaults to false. This value can also be sourced from the ARM_SNAPSHOT environment variable.

`subscription_id`^Optional

subscription_id: str

Type: str

(Optional) The Subscription ID in which the Storage Account exists. This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.

`tenant_id`^Optional

tenant_id: str

Type: str

(Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the ARM_TENANT_ID environment variable.

`use_azuread_auth`^Optional

use_azuread_auth: bool

Type: bool

(Optional) Should AzureAD Authentication be used to access the Blob Storage Account. This can also be sourced from the ARM_USE_AZUREAD environment variable. Note: When using AzureAD for Authentication to Storage you also need to ensure the Storage Blob Data Owner role is assigned.

`use_microsoft_graph`^Optional

use_microsoft_graph: bool

Type: bool

(Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph? Defaults to true. Note: In Terraform 1.2 the Azure Backend uses MSAL (and Microsoft Graph) rather than ADAL (and Azure Active Directory Graph) for authentication by default - you can disable this by setting use_microsoft_graph to false. This setting will be removed in Terraform 1.3, due to Microsoft’s deprecation of ADAL.

`use_msi`^Optional

use_msi: bool

Type: bool

(Optional) Should Managed Service Identity authentication be used? This can also be sourced from the ARM_USE_MSI environment variable.

`use_oidc`^Optional

use_oidc: bool

Type: bool

(Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable. Note: When using OIDC for authentication, use_microsoft_graph must be set to true (which is the default).

​Initializer

​Properties

​container_nameRequired

​keyRequired

​storage_account_nameRequired

​access_keyOptional

​client_certificate_passwordOptional

​client_certificate_pathOptional

​client_idOptional

​client_secretOptional

​endpointOptional

​environmentOptional

​metadata_hostOptional

​msi_endpointOptional

​oidc_request_tokenOptional

​oidc_request_urlOptional

​oidc_tokenOptional

​oidc_token_file_pathOptional

​resource_group_nameOptional

​sas_tokenOptional

​snapshotOptional

​subscription_idOptional

​tenant_idOptional

​use_azuread_authOptional

​use_microsoft_graphOptional

​use_msiOptional

​use_oidcOptional