Модуль azure.azcollection.azure_rm_virtualnetworkpeering_info — получение сведений о пиринге виртуальных сетей Azure

Примечание

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

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

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

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

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

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

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

Получение сведений о пиринге виртуальных сетей Azure.

Требования

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

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

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используется для аутентификации с учетной записью пользователя Active Directory, а не с субъектом-службой.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL-адрес центра Azure AD. Используется при аутентификации по имени пользователя и паролю, если у вас собственный центр ADFS.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
auth_source строка добавлено в 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 строка добавлено в azure.azcollection 0.0.1	Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав `ignore`. Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используется при аутентификации с субъектом-службой или управляемым удостоверением (msi). Также можно задать с помощью переменной окружения `AZURE_CLIENT_ID`.
cloud_environment строка добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, указывается имя среды (согласно Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery логический добавлено в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра авторизации будут полностью отключены. Эта функция предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает получение метаданных центра авторизации с https://login.microsoft.com/ для проверки центра авторизации. Если задать значение True, проверка центра авторизации будет отключена. Поэтому важно убедиться, что настроенный узел центра авторизации является допустимым и заслуживающим доверия. Значение можно задать в профиле файла учетных данных или с помощью переменной окружения `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
log_mode строка	Аргумент родительского элемента.
log_path строка	Аргумент родительского элемента.
name строка	Имя пиринга виртуальных сетей.
oidc_token строка добавлено в 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 путь добавлено в azure.azcollection 3.17.0	Путь к файлу с токеном OpenID Connect (OIDC) (JWT), используемым для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот метод часто используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения `AZURE_FEDERATED_TOKEN_FILE`.
password строка	Пароль пользователя Active Directory. Используется для аутентификации с учетной записью пользователя Active Directory, а не с субъектом-службой.
profile строка	Профиль безопасности из файла ~/.azure/credentials.
resource_group строка / обязательный	Имя группы ресурсов, в которой находится виртуальная сеть.
secret строка	Секрет клиента Azure. Используется при аутентификации с субъектом-службой.
subscription_id строка	Идентификатор вашей подписки Azure.
tenant строка	Идентификатор клиента Azure. Используется при аутентификации с субъектом-службой.
thumbprint строка добавлено в azure.azcollection 1.14.0	Отпечаток закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с субъектом-службой. Обязателен, если задан x509_certificate_path.
virtual_network любой / обязательный	Имя или идентификатор ресурса виртуальной сети.
x509_certificate_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 network peering by name
  azure_rm_virtualnetworkpeering_info:
    resource_group: myResourceGroup
    virtual_network: myVnet1
    name: myVnetPeer

- name: List virtual network peering of virtual network
  azure_rm_virtualnetworkpeering:
    resource_group: myResourceGroup
    virtual_network: myVnet1

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

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

Ключ	Описание
vnetpeerings составной тип	Список сведений о пиринге виртуальных сетей. Возвращается: всегда
allow_forwarded_traffic логический	Разрешен ли или запрещен перенаправленный трафик от виртуальных машин в удаленной виртуальной сети. Возвращается: всегда Пример: `false`
allow_gateway_transit логический	Можно ли использовать ссылки на шлюзы в удаленной виртуальной сети для подключения к этой виртуальной сети. Возвращается: всегда Пример: `false`
allow_virtual_network_access логический	Могут ли виртуальные машины в связанной виртуальной сети получать доступ ко всем виртуальным машинам в локальной виртуальной сети. Возвращается: всегда Пример: `false`
id строка	Идентификатор текущего пиринга виртуальной сети. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/virtualNetworkPeerings/peer1"`
name строка	Имя пиринга виртуальной сети. Возвращается: всегда Пример: `"myPeering"`
peering_state строка	Состояние пиринга виртуальной сети. Возвращается: всегда Пример: `"Connected"`
peering_sync_level строка	Уровень синхронизации пиринга. Возвращается: всегда Пример: `"FullyInSync"`
provisioning_state строка	Состояние подготовки ресурса. Возвращается: всегда Пример: `"Succeeded"`
remote_address_space составной тип	Ссылка на адресное пространство удаленной виртуальной сети. Возвращается: всегда
address_prefixes список / элементы=строка	Список блоков адресов в нотации CIDR, зарезервированных для этой виртуальной сети. Возвращается: всегда Пример: `["10.1.0.0/16"]`
remote_virtual_network строка	Идентификатор удаленной виртуальной сети, с которой устанавливается пиринг. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet2"`
use_remote_gateways логический	Можно ли использовать удаленные шлюзы в этой виртуальной сети. Возвращается: всегда Пример: `false`

Авторы

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_virtualnetworkpeering_info_module.html