你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.RecoveryServices 保管库 2021-03-01

• 最新
• 2024-10-01
• 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-10
• 2022-08-01
• 2022-05-01
• 2022-04-01
• 2022-03-01
• 2022-02-01
• 2022-01-31-preview
• 2022-01-01
• 2021-12-01
• 2021-11-01-preview
• 2021-08-01
• 2021-07-01
• 2021-06-01
• 2021-04-01
• 2021-03-01
• 2021-02-10
• 2021-01-01
• 2020-10-01
• 2020-02-02
• 2016-06-01

Bicep 资源定义

可以使用目标操作部署保管库资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.RecoveryServices/vaults 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.RecoveryServices/vaults@2021-03-01' = {
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    encryption: {
      infrastructureEncryption: 'string'
      kekIdentity: {
        userAssignedIdentity: 'string'
        useSystemAssignedIdentity: bool
      }
      keyVaultProperties: {
        keyUri: 'string'
      }
    }
    upgradeDetails: {}
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

CmkKekIdentity

名字	描述	价值
userAssignedIdentity	用户分配的标识用于授予权限，以防所使用的标识类型为 UserAssigned	字符串
useSystemAssignedIdentity	指示应使用系统分配的标识。 与“userAssignedIdentity”字段互斥	bool

CmkKeyVaultProperties

名字	描述	价值
keyUri	客户管理的密钥的密钥 URI	字符串

IdentityData

名字	描述	价值
类型	使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”（必需）
userAssignedIdentities	与资源关联的用户分配标识的列表。 用户分配的标识字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	IdentityDataUserAssignedIdentities

IdentityDataUserAssignedIdentities

名字	描述	价值

Microsoft.RecoveryServices/vaults

名字	描述	价值
etag	可选 ETag。	字符串
身份	资源的标识。	IdentityData
位置	资源位置。	string （必需）
名字	资源名称	string （必需）
性能	保管库的属性。	VaultProperties
sku	标识每个 Azure 资源的唯一系统标识符。	Sku
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

Sku

名字	描述	价值
名字	Sku 名称。	“RS0” “标准”（必需）
层	Sku 层。	字符串

TrackedResourceTags

名字	描述	价值

UpgradeDetails

名字	描述	价值

UserIdentity

名字	描述	价值

VaultProperties

名字	描述	价值
加密	资源的客户托管密钥详细信息。	VaultPropertiesEncryption
upgradeDetails	升级保管库的详细信息。	UpgradeDetails

VaultPropertiesEncryption

名字	描述	价值
infrastructureEncryption	启用/禁用双重加密状态	“Disabled” “Enabled”
kekIdentity	用于 CMK 的标识的详细信息	CmkKekIdentity
keyVaultProperties	托管 CMK 的 Key Vault 的属性	CmkKeyVaultProperties

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
Azure 虚拟机中工作负荷的 Azure 备份	此模板创建恢复服务保管库和特定于工作负荷的备份策略。 将 VM 注册到备份服务和配置保护
使用恢复服务（每日） 备份现有文件共享	此模板为现有存储帐户中存在的现有文件共享配置保护。 它基于设置参数值创建新的或使用现有的恢复服务保管库和备份策略。
使用恢复服务（每小时） 备份现有文件共享	此模板为现有存储帐户中存在的现有文件共享配置每小时保护。 它基于设置参数值创建新的或使用现有的恢复服务保管库和备份策略。
使用恢复服务保管库 备份资源管理器 VM	此模板将使用现有的恢复服务保管库和现有备份策略，并配置属于同一资源组的多个资源管理器 VM 的备份
使用高级选项创建恢复服务保管库	此模板创建一个恢复服务保管库，该保管库将进一步用于备份和 Site Recovery。
为 RS Vault 创建每日备份策略以保护 IaaSVM	此模板创建恢复服务保管库和每日备份策略，可用于保护经典和基于 ARM 的 IaaS VM。
创建恢复服务保管库并启用诊断	此模板创建恢复服务保管库，并为 Azure 备份启用诊断。 这还会部署存储帐户和 oms 工作区。
使用备份策略创建恢复服务保管库	此模板创建包含备份策略的恢复服务保管库，并配置系统标识、备份存储类型、跨区域还原和诊断日志和删除锁等可选功能。
使用默认选项创建恢复服务保管库	创建恢复服务保管库的简单模板。
为 RS 保管库创建每周备份策略以保护 IaaSVM	此模板创建恢复服务保管库和每日备份策略，可用于保护经典和基于 ARM 的 IaaS VM。
部署 Windows VM 并使用 Azure 备份 启用备份	使用此模板，可以部署使用 DefaultPolicy 进行保护配置的 Windows VM 和恢复服务保管库。

ARM 模板资源定义

可以使用目标操作部署保管库资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.RecoveryServices/vaults 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.RecoveryServices/vaults",
  "apiVersion": "2021-03-01",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "encryption": {
      "infrastructureEncryption": "string",
      "kekIdentity": {
        "userAssignedIdentity": "string",
        "useSystemAssignedIdentity": "bool"
      },
      "keyVaultProperties": {
        "keyUri": "string"
      }
    },
    "upgradeDetails": {
    }
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

CmkKekIdentity

名字	描述	价值
userAssignedIdentity	用户分配的标识用于授予权限，以防所使用的标识类型为 UserAssigned	字符串
useSystemAssignedIdentity	指示应使用系统分配的标识。 与“userAssignedIdentity”字段互斥	bool

CmkKeyVaultProperties

名字	描述	价值
keyUri	客户管理的密钥的密钥 URI	字符串

IdentityData

名字	描述	价值
类型	使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”（必需）
userAssignedIdentities	与资源关联的用户分配标识的列表。 用户分配的标识字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	IdentityDataUserAssignedIdentities

