azure.azcollection.azure_rm_deployment_info – Получение фактов развертывания Azure

Примечание

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_deployment_info.

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

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

Описание

Получение фактов развертывания Azure.

Требования

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

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 строка		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.
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 instance of Deployment
  azure_rm_deployment_info:
    resource_group: myResourceGroup
    name: myDeployment

Значения возврата

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

Ключевые значения			Возвращаемое значение	Описание
deployments сложный			всегда	Список словарей, содержащих данные для развертываний.
	id строка		всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/myDeployment
	name строка		всегда	Имя развертывания. Пример: myDeployment
	output_resources сложный		всегда	Список ресурсов.
		depends_on список / элементы=строка	всегда	Список идентификаторов ресурсов. Пример: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGropup/providers/Microsoft.Network/virtualNet works/myVirtualNetwork']
		id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkI nterfaces/myNetworkInterface
		name строка	всегда	Имя ресурса. Пример: myNetworkInterface
		type строка	всегда	Тип ресурса. Пример: Microsoft.Network/networkInterfaces
	outputs строка		всегда	Словарь, содержащий выходные данные развертывания.
	parameters сложный		всегда	Словарь, содержащий параметры развертывания.
	provisioning_state строка		всегда	Состояние подготовки развертывания. Пример: Успешно
	resource_group строка		всегда	Имя группы ресурсов. Пример: myResourceGroup
	template_link строка		всегда	Ссылка на шаблон. Пример: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/d01a5c06f4f1bc03a049ca17bbbd6e06d62657b3/101-vm-simple-linux/ azuredeploy.json

Авторы

Зим Калиновский (@zikalino)

© 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_deployment_info_module.html