Spec-Zone.ru › Ansible

azure.azcollection.azure_rm_virtualhubconnection_info module – Получение сведений о VirtualHub

Примечание

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

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

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

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

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

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

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

  • Получение сведений о VirtualHub.

Требования

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

  • 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

Имя подключения VirtualHub.

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 / обязательный

Имя группы ресурсов VirtualHub.

secret

string

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

subscription_id

string

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

tenant

string

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

thumbprint

string

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

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

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

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

virtual_hub_name

string / обязательный

Имя ресурса VirtualHub.

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 virtual hub connection info by name
  azure_rm_virtualhubconnection_info:
    resource_group: myResourceGroup
    virtual_hub_name: virtualHub
    name: vhubname

- name: Get virtual hub connection info by resource group
  azure_rm_virtualhubconnection_info:
    resource_group: myResourceGroup
    virtual_hub_name: virtualHub

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

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

Ключ

Описание

virtual_hub_connection

complex

Список результатов в формате dict с информацией о подключении виртуального хаба.

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

allow_hub_to_remote_vnet_transit

boolean

(Устарело) Включить транзит из хаба в удаленную VNet.

Это поле устарело и будет удалено в следующем основном выпуске версии.

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

Пример: true

allow_remote_vnet_to_use_hub_vnet_gateways

boolean

(Устарело) Разрешить удаленной VNet использовать шлюзы VNet хаба.

Это поле устарело и будет удалено в следующем основном выпуске версии.

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

Пример: true

enable_internet_security

boolean

Включить защиту в Интернете; по умолчанию она включена.

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

Пример: true

etag

string

Уникальная строка только для чтения, которая меняется при каждом обновлении ресурса.

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

Пример: "31102041-49e7-4cac-8573-aac1e1a16793"

id

string

Идентификатор ресурса.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/vhub/hubVirtualNetworkConnections/MyConnection"

name

string

Имя ресурса.

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

Пример: "MyConnection"

provisioning_state

string

Состояние подготовки ресурса подключения виртуального хаба.

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

Пример: "Succeeded"

remote_virtual_network

complex

Имя или идентификатор удаленной VNet, к которой выполняется подключение.

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

id

string

Идентификатор удаленной VNet, к которой выполняется подключение.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/testvnet"

routing_configuration

complex

Сведения о конфигурации маршрутизации

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

associated_route_table

complex

Идентификатор ресурса таблицы маршрутизации, связанной с этой конфигурацией маршрутизации.

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

id

string

Идентификатор таблицы маршрутизации.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub/hubRouteTables/rt_name"

propagated_route_tables

complex

Список идентификаторов ресурсов распространяемых таблиц маршрутизации, разделенных пробелами.

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

ids

list / elements=string

Список идентификаторов ресурсов распространяемых таблиц маршрутизации.

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

Пример: [{"id": "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub/hubRouteTables/rt_name"}]

labels

list / elements=string

Список меток распространяемых таблиц маршрутизации, разделенных пробелами.

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

Пример: ["labels1", "labels2"]

vnet_routes

complex

Имя статического маршрута, уникальное в пределах маршрута VNet.

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

static_routes

list / elements=string

Имя статического маршрута.

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

address_prefixes

list / elements=string

Список всех префиксов адресов, разделенных пробелами.

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

Пример: ["10.1.0.0/16", "10.2.0.0/16"]

name

string

Имя статического маршрутизатора.

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

Пример: "route1"

next_hop_ip_address

string

IP-адрес следующего перехода.

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

Пример: "10.0.0.65"

Авторы

  • Fred-Sun (@Fred-Sun)
  • Xu Zhang (@xuzhang3)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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_virtualhubconnection_info_module.html

Spec-Zone.ru

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