azure_rm_trafficmanagerendpoint – Управление конечной точкой Azure Traffic Manager

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

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

Обзор

Создание, обновление и удаление конечной точки Azure 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.
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`.
enabled булево	Варианты: no да ←	Статус конечной точки.
geo_mapping список		Список стран/регионов, сопоставленных с этой конечной точкой, когда профиль Traffic Manager имеет метод маршрутизации `geographic`.
location строка		Указывает расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика «Производительность».
min_child_endpoints целое число		Минимальное количество конечных точек, которое должно быть доступно в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечным точкам типа type=nested_endpoints.
name строка / обязательно		Имя конечной точки.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.
priority целое число		Приоритет этой конечной точки, когда у профиля Traffic Manager метод маршрутизации priority. Возможные значения от 1 до 1000, меньшие значения обозначают более высокий приоритет. Это необязательный параметр. Если указан, должен быть указан для всех конечных точек. Две конечные точки не могут иметь одинаковое значение приоритета.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
profile_name строка / обязательно		Имя профиля Traffic Manager, к которому подключена эта конечная точка.
resource_group строка / обязательно		Имя группы ресурсов, в которой существует или будет создана конечная точка Traffic Manager.
secret строка		Секрет Azure-клиента. Используется при аутентификации с помощью сервисного принципала.
state -	Варианты: absent present ←	Утверждение состояния конечной точки Traffic Manager. Используйте `present` для создания или обновления конечной точки Traffic Manager и `absent` для её удаления.
subscription_id строка		Ваш идентификатор Azure-подписки.
target строка		Полное доменное имя конечной точки.
target_resource_id строка		URI Azure-ресурса конечной точки. Неприменимо к конечным точкам типа type=external_endpoints.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала.
type - / обязательно	Варианты: azure_endpoints external_endpoints nested_endpoints	Тип конечной точки.
weight целое число		Вес этой конечной точки, когда у профиля Traffic Manager метод маршрутизации `weighted`. Возможные значения от 1 до 1000.

Примечания

Примечание

Для аутентификации с 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 endpoint for a traffic manager profile
  azure_rm_trafficmanagerendpoint:
      resource_group: testresourcegroup
      profile_name: myprofilename
      name: testendpoint1
      type: external_endpoints
      location: westus
      priority: 2
      weight: 1
      target: 1.2.3.4

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

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

Ключ	Возвращаемое значение	Описание
id строка	если конечная точка менеджера трафика существует	Идентификатор конечной точки менеджера трафика.

Статус

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

Авторы

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_trafficmanagerendpoint_module.html