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

Примечание

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

Для его установки используйте: 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		Варианты: auto ← 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	Время жизни (TTL) DNS в секундах.
endpoints строка			Список точек доступа в профиле Traffic Manager.
	endpoint_location строка		Указывает расположение внешних или вложенных точек доступа при использовании метода маршрутизации трафика «Производительность».
	endpoint_status строка	Варианты: Enabled Disabled	Статус точки доступа.
	geo_mapping строка		Список стран/регионов, сопоставленных с этой точкой доступа при использовании метода маршрутизации трафика «Географическое положение».
	id строка		Полный квалифицированный идентификатор ресурса.
	min_child_endpoints строка		Минимальное количество точек доступа, которое должно быть доступно в дочернем профиле для того, чтобы родительский профиль считался доступным. Применимо только к точкам доступа типа «Вложенные точки доступа».
	name строка / обязательно		Имя точки доступа.
	priority строка		Приоритет этой точки доступа при использовании метода маршрутизации трафика «Приоритет». Возможные значения от 1 до 1000, меньшие значения соответствуют более высокому приоритету. Это необязательный параметр. Если указан, он должен быть указан для всех точек доступа. Две точки доступа не могут иметь одинаковое значение приоритета.
	target строка		Полное доменное имя точки доступа.
	target_resource_id строка		Полный URI Azure Resource для точки доступа. Не применимо к точкам доступа типа «Внешние точки доступа».
	type строка / обязательно		Тип точки доступа. Пример - Microsoft.network/TrafficManagerProfiles/ExternalEndpoints.
	weight строка		Вес этой точки доступа при использовании метода маршрутизации трафика «Взвешенный». Возможные значения от 1 до 1000.
location строка			Действительное расположение azure. По умолчанию 'global'.
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 строка		Варианты: Enabled ← Disabled	Статус профиля Traffic Manager.
resource_group строка / обязательно			Имя группы ресурсов, в которой существует или будет создан профиль Traffic Manager.
secret строка			Секрет клиента Azure. Используйте при аутентификации с главным объектом службы.
state строка		Варианты: absent present ←	Утвердить состояние профиля Traffic Manager. Используйте `present` для создания или обновления профиля Traffic Manager и `absent` для его удаления.
subscription_id строка			Ваш идентификатор подписки Azure.

Теги словарь		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные объекта будут обновлены всеми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false.
арендатор строка		Идентификатор арендатора 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_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

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

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

Ключ	Возвращаемое	Описание
состояние словарь	всегда	Текущее состояние профиля Трафик-менеджера Пример: {'dns_config': {'fqdn': 'tmtest.trafficmanager.net', 'relative_name': 'tmtest', 'ttl': 60}, 'endpoints': [{'endpoint_location': 'Запад США 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': 'global', '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': {'Среда': 'Тест'}, 'traffic_routing_method': 'Приоритет', 'type': 'Microsoft.Network/trafficManagerProfiles'}

Авторы

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

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