|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "polaris_azure_archival_location Resource - terraform-provider-polaris" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + The polaris_azure_archival_location resource creates an RSC archival location for cloud-native workloads. |
| 7 | + When creating an archival location, the region where the snapshots are stored needs to be specified: |
| 8 | + * Source Region - Store snapshots in the same region to minimize data transfer charges. This is the default behaviour when the storage_account_region field is not specified. |
| 9 | + * Specific region - Storing snapshots in another region can increase total data transfer charges. The storage_account_region field specifies the region. |
| 10 | + Custom storage encryption is enabled by specifying one or more customer_managed_key blocks. Each customer_managed_key block specifies the encryption details to use for a region. For other regions, data will be encrypted using platform managed keys. |
| 11 | + -> Note: The Azure storage account is not created until the first protected object is archived to the location. |
| 12 | +--- |
| 13 | + |
| 14 | +# polaris_azure_archival_location (Resource) |
| 15 | + |
| 16 | +The `polaris_azure_archival_location` resource creates an RSC archival location for cloud-native workloads. |
| 17 | + |
| 18 | +When creating an archival location, the region where the snapshots are stored needs to be specified: |
| 19 | + * *Source Region* - Store snapshots in the same region to minimize data transfer charges. This is the default behaviour when the `storage_account_region` field is not specified. |
| 20 | + * *Specific region* - Storing snapshots in another region can increase total data transfer charges. The `storage_account_region` field specifies the region. |
| 21 | + |
| 22 | +Custom storage encryption is enabled by specifying one or more `customer_managed_key` blocks. Each `customer_managed_key` block specifies the encryption details to use for a region. For other regions, data will be encrypted using platform managed keys. |
| 23 | + |
| 24 | +-> **Note:** The Azure storage account is not created until the first protected object is archived to the location. |
| 25 | + |
| 26 | + |
| 27 | + |
| 28 | +<!-- schema generated by tfplugindocs --> |
| 29 | +## Schema |
| 30 | + |
| 31 | +### Required |
| 32 | + |
| 33 | +- `cloud_account_id` (String) RSC cloud account ID. |
| 34 | +- `name` (String) Cloud native archival location name. |
| 35 | +- `storage_account_name_prefix` (String) Azure storage account name prefix. The storage account name prefix cannot be longer than 14 characters and can only consist of numbers and lower case letters. |
| 36 | + |
| 37 | +### Optional |
| 38 | + |
| 39 | +- `customer_managed_key` (Block Set) Customer managed storage encryption. Specify the regions and their respective encryption details. For other regions, data will be encrypted using platform managed keys. (see [below for nested schema](#nestedblock--customer_managed_key)) |
| 40 | +- `redundancy` (String) Azure storage redundancy. Possible values are `GRS`, `GZRS`, `LRS`, `RA_GRS`, `RA_GZRS` and `ZRS`. Default value is `LRS`. |
| 41 | +- `storage_account_region` (String) Azure region to store the snapshots in. If not specified, the snapshots will be stored in the same region as the workload. |
| 42 | +- `storage_account_tags` (Map of String) Azure storage account tags. Each tag will be added to the storage account created by RSC. |
| 43 | +- `storage_tier` (String) Azure storage tier. Possible values are `COOL` and `HOT`. Default value is `COOL`. |
| 44 | + |
| 45 | +### Read-Only |
| 46 | + |
| 47 | +- `connection_status` (String) Connection status of the cloud native archival location. |
| 48 | +- `container_name` (String) Azure storage container name. |
| 49 | +- `id` (String) Cloud native archival location ID. |
| 50 | +- `location_template` (String) RSC location template. If a storage account region was specified, it will be `SPECIFIC_REGION`, otherwise `SOURCE_REGION`. |
| 51 | + |
| 52 | +<a id="nestedblock--customer_managed_key"></a> |
| 53 | +### Nested Schema for `customer_managed_key` |
| 54 | + |
| 55 | +Required: |
| 56 | + |
| 57 | +- `name` (String) Key name. |
| 58 | +- `region` (String) The region in which the key will be used. Regions without customer managed keys will use platform managed keys. |
| 59 | +- `vault_name` (String) Key vault name. |
0 commit comments