community.azure.azure_rm_virtualnetworkpeering_info – Получение фактов о подключении Azure виртуальных сетей

Примечание

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

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

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

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

Обзор

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

Требования

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

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 строка		Имя подключения виртуальных сетей.
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
  community.azure.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/community/azure/azure_rm_virtualnetworkpeering_info_module.html