модуль azure.azcollection.azure_rm_availabilityset — управление набором доступности Azure
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_availabilityset.
Добавлено в azure.azcollection 0.1.2
Краткое описание
- Создание, обновление и удаление набора доступности Azure.
- Набор доступности нельзя обновить — вместо этого необходимо создать его заново.
- Единственная операция обновления применяется к тегам.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 2.7
- На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
- Все пакеты Python, перечисленные в requirements.txt коллекции, должны быть установлены на узле, выполняющем модули из azure.azcollection, с помощью pip
- Полные инструкции по установке можно найти здесь: https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url string добавлено в azure.azcollection 0.0.1 | URL центра сертификации Azure AD. Используйте при аутентификации по имени пользователя и паролю, если у вас есть собственный центр сертификации ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
append_tags boolean | Определяет, является ли поле тегов каноническим или новые теги добавляются к существующим. Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Можно также задать с помощью переменной окружения Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Можно также задать с помощью переменной окружения |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США: имя среды (как определено в Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Значение true полностью отключает и обнаружение экземпляра, и проверку центра сертификации. Эта функция предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра сертификации с https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра сертификации является допустимым и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной окружения Варианты:
|
location string | Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательный | Имя набора доступности. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions и Azure DevOps), где платформа напрямую предоставляет токен OIDC. Можно также задать с помощью переменной окружения |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только исходный токен. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Можно также задать с помощью переменной окружения |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
platform_fault_domain_count integer | Домены сбоя определяют группы виртуальных машин, использующих общий источник питания и сетевой коммутатор. Значение должно быть в диапазоне от По умолчанию: |
platform_update_domain_count integer | Домены обновления определяют группы виртуальных машин и базового физического оборудования, которые можно перезагрузить одновременно. По умолчанию: |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
proximity_placement_group string | Группа размещения с близким расположением, которой следует назначить набор доступности. |
resource_group string / обязательный | Имя группы ресурсов, в которой находится или будет создан набор доступности. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
sku string | Определяет, поддерживает ли набор доступности управляемые диски. Варианты:
|
state string | Задает требуемое состояние набора доступности. Используйте Варианты:
|
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар строка:строка, назначаемых объекту в качестве метаданных. Метаданные объекта будут обновлены с учетом всех предоставленных значений. Чтобы удалить теги, установите для параметра append_tags значение false. В настоящее время в зонах Azure DNS и службах Traffic Manager также нельзя использовать пробелы в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают не более 15 тегов на ресурс. |
tenant string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен следовать за закрытым ключом. Используйте при аутентификации с помощью субъекта-службы. |
Примечания
Примечание
- Для аутентификации в Azure можно передать параметры, задать переменные окружения, использовать профиль из ~/.azure/credentials или выполнить вход перед запуском задач или плейбука с помощью
az login. - Аутентификация также возможна с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации через субъект-службу передайте 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: Create an availability set with default options
azure_rm_availabilityset:
name: myAvailabilitySet
location: eastus
resource_group: myResourceGroup
- name: Create an availability set with advanced options
azure_rm_availabilityset:
name: myAvailabilitySet
location: eastus
resource_group: myResourceGroup
platform_update_domain_count: 5
platform_fault_domain_count: 3
proximity_placement_group: myProximityPlacementGroup
sku: Aligned
- name: Delete an availability set
azure_rm_availabilityset:
name: myAvailabilitySet
location: eastus
resource_group: myResourceGroup
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
changed boolean | Изменился ли ресурс Возвращается: всегда Пример: |
state complex | Текущее состояние группы доступности. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: при успешном выполнении Пример: |
|
location string |
Расположение ресурса. Возвращается: при успешном выполнении Пример: |
|
name string |
Имя ресурса. Возвращается: при успешном выполнении Пример: |
|
platform_fault_domain_count integer |
Значения доменов сбоя. Возвращается: при успешном выполнении Пример: |
|
platform_update_domain_count integer |
Значения доменов обновления. Возвращается: при успешном выполнении Пример: |
|
proximity_placement_group string |
Группа размещения с близким расположением, к которой привязана группа доступности. Возвращается: при успешном выполнении Пример: |
|
sku string |
Группа доступности поддерживает управляемые диски. Возвращается: при успешном выполнении Пример: |
|
tags dictionary |
Теги ресурса. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_availabilityset_module.html