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	По умолчанию: null	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	Варианты: validate ignore	Управляет поведением проверки сертификатов для 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. Аутентификация возможна с помощью служебного принципала или пользователя 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 в среде.

Примеры

- name: Get facts for one Traffic Manager profile
  azure_rm_trafficmanager_facts:
    name: Testing
    resource_group: TestRG

- 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 список		Список стран/регионов, сопоставленных с этой конечной точкой, когда профиль имеет routing_method `geographic`. Пример: ['GEO-NA', 'GEO-AS']
		id строка		Полный квалифицированный идентификатор ресурса для ресурса. Пример: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1
		location строка		Расположение конечных точек, когда тип равен `external_endpoints` или `nested_endpoints`, а метод маршрутизации профиля — (performance). Пример: Восточная часть США
		min_child_endpoints целое число		Минимальное количество конечных точек, которое должно быть доступно в дочернем профиле, чтобы сделать родительский профиль доступным. Пример: 3
		name строка		Имя конечной точки. Пример: e1
		priority строка		Приоритет этой конечной точки, когда профиль имеет метод маршрутизации `priority`. Пример: 3
		status строка		Статус конечной точки. Пример: Включено
		target строка		Полное доменное имя конечной точки. Пример: 8.8.8.8
		target_resource_id строка		URI ресурса Azure конечной точки. Пример: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/vscjavaci/providers/Microsoft.ClassicCompute/domainNames/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. Пример: performance
	state строка			Состояние профиля Traffic Manager. Пример: present

Статус

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

Авторы

Хай Као <t-haicao@microsoft.com>
Юнге Жу <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.7/modules/azure_rm_trafficmanagerprofile_facts_module.html