Share via

Microsoft.RecoveryServices vaults/backupEncryptionConfigs 2024-10-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-10-01' = {
  parent: resourceSymbolicName
  eTag: 'string'
  location: 'string'
  name: 'backupResourceEncryptionConfig'
  properties: {
    encryptionAtRestType: 'string'
    infrastructureEncryptionState: 'string'
    keyUri: 'string'
    lastUpdateStatus: 'string'
    subscriptionId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

BackupResourceEncryptionConfigOrBackupResourceEncryptionConfigExtended

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

Microsoft.RecoveryServices/vaults/backupEncryptionConfigs

Name Description Value
eTag Optional ETag. string
location Resource location. string
name The resource name 'backupResourceEncryptionConfig' (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 BackupResourceEncryptionConfigResource properties BackupResourceEncryptionConfigOrBackupResourceEncryptionConfigExtended
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

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-10-01",
  "name": "string",
  "eTag": "string",
  "location": "string",
  "properties": {
    "encryptionAtRestType": "string",
    "infrastructureEncryptionState": "string",
    "keyUri": "string",
    "lastUpdateStatus": "string",
    "subscriptionId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

BackupResourceEncryptionConfigOrBackupResourceEncryptionConfigExtended

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

Microsoft.RecoveryServices/vaults/backupEncryptionConfigs

Name Description Value
apiVersion The api version '2024-10-01'
eTag Optional ETag. string
location Resource location. string
name The resource name 'backupResourceEncryptionConfig' (required)
properties BackupResourceEncryptionConfigResource properties BackupResourceEncryptionConfigOrBackupResourceEncryptionConfigExtended
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.RecoveryServices/vaults/backupEncryptionConfigs'

ResourceTags

Name Description Value

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-10-01"
  name = "string"
  eTag = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      encryptionAtRestType = "string"
      infrastructureEncryptionState = "string"
      keyUri = "string"
      lastUpdateStatus = "string"
      subscriptionId = "string"
    }
  })
}

Property values

BackupResourceEncryptionConfigOrBackupResourceEncryptionConfigExtended

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

Microsoft.RecoveryServices/vaults/backupEncryptionConfigs

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

ResourceTags

Name Description Value