你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Compute diskEncryptionSets 2023-01-02
Bicep 资源定义
可以使用目标操作部署 diskEncryptionSets 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Compute/diskEncryptionSets 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Compute/diskEncryptionSets@2023-01-02' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
activeKey: {
keyUrl: 'string'
sourceVault: {
id: 'string'
}
}
encryptionType: 'string'
federatedClientId: 'string'
rotationToLatestKeyVersionEnabled: bool
}
}
属性值
diskEncryptionSets
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源名称 | string (必需) 字符限制:1-80 有效字符: 字母数字、下划线和连字符。 |
位置 | 资源位置 | string (必需) |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
身份 | 磁盘加密集的托管标识。 它应授予对密钥保管库的权限,然后才能用于加密磁盘。 | EncryptionSetIdentity |
性能 | EncryptionSetProperties |
EncryptionSetIdentity
名字 | 描述 | 价值 |
---|---|---|
类型 | DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 将订阅迁移到新的 Azure Active Directory 租户期间,可以使用标识类型 None 更新磁盘加密集;这将导致加密的资源失去对密钥的访问权限。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned” |
userAssignedIdentities | 与磁盘加密集关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | UserAssignedIdentities |
UserAssignedIdentities
名字 | 描述 | 价值 |
---|---|---|
{自定义属性} | UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
EncryptionSetProperties
名字 | 描述 | 价值 |
---|---|---|
activeKey | 此磁盘加密集当前使用的密钥保管库密钥。 | KeyForDiskEncryptionSet |
encryptionType | 用于加密磁盘数据的密钥类型。 | “ConfidentialVmEncryptedWithCustomerKey” “EncryptionAtRestWithCustomerKey” “EncryptionAtRestWithPlatformAndCustomerKeys” |
federatedClientId | 多租户应用程序客户端 ID,用于访问不同租户中的密钥保管库。 将值设置为“None”将清除该属性。 | 字符串 |
rotationToLatestKeyVersionEnabled | 将此标志设置为 true 以启用此磁盘加密设置为最新密钥版本的自动更新。 | bool |
KeyForDiskEncryptionSet
名字 | 描述 | 价值 |
---|---|---|
keyUrl | 指向 KeyVault 中的密钥的完全版本控制密钥 URL。 无论 rotationToLatestKeyVersionEnabled 值如何,都需要 URL 的版本段。 | string (必需) |
sourceVault | 包含密钥或机密的 KeyVault 的资源 ID。 此属性是可选的,如果 KeyVault 订阅与磁盘加密集订阅不同,则不能使用此属性。 | SourceVault |
SourceVault
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID | 字符串 |
ARM 模板资源定义
可以使用目标操作部署 diskEncryptionSets 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Compute/diskEncryptionSets 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Compute/diskEncryptionSets",
"apiVersion": "2023-01-02",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"activeKey": {
"keyUrl": "string",
"sourceVault": {
"id": "string"
}
},
"encryptionType": "string",
"federatedClientId": "string",
"rotationToLatestKeyVersionEnabled": "bool"
}
}
属性值
diskEncryptionSets
名字 | 描述 | 价值 |
---|---|---|
类型 | 资源类型 | “Microsoft.Compute/diskEncryptionSets” |
apiVersion | 资源 API 版本 | '2023-01-02' |
名字 | 资源名称 | string (必需) 字符限制:1-80 有效字符: 字母数字、下划线和连字符。 |
位置 | 资源位置 | string (必需) |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
身份 | 磁盘加密集的托管标识。 它应授予对密钥保管库的权限,然后才能用于加密磁盘。 | EncryptionSetIdentity |
性能 | EncryptionSetProperties |
EncryptionSetIdentity
名字 | 描述 | 价值 |
---|---|---|
类型 | DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 将订阅迁移到新的 Azure Active Directory 租户期间,可以使用标识类型 None 更新磁盘加密集;这将导致加密的资源失去对密钥的访问权限。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned” |
userAssignedIdentities | 与磁盘加密集关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | UserAssignedIdentities |
UserAssignedIdentities
名字 | 描述 | 价值 |
---|---|---|
{自定义属性} | UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
EncryptionSetProperties
名字 | 描述 | 价值 |
---|---|---|
activeKey | 此磁盘加密集当前使用的密钥保管库密钥。 | KeyForDiskEncryptionSet |
encryptionType | 用于加密磁盘数据的密钥类型。 | “ConfidentialVmEncryptedWithCustomerKey” “EncryptionAtRestWithCustomerKey” “EncryptionAtRestWithPlatformAndCustomerKeys” |
federatedClientId | 多租户应用程序客户端 ID,用于访问不同租户中的密钥保管库。 将值设置为“None”将清除该属性。 | 字符串 |
rotationToLatestKeyVersionEnabled | 将此标志设置为 true 以启用此磁盘加密设置为最新密钥版本的自动更新。 | bool |
KeyForDiskEncryptionSet
名字 | 描述 | 价值 |
---|---|---|
keyUrl | 指向 KeyVault 中的密钥的完全版本控制密钥 URL。 无论 rotationToLatestKeyVersionEnabled 值如何,都需要 URL 的版本段。 | string (必需) |
sourceVault | 包含密钥或机密的 KeyVault 的资源 ID。 此属性是可选的,如果 KeyVault 订阅与磁盘加密集订阅不同,则不能使用此属性。 | SourceVault |
SourceVault
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID | 字符串 |
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署 diskEncryptionSets 资源类型:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Compute/diskEncryptionSets 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/diskEncryptionSets@2023-01-02"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
activeKey = {
keyUrl = "string"
sourceVault = {
id = "string"
}
}
encryptionType = "string"
federatedClientId = "string"
rotationToLatestKeyVersionEnabled = bool
}
})
}
属性值
diskEncryptionSets
名字 | 描述 | 价值 |
---|---|---|
类型 | 资源类型 | “Microsoft.Compute/diskEncryptionSets@2023-01-02” |
名字 | 资源名称 | string (必需) 字符限制:1-80 有效字符: 字母数字、下划线和连字符。 |
位置 | 资源位置 | string (必需) |
parent_id | 若要部署到资源组,请使用该资源组的 ID。 | string (必需) |
标签 | 资源标记 | 标记名称和值的字典。 |
身份 | 磁盘加密集的托管标识。 它应授予对密钥保管库的权限,然后才能用于加密磁盘。 | EncryptionSetIdentity |
性能 | EncryptionSetProperties |
EncryptionSetIdentity
名字 | 描述 | 价值 |
---|---|---|
类型 | DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 将订阅迁移到新的 Azure Active Directory 租户期间,可以使用标识类型 None 更新磁盘加密集;这将导致加密的资源失去对密钥的访问权限。 | “SystemAssigned” “SystemAssigned, UserAssigned” “UserAssigned” |
identity_ids | 与磁盘加密集关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 | 用户标识 ID 的数组。 |
UserAssignedIdentities
名字 | 描述 | 价值 |
---|---|---|
{自定义属性} | UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue
此对象不包含在部署期间设置的任何属性。 所有属性都是 ReadOnly。
EncryptionSetProperties
名字 | 描述 | 价值 |
---|---|---|
activeKey | 此磁盘加密集当前使用的密钥保管库密钥。 | KeyForDiskEncryptionSet |
encryptionType | 用于加密磁盘数据的密钥类型。 | “ConfidentialVmEncryptedWithCustomerKey” “EncryptionAtRestWithCustomerKey” “EncryptionAtRestWithPlatformAndCustomerKeys” |
federatedClientId | 多租户应用程序客户端 ID,用于访问不同租户中的密钥保管库。 将值设置为“None”将清除该属性。 | 字符串 |
rotationToLatestKeyVersionEnabled | 将此标志设置为 true 以启用此磁盘加密设置为最新密钥版本的自动更新。 | bool |
KeyForDiskEncryptionSet
名字 | 描述 | 价值 |
---|---|---|
keyUrl | 指向 KeyVault 中的密钥的完全版本控制密钥 URL。 无论 rotationToLatestKeyVersionEnabled 值如何,都需要 URL 的版本段。 | string (必需) |
sourceVault | 包含密钥或机密的 KeyVault 的资源 ID。 此属性是可选的,如果 KeyVault 订阅与磁盘加密集订阅不同,则不能使用此属性。 | SourceVault |
SourceVault
名字 | 描述 | 价值 |
---|---|---|
id | 资源 ID | 字符串 |