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]
                          [--subscription]
                          [--vault-name]

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

--file -f

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

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

--id

Идентификатор секрета. При указании всех остальных аргументов "ID" следует опустить.

--name -n

Имя секрета. Требуется, если не указан идентификатор--ID.

--subscription

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

--vault-name

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

az keyvault secret delete

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

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

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

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

--id

Идентификатор секрета. При указании всех остальных аргументов "ID" следует опустить.

--name -n

Имя секрета. Требуется, если не указан идентификатор--ID.

--subscription

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

--vault-name

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

az keyvault secret download

Скачайте секрет из KeyVault.

az keyvault secret download --file
                            [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                            [--id]
                            [--name]
                            [--subscription]
                            [--vault-name]
                            [--version]

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

--file -f

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

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

--encoding -e

Кодировка секрета. По умолчанию будет искать в секрете тег "File-Encoding". В противном случае будет считаться "UTF-8".

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

Идентификатор секрета. При указании всех остальных аргументов "ID" следует опустить.

--name -n

Имя секрета. Требуется, если не указан идентификатор--ID.

--subscription

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

--vault-name

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

--version -v

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

az keyvault secret list

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

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

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

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

--id

Идентификатор хранилища или HSM. При указании всех остальных аргументов "ID" следует опустить.

--include-managed

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

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

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

--query-examples

Рекомендуемая строка JMESPath. Можно скопировать один из запросов и вставить его после параметра--query в двойных кавычках, чтобы увидеть результаты. Можно добавить одно или несколько позиций ключевых слов, чтобы мы могли предоставлять предложения на основе этих ключевых слов.

--subscription

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

--vault-name

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

az keyvault secret list-deleted

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

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

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

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

--vault-name

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

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

--id

Идентификатор хранилища. При указании всех остальных аргументов "ID" следует опустить.

--maxresults

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

--subscription

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

az keyvault secret list-versions

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

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

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

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

--id

Идентификатор секрета. При указании всех остальных аргументов "ID" следует опустить.

--maxresults

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

--name -n

Имя секрета. Требуется, если не указан идентификатор--ID.

--subscription

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

--vault-name

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

az keyvault secret purge

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

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

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

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

--id

Идентификатор восстановления секрета. При указании всех остальных аргументов "ID" следует опустить.

--name -n

Имя секрета. Требуется, если не указан идентификатор--ID.

--subscription

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

--vault-name

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

az keyvault secret recover

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

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

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

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

--id

Идентификатор восстановления секрета. При указании всех остальных аргументов "ID" следует опустить.

--name -n

Имя секрета. Требуется, если не указан идентификатор--ID.

--subscription

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

--vault-name

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

az keyvault secret restore

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

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

az keyvault secret restore --file
                           --vault-name
                           [--subscription]

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

--file -f

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

--vault-name

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

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

--subscription

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

az keyvault secret set

Создайте секрет (если он не существует) или обновите секрет в KeyVault.

az keyvault secret set --name
                       --vault-name
                       [--description]
                       [--disabled {false, true}]
                       [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                       [--expires]
                       [--file]
                       [--not-before]
                       [--subscription]
                       [--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

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

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

--description

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

--disabled

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

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

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

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

Дата и время в формате UTC (Y-m-Д'т ' ч: С'З ').

--file -f

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

--not-before

Ключ не может использоваться до указанной даты и времени в формате UTC (Y-m-Д'т ' ч: С'З ').

--subscription

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

--tags

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

--value

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

az keyvault secret set-attributes

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

Операция UPDATE изменяет указанные атрибуты существующего хранимого секрета. Атрибуты, которые не указаны в запросе, остаются без изменений. Значение самого секрета не может быть изменено. Для этой операции требуется разрешение Secret/Set.

az keyvault secret set-attributes [--content-type]
                                  [--enabled {false, true}]
                                  [--expires]
                                  [--id]
                                  [--name]
                                  [--not-before]
                                  [--subscription]
                                  [--tags]
                                  [--vault-name]
                                  [--version]

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

--content-type

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

--enabled

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

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

Дата и время в формате UTC (Y-m-Д'т ' ч: С'З ').

--id

Идентификатор секрета. При указании всех остальных аргументов "ID" следует опустить.

--name -n

Имя секрета. Требуется, если не указан идентификатор--ID.

--not-before

Ключ не может использоваться до указанной даты и времени в формате UTC (Y-m-Д'т ' ч: С'З ').

--subscription

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

--tags

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

--vault-name

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

--version -v

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

az keyvault secret show

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

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

az keyvault secret show [--id]
                        [--name]
                        [--query-examples]
                        [--subscription]
                        [--vault-name]
                        [--version]

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

--id

Идентификатор секрета. При указании всех остальных аргументов "ID" следует опустить.

--name -n

Имя секрета. Требуется, если не указан идентификатор--ID.

--query-examples

Рекомендуемая строка JMESPath. Можно скопировать один из запросов и вставить его после параметра--query в двойных кавычках, чтобы увидеть результаты. Можно добавить одно или несколько позиций ключевых слов, чтобы мы могли предоставлять предложения на основе этих ключевых слов.

--subscription

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

--vault-name

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

--version -v

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

az keyvault secret show-deleted

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

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

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

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

--id

Идентификатор восстановления секрета. При указании всех остальных аргументов "ID" следует опустить.

--name -n

Имя секрета. Требуется, если не указан идентификатор--ID.

--subscription

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

--vault-name

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