CSharp: 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

using Io.Cdktn;

new AzurermBackendConfig {
    string ContainerName,
    string Key,
    string StorageAccountName,
    string AccessKey = null,
    string ClientCertificatePassword = null,
    string ClientCertificatePath = null,
    string ClientId = null,
    string ClientSecret = null,
    string Endpoint = null,
    string Environment = null,
    string MetadataHost = null,
    string MsiEndpoint = null,
    string OidcRequestToken = null,
    string OidcRequestUrl = null,
    string OidcToken = null,
    string OidcTokenFilePath = null,
    string ResourceGroupName = null,
    string SasToken = null,
    bool Snapshot = null,
    string SubscriptionId = null,
    string TenantId = null,
    bool UseAzureadAuth = null,
    bool UseMicrosoftGraph = null,
    bool UseMsi = null,
    bool UseOidc = null
};

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

public string ContainerName { get; set; }

Type: string

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

`Key`^Required

public string Key { get; set; }

Type: string

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

`StorageAccountName`^Required

public string StorageAccountName { get; set; }

Type: string

(Required) The Name of the Storage Account.

`AccessKey`^Optional

public string AccessKey { get; set; }

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 string ClientCertificatePassword { get; set; }

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 string ClientCertificatePath { get; set; }

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 string ClientId { get; set; }

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 string ClientSecret { get; set; }

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 string Endpoint { get; set; }

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 string Environment { get; set; }

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 string MetadataHost { get; set; }

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 string MsiEndpoint { get; set; }

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 string OidcRequestToken { get; set; }

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 string OidcRequestUrl { get; set; }

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 string OidcToken { get; set; }

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 string OidcTokenFilePath { get; set; }

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 string ResourceGroupName { get; set; }

Type: string

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

`SasToken`^Optional

public string SasToken { get; set; }

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 bool Snapshot { get; set; }

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

public string SubscriptionId { get; set; }

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 string TenantId { get; set; }

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 bool UseAzureadAuth { get; set; }

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

public bool UseMicrosoftGraph { get; set; }

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

public bool UseMsi { get; set; }

Type: bool

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

`UseOidc`^Optional

public bool UseOidc { get; set; }

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

​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