azure_rm_keyvaultkey_info – Получение сведений о ключе Azure Key Vault

Новая версия 2.9.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Обзор

Получение сведений о ключе Azure Key Vault.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлен в 2.6		URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и собственных полномочиях ADFS.
api_profile строка добавлен в 2.5	Значение по умолчанию: "latest"	Выбор профиля API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлен в 2.5	Варианты: auto cli credential_file env msi	Определяет источник учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать по умолчанию приоритетам параметров модуля -> переменных среды -> профилю по умолчанию в файле учетных данных `~/.azure/credentials`. При установке `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также можно установить через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке `msi`, хост-машина должна быть ресурсом Azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 2.5	Варианты: ignore validate	Управление поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси-сервера HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment строка добавлен в 2.4	Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
name строка		Имя ключа. Если не указано, будут перечислены все ключи в vault_uri.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
secret строка		Секрет клиента Azure. Используется при аутентификации с принципалом службы.
show_deleted_key логическое значение	Варианты: нет ← да	Установите значение true, чтобы отобразить удаленные ключи. Установите значение False, чтобы отобразить не удаленные ключи.
subscription_id строка		Идентификатор вашей подписки Azure.
tags список		Ограничить результаты, указав список тегов. Формат тегов «ключ» или «ключ:значение».
tenant строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
vault_uri строка / требуется		URL хранилища, где хранится ключ.
version строка	Значение по умолчанию: "current"	Версия ключа. Установите `current`, чтобы отобразить последнюю версию ключа. Установите `all`, чтобы перечислить все версии ключа. Установите конкретную версию, чтобы перечислить конкретную версию ключа, например, fd2682392a504455b79c90dd04a1bf46.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или выполнить вход перед запуском задач или плана с az login.
Аутентификация также возможна с помощью принципала службы или пользователя Active Directory.
Для аутентификации с помощью принципала службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации с помощью пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

Вход с помощью Azure CLI: Как выполнить вход с помощью команды az login.

Примеры

- name: Get latest version of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey

- name: List all versions of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey
    version: all

- name: List specific version of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey
    version: fd2682392a504455b79c90dd04a1bf46

- name: List all keys in specific key vault
  azure_rm_keyvaultkey_info:
      vault_uri: "https://myVault.vault.azure.net"

- name: List deleted keys in specific key vault
  azure_rm_keyvaultkey_info:
      vault_uri: "https://myVault.vault.azure.net"
      show_deleted_key: True

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращаемое значение	Описание
keyvaults complex			всегда	Список ключей в хранилище ключей Azure.
	attributes -			Атрибуты ключа.
		created string	всегда	Дата и время создания. Пример: 2019-04-25T07:26:49+00:00
		enabled string	всегда	Указывает, включён ли ключ. Пример: True
		expires string		Дата и время истечения срока действия. Пример: 2019-04-25T07:26:49+00:00
		not_before string		Дата и время, до которого ключ не может быть использован. Пример: 2019-04-25T07:26:49+00:00
		recovery_level string	всегда	Уровень восстановления при удалении ключей в хранилище. Если содержит 'Purgeable', ключ может быть постоянно удалён привилегированным пользователем. В противном случае, только система может удалить ключ по истечении периода хранения. Пример: Purgable
		updated string	всегда	Дата и время последнего обновления. Пример: 2019-04-25T07:26:49+00:00
	key -			Публичная часть ключа.
		crv string		Название эллиптической кривой.
		e string		Публичный показатель RSA.
		n string		Модули RSA.
		x string		X-компонента открытого ключа эллиптической кривой.
		y string		Y-компонента открытого ключа эллиптической кривой.
	kid string		всегда	Идентификатор ключа. Пример: https://myVault.vault.azure.net/keys/key1/fd2682392a504455b79c90dd04a1bf46
	managed boolean			True, если срок действия ключа управляется хранилищем ключей. Пример: True
	permitted_operations list		всегда	Разрешённые операции с ключом. Пример: encrypt
	tags list		всегда	Теги ключа. Пример: foo
	type string		всегда	Тип ключа. Пример: RSA
	version string		всегда	Версия ключа. Пример: fd2682392a504455b79c90dd04a1bf46

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Yunge Zhu (@yungezz)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_keyvaultkey_info_module.html