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

Примечание

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

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

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

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

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

Описание

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

Требования

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

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
  azure_rm_resourcegroup_info:
    name: myResourceGroup

- name: Get facts for all resource groups
  azure_rm_resourcegroup_info:

- name: Get facts by tags
  azure_rm_resourcegroup_info:
    tags:
      - testing
      - foo:bar

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

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

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

Ключ			Возвращаемое	Описание
resourcegroups список / элементы=строка			всегда	Список словарей группы ресурсов.
	id строка		всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup
	name строка		всегда	Имя группы ресурсов. Пример: foo
	resources список / элементы=строка		при list_resources=yes.	Список ресурсов в группе ресурсов.
		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/azure/azcollection/azure_rm_resourcegroup_info_module.html