Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_trafficmanagerprofile_info — получение сведений о профилях Azure Traffic Manager

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробнее см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: azure.azcollection.azure_rm_trafficmanagerprofile_info.

Добавлено в azure.azcollection 0.1.2

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

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

  • Получение сведений об указанном профиле Traffic Manager Azure или обо всех профилях Traffic Manager.

Требования

Следующие требования должны быть выполнены на узле, выполняющем этот модуль.

  • python >= 2.7
  • На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
  • Полные инструкции по установке приведены по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используется для аутентификации по имени пользователя и паролю при наличии собственного центра ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных для аутентификации.

Также можно задать с помощью переменной окружения 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.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Определяет способ проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной окружения AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (в соответствии с Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра будут полностью отключены. Эта возможность предназначена для случаев, когда конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Обнаружение экземпляров включает получение метаданных центра с https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия.

Задается в профиле файла учетных данных или с помощью переменной окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Ограничивает результаты указанным профилем Traffic Manager.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), непосредственно используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается на токен Azure AD с использованием федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_group

string

Группа ресурсов, в которой выполняется поиск нужного профиля Traffic Manager.

secret

string

Секрет клиента Azure. Используется для аутентификации с помощью субъекта-службы.

subscription_id

string

Идентификатор вашей подписки Azure.

tags

list / элементы=string

Ограничивает результаты списком тегов. Формат тегов: «ключ» или «ключ:значение».

tenant

string

Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется для аутентификации с помощью субъекта-службы.

Обязателен, если задан параметр x509_certificate_path.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат должен быть добавлен в конец закрытого ключа.

Используется для аутентификации с помощью субъекта-службы.

Примечания

Примечание

  • Для аутентификации в Azure можно передавать параметры, задавать переменные окружения, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или сценария с помощью az login.
  • Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации с помощью субъекта-службы передайте 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.

Возвращается: всегда

allowed_endpoint_record_types

list / elements=string

Список допустимых типов записей конечных точек.

Возвращается: всегда

Пример: ["None"]

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"

max_return

integer

Максимальное количество возвращаемых конечных точек для типа маршрутизации MultiValue.

Возвращается: всегда

Пример: 10

monitor_config

complex

Параметры мониторинга конечных точек профиля Traffic Manager.

Возвращается: всегда

custom_headers

list / elements=string

Список пользовательских заголовков.

Возвращается: всегда

Пример: [{"name": "key1", "value": "value1"}, {"name": "key2", "value": "value2"}]

expected_status_code_ranges

list / elements=string

Список ожидаемых диапазонов кодов состояния.

Возвращается: всегда

Пример: [{"max": 205, "min": 200}, {"max": 222, "min": 211}]

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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_trafficmanagerprofile_info_module.html

Spec-Zone.ru

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