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

Примечание

Этот плагин является частью коллекции community.azure (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.azure.

Для использования в playbook, укажите: community.azure.azure_rm_trafficmanagerprofile_facts.

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

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

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.
adfs_authority_url строка добавлено в версии 0.0.1 azure.azcollection		URL-адрес узла Azure AD. Используйте при аутентификации с использованием имени пользователя/пароля и имеете собственный узел ADFS.
api_profile строка добавлено в версии 0.0.1 azure.azcollection	Значение по умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source строка добавлено в версии 0.0.1 azure.azcollection	Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `auto` (по умолчанию) приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. При установке в `env`, учетные данные будут считываться из переменных среды При установке в `credential_file`, он будет считывать профиль из `~/.azure/credentials`. При установке в `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию. При установке в `msi`, хост-машина должна быть ресурсом azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлено в версии 0.0.1 azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используйте при аутентификации с главным субъектом безопасности.
cloud_environment строка добавлено в версии 0.0.1 azure.azcollection	Значение по умолчанию: "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, или войти в систему перед выполнением задач или 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 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 complex			всегда	Список профилей Traffic Manager.
	dns_config complex		всегда	Настройки DNS профиля Traffic Manager.
		fqdn string	всегда	Полностью квалифицированное доменное имя (FQDN) профиля Traffic Manager. Пример: testTm.trafficmanager.net
		relative_name string	всегда	Относительное имя DNS, предоставленное профилем Traffic Manager. Пример: testTm
		ttl integer	всегда	Время существования DNS (TTL) в секундах. Пример: 60
	endpoints complex		всегда	Список конечных точек в профиле Traffic Manager.
		geo_mapping list / elements=string	всегда	Список стран/регионов, сопоставленных с этой конечной точкой, когда профиль имеет routing_method `geographic`. Пример: ['GEO-NA', 'GEO-AS']
		id string	всегда	Полностью квалифицированный идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan agerProfiles/tmtest/externalEndpoints/e1
		location string	всегда	Расположение конечных точек, когда type=external_endpoints или type=nested_endpoints, и профиль routing_method=performance. Пример: East US
		min_child_endpoints integer	всегда	Минимальное количество конечных точек, которые должны быть доступны во вложенном профиле, чтобы родительский профиль был доступен. Пример: 3
		name string	всегда	Имя конечной точки. Пример: e1
		priority string	всегда	Приоритет этой конечной точки, когда профиль имеет routing_method=priority. Пример: 3
		status string	всегда	Статус конечной точки. Пример: Enabled
		target string	всегда	Полностью квалифицированное доменное имя DNS конечной точки. Пример: 8.8.8.8
		target_resource_id string	всегда	URI ресурса Azure конечной точки. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/dom ainNames/vscjavaci
		type string	всегда	Тип конечной точки. Пример: external_endpoints
		weight integer	всегда	Вес этой конечной точки, когда профиль имеет routing_method=weighted. Пример: 10
	location string		всегда	Местоположение профиля Traffic Manager. Пример: global
	monitor_config complex		всегда	Настройки мониторинга конечных точек профиля Traffic Manager.
		interval integer	всегда	Интервал мониторинга для конечных точек в этом профиле в секундах. Пример: 10
		path string	всегда	Путь относительно доменного имени конечной точки, используемый для проверки работоспособности конечной точки. Пример: /
		port integer	всегда	TCP-порт, используемый для проверки работоспособности конечной точки. Пример: 80
		protocol string	всегда	Протокол `HTTP`, `HTTPS` или `TCP`, используемый для проверки работоспособности конечной точки. Пример: HTTP
		timeout integer	всегда	Тайм-аут мониторинга для конечных точек в этом профиле в секундах. Пример: 30
		tolerated_failures integer	всегда	Количество последовательных сбоев проверки работоспособности, прежде чем конечная точка будет объявлена как ухудшенная после следующего сбоя проверки работоспособности. Пример: 3
	name string		всегда	Имя профиля Traffic Manager. Пример: testTm
	profile_status string		всегда	Статус профиля Traffic Manager. Пример: Enabled
	resource_group string		всегда	Имя группы ресурсов, где существует профиль Traffic Manager. Пример: testGroup
	routing_method string		всегда	Метод маршрутизации трафика профиля Traffic Manager. Пример: performance
	state string		всегда	Состояние профиля Traffic Manager. Пример: present

Авторы

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.10/collections/community/azure/azure_rm_trafficmanagerprofile_facts_module.html