azure_rm_virtualmachineextension_facts – Получение фактов о расширениях виртуальных машин Azure

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

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

Обзор

Получение фактов о расширениях виртуальных машин Azure.

Требования

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

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. Используется при аутентификации с помощью принципала службы.
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.
tags -		Ограничить результаты, предоставив список тегов. Формат тегов - 'ключ' или 'ключ:значение'.
tenant строка		Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы.
virtual_machine_name - / обязательно		Имя виртуальной машины, содержащей расширение.

Примечания

Примечание

Для аутентификации с 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 Extension
  azure_rm_virtualmachineextension_facts:
    resource_group: myResourceGroup
    virtual_machine_name: myvm
    name: myextension

- name: List installed Virtual Machine Extensions
  azure_rm_virtualmachineextension_facts:
    resource_group: myResourceGroup
    virtual_machine_name: myvm

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

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

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

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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