Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_trafficmanager – Управление профилем Traffic Manager.

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

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

В коллекции azure.azcollection 0.1.2

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

Описание

  • Создание, обновление и удаление профиля Traffic Manager.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

  • python >= 2.7
  • На хосте, который выполняет этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и имеет собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

append_tags

boolean

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

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.

При установке в значение auto (по умолчанию) приоритет имеет параметры модуля -> env -> credential_file -> cli.

При установке в значение env, учетные данные будут считываться из переменных среды

При установке в значение credential_file, он будет считывать профиль из ~/.azure/credentials.

При установке в значение cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации ID подписки, если присутствует более одной, в противном случае используется подписка az cli по умолчанию.

При установке в значение msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации ID подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или для Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi).

Также может быть задано через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки подлинности узла. Установив это значение в **True**, проверка подлинности узла отключается. В результате очень важно убедиться, что настроенный узел является действительным и заслуживающим доверия.

Задается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Choices:

  • false ← (default)
  • true

dns_config

dictionary

Параметры DNS профиля Traffic Manager.

relative_name

string

Относительное доменное имя, предоставленное этим профилем Traffic Manager.

Если не указано, будет использовано имя Traffic Manager

ttl

integer

Время существования DNS (TTL) в секундах.

endpoints

list / elements=dictionary

Список конечных точек в профиле Traffic Manager.

Default: []

endpoint_location

string

Указывает местоположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика «Производительность».

endpoint_monitor_status

string

Состояние мониторинга конечной точки.

endpoint_status

string

Статус конечной точки.

Варианты:

  • "Enabled"
  • "Disabled"

geo_mapping

list / elements=string

Список стран/регионов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика «Географический».

id

string

Полный квалифицированный идентификатор ресурса для ресурса.

min_child_endpoints

integer

Минимальное количество конечных точек, которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным.

Применимо только к конечным точкам типа «NestedEndpoints».

name

string

Имя конечной точки.

priority

integer

Приоритет этой конечной точки при использовании метода маршрутизации трафика «Приоритет».

Возможные значения от 1 до 1000, меньшие значения представляют более высокий приоритет.

Это необязательный параметр. Если он указан, он должен быть указан для всех конечных точек.

Две конечные точки не могут иметь одинаковое значение приоритета.

target

string

Полное доменное имя конечной точки.

target_resource_id

string

URI ресурса Azure конечной точки.

Не применимо к конечным точкам типа «ExternalEndpoints».

type

string

Тип конечной точки. Пример: Microsoft.network/TrafficManagerProfiles/ExternalEndpoints.

weight

integer

Вес этой конечной точки при использовании метода маршрутизации трафика «Взвешенная».

Возможные значения от 1 до 1000.

location

string

Допустимое расположение azure. По умолчанию «global».

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

monitor_config

dictionary

Настройки мониторинга конечных точек профиля Traffic Manager.

По умолчанию: {"path": "/", "port": 80, "protocol": "HTTP"}

interval_in_seconds

integer

Интервал мониторинга для конечных точек в этом профиле.

path

string

Путь, относительный к доменному имени конечной точки, используемый для проверки работоспособности конечной точки.

port

integer

Порт TCP, используемый для проверки работоспособности конечной точки.

profile_monitor_status

string

Статус мониторинга профиля уровня Traffic Manager.

protocol

string

Протокол (HTTP, HTTPS или TCP), используемый для проверки работоспособности конечной точки.

Варианты:

  • "HTTP"
  • "HTTPS"
  • "TCP"

timeout_in_seconds

integer

Тайм-аут мониторинга для конечных точек в этом профиле.

tolerated_number_of_failures

integer

Количество последовательных сбоев проверки работоспособности перед объявлением конечной точки в этом профиле как неудовлетворительной после следующего сбоя проверки работоспособности.

name

string / обязательно

Имя профиля Traffic Manager.

password

string

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

profile_status

string

Статус профиля Traffic Manager.

Варианты:

  • "Enabled" ← (по умолчанию)
  • "Disabled"

resource_group

string / обязательно

Имя группы ресурсов, в которой существует или будет создан профиль Traffic Manager.

secret

string

Секретный ключ Azure. Используется при аутентификации с помощью Служебного принципала.

state

string

Утверждение состояния профиля Traffic Manager. Используйте present для создания или обновления профиля Traffic Manager и absent для его удаления.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

subscription_id

string

Ваш идентификатор подписки Azure.

tags

словарь

Словарь пар ключ-значение типа строка:строка для назначения в качестве метаданных объекту.

Метаданные теги объекта будут обновлены всеми предоставленными значениями.

Чтобы удалить теги, установите опцию append_tags в значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не поддерживают использование пробелов в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используется при аутентификации с помощью Служебного принципала.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью Служебного принципала.

Требуется, если определен x509_certificate_path.

traffic_routing_method

string

Метод маршрутизации трафика профиля Traffic Manager.

Варианты:

  • "Performance" ← (по умолчанию)
  • "Priority"
  • "Weighted"
  • "Geographic"

x509_certificate_path

путь

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания служебного принципала в формате PEM.

Сертификат должен быть присоединен к закрытому ключу.

Используется при аутентификации с помощью Служебного принципала.

Примечания

Примечание

  • Для аутентификации в 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 и пароль или установите 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_trafficmanager:
    name: tmtest
    resource_group: tmt
    location: global
    profile_status: Enabled
    traffic_routing_method: Priority
    dns_config:
      relative_name: tmtest
      ttl: 60
    monitor_config:
      protocol: HTTPS
      port: 80
      path: '/'
    endpoints:
      - name: e1
        type: Microsoft.network/TrafficManagerProfiles/ExternalEndpoints
        endpoint_location: West US 2
        endpoint_status: Enabled
        priority: 2
        target: 1.2.3.4
        weight: 1
    tags:
      Environment: Test

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

Возвращаемые значения

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

Ключ

Описание

state

словарь

Текущее состояние профиля Traffic Manager

Возвращается: всегда

Пример: {"dns_config": {"fqdn": "tmtest.trafficmanager.net", "relative_name": "tmtest", "ttl": 60}, "endpoints": [{"endpoint_location": "West US 2", "endpoint_monitor_status": "Degraded", "endpoint_status": "Enabled", "geo_mapping": null, "id": "/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1", "min_child_endpoints": null, "name": "e1", "priority": 2, "target": "1.2.3.4", "target_resource_id": null, "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", "weight": 1}], "id": "/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest", "location": "global", "monitor_config": {"interval_in_seconds": 30, "path": "/", "port": 80, "profile_monitor_status": "Degraded", "protocol": "HTTPS", "timeout_in_seconds": 10, "tolerated_number_of_failures": 3}, "name": "tmtest", "profile_status": "Enabled", "tags": {"Environment": "Test"}, "traffic_routing_method": "Priority", "type": "Microsoft.Network/trafficManagerProfiles"}

Авторы

  • Hai Cao (@caohai)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_trafficmanager_module.html

Spec-Zone.ru

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