azure_rm_trafficmanagerendpoint_facts – Получение фактов о конечных точках Azure Traffic Manager

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

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

Краткое описание

Получение фактов о конкретных конечных точках 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	Варианты: 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 строка		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, или войти в систему перед выполнением задач или пьесы с помощью 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_facts:
    resource_group: myResourceGroup
    profile_name: Testing

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

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

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

Ключ		Возвращаемое значение	Описание
endpoints сложный тип		всегда	Список конечных точек 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) <t-haicao@microsoft.com>
Yunge Zhu (@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_trafficmanagerendpoint_facts_module.html