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

Новая версия 2.8.

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

Описание

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлен в 2.6		URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой авторизации ADFS.
api_profile строка добавлен в 2.5	По умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлен в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При значении `cli`, учетные данные будут получены из профиля Azure CLI по умолчанию. Также можно задать через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `msi`, хост-машина должна быть ресурсом Azure с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` была добавлена в Ansible 2.6.
cert_validation_mode строка добавлен в 2.5	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment строка добавлен в 2.4	По умолчанию: "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
  azure_rm_virtualnetworkpeering_facts:
    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 логический тип		всегда	Можно ли использовать удаленные шлюзы в данной виртуальной сети.

Состояние

Данный модуль не гарантирует обратной совместимости интерфейса. [бета-версия]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.8/modules/azure_rm_virtualnetworkpeering_facts_module.html