community.azure.azure_rm_hdinsightcluster_info – Получение фактов о кластере Azure HDInsight
Примечание
Этот плагин является частью коллекции community.azure (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.azure.
Для использования в книге задач укажите: community.azure.azure_rm_hdinsightcluster_info.
Обзор
- Получение фактов о кластере 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 |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды 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 |
| Управляет поведением проверки сертификата для 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 complex | всегда | Список словарей, содержащих факты для кластера HDInsight. | |||
| cluster_definition string | успех | Определение кластера. | |||
| kind string | всегда | Тип кластера. Пример: spark | |||
| cluster_version string | всегда | Версия кластера. Пример: 3.6.1000.67 | |||
| compute_profile_roles list / elements=string | успех | Список ролей в кластере. | |||
| linux_profile string | успех | Профиль операционной системы Linux. | |||
| username string | всегда | Имя пользователя. Пример: myuser | |||
| name string | всегда | Имя роли. Пример: headnode | |||
| target_instance_count integer | всегда | Количество экземпляров в кластере. Пример: 2 | |||
| vm_size string | всегда | Размер ВМ. Пример: Standard_D3 | |||
| connectivity_endpoints list / elements=string | успех | Точки подключения кластера. | |||
| location string | всегда | Расположение конечной точки. Пример: myCluster-ssh.azurehdinsight.net | |||
| name string | всегда | Имя конечной точки. Пример: SSH | |||
| port integer | всегда | Порт конечной точки. Пример: 22 | |||
| protocol string | всегда | Протокол конечной точки. Пример: TCP | |||
| id string | всегда | Уникальный идентификатор ресурса кластера HDInsight. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HDInsight/clusters/myCluster | |||
| location string | всегда | Расположение группы ресурсов, к которой принадлежит ресурс. Пример: westus | |||
| name string | всегда | Имя кластера HDInsight. Пример: testaccount | |||
| os_type string | всегда | Тип операционной системы. Пример: linux | |||
| resource_group string | всегда | Имя группы ресурсов Azure. Пример: myResourceGroup | |||
| tags complex | всегда | Теги ресурса. | |||
| tier string | всегда | Уровень кластера. Пример: standard | |||
Авторы
- Zim Kalinowski (@zikalino)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_hdinsightcluster_info_module.html
