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

Авторы

Yunge Zhu (@yungezz)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/azure/azure_rm_virtualnetworkpeering_info_module.html