azure.azcollection.azure_rm_hdinsightcluster – Управление экземпляром кластера Azure HDInsight

Примечание

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

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

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

Новое в версии 0.1.2: коллекции azure.azcollection

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

Описание

Создание, обновление и удаление экземпляра кластера 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.
append_tags логический			Варианты: нет да ←	Используйте для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 из azure.azcollection			Варианты: авто ← 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`.
cluster_definition строка				Определение кластера.
	gateway_rest_password строка			Пароль REST-шлюза.
	gateway_rest_username строка			Имя пользователя REST-шлюза.
	kind строка		Варианты: hadoop spark hbase storm	Тип кластера.
cluster_version строка				Версия кластера. Например, `3.6`.
compute_profile_roles список / элементы=строка				Список ролей в кластере.
	linux_profile строка			Профиль Linux ОС.
		password строка		Пароль SSH.
		username строка		Имя пользователя SSH.
	min_instance_count строка			Минимальное количество экземпляров кластера.
	name строка		Варианты: headnode workernode zookepernode	Имя роли.
	target_instance_count строка			Количество экземпляров кластера.
	vm_size строка			Размер виртуальной машины.
location строка				Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию.
name строка / обязательно				Название кластера.
os_type строка			Варианты: linux	Тип операционной системы.
password строка				Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка				Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно				Имя группы ресурсов.
secret строка				Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
state строка			Варианты: отсутствует наличие ←	Утвердить состояние кластера. Используйте `present` для создания или обновления кластера и `absent` для его удаления.
storage_accounts список / элементы=строка				Список хранилищ данных в кластере.
	container строка			Контейнер в хранилище данных.
	is_default строка			Является ли хранилище данных хранилищем по умолчанию.
	key строка			Ключ доступа к хранилищу данных.
	name строка			Конечная точка хранилища BLOB. Например, storage_account_name.blob.core.windows.net.
subscription_id строка				Ваш идентификатор подписки Azure.
tags словарь				Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены с предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false.
tenant строка				Идентификатор Azure-аренды. Используйте при аутентификации с принципалом службы.
tier строка			Варианты: стандартный премиум	Уровень кластера.

Примечания

Примечание

Для аутентификации с Azure вы можете передавать параметры, задавать переменные среды, использовать профиль, хранящийся в файле ~/.azure/credentials, или выполнить вход перед запуском задач или книги Play с 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: Create instance of HDInsight Cluster
  azure_rm_hdinsightcluster:
    resource_group: myResourceGroup
    name: myCluster
    location: eastus2
    cluster_version: 3.6
    os_type: linux
    tier: standard
    cluster_definition:
      kind: spark
      gateway_rest_username: http-user
      gateway_rest_password: MuABCPassword!!@123
    storage_accounts:
      - name: myStorageAccount.blob.core.windows.net
        is_default: yes
        container: myContainer
        key: GExmaxH4lDNdHA9nwAsCt8t4AOQas2y9vXQP1kKALTram7Q3/5xLVIab3+nYG1x63Xyak9/VXxQyNBHA9pDWw==
    compute_profile_roles:
      - name: headnode
        target_instance_count: 2
        hardware_profile:
          vm_size: Standard_D3
        linux_profile:
          username: sshuser
          password: MuABCPassword!!@123
      - name: workernode
        target_instance_count: 2
        vm_size: Standard_D3
        linux_profile:
          username: sshuser
          password: MuABCPassword!!@123

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

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

Ключ	Возвращаемое значение	Описание
id строка	всегда	Полный квалифицированный идентификатор ресурса кластера. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HDInsight/clusters/myCluster

Авторы

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/azure/azcollection/azure_rm_hdinsightcluster_module.html