community.azure.azure_rm_virtualmachinescalesetextension_info – Получение фактов расширения Azure Virtual Machine Scale Set

Примечание

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

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

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

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

Обзор

Получение фактов расширения Azure Virtual Machine Scale Set.

Требования

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

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`.
name строка		Имя виртуального машинного расширения.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не принципала службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / требуется		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
subscription_id строка		Ваш идентификатор подписки Azure.
tenant строка		Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы.
vmss_name строка / требуется		Имя VMSS, содержащего расширение.

Примечания

Примечание

Для аутентификации в 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 information on specific Virtual Machine Scale Set Extension
  azure_rm_virtualmachineextension_info:
    resource_group: myResourceGroup
    vmss_name: myvmss
    name: myextension

- name: List installed Virtual Machine Scale Set Extensions
  azure_rm_virtualmachineextension_info:
    resource_group: myrg
    vmss_name: myvmss

Возвращаемые значения

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

Ключ		Возвращаемое значение	Описание
extensions сложный		всегда	Список словарей, содержащих факты виртуального машинного расширения.
	auto_upgrade_minor_version логическое	всегда	Флаг автоматического обновления малой версии. Пример: True
	id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/ myvmss/extensions/myextension
	name строка	всегда	Имя расширения виртуальной машины. Пример: myextension
	provisioning_state строка	всегда	Состояние подготовки расширения. Пример: Успешно
	publisher строка	всегда	Издатель расширения. Пример: Microsoft.Azure.Extensions
	resource_group строка	всегда	Имя группы ресурсов. Пример: myrg
	settings словарь	всегда	Словарь параметров, специфичных для расширения. Пример: {'commandToExecute': 'hostname'}
	type строка	всегда	Тип расширения. Пример: CustomScript
	vmss_name строка	всегда	Имя масштабируемого набора виртуальных машин. Пример: myvmss

Авторы

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_virtualmachinescalesetextension_info_module.html