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

Disk Encryption Sets - List By Resource Group

列出资源组下的所有磁盘加密集。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets?api-version=2021-12-01

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

客户端 API 版本。

响应

Name Type Description
200 OK

OK

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

List all disk encryption sets in a resource group.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets?api-version=2021-12-01

Sample Response

{
  "value": [
    {
      "identity": {
        "type": "SystemAssigned"
      },
      "properties": {
        "activeKey": {
          "sourceVault": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault"
          },
          "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}"
        },
        "encryptionType": "EncryptionAtRestWithCustomerKey",
        "previousKeys": [],
        "provisioningState": "Succeeded"
      },
      "type": "Microsoft.Compute/diskEncryptionSets",
      "location": "westus",
      "tags": {
        "department": "Development",
        "project": "Encryption"
      },
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
      "name": "myDiskEncryptionSet"
    },
    {
      "identity": {
        "type": "SystemAssigned"
      },
      "properties": {
        "activeKey": {
          "sourceVault": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2"
          },
          "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}"
        },
        "encryptionType": "EncryptionAtRestWithCustomerKey",
        "previousKeys": [],
        "provisioningState": "Succeeded"
      },
      "type": "Microsoft.Compute/diskEncryptionSets",
      "location": "westus",
      "tags": {
        "department": "Development",
        "project": "Encryption"
      },
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2",
      "name": "myDiskEncryptionSet2"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets?$skiptoken={token}"
}

定义

ApiError

API 错误。

ApiErrorBase

Api 错误基数。

CloudError

来自计算服务的错误响应。

DiskEncryptionSet

磁盘加密集资源。

DiskEncryptionSetIdentityType

DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 将订阅迁移到新的Azure Active Directory租户期间,可以使用标识类型 None 更新磁盘加密集;这将导致加密资源失去对密钥的访问权限。

DiskEncryptionSetList

列出磁盘加密集操作响应。

DiskEncryptionSetType

用于加密磁盘数据的密钥类型。

EncryptionSetIdentity

磁盘加密集的托管标识。 它应授予对密钥保管库的权限,然后才能使用它来加密磁盘。

InnerError

内部错误详细信息。

KeyForDiskEncryptionSet

用于服务器端加密托管磁盘和快照的密钥保管库密钥 URL

SourceVault

保管库 ID 是 Azure 资源管理器资源 ID,格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

ApiError

API 错误。

Name Type Description
code
  • string

错误代码。

details

API 错误详细信息

innererror

Api 内部错误

message
  • string

错误消息。

target
  • string

特定错误的目标。

ApiErrorBase

Api 错误基数。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息。

target
  • string

特定错误的目标。

CloudError

来自计算服务的错误响应。

Name Type Description
error

API 错误。

DiskEncryptionSet

磁盘加密集资源。

Name Type Description
id
  • string

资源 ID

identity

磁盘加密集的托管标识。 它应授予对密钥保管库的权限,然后才能使用它来加密磁盘。

location
  • string

资源位置

name
  • string

资源名称

properties.activeKey

此磁盘加密集当前使用的密钥保管库密钥。

properties.autoKeyRotationError

自动密钥轮换过程中遇到的错误。 如果存在错误,则在修复此磁盘加密集上的错误之前,不会尝试自动密钥轮换。

properties.encryptionType

用于加密磁盘数据的密钥类型。

properties.lastKeyRotationTimestamp
  • string

更新此磁盘加密集的活动密钥的时间。

properties.previousKeys

密钥轮换正在进行时,此磁盘加密集以前使用的密钥保管库密钥的只读集合。 如果没有正在进行的密钥轮换,它将为空。

properties.provisioningState
  • string

磁盘加密集预配状态。

properties.rotationToLatestKeyVersionEnabled
  • boolean

将此标志设置为 true 以启用此磁盘加密设置为最新密钥版本的自动更新。

tags
  • object

资源标记

type
  • string

资源类型

DiskEncryptionSetIdentityType

DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 将订阅迁移到新的Azure Active Directory租户期间,可以使用标识类型 None 更新磁盘加密集;这将导致加密资源失去对密钥的访问权限。

Name Type Description
None
  • string
SystemAssigned
  • string

DiskEncryptionSetList

列出磁盘加密集操作响应。

Name Type Description
nextLink
  • string

用于提取磁盘加密集下一页的 URI。 调用 ListNext () 以提取磁盘加密集的下一页。

value

磁盘加密集的列表。

DiskEncryptionSetType

用于加密磁盘数据的密钥类型。

Name Type Description
ConfidentialVmEncryptedWithCustomerKey
  • string

使用客户管理的密钥对机密 VM 支持的磁盘和 VM 来宾状态进行加密。

EncryptionAtRestWithCustomerKey
  • string

使用 diskEncryptionSet 的资源将使用客户管理的密钥进行静态加密,客户可以更改和吊销这些密钥。

EncryptionAtRestWithPlatformAndCustomerKeys
  • string

使用 diskEncryptionSet 的资源将使用两个加密层进行静态加密。 其中一个密钥是客户管理的,另一个密钥是平台管理的。

EncryptionSetIdentity

磁盘加密集的托管标识。 它应授予对密钥保管库的权限,然后才能使用它来加密磁盘。

Name Type Description
principalId
  • string

托管标识资源的对象 ID。 如果资源具有 systemAssigned (隐式) 标识,则会通过 PUT 请求中的 x-ms-identity-principal-id 标头从 ARM 发送到 RP

tenantId
  • string

托管标识资源的租户 ID。 如果资源具有 systemAssigned (隐式) 标识,则会通过 PUT 请求中的 x-ms-client-tenant-id 标头从 ARM 发送到 RP

type

DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 将订阅迁移到新的Azure Active Directory租户期间,可以使用标识类型 None 更新磁盘加密集;这将导致加密资源失去对密钥的访问权限。

InnerError

内部错误详细信息。

Name Type Description
errordetail
  • string

内部错误消息或异常转储。

exceptiontype
  • string

异常类型。

KeyForDiskEncryptionSet

用于服务器端加密托管磁盘和快照的密钥保管库密钥 URL

Name Type Description
keyUrl
  • string

指向 KeyVault 中的密钥的完全版本控制密钥 URL。 无论 rotationToLatestKeyVersionEnabled 值如何,都需要 URL 的版本段。

sourceVault

包含密钥或机密的 KeyVault 的资源 ID。 此属性是可选的,如果 KeyVault 订阅与磁盘加密集订阅不同,则不能使用此属性。

SourceVault

保管库 ID 是 Azure 资源管理器资源 ID,格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Name Type Description
id
  • string

资源 ID