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	Значение по умолчанию: 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 -		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. Аутентификация возможна с помощью служебного принципала или пользователя 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 endpoints facts of a Traffic Manager profile
  azure_rm_trafficmanagerendpoint_facts:
    resource_group: TestRG
    profile_name: Testing

- name: Get specific endpoint of a Traffic Manager profie
  azure_rm_trafficmanager_facts:
    resource_group: TestRG
    profile_name: Testing
    name: test_external_endpoint

Значения возврата

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

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

Статус

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

Авторы

Hai Cao <t-haicao@microsoft.com>
Yunge Zhu <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_trafficmanagerendpoint_facts_module.html