Spec-Zone.ru › Ansible 2.9

azure_rm_trafficmanagerprofile_info – Получение фактов профиля Azure Traffic Manager

Новая версия 2.9.

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

Обзор

  • Получение фактов для определенного профиля Azure Traffic Manager или всех профилей Traffic Manager.

Псевдонимы: azure_rm_trafficmanagerprofile_facts

Требования

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

  • 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
    Варианты:
  • 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.
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
строка
всегда
Относительное доменное имя, предоставленное профилем 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
строка
всегда
Расположение конечных точек, когда тип=external_endpoints или тип=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.

Пример:
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
string
always
Статус профиля Traffic Manager.

Пример:
Enabled
resource_group
string
always
Имя группы ресурсов, в которой существует профиль Traffic Manager.

Пример:
testGroup
routing_method
string
always
Метод маршрутизации трафика для профиля Traffic Manager.

Пример:
performance
state
string
always
Состояние профиля Traffic Manager.

Пример:
present


Статус

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

Авторы

  • 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.9/modules/azure_rm_trafficmanagerprofile_info_module.html

Spec-Zone.ru

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