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]

Обязательные параметры

--file -f

Файл для получения содержимого секрета.

Необязательные параметры

--id

Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.

--name -n

Имя секрета. Требуется, если --id не указан.

--vault-name

Имя Key Vault. Требуется, если --id не указан.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az keyvault secret delete

Изменить
Не рекомендуется

Предупреждение. Если в этом хранилище ключей включена защита обратимого удаления, этот секрет будет перемещен в обратимое удаленное состояние. Вы не сможете создать секрет с тем же именем в этом хранилище ключей, пока секрет не будет удален из обратимого удаленного состояния. Дополнительные рекомендации см. в следующей документации. https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview

Удалите все версии секрета.

Требуется разрешение на секреты или удаление. Когда этот метод возвращает Key Vault, начал удалять секрет. Удаление может занять несколько секунд в хранилище с поддержкой обратимого удаления. Таким образом, этот метод возвращает опрашиватель, позволяющий ждать завершения удаления.

az keyvault secret delete [--id]
                          [--name]
                          [--vault-name]

Необязательные параметры

--id

Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.

--name -n

Имя секрета. Требуется, если --id не указан.

--vault-name

Имя Key Vault. Требуется, если --id не указан.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --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]

Обязательные параметры

--file -f

Файл для получения содержимого секрета.

Необязательные параметры

--encoding -e

Кодировка секрета. По умолчанию найдите тег "кодировка файлов" в секрете. В противном случае предполагается , что utf-8.

допустимые значения: ascii, base64, hex, utf-16be, utf-16le, utf-8
--id

Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.

--name -n

Имя секрета. Требуется, если --id не указан.

--vault-name

Имя Key Vault. Требуется, если --id не указан.

--version -v

Версия секрета. Если опущено, используется последняя версия.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az keyvault secret list

Изменить

Вывод списка секретов в указанном хранилище ключей.

Операция Get Secret применима ко всему хранилищу. Однако в ответе предоставляются только базовый идентификатор секрета и его атрибуты. Отдельные версии секретов не перечислены в ответе. Для этой операции требуется разрешение секретов или списка.

az keyvault secret list [--id]
                        [--include-managed {false, true}]
                        [--maxresults]
                        [--vault-name]

Необязательные параметры

--id

Полный универсальный код ресурса (URI) хранилища. Если заданы все остальные аргументы "Id" должны быть опущены.

--include-managed

Включите управляемые секреты. По умолчанию: false.

допустимые значения: false, true
значение по умолчанию: False
--maxresults

Максимальное количество результатов, возвращаемых на странице. Если это не указано, служба возвращает до 25 результатов.

--vault-name

Имя Key Vault. Требуется, если --id не указан.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az keyvault secret list-deleted

Изменить

Выводит список удаленных секретов для указанного хранилища.

Операция получения удаленных секретов возвращает секреты, которые были удалены для хранилища, включенного для обратимого удаления. Для этой операции требуется разрешение секретов или списка.

az keyvault secret list-deleted [--id]
                                [--maxresults]
                                [--vault-name]

Необязательные параметры

--id

Полный универсальный код ресурса (URI) хранилища. Если заданы все остальные аргументы "Id" должны быть опущены.

--maxresults

Максимальное количество результатов, возвращаемых на странице. Если это не указано, служба возвращает до 25 результатов.

--vault-name

Имя Key Vault. Требуется, если --id не указан.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az keyvault secret list-versions

Изменить

Список всех версий указанного секрета.

Полный идентификатор секрета и атрибуты предоставляются в ответе. Значения для секретов не возвращаются. Для этих операций требуется разрешение секретов или списка.

az keyvault secret list-versions [--id]
                                 [--maxresults]
                                 [--name]
                                 [--vault-name]

Необязательные параметры

--id

Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.

--maxresults

Максимальное количество результатов, возвращаемых на странице. Если это не указано, служба возвращает до 25 результатов.

--name -n

Имя секрета. Требуется, если --id не указан.

--vault-name

Имя Key Vault. Требуется, если --id не указан.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az keyvault secret purge

Изменить

Окончательно удаляет указанный секрет.

Удаленная операция очистки секрета окончательно удаляет секрет без возможности восстановления. Эта операция может быть включена только в хранилище с поддержкой обратимого удаления. Для этой операции требуется разрешение секретов или очистки.

