Share via

Microsoft.RecoveryServices vaults/backupEncryptionConfigs 2024-04-01

  • Article

Bicep resource definition

The vaults/backupEncryptionConfigs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/backupEncryptionConfigs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2024-04-01' = {
  name: 'backupResourceEncryptionConfig'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  eTag: 'string'
  properties: {
    encryptionAtRestType: 'string'
    infrastructureEncryptionState: 'string'
    keyUri: 'string'
    lastUpdateStatus: 'string'
    subscriptionId: 'string'
  }
}

Property values

vaults/backupEncryptionConfigs

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 'backupResourceEncryptionConfig'
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
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
eTag Optional ETag. string
properties BackupResourceEncryptionConfigResource properties BackupResourceEncryptionConfigOrBackupResourceEncryp...

BackupResourceEncryptionConfigOrBackupResourceEncryp...

Name Description Value
encryptionAtRestType Encryption At Rest Type 'CustomerManaged'
'Invalid'
'MicrosoftManaged'
infrastructureEncryptionState 'Disabled'
'Enabled'
'Invalid'
keyUri Key Vault Key URI string
lastUpdateStatus 'Failed'
'FirstInitialization'
'Initialized'
'Invalid'
'NotEnabled'
'PartiallyFailed'
'PartiallySucceeded'
'Succeeded'
subscriptionId Key Vault Subscription Id string

ARM template resource definition

The vaults/backupEncryptionConfigs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/backupEncryptionConfigs resource, add the following JSON to your template.

{
  "type": "Microsoft.RecoveryServices/vaults/backupEncryptionConfigs",
  "apiVersion": "2024-04-01",
  "name": "backupResourceEncryptionConfig",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "eTag": "string",
  "properties": {
    "encryptionAtRestType": "string",
    "infrastructureEncryptionState": "string",
    "keyUri": "string",
    "lastUpdateStatus": "string",
    "subscriptionId": "string"
  }
}

Property values

vaults/backupEncryptionConfigs

Name Description Value
type The resource type 'Microsoft.RecoveryServices/vaults/backupEncryptionConfigs'
apiVersion The resource api version '2024-04-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 'backupResourceEncryptionConfig'
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
eTag Optional ETag. string
properties BackupResourceEncryptionConfigResource properties BackupResourceEncryptionConfigOrBackupResourceEncryp...

BackupResourceEncryptionConfigOrBackupResourceEncryp...

Name Description Value
encryptionAtRestType Encryption At Rest Type 'CustomerManaged'
'Invalid'
'MicrosoftManaged'
infrastructureEncryptionState 'Disabled'
'Enabled'
'Invalid'
keyUri Key Vault Key URI string
lastUpdateStatus 'Failed'
'FirstInitialization'
'Initialized'
'Invalid'
'NotEnabled'
'PartiallyFailed'
'PartiallySucceeded'
'Succeeded'
subscriptionId Key Vault Subscription Id string

Terraform (AzAPI provider) resource definition

The vaults/backupEncryptionConfigs 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/backupEncryptionConfigs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2024-04-01"
  name = "backupResourceEncryptionConfig"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      encryptionAtRestType = "string"
      infrastructureEncryptionState = "string"
      keyUri = "string"
      lastUpdateStatus = "string"
      subscriptionId = "string"
    }
    eTag = "string"
  })
}

Property values

vaults/backupEncryptionConfigs

Name Description Value
type The resource type "Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2024-04-01"
name The resource name "backupResourceEncryptionConfig"
location Resource location. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: vaults
tags Resource tags. Dictionary of tag names and values.
eTag Optional ETag. string
properties BackupResourceEncryptionConfigResource properties BackupResourceEncryptionConfigOrBackupResourceEncryp...

BackupResourceEncryptionConfigOrBackupResourceEncryp...

Name Description Value
encryptionAtRestType Encryption At Rest Type "CustomerManaged"
"Invalid"
"MicrosoftManaged"
infrastructureEncryptionState "Disabled"
"Enabled"
"Invalid"
keyUri Key Vault Key URI string
lastUpdateStatus "Failed"
"FirstInitialization"
"Initialized"
"Invalid"
"NotEnabled"
"PartiallyFailed"
"PartiallySucceeded"
"Succeeded"
subscriptionId Key Vault Subscription Id string