Модуль azure.azcollection.azure_rm_virtualmachinescalesetinstance – Получение фактов экземпляров группы виртуальных машин Azure
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_virtualmachinescalesetinstance.
Новая в azure.azcollection 0.1.2
Описание
- Получение фактов виртуальных машин из группы виртуальных машин Azure.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, на котором выполняется модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес центра проверки подлинности Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный центр проверки подлинности ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных центра проверки подлинности с https://login.microsoft.com/ для проверки центра проверки подлинности. Установив это значение в **True**, проверка центра проверки подлинности отключается. В результате крайне важно убедиться, что настроенный хост центра проверки подлинности является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
instance_id string / required | Идентификатор экземпляра виртуальной машины. |
latest_model boolean | Установите в Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
power_state string | Используйте этот параметр для изменения состояния питания экземпляра. Варианты:
|
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
protect_from_scale_in boolean | включить/выключить защиту экземпляра от масштабирования Выбоpы:
|
protect_from_scale_set_actions boolean | включить/выключить защиту экземпляра от действий масштабирования набора Выбоpы:
|
resource_group string / обязательно | Имя группы ресурсов. |
secret string | Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала. |
state string | Состояние экземпляра VMSS. Используйте Выбоpы:
|
subscription_id string | Ваш идентификатор подписки Azure. |
tenant string | Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток сертификата закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью службы-принципала. Требуется, если определено x509_certificate_path. |
vmss_name string / обязательно | Имя масштабируемого набора ВМ. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к X509 сертификату, используемому для создания службы-принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью службы-принципала. |
Примечания
Примечание
- Для аутентификации с 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.
См. также
См. также
- Авторизация с помощью Azure CLI
-
Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: Upgrade instance to the latest image
azure_rm_virtualmachinescalesetinstance:
resource_group: myResourceGroup
vmss_name: myVMSS
instance_id: "2"
latest_model: true
- name: Turn on protect from scale in
azure_rm_virtualmachinescalesetinstance:
resource_group: myResourceGroup
vmss_name: myVMSS
instance_id: "2"
protect_from_scale_in: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
instances complex | Список экземпляров. Возвращается: всегда |
|
id string |
Идентификатор ресурса экземпляра. Возвращается: всегда Пример: |
Справочные ссылки по коллекциям
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_virtualmachinescalesetinstance_module.html