az keyvault secret purge [--id]
                         [--name]
                         [--vault-name]

Необязательные параметры

--id

Идентификатор восстановления секрета. Если заданы все остальные аргументы "Id" должны быть опущены.

--name -n

Имя секрета. Требуется, если --id не указан.

--vault-name

Имя хранилища. Требуется, если --id не указан.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az keyvault secret recover

Изменить

Восстанавливает удаленный секрет до последней версии.

Восстанавливает удаленный секрет в указанном хранилище. Эта операция может выполняться только в хранилище с поддержкой обратимого удаления. Для этой операции требуется разрешение секретов или восстановления.

az keyvault secret recover [--id]
                           [--name]
                           [--vault-name]

Необязательные параметры

--id

Идентификатор восстановления секрета. Если заданы все остальные аргументы "Id" должны быть опущены.

--name -n

Имя секрета. Требуется, если --id не указан.

--vault-name

Имя хранилища. Требуется, если --id не указан.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az keyvault secret restore

Изменить

Восстанавливает резервную копию секрета в хранилище.

Восстанавливает резервную копию секрета и всех его версий в хранилище. Для этой операции требуется разрешение секретов и восстановления.

az keyvault secret restore --file
                           --vault-name

Обязательные параметры

--file -f

Файл для получения содержимого секрета.

--vault-name

Имя хранилища.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --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

Обязательные параметры

--name -n

Имя секрета.

--vault-name

Имя хранилища.

Необязательные параметры

--content-type --description

Описание содержимого секрета (например, пароль, строка подключения и т. д.).

--disabled

Создайте секрет в отключенном состоянии.

допустимые значения: false, true
--encoding -e

Кодировка исходного файла. Значение сохраняется в виде тега (file-encoding=<val>) и используется во время скачивания для автоматического кодирования результирующего файла.

допустимые значения: ascii, base64, hex, utf-16be, utf-16le, utf-8
значение по умолчанию: utf-8
--expires

Дата окончания срока действия UTC (Y-m-d'T'H:M:S'Z').

--file -f

Исходный файл секрета. Используйте в сочетании с "--кодировкой".

--not-before

Секрет недоступен до предоставленной даты в формате UTC (Y-m-d'T:M:S'Z).

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--value

Значение секрета обычного текста. Невозможно использовать с "--file" или "---кодировкой".

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --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]

Необязательные параметры

--content-type

Тип значения секрета, например пароля.

--enabled

Включите секрет.

допустимые значения: false, true
--expires

Дата окончания срока действия UTC (Y-m-d'T'H:M:S'Z').

--id

Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.

--name -n

Имя секрета. Требуется, если --id не указан.

--not-before

Секрет недоступен до предоставленной даты в формате UTC (Y-m-d'T:M:S'Z).

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--vault-name

Имя Key Vault. Требуется, если --id не указан.

--version -v

Версия секрета. Если опущено, используется последняя версия.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az keyvault secret show

Изменить

Получите указанный секрет из заданного хранилища ключей.

Операция GET применима к любому секрету, хранящейся в Azure Key Vault. Для этой операции требуются секреты и разрешение на получение.

az keyvault secret show [--id]
                        [--name]
                        [--vault-name]
                        [--version]

Необязательные параметры

--id

Идентификатор секрета. Если заданы все остальные аргументы "Id" должны быть опущены.

--name -n

Имя секрета. Требуется, если --id не указан.

--vault-name

Имя Key Vault. Требуется, если --id не указан.

--version -v

Версия секрета. Если опущено, используется последняя версия.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az keyvault secret show-deleted

Изменить

Возвращает указанный удаленный секрет.

Операция Get Deleted Secret возвращает указанный удаленный секрет вместе с его атрибутами. Для этой операции требуются секреты и разрешение на получение.

az keyvault secret show-deleted [--id]
                                [--name]
                                [--vault-name]

Необязательные параметры

--id

Идентификатор восстановления секрета. Если заданы все остальные аргументы "Id" должны быть опущены.

--name -n

Имя секрета. Требуется, если --id не указан.

--vault-name

Имя хранилища. Требуется, если --id не указан.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.