azure_rm_hdinsightcluster_info – Получение фактов о кластере Azure HDInsight
Новая версия 2.9.
Краткое описание
- Получить факты о кластере Azure HDInsight.
Псевдонимы: azure_rm_hdinsightcluster_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | |
| adfs_authority_url строка добавлено в 2.6 | URL-адрес службы авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службой авторизации ADFS. | |
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source строка добавлено в 2.5 |
| Определяет источник учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.При значении cli, учетные данные берутся из профиля Azure CLI по умолчанию.Также можно задать через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При значении msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi было добавлено в Ansible 2.6. |
| cert_validation_mode строка добавлено в 2.5 |
| Определяет поведение проверки сертификата для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или с Azure Stack может потребоваться отключить это поведение, передав ignore. Также можно задать через профиль в файле учетных данных или переменной среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| cloud_environment строка добавлено в 2.4 | По умолчанию: "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
azure_rm_hdinsightcluster_info:
resource_group: myResourceGroup
name: myCluster
- name: List instances of HDInsight Cluster
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 | |||
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/azure_rm_hdinsightcluster_info_module.html
