azure.azcollection.azure_rm_virtualnetworkpeering_info – Получение сведений об Azure виртуальных сетях

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

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

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

Добавлено в версии 0.0.1: из azure.azcollection

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в 0.0.1 of azure.azcollection		URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлено в 0.0.1 of azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для публичных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлено в 0.0.1 of 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 of azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную окружения `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 of azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную окружения `AZURE_CLOUD_ENVIRONMENT`.
name строка		Имя виртуального соединения сетей.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов, где существует vnet.
secret строка		Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
subscription_id строка		Ваш идентификатор подписки Azure.
tenant строка		Идентификатор Azure-аренды. Используйте при аутентификации с принципалом службы.
virtual_network строка / обязательно		Имя или идентификатор ресурса виртуальной сети.

Примечания

Примечание

Для аутентификации в 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 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 complex			всегда	Список фактов о взаимном подключении виртуальных сетей.
	allow_forwarded_traffic boolean		всегда	Разрешено ли передача трафика из виртуальных машин в удалённой виртуальной сети.
	allow_gateway_transit boolean		всегда	Можно ли использовать шлюзовые подключения в удалённой виртуальной сети для связи с этой виртуальной сетью.
	allow_virtual_network_access boolean		всегда	Могут ли виртуальные машины в связанном пространстве виртуальной сети получить доступ ко всем виртуальным машинам в локальном пространстве виртуальной сети.
	id string		всегда	Идентификатор текущего взаимного подключения виртуальных сетей. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/virtualNetworkPeerings/peer1
	name string		всегда	Имя взаимного подключения виртуальных сетей. Пример: myPeering
	peering_state string		всегда	Состояние взаимного подключения виртуальных сетей. Пример: Подключено
	provisioning_state string		всегда	Состояние подготовки ресурса. Пример: Успешно
	remote_address_space complex		всегда	Ссылка на адресное пространство удалённой виртуальной сети.
		address_prefixes list / elements=string	всегда	Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR. Пример: 10.1.0.0/16
	remote_virtual_network string		всегда	Идентификатор удалённой виртуальной сети для взаимного подключения. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet2
	use_remote_gateways boolean		всегда	Можно ли использовать удалённые шлюзы в этой виртуальной сети.

Авторы

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/azure/azcollection/azure_rm_virtualnetworkpeering_info_module.html