Spec-Zone.ru › Ansible 2.7

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

Примечания

Примечание

  • Для аутентификации с Azure вы можете передать параметры, установить переменные среды или использовать профиль, сохраненный в ~/.azure/credentials. Аутентификация возможна с помощью службы-принципала или пользователя 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 в среде.
END_OF_DOCUMENT_MARKER

Примеры

- 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. [сообщество]

Авторы

  • Hai Cao <t-haicao@microsoft.com>
  • Yunge Zhu <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.7/modules/azure_rm_trafficmanagerendpoint_module.html

Spec-Zone.ru

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