Модуль azure.azcollection.azure_rm_trafficmanagerprofile — Управление профилем Azure Traffic Manager
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в playbook, укажите: azure.azcollection.azure_rm_trafficmanagerprofile.
Добавлена в azure.azcollection 0.1.2
Описание
- Создание, обновление и удаление профиля Traffic Manager.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, выполняющем этот модуль.
- 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: |
append_tags boolean | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлено через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Choices:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Choices:
|
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**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
dns_config dictionary | Параметры DNS профиля Traffic Manager. |
|
relative_name string |
Относительное доменное имя, предоставляемое этим профилем Traffic Manager. Если не указано, будет использоваться имя Traffic Manager. |
|
ttl integer |
Время жизни DNS (TTL) в секундах. |
location string | Допустимое расположение Azure. По умолчанию используется Default: |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
monitor_config dictionary | Настройки мониторинга конечной точки профиля Traffic Manager. По умолчанию: |
|
interval integer |
Интервал мониторинга конечных точек в этом профиле в секундах. |
|
path string |
Путь, относительный к имени домена конечной точки, используемый для проверки работоспособности конечной точки. |
|
port integer |
TCP-порт, используемый для проверки работоспособности конечной точки. |
|
profile_monitor_status string |
Статус мониторинга на уровне профиля Traffic Manager. |
|
protocol string |
Протокол Доступные значения:
|
|
timeout integer |
Таймаут мониторинга конечных точек в этом профиле в секундах. |
|
tolerated_failures integer |
Количество последовательных неудачных проверок работоспособности перед тем, как конечная точка в этом профиле будет считаться неработоспособной после следующей неудачной проверки. |
name string / обязательно | Имя профиля Traffic Manager. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
profile_status string | Статус профиля Traffic Manager. Доступные значения:
|
resource_group string / обязательно | Имя группы ресурсов, в которой существует или будет создан профиль Traffic Manager. |
routing_method string | Метод маршрутизации трафика профиля Traffic Manager. Доступные значения:
|
secret string | Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала. |
state string | Утверждение состояния профиля Traffic Manager. Используйте Доступные значения:
|
subscription_id string | Ваш идентификатор подписки Azure. |
tags dictionary | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные-теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. В настоящее время Azure DNS zones и Traffic Manager services также не допускают использование пробелов в тегах. 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 added in azure.azcollection 1.14.0 | Путь к X509 сертификату, используемому для создания служебного принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью Служебного принципала. |
Примечания
Примечание
- Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или выполнить вход перед запуском задач или playbook с помощью
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: Create a Traffic Manager Profile
azure_rm_trafficmanagerprofile:
name: tmtest
resource_group: myResourceGroup
location: global
profile_status: enabled
routing_method: priority
dns_config:
relative_name: tmtest
ttl: 60
monitor_config:
protocol: HTTPS
port: 80
path: '/'
tags:
Environment: Test
- name: Delete a Traffic Manager Profile
azure_rm_trafficmanagerprofile:
state: absent
name: tmtest
resource_group: myResourceGroup
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
endpoints список / элементы=строка | Список идентификаторов конечных точек, присоединённых к профилю. Возвращается: при наличии конечных точек балансировщика трафика Пример: |
id строка | Идентификатор профиля балансировщика трафика. Возвращается: при наличии профиля балансировщика трафика Пример: |
Ссылки на коллекцию
© 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_trafficmanagerprofile_module.html