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

Примечание

Этот плагин входит в состав коллекции azure.azcollection (версия 1.3.1).

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

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

Новое в версии 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 логический тип		Варианты: no да ←	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом варианте все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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` может быть использована для определения идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az 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) в секундах.
endpoints строка			Список точек конечного доступа в профиле Traffic Manager.
	endpoint_location строка		Указывает расположение внешних или вложенных точек конечного доступа при использовании метода маршрутизации трафика «Производительность».
	endpoint_status строка	Варианты: Enabled Disabled	Статус точки конечного доступа.
	geo_mapping строка		Список стран/регионов, сопоставленных с этой точкой конечного доступа при использовании метода маршрутизации трафика «Географическое положение».
	id строка		Полный квалифицированный идентификатор ресурса для ресурса.
	min_child_endpoints строка		Минимальное количество точек конечного доступа, которые должны быть доступны в дочернем профиле для того, чтобы родительский профиль считался доступным. Применимо только к точкам конечного доступа типа «Вложенные точки конечного доступа».
	name строка / обязательно		Имя точки конечного доступа.
	priority строка		Приоритет этой точки конечного доступа при использовании метода маршрутизации трафика «Приоритет». Возможные значения от 1 до 1000, меньшие значения означают больший приоритет. Этот параметр необязателен. Если он указан, он должен быть указан для всех точек конечного доступа. Две точки конечного доступа не могут иметь одинаковое значение приоритета.
	target строка		Полное квалифицированное имя DNS точки конечного доступа.
	target_resource_id строка		Полный URI Azure Resource для точки конечного доступа. Не применимо к точкам конечного доступа типа «Внешние точки конечного доступа».
	type строка / обязательно		Тип точки конечного доступа. Пример: Microsoft.network/TrafficManagerProfiles/ExternalEndpoints.
	weight строка		Вес этой точки конечного доступа при использовании метода маршрутизации трафика «Взвешенная». Возможные значения от 1 до 1000.
location строка			Допустимое расположение Azure. По умолчанию «глобальное».
monitor_config строка		Значение по умолчанию: {"path": "/", "port": 80, "protocol": "HTTP"}	Настройки мониторинга точки конечного доступа профиля Traffic Manager.
	interval_in_seconds строка		Интервал мониторинга точек конечного доступа в этом профиле.
	path строка		Путь, относящийся к домену точки конечного доступа, используемый для проверки работоспособности точки конечного доступа.
	port строка		TCP-порт, используемый для проверки работоспособности точки конечного доступа.
	protocol строка	Варианты: HTTP HTTPS TCP	Протокол (HTTP, HTTPS или TCP), используемый для проверки работоспособности точки конечного доступа.
	timeout_in_seconds строка		Тайм-аут мониторинга для точек конечного доступа в этом профиле.
	tolerated_number_of_failures строка		Количество последовательных неудачных проверок работоспособности перед объявлением точки конечного доступа в этом профиле как недоступной после следующей неудачной проверки.
name строка / обязательно			Имя профиля Traffic Manager.
password строка			Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка			Профиль безопасности в файле ~/.azure/credentials.
profile_status строка		Варианты: Включено ← Выключено	Статус профиля Traffic Manager.
resource_group строка / обязательно			Имя группы ресурсов, в которой существует или будет создан профиль Traffic Manager.
secret строка			Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
state строка		Варианты: absent present ←	Утверждение состояния профиля Traffic Manager. Используйте `present`, чтобы создать или обновить профиль Traffic Manager, и `absent`, чтобы удалить его.
subscription_id строка			Ваш идентификатор подписки Azure.

Теги словарь		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в значение false.
арендатор строка		Идентификатор арендатора Azure. Используется при аутентификации с помощью Служебного принципа.
метод_маршрутизации_трафика строка	Варианты: Производительность ← Приоритет Весовой Географический	Метод маршрутизации трафика профиля Traffic Manager.

Примечания

Примечание

Для аутентификации в 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_trafficmanager:
    name: tmtest
    resource_group: tmt
    location: global
    profile_status: Enabled
    traffic_routing_method: Priority
    dns_config:
      relative_name: tmtest
      ttl: 60
    monitor_config:
      protocol: HTTPS
      port: 80
      path: '/'
    endpoints:
      - name: e1
        type: Microsoft.network/TrafficManagerProfiles/ExternalEndpoints
        endpoint_location: West US 2
        endpoint_status: Enabled
        priority: 2
        target: 1.2.3.4
        weight: 1
    tags:
      Environment: Test

- name: Delete a Traffic Manager Profile
  azure_rm_trafficmanager:
    state: absent
    name: tmtest
    resource_group: tmt

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
состояние словарь	всегда	Текущее состояние профиля Traffic Manager Пример: {'dns_config': {'fqdn': 'tmtest.trafficmanager.net', 'relative_name': 'tmtest', 'ttl': 60}, 'endpoints': [{'endpoint_location': 'West US 2', 'endpoint_monitor_status': 'Деградирован', 'endpoint_status': 'Включен', 'geo_mapping': None, 'id': '/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1', 'min_child_endpoints': None, 'name': 'e1', 'priority': 2, 'target': '1.2.3.4', 'target_resource_id': None, 'type': 'Microsoft.Network/trafficManagerProfiles/externalEndpoints', 'weight': 1}], 'id': '/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest', 'location': 'глобальный', 'monitor_config': {'interval_in_seconds': 30, 'path': '/', 'port': 80, 'profile_monitor_status': 'Деградирован', 'protocol': 'HTTPS', 'timeout_in_seconds': 10, 'tolerated_number_of_failures': 3}, 'name': 'tmtest', 'profile_status': 'Включен', 'tags': {'Environment': 'Тест'}, 'traffic_routing_method': 'Приоритет', 'type': 'Microsoft.Network/trafficManagerProfiles'}

Авторы

Хай Као <t-haicao@microsoft.com>

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