Typescript: 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 { AzurermBackendConfig } from 'cdktn'

const azurermBackendConfig: AzurermBackendConfig = { ... }

Properties

Name	Type	Description
`containerName`	`string`	(Required) The Name of the Storage Container within the Storage Account.
`key`	`string`	(Required) The name of the Blob used to retrieve/store Terraform’s State file inside the Storage Container.
`storageAccountName`	`string`	(Required) The Name of the Storage Account.
`accessKey`	`string`	access_key - (Optional) The Access Key used to access the Blob Storage Account.
`clientCertificatePassword`	`string`	(Optional) The password associated with the Client Certificate specified in client_certificate_path.
`clientCertificatePath`	`string`	(Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal.
`clientId`	`string`	(Optional) The Client ID of the Service Principal.
`clientSecret`	`string`	(Optional) The Client Secret of the Service Principal.
`endpoint`	`string`	(Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable.
`environment`	`string`	(Optional) The Azure Environment which should be used.
`metadataHost`	`string`	(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.).
`msiEndpoint`	`string`	(Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.
`oidcRequestToken`	`string`	(Optional) The bearer token for the request to the OIDC provider.
`oidcRequestUrl`	`string`	(Optional) The URL for the OIDC provider from which to request an ID token.
`oidcToken`	`string`	(Optional) The ID token when authenticating using OpenID Connect (OIDC).
`oidcTokenFilePath`	`string`	(Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC).
`resourceGroupName`	`string`	(Required) The Name of the Resource Group in which the Storage Account exists.
`sasToken`	`string`	(Optional) The SAS Token used to access the Blob Storage Account.
`snapshot`	`boolean`	(Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use?
`subscriptionId`	`string`	(Optional) The Subscription ID in which the Storage Account exists.
`tenantId`	`string`	(Optional) The Tenant ID in which the Subscription exists.
`useAzureadAuth`	`boolean`	(Optional) Should AzureAD Authentication be used to access the Blob Storage Account.
`useMicrosoftGraph`	`boolean`	(Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph?
`useMsi`	`boolean`	(Optional) Should Managed Service Identity authentication be used?
`useOidc`	`boolean`	(Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable.

`containerName`^Required

public readonly containerName: string;

Type: string

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

`key`^Required

public readonly key: string;

Type: string

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

`storageAccountName`^Required

public readonly storageAccountName: string;

Type: string

(Required) The Name of the Storage Account.

`accessKey`^Optional

public readonly accessKey: string;

Type: string

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.

`clientCertificatePassword`^Optional

public readonly clientCertificatePassword: string;

Type: string

(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.

`clientCertificatePath`^Optional

public readonly clientCertificatePath: string;

Type: string

(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.

`clientId`^Optional

public readonly clientId: string;

Type: string

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

`clientSecret`^Optional

public readonly clientSecret: string;

Type: string

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

`endpoint`^Optional

public readonly endpoint: string;

Type: string

(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

public readonly environment: string;

Type: string

(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.

`metadataHost`^Optional

public readonly metadataHost: string;

Type: string

(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.).

`msiEndpoint`^Optional

public readonly msiEndpoint: string;

Type: string

(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.

`oidcRequestToken`^Optional

public readonly oidcRequestToken: string;

Type: string

(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.

`oidcRequestUrl`^Optional

public readonly oidcRequestUrl: string;

Type: string

(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.

`oidcToken`^Optional

public readonly oidcToken: string;

Type: string

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

`oidcTokenFilePath`^Optional

public readonly oidcTokenFilePath: string;

Type: string

(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.

`resourceGroupName`^Optional

public readonly resourceGroupName: string;

Type: string

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

`sasToken`^Optional

public readonly sasToken: string;

Type: string

(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

public readonly snapshot: boolean;

Type: boolean

(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.

`subscriptionId`^Optional

public readonly subscriptionId: string;

Type: string

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

`tenantId`^Optional

public readonly tenantId: string;

Type: string

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

`useAzureadAuth`^Optional

public readonly useAzureadAuth: boolean;

Type: boolean

(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.

`useMicrosoftGraph`^Optional

public readonly useMicrosoftGraph: boolean;

Type: boolean

(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.

`useMsi`^Optional

public readonly useMsi: boolean;

Type: boolean

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

`useOidc`^Optional

public readonly useOidc: boolean;

Type: boolean

(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

​containerNameRequired

​keyRequired

​storageAccountNameRequired

​accessKeyOptional

​clientCertificatePasswordOptional

​clientCertificatePathOptional

​clientIdOptional

​clientSecretOptional

​endpointOptional

​environmentOptional

​metadataHostOptional

​msiEndpointOptional

​oidcRequestTokenOptional

​oidcRequestUrlOptional

​oidcTokenOptional

​oidcTokenFilePathOptional

​resourceGroupNameOptional

​sasTokenOptional

​snapshotOptional

​subscriptionIdOptional

​tenantIdOptional

​useAzureadAuthOptional

​useMicrosoftGraphOptional

​useMsiOptional

​useOidcOptional