Модуль azure.azcollection.azure_rm_trafficmanagerendpoint – Управление конечной точкой Azure Traffic Manager
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: azure.azcollection.azure_rm_trafficmanagerendpoint.
Новая функция в azure.azcollection 0.1.2
Обзор
- Создание, обновление и удаление конечной точки Azure 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. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для проверки подлинности. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в
Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных узла проверки подлинности из https://login.microsoft.com/ для проверки узла проверки подлинности. Установив это значение в **True**, проверка узла проверки подлинности отключается. В результате крайне важно убедиться, что настроенный узел проверяющей стороны является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
enabled boolean | Статус конечной точки. Варианты:
|
geo_mapping list / elements=string | Список стран/регионов, сопоставленных с этой конечной точкой, когда профиль диспетчера трафика имеет routing_method |
location string | Указывает местоположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика «Производительность». |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
min_child_endpoints integer | Минимальное количество конечных точек, которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке type=nested_endpoints. |
name string / required | Имя конечной точки. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
priority integer | Приоритет этой конечной точки, когда профиль диспетчера трафика имеет метод маршрутизации priority. Возможные значения — от 1 до 1000, меньшие значения представляют более высокий приоритет. Это необязательный параметр. Если указан, он должен быть указан для всех конечных точек. Никакие две конечные точки не могут иметь одно и то же значение приоритета. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
profile_name string / required | Имя профиля Traffic Manager, к которому подключена эта конечная точка. |
resource_group string / required | Имя группы ресурсов, где существует или будет создана конечная точка Traffic Manager. |
secret string | Секретный ключ клиента Azure. Используется при аутентификации с помощью субъекта безопасности. |
state string | Утверждает состояние конечной точки Traffic Manager. Используйте Варианты:
|
subscription_id string | Ваш идентификатор подписки Azure. |
target string | Полностью квалифицированное доменное имя конечной точки. |
target_resource_id string | URI ресурса Azure конечной точки. Не применимо к конечным точкам типа type=external_endpoints. |
tenant string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью субъекта безопасности. Обязательно, если определен x509_certificate_path. |
type string / required | Тип конечной точки. Варианты:
|
weight integer | Вес этой конечной точки, когда профиль диспетчера трафика имеет метод маршрутизации Возможные значения — от 1 до 1000. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания субъекта безопасности в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью субъекта безопасности. |
Примечания
Примечание
- Для аутентификации с 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 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 строка | Идентификатор конечной точки управляющего трафиком. Возвращается: при существовании конечной точки управляющего трафиком Пример: |
Ссылки на сборку
© 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_trafficmanagerendpoint_module.html