Spec-Zone.ru › Ansible 2.8

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
URL авторизации Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS.
api_profile
строка
добавлено в 2.5
 По умолчанию:
"latest"
Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags
логическое значение
    Варианты:
  • no
  • да ←
Используется для управления тем, является ли поле тегов каноническим или оно только добавляется к существующим тегам.
При каноническом представлении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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.
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
-
Количество последовательных сбоев проверки работоспособности перед тем, как конечная точка в этом профиле будет объявлена в состоянии 'Degraded' после следующего сбоя проверки работоспособности.
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, или войти в систему перед выполнением задач или playbook с 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 Traffic Manager Profile
  azure_rm_trafficmanagerprofile:
    name: tmtest
    resource_group: myResourceGroup
    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_trafficmanagerprofile:
    state: absent
    name: tmtest
    resource_group: myResourceGroup

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

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

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

Пример:
['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter nalEndpoints/e2', '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter nalEndpoints/e1']
id
строка
 если профиль traffic manager существует
Идентификатор профиля traffic manager


Статус

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

Авторы

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

Spec-Zone.ru

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