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

Новая версия с 2.7.

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

Описание

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

Требования

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

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.
append_tags логическое значение		Варианты: no да ←	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 2.5		Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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		Варианты: ignore validate	Управляет поведением проверки сертификата для 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`.
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/en-us/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, или выполнить вход перед запуском задач или 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 список	если существуют конечные точки 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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [бета-версия]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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

Подсказка

Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_trafficmanagerprofile_module.html