Get Keys - Get Keys

Ссылка

Служба:: Key Vault

Версия API:: 7.4

Вывод списка ключей в указанном хранилище.
Извлекает список ключей в Key Vault в виде структур веб-ключей 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) minimum: 1 maximum: 25	Максимальное количество результатов, возвращаемых на странице. Если служба не указана, возвращает до 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	Обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистка при 7<= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности во время периода хранения и пока подписка по-прежнему доступна.
CustomizedRecoverable+ProtectedSubscription	Обозначает состояние хранилища и подписки, в котором удаление можно восстановить, немедленное и постоянное удаление (т. е. очистка) не допускается, и при этом сама подписка не может быть окончательно отменена, когда 7<= SoftDeleteRetentionInDays < 90. Этот уровень гарантирует возможность восстановления удаленной сущности во время интервала хранения, а также отражает тот факт, что сама подписка не может быть отменена.
CustomizedRecoverable+Purgeable	Обозначает состояние хранилища, в котором можно восстановить удаление, а также разрешает немедленное и постоянное удаление (т. е. очистка при 7<= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности во время интервала хранения, если не запрашивается операция очистки или подписка отменена.
Purgeable	Обозначает состояние хранилища, в котором удаление является необратимой операцией без возможности восстановления. Этот уровень не соответствует защите от операции delete; данные безвозвратно теряются при принятии операции удаления на уровне сущности или выше (хранилище, группа ресурсов, подписка и т. д.).
Recoverable	Обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистки). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней) и пока подписка по-прежнему доступна. Система будет окончательно удалять ее через 90 дней, если не восстановлена
Recoverable+ProtectedSubscription	Обозначает состояние хранилища и подписки, в котором удаление можно восстановить в пределах интервала хранения (90 дней), немедленное и постоянное удаление (т. е. очистка) не допускается, и при этом сама подписка не может быть окончательно отменена. Система будет окончательно удалять ее через 90 дней, если не восстановлена
Recoverable+Purgeable	Обозначает состояние хранилища, в котором можно восстановить удаление, а также разрешает немедленное и постоянное удаление (т. е. очистка). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней), если операция очистки не запрашивается или подписка отменена. Система будет окончательно удалять ее через 90 дней, если не восстановлена

Error

Object

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

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

KeyAttributes

Object

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

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

KeyItem

Object

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

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

KeyListResult

Object

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

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

KeyVaultError

Object

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

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

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

Get Keys - Get Keys

Параметры URI

Ответы

Примеры

GetKeys

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

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

Определения

DeletionRecoveryLevel

Error

KeyAttributes

KeyItem

KeyListResult

KeyVaultError

Дополнительные ресурсы