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

Примечание

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_trafficmanagerendpoint.

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

Создание, обновление и удаление конечной точки Azure 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.
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`.
enabled булево	Варианты: no yes ←	Статус конечной точки.
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 строка		Azure URI ресурса конечной точки. Неприменимо к конечным точкам типа 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 строка	если конечная точка управления трафиком существует	Идентификатор конечной точки управления трафиком. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficManagerProfiles/testProfil e/externalEndpoints/testendpoint

Авторы

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.10/collections/azure/azcollection/azure_rm_trafficmanagerendpoint_module.html