community.azure.azure_rm_hdinsightcluster_facts – Получение сведений об Azure HDInsight кластере

Примечание

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

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

Чтобы использовать его в книге задач, укажите: community.azure.azure_rm_hdinsightcluster_facts.

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

Обзор

Получить сведения об Azure HDInsight кластере.

Требования

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

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 строка		Имя кластера HDInsight.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка		Имя группы Azure-ресурсов.
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 instance of HDInsight Cluster
  community.azure.azure_rm_hdinsightcluster_info:
    resource_group: myResourceGroup
    name: myCluster

- name: List instances of HDInsight Cluster
  community.azure.azure_rm_hdinsightcluster_info:
    resource_group: myResourceGroup

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

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

Ключ				Возвращаемое значение	Описание
clusters сложный				всегда	Список словарей, содержащих факты для кластера HDInsight.
	cluster_definition строка			успех	Определение кластера.
		kind строка		всегда	Тип кластера. Пример: spark
	cluster_version строка			всегда	Версия кластера. Пример: 3.6.1000.67
	compute_profile_roles список / элементы=строка			успех	Список ролей в кластере.
		linux_profile строка		успех	Профиль операционной системы Linux.
			username строка	всегда	Имя пользователя. Пример: myuser
		name строка		всегда	Имя роли. Пример: headnode
		target_instance_count целое число		всегда	Количество экземпляров кластера. Пример: 2
		vm_size строка		всегда	Размер виртуальной машины. Пример: Standard_D3
	connectivity_endpoints список / элементы=строка			успех	Точки подключения кластера.
		location строка		всегда	Расположение конечной точки. Пример: myCluster-ssh.azurehdinsight.net
		name строка		всегда	Имя конечной точки. Пример: SSH
		port целое число		всегда	Порт конечной точки. Пример: 22
		protocol строка		всегда	Протокол конечной точки. Пример: TCP
	id строка			всегда	Уникальный идентификатор ресурса кластера HDInsight. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HDInsight/clusters/myCluster
	location строка			всегда	Расположение группы ресурсов, к которой принадлежит ресурс. Пример: westus
	name строка			всегда	Имя кластера HDInsight. Пример: testaccount
	os_type строка			всегда	Тип операционной системы. Пример: linux
	resource_group строка			всегда	Имя группы Azure ресурсов. Пример: myResourceGroup
	tags сложный			всегда	Теги ресурса.
	tier строка			всегда	Уровень кластера. Пример: standard

Авторы

Zim Kalinowski (@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/community/azure/azure_rm_hdinsightcluster_facts_module.html