Get Keys - Get Keys

Ссылка

Служба:: Key Vault

Версия API:: 7.4

Вывод списка ключей в указанном хранилище.
Получает список ключей в хранилище ключей в виде структур веб-ключей JSON, содержащих открытую часть сохраненных ключей. Операция LIST применима ко всем типам ключей, однако в ответе указаны только идентификатор базового ключа, атрибуты и теги. Отдельные версии ключа не перечисляются в ответе. Для этой операции требуется разрешение "ключи/список".

GET {vaultBaseUrl}/keys?api-version=7.4

С использованием необязательных параметров:

GET {vaultBaseUrl}/keys?maxresults={maxresults}&api-version=7.4

Параметры URI

Имя	В	Обязательно	Тип	Описание
vaultBaseUrl	path	True	string	Имя хранилища, например https://myvault.vault.azure.net.
api-version	query	True	string	Версия API клиента.
maxresults	query		integer int32	Максимальное количество результатов, возвращаемых на странице. Если этот параметр не указан, служба вернет до 25 результатов.

Ответы

Имя	Тип	Описание
200 OK	KeyListResult	Ответное сообщение, содержащее список ключей в хранилище и ссылку на следующую страницу ключей.
Other Status Codes	KeyVaultError	Key Vault ответ об ошибке, описывающий причину сбоя операции.

Примеры

GetKeys

Образец запроса

HTTP

GET https://myvault.vault.azure.net//keys?maxresults=1&api-version=7.4

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/sdktestkey",
      "attributes": {
        "enabled": true,
        "created": 1493937656,
        "updated": 1493937656,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1"
}

Определения

Имя	Описание
DeletionRecoveryLevel	Отражает уровень восстановления удаления, действующий в настоящее время для ключей в текущем хранилище. Если он содержит Purgeable, ключ может быть окончательно удален привилегированным пользователем; В противном случае только система может очистить ключ в конце интервала хранения.
Error	Ошибка сервера хранилища ключей.
KeyAttributes	Атрибуты ключа, управляемого службой хранилища ключей.
KeyItem	Ключевой элемент, содержащий метаданные ключа.
KeyListResult	Результат списка ключей.
KeyVaultError	Исключение ошибки хранилища ключей.

DeletionRecoveryLevel

Отражает уровень восстановления удаления, действующий в настоящее время для ключей в текущем хранилище. Если он содержит Purgeable, ключ может быть окончательно удален привилегированным пользователем; В противном случае только система может очистить ключ в конце интервала хранения.

Имя	Тип	Описание
CustomizedRecoverable	string	Обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистки, когда 7< = SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения и в то время, когда подписка по-прежнему доступна.
CustomizedRecoverable+ProtectedSubscription	string	Обозначает состояние хранилища и подписки, в котором удаление подлежит восстановлению, немедленное и постоянное удаление (т. е. очистка) запрещено, а сама подписка не может быть окончательно отменена, если 7< = SoftDeleteRetentionInDays < 90. Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения, а также отражает тот факт, что сама подписка не может быть отменена.
CustomizedRecoverable+Purgeable	string	Обозначает состояние хранилища, в котором удаление можно восстановить, а также позволяет немедленное и постоянное удаление (т. е. очистка, когда 7< = SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения, если не запрашивается операция очистки или подписка не отменена.
Purgeable	string	Обозначает состояние хранилища, в котором удаление является необратимой операцией без возможности восстановления. Этот уровень соответствует отсутствием защиты от операции удаления; данные безвозвратно теряются при принятии операции удаления на уровне сущности или выше (хранилище, группа ресурсов, подписка и т. д.).
Recoverable	string	Обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистки). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней) и пока подписка по-прежнему доступна. Система окончательно удаляет его через 90 дней, если она не восстановлена
Recoverable+ProtectedSubscription	string	Обозначает состояние хранилища и подписки, в котором удаление можно восстановить в течение интервала хранения (90 дней), немедленное и постоянное удаление (т. е. очистка) запрещено, а сама подписка не может быть окончательно отменена. Система окончательно удаляет его через 90 дней, если она не восстановлена
Recoverable+Purgeable	string	Обозначает состояние хранилища, в котором удаление можно восстановить, а также позволяет немедленное и постоянное удаление (т. е. очистка). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней), если не будет запрошена операция очистки или подписка не отменена. Система окончательно удаляет его через 90 дней, если она не восстановлена

Error

Ошибка сервера хранилища ключей.

Имя	Тип	Описание
code	string	Код ошибки.
innererror	Error	Ошибка сервера хранилища ключей.
message	string	Сообщение об ошибке.

KeyAttributes

Атрибуты ключа, управляемого службой хранилища ключей.

Имя	Тип	Описание
created	integer	Время создания в формате UTC.
enabled	boolean	Определяет, включен ли объект.
exp	integer	Дата окончания срока действия в формате UTC.
exportable	boolean	Указывает, можно ли экспортировать закрытый ключ. При создании первой версии экспортируемого ключа необходимо указать политику выпуска.
nbf	integer	Не раньше даты в формате UTC.
recoverableDays	integer	softDelete data retention days. Значение должно быть >равно =7 и <=90, если softDelete включено, в противном случае — 0.
recoveryLevel	DeletionRecoveryLevel	Отражает уровень восстановления удаления, действующий в настоящее время для ключей в текущем хранилище. Если он содержит Purgeable, ключ может быть окончательно удален привилегированным пользователем; В противном случае только система может очистить ключ в конце интервала хранения.
updated	integer	Время последнего обновления в формате UTC.

KeyItem

Ключевой элемент, содержащий метаданные ключа.

Имя	Тип	Описание
attributes	KeyAttributes	Атрибуты управления ключами.
kid	string	Идентификатор ключа.
managed	boolean	Значение true, если время существования ключа управляется хранилищем ключей. Если это ключ, который поддерживает сертификат, то параметр managed будет иметь значение true.
tags	object	Метаданные конкретного приложения в виде пар «ключ — значение».

KeyListResult

Результат списка ключей.

Имя	Тип	Описание
nextLink	string	URL-адрес для получения следующего набора ключей.
value	KeyItem[]	Ответное сообщение, содержащее список ключей в хранилище ключей и ссылку на следующую страницу ключей.

KeyVaultError

Исключение ошибки хранилища ключей.

Имя	Тип	Описание
error	Error	Ошибка сервера хранилища ключей.

Поделиться через