azure_rm_virtualmachine_scaleset_facts - Получение фактов о группах виртуальных машин
Новая версия 2.4.
Обзор
- Получение фактов о группе виртуальных машин
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. | |
| adfs_authority_url (добавлено в 2.6) | По умолчанию: null | 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. |
| format (добавлено в 2.6) |
| Формат возвращаемых данных. Если выбран raw, информация будет возвращена в формате raw из Azure Python SDK.Если выбран curated, структура будет идентична входным параметрам модуля azure_rm_virtualmachine_scaleset.В Ansible 2.5 и ниже факты всегда возвращаются в формате raw. |
| name | Ограничить результаты определенной группой виртуальных машин | |
| password | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. | |
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group | Группа ресурсов для поиска нужной группы виртуальных машин. | |
| secret | Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала. | |
| subscription_id | Идентификатор вашей Azure-подписки. | |
| tags (добавлено в 2.6) | Список тегов для сопоставления. | |
| tenant | Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с помощью службы-принципала или пользователя 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 в среде.
Примеры
- name: Get facts for a virtual machine scale set
azure_rm_virtualmachine_scaleset_facts:
resource_group: Testing
name: testvmss001
format: curated
- name: Get facts for all virtual networks
azure_rm_virtualmachine_scaleset_facts:
resource_group: Testing
- name: Get facts by tags
azure_rm_virtualmachine_scaleset_facts:
resource_group: Testing
tags:
- testing
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| azure_vmss список | всегда | Список групп виртуальных машин |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание модулей и поддержка для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Sertac Ozercan (@sozercan)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/azure_rm_virtualmachine_scaleset_facts_module.html
