azure_rm_trafficmanagerendpoint_info – Получение фактов о конечной точке Azure Traffic Manager

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

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

Описание

Получение фактов о конкретной конечной точке Traffic Manager или всех конечных точках в профиле Traffic Manager.

Псевдонимы: azure_rm_trafficmanagerendpoint_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` будет следовать умолчанию по приоритету: параметры модуля -> переменные среды -> профиль по умолчанию в файле credentian `~/.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.
profile_name - / обязательно		Имя профиля Traffic Manager.
resource_group - / обязательно		Группа ресурсов для поиска нужного профиля Traffic Manager.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
subscription_id строка		Идентификатор вашей Azure-подписки.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с помощью служебного принципала.
type -	Варианты: azure_endpoints external_endpoints nested_endpoints	Тип конечной точки.

Примечания

Примечание

Для аутентификации в 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 endpoints facts of a Traffic Manager profile
  azure_rm_trafficmanagerendpoint_info:
    resource_group: myResourceGroup
    profile_name: Testing

- name: Get specific endpoint of a Traffic Manager profile
  azure_rm_trafficmanager_info:
    resource_group: myResourceGroup
    profile_name: Testing
    name: test_external_endpoint

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:

Ключ		Возвращаемое значение	Описание
endpoints complex		всегда	Список конечных точек Traffic Manager.
	enabled строка	всегда	Статус конечной точки. Пример: Enabled
	geo_mapping список	всегда	Список стран/регионов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика «Географическое расположение». Пример: ['GEO-NA', 'GEO-AS']
	location строка	всегда	Расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика «Производительность». Пример: Восточная часть США
	min_child_endpoints целое число	всегда	Минимальное количество конечных точек, которое должно быть доступно в дочернем профиле, чтобы сделать родительский профиль доступным. Пример: 3
	name строка	всегда	Имя конечной точки Traffic Manager. Пример: testendpoint
	priority строка	всегда	Приоритет этой конечной точки при использовании метода маршрутизации трафика «Приоритет». Пример: 3
	resource_group строка	всегда	Имя группы ресурсов. Пример: myResourceGroup
	target строка	всегда	Полное доменное имя конечной точки. Пример: 8.8.8.8
	target_resource_id строка	всегда	URI ресурса Azure для конечной точки. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/vscjavaci
	type строка	всегда	Тип конечной точки. Пример: external_endpoints
	weight целое число	всегда	Вес этой конечной точки при использовании метода маршрутизации трафика «С весами». Пример: 10

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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_trafficmanagerendpoint_info_module.html