azure.azcollection.azure_rm_keyvault_info – Получение фактов Azure Key Vault

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

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

Для использования в плейбуке укажите: 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` могут быть использованы для определения идентификатора подписки, если их несколько; в противном случае используется по умолчанию подписка Azure 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, или выполнить вход перед выполнением задач или плейбука с помощью 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 список / элементы=строка				всегда	Список хранилищ ключей Azure.
	access_policies список / элементы=строка			всегда	Расположение хранилища.
		object_id строка		всегда	Идентификатор объекта пользователя, службы-принципала или группы безопасности в AAD для хранилища ключей. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
		permissions сложный		всегда	Разрешения, которыми обладает учетная запись для ключей, секретов и сертификатов.
			certificates список / элементы=строка	всегда	Разрешения на секреты. Пример: ['get', 'import']
			keys список / элементы=строка	всегда	Разрешения на ключи. Пример: ['get', 'create']
			secrets список / элементы=строка	всегда	Разрешения на секреты. Пример: ['list', 'set']
		tenant_id строка		всегда	Идентификатор аренды AAD, который следует использовать для проверки подлинности запросов к хранилищу ключей. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
	enabled_for_deployments булево			всегда	Разрешено ли виртуальным машинам Azure получать сертификаты, хранящиеся в хранилище ключей, как секреты.
	enabled_for_disk_encryption булево			всегда	Разрешено ли Azure Disk Encryption получать секреты из хранилища и распаковывать ключи.
	enabled_for_template_deployment булево			всегда	Разрешено ли Azure Resource Manager получать секреты из хранилища ключей.
	id строка			всегда	Идентификатор ресурса хранилища ключей. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault
	location строка			всегда	Расположение хранилища. Пример: eastus
	name строка			всегда	Имя хранилища. Пример: myVault
	sku словарь			всегда	SKU хранилища.
		family строка		всегда	Имя семейства SKU. Пример: A
		name строка		всегда	Имя SKU. Пример: standard
	tags список / элементы=строка			успех	Список тегов. Пример: ['foo']
	vault_uri строка			всегда	URI хранилища. Пример: https://myVault.vault.azure.net/

Авторы

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.10/collections/azure/azcollection/azure_rm_keyvault_info_module.html