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

Новая в версии 2.8.

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

Обзор

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

Требования

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

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	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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	Варианты: ignore validate	Управляет поведением проверки сертификата для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Azure client ID. Используется при аутентификации с помощью принципала службы.
cloud_environment строка добавлен в 2.4	По умолчанию: "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, или войти в систему перед запуском задач или playbook с помощью 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_facts:
    resource_group: myResourceGroup
    vmss_name: myvmss
    name: myextension

- name: List installed Virtual Machine Scale Set Extensions
  azure_rm_virtualmachineextension_facts:
    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 строка	всегда	Состояние подготовки расширения Пример: Succeeded
	publisher строка	всегда	Издатель расширения Пример: Microsoft.Azure.Extensions
	resource_group строка	всегда	Имя группы ресурсов Пример: myrg
	settings сложный	всегда	Словарь настроек, специфичных для расширения Пример: {'commandToExecute': 'hostname'}
	type строка	всегда	Тип расширения Пример: CustomScript
	vmss_name строка	всегда	Имя виртуальной машины Пример: myvmss

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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.8/modules/azure_rm_virtualmachinescalesetextension_facts_module.html