azure_rm_virtualmachinescalesetinstance – Получение фактов экземпляра группы масштабирования виртуальных машин 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 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды 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. |
| instance_id - / обязательно | Идентификатор экземпляра виртуальной машины. | |
| latest_model логическое |
| Установите в значение yes для обновления до последней модели. |
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципала службы. | |
| power_state - / обязательно |
| Используйте этот параметр для изменения состояния питания экземпляра. |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - / обязательно | Имя группы ресурсов. | |
| secret строка | Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы. | |
| state - |
| Состояние экземпляра VMSS. Используйте present для обновления экземпляра и absent для удаления экземпляра. |
| subscription_id строка | Идентификатор вашей Azure-подписки. | |
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы. | |
| vmss_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: Upgrade instance to the latest image
azure_rm_virtualmachinescalesetinstance:
resource_group: myResourceGroup
vmss_name: myVMSS
instance_id: "2"
latest_model: yes
Значения возврата
Общие значения возврата описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| instances сложный | всегда | Список экземпляров. | |
| id строка | всегда | Идентификатор ресурса экземпляра. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.Compute/scalesets/myscaleset/vms/myvm | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/azure_rm_virtualmachinescalesetinstance_module.html
