58 lines
2.1 KiB
Markdown
58 lines
2.1 KiB
Markdown
|
---
|
||
|
|
layout: "remotestate"
|
||
|
|
page_title: "Remote State Backend: mas"
|
||
|
|
sidebar_current: "docs-state-remote-mas"
|
||
|
|
description: |-
|
||
|
|
Terraform can store the state remotely, making it easier to version and work with in a team.
|
||
|
|
---
|
||
|
|
|
||
|
|
# mas
|
||
|
|
|
||
|
|
Stores the state as a given key in a given bucket on [Microsoft Azure Storage](https://azure.microsoft.com/en-us/documentation/articles/storage-introduction/).
|
||
|
|
|
||
|
|
-> **Note:** Passing credentials directly via config options will
|
||
|
|
make them included in cleartext inside the persisted state.
|
||
|
|
Use of environment variables or config file is recommended.
|
||
|
|
|
||
|
|
## Example Usage
|
||
|
|
|
||
|
|
```
|
||
|
|
terraform remote config \
|
||
|
|
-backend=mas \
|
||
|
|
-backend-config="storage_account_name=terraform123abc" \
|
||
|
|
-backend-config="container_name=terraform-state" \
|
||
|
|
-backend-config="key=prod.terraform.tfstate"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Example Referencing
|
||
|
|
|
||
|
|
```hcl
|
||
|
|
# setup remote state data source
|
||
|
|
data "terraform_remote_state" "foo" {
|
||
|
|
backend = "mas"
|
||
|
|
config {
|
||
|
|
storage_account_name = "terraform123abc"
|
||
|
|
container_name = "terraform-state"
|
||
|
|
key = "prod.terraform.tfstate"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Configuration variables
|
||
|
|
|
||
|
|
The following configuration options are supported:
|
||
|
|
|
||
|
|
* `storage_account_name` - (Required) The name of the storage account
|
||
|
|
* `container_name` - (Required) The name of the container to use within the storage account
|
||
|
|
* `key` - (Required) The key where to place/look for state file inside the container
|
||
|
|
* `access_key` / `ARM_ACCESS_KEY` - (Optional) Storage account access key
|
||
|
|
* `resource_group_name` - (Optional) The name of the resource group for the storage account. This is required when using the ARM credentials described below.
|
||
|
|
* `arm_subscription_id` - (Optional) The subscription ID to use. It can also
|
||
|
|
be sourced from the `ARM_SUBSCRIPTION_ID` environment variable.
|
||
|
|
* `arm_client_id` - (Optional) The client ID to use. It can also be sourced from
|
||
|
|
the `ARM_CLIENT_ID` environment variable.
|
||
|
|
* `arm_client_secret` - (Optional) The client secret to use. It can also be sourced from
|
||
|
|
the `ARM_CLIENT_SECRET` environment variable.
|
||
|
|
* `arm_tenant_id` - (Optional) The tenant ID to use. It can also be sourced from the
|
||
|
|
`ARM_TENANT_ID` environment variable.
|