Go: AzurermBackendConfig

CDKTN Core API Reference for AzurermBackendConfig in Go.

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 "github.com/open-constructs/cdk-terrain-go/cdktn"

&cdktn.AzurermBackendConfig {
	ContainerName: *string,
	Key: *string,
	StorageAccountName: *string,
	AccessKey: *string,
	ClientCertificatePassword: *string,
	ClientCertificatePath: *string,
	ClientId: *string,
	ClientSecret: *string,
	Endpoint: *string,
	Environment: *string,
	MetadataHost: *string,
	MsiEndpoint: *string,
	OidcRequestToken: *string,
	OidcRequestUrl: *string,
	OidcToken: *string,
	OidcTokenFilePath: *string,
	ResourceGroupName: *string,
	SasToken: *string,
	Snapshot: *bool,
	SubscriptionId: *string,
	TenantId: *string,
	UseAzureadAuth: *bool,
	UseMicrosoftGraph: *bool,
	UseMsi: *bool,
	UseOidc: *bool,
}

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	*bool	(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	*bool	(Optional) Should AzureAD Authentication be used to access the Blob Storage Account.
UseMicrosoftGraph	*bool	(Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph?
UseMsi	*bool	(Optional) Should Managed Service Identity authentication be used?
UseOidc	*bool	(Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable.

---

ContainerName^Required

ContainerName *string

• Type: *string

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

---

Key^Required

Key *string

• Type: *string

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

---

StorageAccountName^Required

StorageAccountName *string

• Type: *string

(Required) The Name of the Storage Account.

---

AccessKey^Optional

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

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

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

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

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

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

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

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

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

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

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

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

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

ResourceGroupName *string

• Type: *string

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

---

SasToken^Optional

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

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.

---

SubscriptionId^Optional

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

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

UseAzureadAuth *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.

---

UseMicrosoftGraph^Optional

UseMicrosoftGraph *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.

---

UseMsi^Optional

UseMsi *bool

• Type: *bool

(Optional) Should Managed Service Identity authentication be used?

This can also be sourced from the ARM_USE_MSI environment variable.

---

UseOidc^Optional

UseOidc *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).

---