az keyvault secret
Управление секретами.
Команды
Имя | Описание | Тип | Состояние |
---|---|---|---|
az keyvault secret backup |
Резервное копирование указанного секрета. |
Ядро | ГА |
az keyvault secret delete |
Удалите все версии секрета. |
Ядро | Устаревшие |
az keyvault secret download |
Скачайте секрет из KeyVault. |
Ядро | ГА |
az keyvault secret list |
Вывод списка секретов в указанном хранилище ключей. |
Ядро | ГА |
az keyvault secret list-deleted |
Выводит список удаленных секретов для указанного хранилища. |
Ядро | ГА |
az keyvault secret list-versions |
Список всех версий указанного секрета. |
Ядро | ГА |
az keyvault secret purge |
Окончательно удаляет указанный секрет. |
Ядро | ГА |
az keyvault secret recover |
Восстанавливает удаленный секрет до последней версии. |
Ядро | ГА |
az keyvault secret restore |
Восстанавливает резервную копию секрета в хранилище. |
Ядро | ГА |
az keyvault secret set |
Создайте секрет (если он не существует) или обновите секрет в KeyVault. |
Ядро | ГА |
az keyvault secret set-attributes |
Обновляет атрибуты, связанные с указанным секретом в заданном хранилище ключей. |
Ядро | ГА |
az keyvault secret show |
Получите указанный секрет из заданного хранилища ключей. |
Ядро | ГА |
az keyvault secret show-deleted |
Возвращает указанный удаленный секрет. |
Ядро | ГА |
az keyvault secret backup
Резервное копирование указанного секрета.
Запрашивает скачивание резервной копии указанного секрета клиенту. Будут загружены все версии секрета. Для этой операции требуется разрешение секретов или резервного копирования.
az keyvault secret backup --file
[--id]
[--name]
[--vault-name]
Обязательные параметры
Файл для получения содержимого секрета.
Необязательные параметры
Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.
Имя секрета. Требуется, если --id не указан.
Имя Key Vault. Требуется, если --id не указан.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret delete
Предупреждение! Если в этом хранилище ключей включена защита обратимого удаления, этот секрет будет перемещен в обратимое удаленное состояние. Вы не сможете создать секрет с тем же именем в этом хранилище ключей, пока секрет не будет удален из обратимого удаленного состояния. Дополнительные рекомендации см. в следующей документации. https://learn.microsoft.com/azure/key-vault/general/soft-delete-overview
Удалите все версии секрета.
Требуется разрешение на секреты или удаление. Когда этот метод возвращает Key Vault, начал удалять секрет. Удаление может занять несколько секунд в хранилище с поддержкой обратимого удаления. Таким образом, этот метод возвращает опрашиватель, позволяющий ждать завершения удаления.
az keyvault secret delete [--id]
[--name]
[--vault-name]
Необязательные параметры
Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.
Имя секрета. Требуется, если --id не указан.
Имя Key Vault. Требуется, если --id не указан.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret download
Скачайте секрет из KeyVault.
az keyvault secret download --file
[--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
[--id]
[--name]
[--vault-name]
[--version]
Обязательные параметры
Файл для получения содержимого секрета.
Необязательные параметры
Кодировка секрета. По умолчанию найдите тег "кодировка файлов" в секрете. В противном случае предполагается , что utf-8.
Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.
Имя секрета. Требуется, если --id не указан.
Имя Key Vault. Требуется, если --id не указан.
Версия секрета. Если опущено, используется последняя версия.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret list
Вывод списка секретов в указанном хранилище ключей.
Операция Get Secret применима ко всему хранилищу. Однако в ответе предоставляются только базовый идентификатор секрета и его атрибуты. Отдельные версии секретов не перечислены в ответе. Для этой операции требуется разрешение секретов или списка.
az keyvault secret list [--id]
[--include-managed {false, true}]
[--maxresults]
[--vault-name]
Необязательные параметры
Полный универсальный код ресурса (URI) хранилища. Если заданы все остальные аргументы "Id" должны быть опущены.
Включите управляемые секреты. Значение по умолчанию: false.
Максимальное количество результатов, возвращаемых на странице. Если это не указано, служба возвращает до 25 результатов.
Имя Key Vault. Требуется, если --id не указан.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret list-deleted
Выводит список удаленных секретов для указанного хранилища.
Операция получения удаленных секретов возвращает секреты, которые были удалены для хранилища, включенного для обратимого удаления. Для этой операции требуется разрешение секретов или списка.
az keyvault secret list-deleted [--id]
[--maxresults]
[--vault-name]
Необязательные параметры
Полный универсальный код ресурса (URI) хранилища. Если заданы все остальные аргументы "Id" должны быть опущены.
Максимальное количество результатов, возвращаемых на странице. Если это не указано, служба возвращает до 25 результатов.
Имя Key Vault. Требуется, если --id не указан.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret list-versions
Список всех версий указанного секрета.
Полный идентификатор секрета и атрибуты предоставляются в ответе. Значения для секретов не возвращаются. Для этих операций требуется разрешение секретов или списка.
az keyvault secret list-versions [--id]
[--maxresults]
[--name]
[--vault-name]
Необязательные параметры
Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.
Максимальное количество результатов, возвращаемых на странице. Если это не указано, служба возвращает до 25 результатов.
Имя секрета. Требуется, если --id не указан.
Имя Key Vault. Требуется, если --id не указан.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret purge
Окончательно удаляет указанный секрет.
Удаленная операция очистки секрета окончательно удаляет секрет без возможности восстановления. Эта операция может быть включена только в хранилище с поддержкой обратимого удаления. Для этой операции требуется разрешение секретов или очистки.
az keyvault secret purge [--id]
[--name]
[--vault-name]
Необязательные параметры
Идентификатор восстановления секрета. Если заданы все остальные аргументы "Id" должны быть опущены.
Имя секрета. Требуется, если --id не указан.
Имя хранилища. Требуется, если --id не указан.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret recover
Восстанавливает удаленный секрет до последней версии.
Восстанавливает удаленный секрет в указанном хранилище. Эта операция может выполняться только в хранилище с поддержкой обратимого удаления. Для этой операции требуется разрешение секретов или восстановления.
az keyvault secret recover [--id]
[--name]
[--vault-name]
Необязательные параметры
Идентификатор восстановления секрета. Если заданы все остальные аргументы "Id" должны быть опущены.
Имя секрета. Требуется, если --id не указан.
Имя хранилища. Требуется, если --id не указан.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret restore
Восстанавливает резервную копию секрета в хранилище.
Восстанавливает резервную копию секрета и всех его версий в хранилище. Для этой операции требуется разрешение секретов и восстановления.
az keyvault secret restore --file
--vault-name
Обязательные параметры
Файл для получения содержимого секрета.
Имя хранилища.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret set
Создайте секрет (если он не существует) или обновите секрет в KeyVault.
az keyvault secret set --name
--vault-name
[--content-type]
[--disabled {false, true}]
[--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
[--expires]
[--file]
[--not-before]
[--tags]
[--value]
Примеры
Создайте секрет (если он не существует) или обновите секрет в KeyVault.
az keyvault secret set --name MySecretName --vault-name MyKeyVault --value MyVault
Создайте секрет (если он не существует) или обновите секрет в KeyVault через файл.
az keyvault secret set --name MySecretName --vault-name MyKeyVault --file /path/to/file --encoding MyEncoding
Обязательные параметры
Имя секрета.
Имя хранилища.
Необязательные параметры
Описание содержимого секрета (например, пароль, строка подключения и т. д.).
Создайте секрет в отключенном состоянии.
Кодировка исходного файла. Значение сохраняется в виде тега (file-encoding=<val>
) и используется во время скачивания для автоматического кодирования результирующего файла.
Дата окончания срока действия UTC (Y-m-d'T'H:M:S'Z').
Исходный файл секрета. Используйте в сочетании с "--кодировкой".
Секрет недоступен до предоставленной даты в формате UTC (Y-m-d'T:M:S'Z).
Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.
Значение секрета обычного текста. Невозможно использовать с "--file" или "---кодировкой".
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret set-attributes
Обновляет атрибуты, связанные с указанным секретом в заданном хранилище ключей.
Операция UPDATE изменяет указанные атрибуты существующего сохраненного секрета. Атрибуты, которые не указаны в запросе, остаются неизменными. Невозможно изменить значение самого секрета. Для этой операции требуется разрешение секретов или набора.
az keyvault secret set-attributes [--content-type]
[--enabled {false, true}]
[--expires]
[--id]
[--name]
[--not-before]
[--tags]
[--vault-name]
[--version]
Необязательные параметры
Тип значения секрета, например пароля.
Включите секрет.
Дата окончания срока действия UTC (Y-m-d'T'H:M:S'Z').
Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.
Имя секрета. Требуется, если --id не указан.
Секрет недоступен до предоставленной даты в формате UTC (Y-m-d'T:M:S'Z).
Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.
Имя Key Vault. Требуется, если --id не указан.
Версия секрета. Если опущено, используется последняя версия.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret show
Получите указанный секрет из заданного хранилища ключей.
Операция GET применима к любому секрету, хранящейся в Azure Key Vault. Для этой операции требуются секреты и разрешение на получение.
az keyvault secret show [--id]
[--name]
[--vault-name]
[--version]
Необязательные параметры
Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.
Имя секрета. Требуется, если --id не указан.
Имя Key Vault. Требуется, если --id не указан.
Версия секрета. Если опущено, используется последняя версия.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az keyvault secret show-deleted
Возвращает указанный удаленный секрет.
Операция Get Deleted Secret возвращает указанный удаленный секрет вместе с его атрибутами. Для этой операции требуются секреты и разрешение на получение.
az keyvault secret show-deleted [--id]
[--name]
[--vault-name]
Необязательные параметры
Идентификатор восстановления секрета. Если заданы все остальные аргументы "Id" должны быть опущены.
Имя секрета. Требуется, если --id не указан.
Имя хранилища. Требуется, если --id не указан.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.