azure_rm_trafficmanagerprofile_facts – Получение фактов профиля Azure Traffic Manager
Новая в версии 2.7.
Описание
- Получение фактов для определенного профиля Azure Traffic Manager или всех профилей 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. |
| auth_source строка добавлено в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды 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 |
| Управляет поведением проверки сертификатов для 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. |
| name - | Ограничить результаты определенным профилем Traffic Manager. | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - | Группа ресурсов для поиска нужного профиля Traffic Manager. | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| subscription_id строка | Идентификатор вашей Azure-подписки. | |
| tags - | Ограничить результаты, предоставив список тегов. Формат тегов: 'ключ' или 'ключ:значение'. | |
| 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: Get facts for one Traffic Manager profile
azure_rm_trafficmanager_facts:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all Traffic Manager profiles
azure_rm_trafficmanager_facts:
- name: Get facts by tags
azure_rm_trafficmanager_facts:
tags:
- Environment:Test
Значения возврата
Общие значения возврата описаны здесь, ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| tms сложное | всегда | Список профилей Traffic Manager. | ||
| dns_config сложное | Настройки DNS профиля Traffic Manager. Пример: {'relative_name': 'testTm', 'fqdn': 'testTm.trafficmanager.net', 'ttl': 60} | |||
| endpoints список | Список конечных точек в профиле Traffic Manager. | |||
| geo_mapping список | Список стран/регионов, сопоставленных с этой конечной точкой, когда профиль имеет метод маршрутизации geographic. Пример: ['GEO-NA', 'GEO-AS'] | |||
| id строка | Полный квалифицированный идентификатор ресурса для ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan agerProfiles/tmtest/externalEndpoints/e1 | |||
| location строка | Расположение конечных точек, когда тип external_endpoints или nested_endpoints, а метод маршрутизации профиля — (performance).Пример: East US | |||
| min_child_endpoints целое число | Минимальное количество конечных точек, которые должны быть доступны в дочернем профиле, чтобы сделать доступным родительский профиль. Пример: 3 | |||
| name строка | Имя конечной точки. Пример: e1 | |||
| priority строка | Приоритет этой конечной точки, когда профиль имеет метод маршрутизации priority. Пример: 3 | |||
| status строка | Статус конечной точки. Пример: Enabled | |||
| target строка | Полное доменное имя конечной точки. Пример: 8.8.8.8 | |||
| target_resource_id строка | URI ресурса Azure для конечной точки. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/dom ainNames/vscjavaci | |||
| type строка | Тип конечной точки. Пример: external_endpoints | |||
| weight целое число | Вес этой конечной точки, когда у профиля метод маршрутизации weighted. Пример: 10 | |||
| location строка | Расположение профиля Traffic Manager. Пример: global | |||
| monitor_config сложное | Настройки мониторинга конечных точек профиля Traffic Manager. | |||
| interval целое число | Интервал мониторинга конечных точек в этом профиле в секундах. Пример: 10 | |||
| path строка | Путь, относящийся к доменному имени конечной точки, используемый для проверки состояния конечной точки. Пример: / | |||
| port целое число | TCP-порт, используемый для проверки состояния конечной точки. Пример: 80 | |||
| protocol строка | Протокол (HTTP, HTTPS или TCP), используемый для проверки состояния конечной точки. Пример: HTTP | |||
| timeout целое число | Таймаут мониторинга конечных точек в этом профиле в секундах. Пример: 30 | |||
| tolerated_failures целое число | Количество последовательных неудачных проверок состояния, прежде чем конечная точка будет считаться Неисправной после следующей неудачной проверки. Пример: 3 | |||
| name строка | всегда | Имя профиля Traffic Manager. Пример: testTm | ||
| profile_status строка | Статус профиля Traffic Manager. Пример: Enabled | |||
| resource_group строка | всегда | Имя группы ресурсов, в которой существует профиль Traffic Manager. Пример: testGroup | ||
| routing_method строка | Метод маршрутизации трафика профиля Traffic Manager. Пример: performance | |||
| state строка | Состояние профиля Traffic Manager. Пример: present | |||
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Хай Као (@caohai) <t-haicao@microsoft.com>
- Юнге Жу (@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_facts_module.html
