Spec-Zone.ru › Ansible 2.7

azure_rm_trafficmanagerprofile – Управление профилем Azure Traffic Manager.

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

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

Описание

  • Создание, обновление и удаление профиля 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.
append_tags
boolean
    Варианты:
  • no
  • yes ←
Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом поле любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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.
dns_config
-
Настройки DNS профиля Traffic Manager.
relative_name
-
Относительное имя DNS, предоставленное этим профилем Traffic Manager.
Если не указано, используется имя Traffic Manager.
ttl
-
По умолчанию:
60
Время жизни DNS (TTL) в секундах.
location
-
По умолчанию:
"global"
Допустимое расположение Azure. По умолчанию «global», так как в общедоступном Azure по умолчанию профиль Traffic Manager может быть развернут только глобально.
Ссылка https://docs.microsoft.com/ru-ru/azure/traffic-manager/quickstart-create-traffic-manager-profile#create-a-traffic-manager-profile
monitor_config
-
По умолчанию:
{"path": "/", "port": 80, "protocol": "HTTP"}
Настройки мониторинга конечной точки профиля Traffic Manager.
interval
-
Интервал мониторинга конечных точек в этом профиле в секундах.
path
-
Путь, относящийся к домену конечной точки, используемый для проверки работоспособности конечной точки.
port
-
TCP-порт, используемый для проверки работоспособности конечной точки.
protocol
-
    Варианты:
  • HTTP
  • HTTPS
  • TCP
Протокол (HTTP, HTTPS или TCP), используемый для проверки работоспособности конечной точки.
timeout
-
Таймаут мониторинга конечных точек в этом профиле в секундах.
tolerated_failures
-
Количество последовательных неудачных проверок работоспособности перед тем, как конечная точка в этом профиле будет объявлена неработоспособной после следующей неудачной проверки.
name
- / обязательно
Имя профиля Traffic Manager.
password
-
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile
-
Профиль безопасности, найденный в файле ~/.azure/credentials.
profile_status
-
    Варианты:
  • enabled ←
  • disabled
Статус профиля Traffic Manager.
resource_group
- / обязательно
Имя группы ресурсов, в которой существует или будет создан профиль Traffic Manager.
routing_method
-
    Варианты:
  • performance ←
  • priority
  • weighted
  • geographic
Метод маршрутизации трафика профиля Traffic Manager.
secret
-
Секрет Azure клиента. Используйте при аутентификации с Сервисным принципалом.
state
-
    Варианты:
  • absent
  • present ←
Утверждение состояния профиля Traffic Manager. Используйте present для создания или обновления профиля Traffic Manager и absent для его удаления.
subscription_id
-
Ваш идентификатор подписки Azure.
tags
-
Словарь пар строка:строка, назначаемых как метаданные объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant
-
Идентификатор Azure-аренды. Используйте при аутентификации с Сервисным принципалом.

Примечания

Примечание

  • Для аутентификации с 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

Примеры

- name: Create a Traffic Manager Profile
  azure_rm_trafficmanager:
    name: tmtest
    resource_group: tmt
    location: global
    profile_status: enabled
    routing_method: priority
    dns_config:
      relative_name: tmtest
      ttl: 60
    monitor_config:
      protocol: HTTPS
      port: 80
      path: '/'
    tags:
      Environment: Test

- name: Delete a Traffic Manager Profile
  azure_rm_trafficmanager:
    state: absent
    name: tmtest
    resource_group: tmt

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

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

Ключ Возвращаемое значение Описание
endpoints
список
 при наличии конечных точек трафик-менеджера
Список идентификаторов конечных точек, присоединенных к профилю

Пример:
['/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/externalEndpoints/e2', '/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/externalEndpoints/e1']
id
строка
 при существовании профиля трафик-менеджера
Идентификатор профиля трафик-менеджера


Статус

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

Авторы

  • 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_trafficmanagerprofile_module.html

Spec-Zone.ru

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