> ## Documentation Index > Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Python: AzurermBackend > CDKTN Core API Reference for AzurermBackend in Python. ## Initializers ```python theme={null} import cdktn cdktn.AzurermBackend( scope: Construct, 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 ) ``` | **Name** | **Type** | **Description** | | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | scope | constructs.Construct | *No 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. | *** ### `scope`^Required * *Type:* constructs.Construct *** ### `container_name`^Required * *Type:* str (Required) The Name of the Storage Container within the Storage Account. *** ### `key`^Required * *Type:* str (Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container. *** ### `storage_account_name`^Required * *Type:* str (Required) The Name of the Storage Account. *** ### `access_key`^Optional * *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 * *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 * *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 * *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 * *Type:* str (Optional) The Client Secret of the Service Principal. This can also be sourced from the ARM\_CLIENT\_SECRET environment variable. *** ### `endpoint`^Optional * *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 * *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 * *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 * *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 * *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 * *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 * *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 * *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 * *Type:* str (Required) The Name of the Resource Group in which the Storage Account exists. *** ### `sas_token`^Optional * *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 * *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 * *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 * *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 * *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 * *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 * *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 * *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). *** ## Methods | **Name** | **Description** | | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | to\_string | Returns a string representation of this construct. | | with | Applies one or more mixins to 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. | | get\_remote\_state\_data\_source | Creates a TerraformRemoteState resource that accesses this backend. | *** ### `to_string` ```python theme={null} def to_string() -> str ``` Returns a string representation of this construct. ### `with` ```python theme={null} def with( mixins: *IMixin ) -> IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. #### `mixins`^Required * *Type:* \*constructs.IMixin The mixins to apply. *** ### `add_override` ```python theme={null} def add_override( path: str, value: typing.Any ) -> None ``` #### `path`^Required * *Type:* str *** #### `value`^Required * *Type:* typing.Any *** ### `override_logical_id` ```python theme={null} def override_logical_id( new_logical_id: str ) -> None ``` Overrides the auto-generated logical ID with a specific ID. #### `new_logical_id`^Required * *Type:* str The new logical ID to use for this stack element. *** ### `reset_override_logical_id` ```python theme={null} def reset_override_logical_id() -> None ``` Resets a previously passed logical Id to use the auto-generated logical id again. ### `to_hcl_terraform` ```python theme={null} def to_hcl_terraform() -> typing.Any ``` ### `to_metadata` ```python theme={null} def to_metadata() -> typing.Any ``` ### `to_terraform` ```python theme={null} def to_terraform() -> typing.Any ``` Adds this resource to the terraform JSON output. ### `get_remote_state_data_source` ```python theme={null} def get_remote_state_data_source( scope: Construct, name: str, _fromstack: str ) -> TerraformRemoteState ``` Creates a TerraformRemoteState resource that accesses this backend. #### `scope`^Required * *Type:* constructs.Construct *** #### `name`^Required * *Type:* str *** #### `_fromstack`^Required * *Type:* str *** ## Static Functions | **Name** | **Description** | | ------------------------------------------------------------------------------------------ | ----------------------------- | | is\_construct | Checks if `x` is a construct. | | is\_terraform\_element | *No description.* | | is\_backend | *No description.* | *** ### `is_construct` ```python theme={null} import cdktn cdktn.AzurermBackend.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. #### `x`^Required * *Type:* typing.Any Any object. *** ### `is_terraform_element` ```python theme={null} import cdktn cdktn.AzurermBackend.is_terraform_element( x: typing.Any ) ``` #### `x`^Required * *Type:* typing.Any *** ### `is_backend` ```python theme={null} import cdktn cdktn.AzurermBackend.is_backend( x: typing.Any ) ``` #### `x`^Required * *Type:* typing.Any *** ## Properties | **Name** | **Type** | **Description** | | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------------- | | node | constructs.Node | The tree node. | | cdktf\_stack | TerraformStack | *No description.* | | fqn | str | *No description.* | | friendly\_unique\_id | str | *No description.* | *** ### `node`^Required ```python theme={null} node: Node ``` * *Type:* constructs.Node The tree node. *** ### `cdktf_stack`^Required ```python theme={null} cdktf_stack: TerraformStack ``` * *Type:* TerraformStack *** ### `fqn`^Required ```python theme={null} fqn: str ``` * *Type:* str *** ### `friendly_unique_id`^Required ```python theme={null} friendly_unique_id: str ``` * *Type:* str ***