Spec-Zone.ru › Ansible 2.8

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
логическое
    Варианты:
  • нет
  • да ←
Статус конечной точки.
geo_mapping
список
Список стран/регионов, сопоставленных с этой конечной точкой, когда профиль Traffic Manager имеет routing_method geographic.
location
строка
Указывает расположение внешних или вложенных конечных точек при использовании метода маршрутизации "Performance".
min_child_endpoints
целое число
Минимальное количество доступных конечных точек в дочернем профиле, необходимое для того, чтобы родительский профиль считался доступным.
Применимо только к конечным точкам типа (nested_endpoints).
name
строка / обязательно
Имя конечной точки.
password
-
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.
priority
целое число
Приоритет этой конечной точки, когда профиль Traffic Manager имеет routing_method priority.
Возможные значения от 1 до 1000, меньшие значения означают больший приоритет.
Этот параметр необязателен. Если указан, он должен быть указан для всех конечных точек.
Две конечных точки не могут иметь одинаковое значение приоритета.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
profile_name
строка / обязательно
Имя профиля Traffic Manager, к которому присоединяются эти конечные точки.
resource_group
строка / обязательно
Имя группы ресурсов, в которой существует или будет создана конечная точка Traffic Manager.
secret
строка
Секрет клиента Azure. Используется при аутентификации с сервисным принципалом.
state
-
    Варианты:
  • отсутствует
  • есть ←
Утверждение состояния конечной точки Traffic Manager. Используйте present для создания или обновления конечной точки Traffic Manager и absent для её удаления.
subscription_id
строка
Ваш идентификатор подписки Azure.
target
строка
Полное доменное имя конечной точки.
target_resource_id
строка
Azure URI ресурса конечной точки.
Не применимо к конечным точкам типа external_endpoints.
tenant
строка
Идентификатор Azure-тенанта. Используется при аутентификации с сервисным принципалом.
type
- / обязательно
    Варианты:
  • azure_endpoints
  • external_endpoints
  • nested_endpoints
Тип конечной точки.
weight
целое число
Вес этой конечной точки, когда профиль Traffic Manager имеет routing_method 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) <t-haicao@microsoft.com>
  • Yunge Zhu (@yungezz) <yungez@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.8/modules/azure_rm_trafficmanagerendpoint_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API