Disk Encryption Sets - List
Список всех наборов шифрования диска в рамках подписки.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets?api-version=2025-01-02
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
subscription
|
path | True |
string minLength: 1 |
Идентификатор целевой подписки. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Запрос выполнен успешно. |
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
azure_auth
Azure Active Directory OAuth2 Flow.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
list all disk encryption sets in a subscription.
Образец запроса
Пример ответа
{
"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/mySecondResourceGroup/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/mySecondResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2",
"name": "myDiskEncryptionSet2"
}
],
"nextLink": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Compute/diskEncryptionSets?$skiptoken=token"
}
Определения
| Имя | Описание |
|---|---|
|
Api |
Ошибка API. |
|
Api |
База ошибок API. |
|
Cloud |
Ответ об ошибке от службы вычислений. |
|
created |
Тип удостоверения, создавшего ресурс. |
|
Disk |
Набор шифрования диска ресурса. |
|
Disk |
Тип управляемого удостоверения, используемого DiskEncryptionSet. Для новых создания поддерживается только SystemAssigned. Наборы шифрования дисков можно обновить с помощью типа удостоверений None во время миграции подписки на новый клиент Azure Active Directory; Это приведет к потере доступа к ключам зашифрованных ресурсов. |
|
Disk |
Ответ на операцию Список настроек шифрования диска. |
|
Disk |
Тип ключа, используемого для шифрования данных диска. |
|
Encryption |
Управляемое удостоверение для набора шифрования дисков. Прежде чем его можно использовать для шифрования дисков, необходимо предоставить разрешение на хранилище ключей. |
|
Inner |
Сведения о внутренней ошибке. |
|
Key |
URL-адрес ключа Key Vault для шифрования управляемых дисков и моментальных снимков на стороне сервера |
|
Source |
Идентификатор хранилища — это идентификатор ресурса Azure Resource Manager в формате /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} |
|
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
|
User |
ApiError
Ошибка API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке Api |
|
| innererror |
Внутренняя ошибка Api |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект конкретной ошибки. |
ApiErrorBase
База ошибок API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект конкретной ошибки. |
CloudError
Ответ об ошибке от службы вычислений.
| Имя | Тип | Описание |
|---|---|---|
| error |
Ошибка API. |
createdByType
Тип удостоверения, создавшего ресурс.
| Значение | Описание |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DiskEncryptionSet
Набор шифрования диска ресурса.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| identity |
Управляемое удостоверение для набора шифрования дисков. Прежде чем его можно использовать для шифрования дисков, необходимо предоставить разрешение на хранилище ключей. |
|
| location |
string |
Географическое расположение, в котором находится ресурс |
| name |
string |
Имя ресурса |
| properties.activeKey |
Ключ хранилища ключей, который в настоящее время используется этим набором шифрования дисков. |
|
| properties.autoKeyRotationError |
Ошибка, возникшая при автоповороте клавиш. Если ошибка присутствует, то автоматическая ротация ключа не будет предпринята до тех пор, пока ошибка на этом наборе шифрования диска не будет исправлена. |
|
| properties.encryptionType |
Тип ключа, используемого для шифрования данных диска. |
|
| properties.federatedClientId |
string |
Идентификатор клиента мультитенантного приложения для доступа к хранилищу ключей в другом клиенте. При задании значения "Нет" свойство очищается. |
| properties.lastKeyRotationTimestamp |
string (date-time) |
Время, когда был обновлен активный ключ данного набора шифрования диска. |
| properties.previousKeys |
Доступная только для чтения коллекция ключей хранилища ключей, ранее использовавшаяся этим набором шифрования диска во время смены ключей. Он будет пустым, если не происходит непрерывная ротация ключей. |
|
| properties.provisioningState |
string |
Шифрование диска задает состояние подготовки. |
| properties.rotationToLatestKeyVersionEnabled |
boolean |
Установите для этого флага значение true, чтобы включить автоматическое обновление этого набора шифрования дисков до последней версии ключа. |
| systemData |
Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy. |
|
| tags |
object |
Теги ресурсов. |
| type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
DiskEncryptionSetIdentityType
Тип управляемого удостоверения, используемого DiskEncryptionSet. Для новых создания поддерживается только SystemAssigned. Наборы шифрования дисков можно обновить с помощью типа удостоверений None во время миграции подписки на новый клиент Azure Active Directory; Это приведет к потере доступа к ключам зашифрованных ресурсов.
| Значение | Описание |
|---|---|
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned, UserAssigned | |
| None |
DiskEncryptionSetList
Ответ на операцию Список настроек шифрования диска.
| Имя | Тип | Описание |
|---|---|---|
| nextLink |
string (uri) |
Ссылка на следующую страницу элементов |
| value |
Элементы DiskEncryptionSet на этой странице |
DiskEncryptionSetType
Тип ключа, используемого для шифрования данных диска.
| Значение | Описание |
|---|---|
| EncryptionAtRestWithCustomerKey |
Ресурс, использующий diskEncryptionSet, будет зашифрован при хранении с помощью ключа, управляемого клиентом, который может быть изменен и отозван клиентом. |
| EncryptionAtRestWithPlatformAndCustomerKeys |
Ресурс, использующий diskEncryptionSet, будет зашифрован при хранении с помощью двух уровней шифрования. Один из ключей управляется клиентом, а другой — управляется платформой. |
| ConfidentialVmEncryptedWithCustomerKey |
Конфиденциальный диск, поддерживаемый виртуальной машиной, и гостевое состояние виртуальной машины будут зашифрованы с помощью ключа, управляемого клиентом. |
EncryptionSetIdentity
Управляемое удостоверение для набора шифрования дисков. Прежде чем его можно использовать для шифрования дисков, необходимо предоставить разрешение на хранилище ключей.
| Имя | Тип | Описание |
|---|---|---|
| principalId |
string |
Идентификатор объекта ресурса управляемого удостоверения. Он будет отправлен RP из ARM через заголовок x-ms-identity-principal-id в запросе PUT, если ресурс имеет идентификатор systemAssigned(неявный) |
| tenantId |
string |
Идентификатор клиента ресурса управляемого удостоверения. Он будет отправлен в RP из ARM через заголовок x-ms-client-tenant-id в запросе PUT, если ресурс имеет идентификатор systemAssigned(неявный) |
| type |
Тип управляемого удостоверения, используемого DiskEncryptionSet. Для новых создания поддерживается только SystemAssigned. Наборы шифрования дисков можно обновить с помощью типа удостоверений None во время миграции подписки на новый клиент Azure Active Directory; Это приведет к потере доступа к ключам зашифрованных ресурсов. |
|
| userAssignedIdentities |
<string,
User |
Список удостоверений пользователей, связанных с набором шифрования дисков. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
InnerError
Сведения о внутренней ошибке.
| Имя | Тип | Описание |
|---|---|---|
| errordetail |
string |
Внутреннее сообщение об ошибке или дамп исключений. |
| exceptiontype |
string |
Тип исключения. |
KeyForDiskEncryptionSet
URL-адрес ключа Key Vault для шифрования управляемых дисков и моментальных снимков на стороне сервера
| Имя | Тип | Описание |
|---|---|---|
| keyUrl |
string |
Полный url-адрес ключа версии, указывающий на ключ в KeyVault. Сегмент версии URL-адреса требуется независимо от значения rotationToLatestKeyVersionEnabled. |
| sourceVault |
Идентификатор ресурса KeyVault, содержащий ключ или секрет. Это свойство является необязательным и не может использоваться, если подписка KeyVault не совпадает с подпиской набора шифрования дисков. |
SourceVault
Идентификатор хранилища — это идентификатор ресурса Azure Resource Manager в формате /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
| Имя | Тип | Описание |
|---|---|---|
| createdAt |
string (date-time) |
Метка времени создания ресурса (UTC). |
| createdBy |
string |
Удостоверение, создающее ресурс. |
| createdByType |
Тип удостоверения, создавшего ресурс. |
|
| lastModifiedAt |
string (date-time) |
Метка времени последнего изменения ресурса (UTC) |
| lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
| lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |
UserAssignedIdentitiesValue
| Имя | Тип | Описание |
|---|---|---|
| clientId |
string |
Идентификатор клиента назначаемого пользователем удостоверения. |
| principalId |
string |
Идентификатор субъекта назначаемого пользователем удостоверения. |