azure.azcollection.azure_rm_keyvault_info – Получение данных о хранилище Azure Key Vault

Примечание

Этот плагин входит в состав коллекции azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в playbook укажите: azure.azcollection.azure_rm_keyvault_info.

Новое в версии 0.1.2: из azure.azcollection

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

Описание

Получение данных о хранилище Azure Key Vault.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

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

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью 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 Key Vault by name
  azure_rm_keyvault_info:
    resource_group: myResourceGroup
    name: myVault

- name: List Key Vaults in specific resource group
  azure_rm_keyvault_info:
    resource_group: myResourceGroup

- name: List Key Vaults in current subscription
  azure_rm_keyvault_info:

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

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

Ключ				Возвращаемое значение	Описание
keyvaults list / elements=string				всегда	Список хранилищ ключей Azure.
	access_policies list / elements=string			всегда	Расположение хранилища.
		object_id string		всегда	Идентификатор объекта пользователя, управляемого сервиса или группы безопасности в AAD для хранилища. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
		permissions complex		всегда	Разрешения, имеющиеся у идентификатора для ключей, секретов и сертификатов.
			certificates list / elements=string	всегда	Разрешения на секреты. Пример: ['get', 'import']
			keys list / elements=string	всегда	Разрешения на ключи. Пример: ['get', 'create']
			secrets list / elements=string	всегда	Разрешения на секреты. Пример: ['list', 'set']
		tenant_id string		всегда	Идентификатор аренды AAD, который следует использовать для аутентификации запросов к хранилищу ключей. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
	enabled_for_deployments boolean			всегда	Разрешено ли виртуальным машинам Azure получать сертификаты, хранящиеся в хранилище ключей как секреты.
	enabled_for_disk_encryption boolean			всегда	Разрешено ли шифрованию дисков Azure получать секреты из хранилища и распаковывать ключи.
	enabled_for_template_deployment boolean			всегда	Разрешено ли службе Azure Resource Manager получать секреты из хранилища ключей.
	id string			всегда	Идентификатор ресурса хранилища. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault
	location string			всегда	Расположение хранилища. Пример: eastus
	name string			всегда	Имя хранилища. Пример: myVault
	sku dictionary			всегда	SKU хранилища.
		family string		всегда	Название семейства SKU. Пример: A
		name string		всегда	Имя SKU. Пример: standard
	tags list / elements=string			успех	Список тегов. Пример: ['foo']
	vault_uri string			всегда	URI хранилища. Пример: https://myVault.vault.azure.net/

Авторы

Yunge Zhu (@yungezz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_keyvault_info_module.html