Microsoft.RecoveryServices vaults/backupconfig 2024-01-01
- Latest
- 2024-10-01
- 2024-07-30-preview
- 2024-04-30-preview
- 2024-04-01
- 2024-02-01
- 2024-01-01
- 2023-08-01
- 2023-06-01
- 2023-04-01
- 2023-02-01
- 2023-01-01
- 2022-10-01
- 2022-09-30-preview
- 2022-09-01-preview
- 2022-06-01-preview
- 2022-04-01
- 2022-03-01
- 2022-02-01
- 2022-01-01
- 2021-12-01
- 2021-10-01
- 2021-08-01
- 2021-07-01
- 2021-06-01
- 2021-04-01
- 2021-03-01
- 2021-02-10
- 2021-02-01
- 2021-02-01-preview
- 2021-01-01
- 2020-12-01
- 2020-10-01
- 2019-06-15
- 2019-05-13
Bicep resource definition
The vaults/backupconfig resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.RecoveryServices/vaults/backupconfig resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.RecoveryServices/vaults/backupconfig@2024-01-01' = {
parent: resourceSymbolicName
eTag: 'string'
location: 'string'
name: 'vaultconfig'
properties: {
enhancedSecurityState: 'string'
isSoftDeleteFeatureStateEditable: bool
resourceGuardOperationRequests: [
'string'
]
softDeleteFeatureState: 'string'
softDeleteRetentionPeriodInDays: int
storageModelType: 'string'
storageType: 'string'
storageTypeState: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
BackupResourceVaultConfig
| Name | Description | Value |
|---|---|---|
| enhancedSecurityState | Enabled or Disabled. | 'Disabled' 'Enabled' 'Invalid' |
| isSoftDeleteFeatureStateEditable | This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault | bool |
| resourceGuardOperationRequests | ResourceGuard Operation Requests | string[] |
| softDeleteFeatureState | Soft Delete feature state | 'AlwaysON' 'Disabled' 'Enabled' 'Invalid' |
| softDeleteRetentionPeriodInDays | Soft delete retention period in days | int |
| storageModelType | Storage type. | 'GeoRedundant' 'Invalid' 'LocallyRedundant' 'ReadAccessGeoZoneRedundant' 'ZoneRedundant' |
| storageType | Storage type. | 'GeoRedundant' 'Invalid' 'LocallyRedundant' 'ReadAccessGeoZoneRedundant' 'ZoneRedundant' |
| storageTypeState | Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. | 'Invalid' 'Locked' 'Unlocked' |
Microsoft.RecoveryServices/vaults/backupconfig
| Name | Description | Value |
|---|---|---|
| eTag | Optional ETag. | string |
| location | Resource location. | string |
| name | The resource name | 'vaultconfig' (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: vaults |
| properties | BackupResourceVaultConfigResource properties | BackupResourceVaultConfig |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The vaults/backupconfig resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.RecoveryServices/vaults/backupconfig resource, add the following JSON to your template.
{
"type": "Microsoft.RecoveryServices/vaults/backupconfig",
"apiVersion": "2024-01-01",
"name": "string",
"eTag": "string",
"location": "string",
"properties": {
"enhancedSecurityState": "string",
"isSoftDeleteFeatureStateEditable": "bool",
"resourceGuardOperationRequests": [ "string" ],
"softDeleteFeatureState": "string",
"softDeleteRetentionPeriodInDays": "int",
"storageModelType": "string",
"storageType": "string",
"storageTypeState": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
BackupResourceVaultConfig
| Name | Description | Value |
|---|---|---|
| enhancedSecurityState | Enabled or Disabled. | 'Disabled' 'Enabled' 'Invalid' |
| isSoftDeleteFeatureStateEditable | This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault | bool |
| resourceGuardOperationRequests | ResourceGuard Operation Requests | string[] |
| softDeleteFeatureState | Soft Delete feature state | 'AlwaysON' 'Disabled' 'Enabled' 'Invalid' |
| softDeleteRetentionPeriodInDays | Soft delete retention period in days | int |
| storageModelType | Storage type. | 'GeoRedundant' 'Invalid' 'LocallyRedundant' 'ReadAccessGeoZoneRedundant' 'ZoneRedundant' |
| storageType | Storage type. | 'GeoRedundant' 'Invalid' 'LocallyRedundant' 'ReadAccessGeoZoneRedundant' 'ZoneRedundant' |
| storageTypeState | Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. | 'Invalid' 'Locked' 'Unlocked' |
Microsoft.RecoveryServices/vaults/backupconfig
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-01-01' |
| eTag | Optional ETag. | string |
| location | Resource location. | string |
| name | The resource name | 'vaultconfig' (required) |
| properties | BackupResourceVaultConfigResource properties | BackupResourceVaultConfig |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.RecoveryServices/vaults/backupconfig' |
ResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The vaults/backupconfig resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.RecoveryServices/vaults/backupconfig resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.RecoveryServices/vaults/backupconfig@2024-01-01"
name = "string"
eTag = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
enhancedSecurityState = "string"
isSoftDeleteFeatureStateEditable = bool
resourceGuardOperationRequests = [
"string"
]
softDeleteFeatureState = "string"
softDeleteRetentionPeriodInDays = int
storageModelType = "string"
storageType = "string"
storageTypeState = "string"
}
})
}
Property values
BackupResourceVaultConfig
| Name | Description | Value |
|---|---|---|
| enhancedSecurityState | Enabled or Disabled. | 'Disabled' 'Enabled' 'Invalid' |
| isSoftDeleteFeatureStateEditable | This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault | bool |
| resourceGuardOperationRequests | ResourceGuard Operation Requests | string[] |
| softDeleteFeatureState | Soft Delete feature state | 'AlwaysON' 'Disabled' 'Enabled' 'Invalid' |
| softDeleteRetentionPeriodInDays | Soft delete retention period in days | int |
| storageModelType | Storage type. | 'GeoRedundant' 'Invalid' 'LocallyRedundant' 'ReadAccessGeoZoneRedundant' 'ZoneRedundant' |
| storageType | Storage type. | 'GeoRedundant' 'Invalid' 'LocallyRedundant' 'ReadAccessGeoZoneRedundant' 'ZoneRedundant' |
| storageTypeState | Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. | 'Invalid' 'Locked' 'Unlocked' |
Microsoft.RecoveryServices/vaults/backupconfig
| Name | Description | Value |
|---|---|---|
| eTag | Optional ETag. | string |
| location | Resource location. | string |
| name | The resource name | 'vaultconfig' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: vaults |
| properties | BackupResourceVaultConfigResource properties | BackupResourceVaultConfig |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.RecoveryServices/vaults/backupconfig@2024-01-01" |
ResourceTags
| Name | Description | Value |
|---|