community.azure.azure_rm_resourcegroup_facts – Получение фактов о группе ресурсов

Примечание

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

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

Для использования в плейбуке укажите: community.azure.azure_rm_resourcegroup_facts.

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

Обзор

Получение фактов о конкретной группе ресурсов или всех группах ресурсов.

Требования

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

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`.
list_resources строка		Список всех ресурсов в группе ресурсов. Обратите внимание, что это потребует дополнительных сетевых затрат для каждой группы ресурсов. Рекомендуется использовать, когда параметр name задан.
name строка		Ограничение результатов конкретной группой ресурсов.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
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 facts for one resource group
  community.azure.azure_rm_resourcegroup_info:
    name: myResourceGroup

- name: Get facts for all resource groups
  community.azure.azure_rm_resourcegroup_info:

- name: Get facts by tags
  community.azure.azure_rm_resourcegroup_info:
    tags:
      - testing
      - foo:bar

- name: Get facts for one resource group including resources it contains
  community.azure.azure_rm_resourcegroup_info:
    name: myResourceGroup
    list_resources: yes

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

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

Ключ			Возвращаемое значение	Описание
azure_resourcegroups список / элементы=строка			всегда	Список словарей групп ресурсов.
	id строка		всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup
	name строка		всегда	Имя группы ресурсов. Пример: foo
	resources список / элементы=строка		при list_resources=да.	Список ресурсов в группе ресурсов.
		id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMa chines/myVirtualMachine
		location строка	всегда	Регион ресурса. Пример: eastus
		name строка	всегда	Имя ресурса. Пример: myVirtualMachine
		tags словарь	всегда	Теги, присваиваемые управляемому диску. Пример: {'тег': 'значение'}
		type строка	всегда	Тип ресурса. Пример: Microsoft.Compute/virtualMachines
	tags словарь		всегда	Теги, присвоенные группе ресурсов. Пример: {'тег': 'значение'}

Авторы

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

© 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/community/azure/azure_rm_resourcegroup_facts_module.html