Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

Для использования в книге задач укажите: community.azure.azure_rm_trafficmanagerendpoint_info.

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

Обзор

  • Получение фактов для конкретной конечной точки 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 могут использоваться для определения идентификатора подписки, если их несколько; в противном случае используется подписка по умолчанию из Azure 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.
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
  community.azure.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
string
всегда
Статус конечной точки.

Пример:
Enabled
geo_mapping
list / elements=string
всегда
Список стран/регионов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика «Географическое».

Пример:
['GEO-NA', 'GEO-AS']
location
string
всегда
Расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика «Производительность».

Пример:
Восточная часть США
min_child_endpoints
integer
всегда
Минимальное количество конечных точек, которое должно быть доступно в дочернем профиле, чтобы сделать родительский профиль доступным.

Пример:
3
name
string
всегда
Имя конечной точки Traffic Manager.

Пример:
testendpoint
priority
string
всегда
Приоритет этой конечной точки при использовании метода маршрутизации трафика «Приоритет».

Пример:
3
resource_group
string
всегда
Имя группы ресурсов.

Пример:
myResourceGroup
target
string
всегда
Полное доменное имя конечной точки.

Пример:
8.8.8.8
target_resource_id
string
всегда
URI ресурса Azure для конечной точки.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/vscjavaci
type
string
всегда
Тип конечной точки.

Пример:
external_endpoints
weight
integer
всегда
Вес этой конечной точки при использовании метода маршрутизации трафика «Взвешенное».

Пример:
10


Авторы

  • Hai Cao (@caohai)
  • Yunge Zhu (@yungezz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_trafficmanagerendpoint_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API