IdentityDataUserAssignedIdentities

名字	描述	价值

Microsoft.RecoveryServices/vaults

名字	描述	价值
apiVersion	API 版本	'2021-03-01'
etag	可选 ETag。	字符串
身份	资源的标识。	IdentityData
位置	资源位置。	string （必需）
名字	资源名称	string （必需）
性能	保管库的属性。	VaultProperties
sku	标识每个 Azure 资源的唯一系统标识符。	Sku
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.RecoveryServices/vaults”

Sku

名字	描述	价值
名字	Sku 名称。	“RS0” “标准”（必需）
层	Sku 层。	字符串

TrackedResourceTags

名字	描述	价值

UpgradeDetails

名字	描述	价值

UserIdentity

名字	描述	价值

VaultProperties

名字	描述	价值
加密	资源的客户托管密钥详细信息。	VaultPropertiesEncryption
upgradeDetails	升级保管库的详细信息。	UpgradeDetails

VaultPropertiesEncryption

名字	描述	价值
infrastructureEncryption	启用/禁用双重加密状态	“Disabled” “Enabled”
kekIdentity	用于 CMK 的标识的详细信息	CmkKekIdentity
keyVaultProperties	托管 CMK 的 Key Vault 的属性	CmkKeyVaultProperties

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
Azure 虚拟机中工作负荷的 Azure 备份	此模板创建恢复服务保管库和特定于工作负荷的备份策略。 将 VM 注册到备份服务和配置保护
使用恢复服务（每日） 备份现有文件共享	此模板为现有存储帐户中存在的现有文件共享配置保护。 它基于设置参数值创建新的或使用现有的恢复服务保管库和备份策略。
使用恢复服务（每小时） 备份现有文件共享	此模板为现有存储帐户中存在的现有文件共享配置每小时保护。 它基于设置参数值创建新的或使用现有的恢复服务保管库和备份策略。
使用恢复服务保管库 备份资源管理器 VM	此模板将使用现有的恢复服务保管库和现有备份策略，并配置属于同一资源组的多个资源管理器 VM 的备份
使用高级选项创建恢复服务保管库	此模板创建一个恢复服务保管库，该保管库将进一步用于备份和 Site Recovery。
为 RS Vault 创建每日备份策略以保护 IaaSVM	此模板创建恢复服务保管库和每日备份策略，可用于保护经典和基于 ARM 的 IaaS VM。
创建恢复服务保管库并启用诊断	此模板创建恢复服务保管库，并为 Azure 备份启用诊断。 这还会部署存储帐户和 oms 工作区。
使用备份策略创建恢复服务保管库	此模板创建包含备份策略的恢复服务保管库，并配置系统标识、备份存储类型、跨区域还原和诊断日志和删除锁等可选功能。
使用默认选项创建恢复服务保管库	创建恢复服务保管库的简单模板。
为 RS 保管库创建每周备份策略以保护 IaaSVM	此模板创建恢复服务保管库和每日备份策略，可用于保护经典和基于 ARM 的 IaaS VM。
部署 Windows VM 并使用 Azure 备份 启用备份	使用此模板，可以部署使用 DefaultPolicy 进行保护配置的 Windows VM 和恢复服务保管库。
Ibm Cloud Pak for Data on Azure	此模板在 Azure 上部署一个 Openshift 群集，其中包含所有必需的资源、基础结构，然后部署 IBM Cloud Pak for Data 以及用户选择的加载项。
Openshift 容器平台 4.3	Openshift 容器平台 4.3

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署保管库资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.RecoveryServices/vaults 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults@2021-03-01"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      encryption = {
        infrastructureEncryption = "string"
        kekIdentity = {
          userAssignedIdentity = "string"
          useSystemAssignedIdentity = bool
        }
        keyVaultProperties = {
          keyUri = "string"
        }
      }
      upgradeDetails = {
      }
    }
  })
}

属性值

CmkKekIdentity

名字	描述	价值
userAssignedIdentity	用户分配的标识用于授予权限，以防所使用的标识类型为 UserAssigned	字符串
useSystemAssignedIdentity	指示应使用系统分配的标识。 与“userAssignedIdentity”字段互斥	bool

CmkKeyVaultProperties

名字	描述	价值
keyUri	客户管理的密钥的密钥 URI	字符串

IdentityData

名字	描述	价值
类型	使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”（必需）
userAssignedIdentities	与资源关联的用户分配标识的列表。 用户分配的标识字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	IdentityDataUserAssignedIdentities

IdentityDataUserAssignedIdentities

名字	描述	价值

Microsoft.RecoveryServices/vaults

名字	描述	价值
etag	可选 ETag。	字符串
身份	资源的标识。	IdentityData
位置	资源位置。	string （必需）
名字	资源名称	string （必需）
性能	保管库的属性。	VaultProperties
sku	标识每个 Azure 资源的唯一系统标识符。	Sku
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.RecoveryServices/vaults@2021-03-01”

Sku

名字	描述	价值
名字	Sku 名称。	“RS0” “标准”（必需）
层	Sku 层。	字符串

TrackedResourceTags

名字	描述	价值

UpgradeDetails

名字	描述	价值

UserIdentity

名字	描述	价值

VaultProperties

名字	描述	价值
加密	资源的客户托管密钥详细信息。	VaultPropertiesEncryption
upgradeDetails	升级保管库的详细信息。	UpgradeDetails

VaultPropertiesEncryption

名字	描述	价值
infrastructureEncryption	启用/禁用双重加密状态	“Disabled” “Enabled”
kekIdentity	用于 CMK 的标识的详细信息	CmkKekIdentity
keyVaultProperties	托管 CMK 的 Key Vault 的属性	CmkKeyVaultProperties