azure.azcollection.azure_rm_trafficmanagerprofile – Управление профилем Azure Traffic Manager

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Чтобы использовать его в playbook, укажите: azure.azcollection.azure_rm_trafficmanagerprofile.

Новый в версии 0.1.2: коллекции azure.azcollection

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Создание, обновление и удаление профиля Traffic Manager.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user строка			Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url строка добавлено в 0.0.1 коллекции azure.azcollection			URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлено в 0.0.1 коллекции azure.azcollection		По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логическое значение		Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом поле теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 коллекции azure.azcollection		Варианты: авто ← cli credential_file env msi	Определяет источник учетных данных для аутентификации. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (по умолчанию) приоритет: параметры модуля -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные будут считываться из переменных среды. При значении `credential_file`, профиль будет считываться из `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для указания идентификатора подписки, если их несколько, в противном случае используется подписка по умолчанию Azure CLI. При значении `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлено в 0.0.1 коллекции azure.azcollection		Варианты: ignore validate	Контролирует поведение проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка			Идентификатор клиента Azure. Используйте при аутентификации со служебным принципалом.
cloud_environment строка добавлено в 0.0.1 коллекции azure.azcollection		По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
dns_config строка			Настройки DNS профиля Traffic Manager.
	relative_name строка		Относительное имя DNS, предоставляемое этим профилем Traffic Manager. Если не указано, используется имя Traffic Manager.
	ttl целое число	По умолчанию: 60	Время жизни DNS (TTL) в секундах.
location строка		По умолчанию: "global"	Действительное расположение Azure. По умолчанию `global`, так как в общедоступном облаке Azure по умолчанию профиль Traffic Manager можно развернуть только глобально. См. https://docs.microsoft.com/ru-ru/azure/traffic-manager/quickstart-create-traffic-manager-profile#create-a-traffic-manager-profile.
monitor_config строка		По умолчанию: {"path": "/", "port": 80, "protocol": "HTTP"}	Настройки мониторинга конечных точек профиля Traffic Manager.
	interval целое число		Интервал мониторинга конечных точек в этом профиле в секундах.
	path строка		Путь, относящийся к домену конечной точки, используемый для проверки работоспособности конечной точки.
	port строка		Порт TCP, используемый для проверки работоспособности конечной точки.
	protocol строка	Варианты: HTTP HTTPS TCP	Протокол `HTTP`, `HTTPS` или `TCP` используемый для проверки работоспособности конечной точки.
	timeout целое число		Таймаут мониторинга конечных точек в этом профиле в секундах.
	tolerated_failures строка		Количество последовательных неудачных проверок работоспособности перед тем, как объявить конечную точку в этом профиле Ухудшенной после следующей неудачной проверки работоспособности.
name строка / обязательно			Имя профиля Traffic Manager.
password строка			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
profile_status строка		Варианты: enabled ← disabled	Статус профиля Traffic Manager.
resource_group строка / обязательно			Имя группы ресурсов, в которой существует или будет создан профиль Traffic Manager.
routing_method строка		Варианты: performance ← priority weighted geographic	Метод маршрутизации трафика профиля Traffic Manager.
secret строка			Секрет клиента Azure. Используйте при аутентификации со служебным принципалом.
state строка		Варианты: absent present ←	Утверждение состояния профиля Traffic Manager. Используйте `present` для создания или обновления профиля Traffic Manager и `absent` для его удаления.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в false.
tenant строка			Идентификатор Azure-арендатора. Используйте при аутентификации со служебным принципалом.

Примечания

Примечание

Для аутентификации с 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: 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 список / элементы=строка	при наличии конечных точек Traffic Manager	Список идентификаторов конечных точек, привязанных к профилю. Пример: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter nalEndpoints/e2', '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter nalEndpoints/e1']
id строка	при существовании профиля Traffic Manager	Идентификатор профиля Traffic Manager. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest

Авторы

Hai Cao (@caohai)
Yunge Zhu (@yungezz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_trafficmanagerprofile_module.html