azure.azcollection.azure_rm_trafficmanagerprofile_info – Получение данных профиля Azure Traffic Manager
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_trafficmanagerprofile_info.
Введено в версии 0.1.2: из azure.azcollection
Обзор
- Получение данных о конкретном профиле Azure Traffic Manager или всех профилях Traffic Manager.
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| adfs_authority_url строка добавлено в 0.0.1 из azure.azcollection | URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. | |
| api_profile строка добавлено в 0.0.1 из azure.azcollection | Значение по умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| auth_source строка добавлено в 0.0.1 из azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в значение auto (по умолчанию), приоритет имеет: параметры модуля -> env -> credential_file -> cli.При установке в env, учетные данные будут считываться из переменных средыПри установке в credential_file, профиль будет считываться из ~/.azure/credentials.При установке в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az cli.При установке в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.Параметр msi был добавлен в Ansible 2.6. |
| cert_validation_mode строка добавлено в 0.0.1 из azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси-сервера HTTPS или Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задано в файле профиля учетных данных или переменной среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с помощью сервисного принципала. | |
| cloud_environment строка добавлено в 0.0.1 из azure.azcollection | Значение по умолчанию: "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, или войти в систему перед запуском задач или книги задач с помощью
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_info:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all Traffic Manager profiles
azure_rm_trafficmanager_info:
- name: Get facts by tags
azure_rm_trafficmanager_info:
tags:
- Environment:Test
Возвращаемые значения
Общие возвращаемые значения описаны в документе, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| tms сложный | всегда | Список профилей Traffic Manager. | ||
| dns_config сложный | всегда | Настройки DNS профиля Traffic Manager. | ||
| fqdn строка | всегда | Полное доменное имя (FQDN) профиля Traffic Manager. Пример: testTm.trafficmanager.net | ||
| relative_name строка | всегда | Относительное имя DNS, предоставленное профилем Traffic Manager. Пример: testTm | ||
| ttl целое число | всегда | Время жизни DNS (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 строка | всегда | Расположение конечных точек, когда type=external_endpoints или type=nested_endpoints, и профиль routing_method=performance. Пример: Восточная часть США | ||
| min_child_endpoints целое число | всегда | Минимальное количество конечных точек, которое должно быть доступно в дочернем профиле, чтобы сделать родительский профиль доступным. Пример: 3 | ||
| name строка | всегда | Имя конечной точки. Пример: e1 | ||
| priority строка | всегда | Приоритет этой конечной точки, когда профиль имеет routing_method=priority. Пример: 3 | ||
| status строка | всегда | Статус конечной точки. Пример: Включено | ||
| 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 целое число | всегда | Вес этой конечной точки, когда профиль имеет routing_method=weighted. Пример: 10 | ||
| location строка | всегда | Расположение профиля Traffic Manager. Пример: глобальный | ||
| 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. Пример: Включено | ||
| resource_group строка | всегда | Имя группы ресурсов, в которой существует профиль Traffic Manager. Пример: testGroup | ||
| routing_method строка | всегда | Метод маршрутизации трафика профиля Traffic Manager. Пример: производительность | ||
| state строка | всегда | Состояние профиля Traffic Manager. Пример: присутствует | ||
Авторы
- Hai Cao (@caohai)
- Yunge Zhu (@yungezz)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_trafficmanagerprofile_info_module.html
