Skip to main content

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.

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 io.cdktn.cdktn.AzurermBackendConfig;

AzurermBackendConfig.builder()
    .containerName(java.lang.String)
    .key(java.lang.String)
    .storageAccountName(java.lang.String)
//  .accessKey(java.lang.String)
//  .clientCertificatePassword(java.lang.String)
//  .clientCertificatePath(java.lang.String)
//  .clientId(java.lang.String)
//  .clientSecret(java.lang.String)
//  .endpoint(java.lang.String)
//  .environment(java.lang.String)
//  .metadataHost(java.lang.String)
//  .msiEndpoint(java.lang.String)
//  .oidcRequestToken(java.lang.String)
//  .oidcRequestUrl(java.lang.String)
//  .oidcToken(java.lang.String)
//  .oidcTokenFilePath(java.lang.String)
//  .resourceGroupName(java.lang.String)
//  .sasToken(java.lang.String)
//  .snapshot(java.lang.Boolean)
//  .subscriptionId(java.lang.String)
//  .tenantId(java.lang.String)
//  .useAzureadAuth(java.lang.Boolean)
//  .useMicrosoftGraph(java.lang.Boolean)
//  .useMsi(java.lang.Boolean)
//  .useOidc(java.lang.Boolean)
    .build();

​
Properties

NameTypeDescription
containerNamejava.lang.String(Required) The Name of the Storage Container within the Storage Account.
keyjava.lang.String(Required) The name of the Blob used to retrieve/store Terraform’s State file inside the Storage Container.
storageAccountNamejava.lang.String(Required) The Name of the Storage Account.
accessKeyjava.lang.Stringaccess_key - (Optional) The Access Key used to access the Blob Storage Account.
clientCertificatePasswordjava.lang.String(Optional) The password associated with the Client Certificate specified in client_certificate_path.
clientCertificatePathjava.lang.String(Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal.
clientIdjava.lang.String(Optional) The Client ID of the Service Principal.
clientSecretjava.lang.String(Optional) The Client Secret of the Service Principal.
endpointjava.lang.String(Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable.
environmentjava.lang.String(Optional) The Azure Environment which should be used.
metadataHostjava.lang.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.).
msiEndpointjava.lang.String(Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.
oidcRequestTokenjava.lang.String(Optional) The bearer token for the request to the OIDC provider.
oidcRequestUrljava.lang.String(Optional) The URL for the OIDC provider from which to request an ID token.
oidcTokenjava.lang.String(Optional) The ID token when authenticating using OpenID Connect (OIDC).
oidcTokenFilePathjava.lang.String(Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC).
resourceGroupNamejava.lang.String(Required) The Name of the Resource Group in which the Storage Account exists.
sasTokenjava.lang.String(Optional) The SAS Token used to access the Blob Storage Account.
snapshotjava.lang.Boolean(Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use?
subscriptionIdjava.lang.String(Optional) The Subscription ID in which the Storage Account exists.
tenantIdjava.lang.String(Optional) The Tenant ID in which the Subscription exists.
useAzureadAuthjava.lang.Boolean(Optional) Should AzureAD Authentication be used to access the Blob Storage Account.
useMicrosoftGraphjava.lang.Boolean(Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph?
useMsijava.lang.Boolean(Optional) Should Managed Service Identity authentication be used?
useOidcjava.lang.Boolean(Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable.

​
containerNameRequired 

public java.lang.String getContainerName();
  • Type: java.lang.String
(Required) The Name of the Storage Container within the Storage Account.

​
keyRequired 

public java.lang.String getKey();
  • Type: java.lang.String
(Required) The name of the Blob used to retrieve/store Terraform’s State file inside the Storage Container.

​
storageAccountNameRequired 

public java.lang.String getStorageAccountName();
  • Type: java.lang.String
(Required) The Name of the Storage Account.

​
accessKeyOptional 

public java.lang.String getAccessKey();
  • Type: java.lang.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.

​
clientCertificatePasswordOptional 

public java.lang.String getClientCertificatePassword();
  • Type: java.lang.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.

​
clientCertificatePathOptional 

public java.lang.String getClientCertificatePath();
  • Type: java.lang.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.

​
clientIdOptional 

public java.lang.String getClientId();
  • Type: java.lang.String
(Optional) The Client ID of the Service Principal. This can also be sourced from the ARM_CLIENT_ID environment variable.

​
clientSecretOptional 

public java.lang.String getClientSecret();
  • Type: java.lang.String
(Optional) The Client Secret of the Service Principal. This can also be sourced from the ARM_CLIENT_SECRET environment variable.

​
endpointOptional 

public java.lang.String getEndpoint();
  • Type: java.lang.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.

​
environmentOptional 

public java.lang.String getEnvironment();
  • Type: java.lang.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.

​
metadataHostOptional 

public java.lang.String getMetadataHost();
  • Type: java.lang.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.).

​
msiEndpointOptional 

public java.lang.String getMsiEndpoint();
  • Type: java.lang.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.

​
oidcRequestTokenOptional 

public java.lang.String getOidcRequestToken();
  • Type: java.lang.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.

​
oidcRequestUrlOptional 

public java.lang.String getOidcRequestUrl();
  • Type: java.lang.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.

​
oidcTokenOptional 

public java.lang.String getOidcToken();
  • Type: java.lang.String
(Optional) The ID token when authenticating using OpenID Connect (OIDC). This can also be sourced from the ARM_OIDC_TOKEN environment variable.

​
oidcTokenFilePathOptional 

public java.lang.String getOidcTokenFilePath();
  • Type: java.lang.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.

​
resourceGroupNameOptional 

public java.lang.String getResourceGroupName();
  • Type: java.lang.String
(Required) The Name of the Resource Group in which the Storage Account exists.

​
sasTokenOptional 

public java.lang.String getSasToken();
  • Type: java.lang.String
(Optional) The SAS Token used to access the Blob Storage Account. This can also be sourced from the ARM_SAS_TOKEN environment variable.

​
snapshotOptional 

public java.lang.Boolean getSnapshot();
  • Type: java.lang.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.

​
subscriptionIdOptional 

public java.lang.String getSubscriptionId();
  • Type: java.lang.String
(Optional) The Subscription ID in which the Storage Account exists. This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.

​
tenantIdOptional 

public java.lang.String getTenantId();
  • Type: java.lang.String
(Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the ARM_TENANT_ID environment variable.

​
useAzureadAuthOptional 

public java.lang.Boolean getUseAzureadAuth();
  • Type: java.lang.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.

​
useMicrosoftGraphOptional 

public java.lang.Boolean getUseMicrosoftGraph();
  • Type: java.lang.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.

​
useMsiOptional 

public java.lang.Boolean getUseMsi();
  • Type: java.lang.Boolean
(Optional) Should Managed Service Identity authentication be used? This can also be sourced from the ARM_USE_MSI environment variable.

​
useOidcOptional 

public java.lang.Boolean getUseOidc();
  • Type: java.lang.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).