azure_rm_virtualnetworkpeering – Управление сопоставлением виртуальных сетей 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.
allow_forwarded_traffic логическое значение	Варианты: нет ← да	Разрешает пересылаемый трафик от ВМ в удаленной виртуальной сети.
allow_gateway_transit логическое значение	Варианты: нет ← да	Разрешает виртуальной сети использовать шлюз удаленной виртуальной сети. Удаленный шлюз виртуальной сети должен иметь параметр --allow-gateway-transit, включенный для удаленного сопоставления. Только одно сопоставление может иметь этот флаг включенным. Не может быть установлено, если у виртуальной сети уже есть шлюз.
allow_virtual_network_access логическое значение	Варианты: нет ← да	Разрешает ВМ в удаленной виртуальной сети доступ ко всем ВМ в локальной виртуальной сети.
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.
remote_virtual_network -		Удаленная виртуальная сеть для сопоставления. Это может быть имя удаленной виртуальной сети в том же ресурсном группе. Это может быть идентификатор ресурса удаленной виртуальной сети. Это может быть словарь, содержащий `name` и `resource_group` удаленной виртуальной сети. Необходимо при создании
resource_group - / обязательно		Имя ресурсной группы, в которой существует виртуальная сеть.
secret строка		Секретный ключ клиента Azure. Используется при аутентификации с помощью служебного принципала.
state -	Варианты: absent present ←	Утверждает состояние сопоставления виртуальных сетей. Используйте `present` для создания или обновления сопоставления и `absent` для его удаления.
subscription_id строка		Идентификатор вашей Azure-подписки.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с помощью служебного принципала.
use_remote_gateways логическое значение	Варианты: нет ← да	Если удаленные шлюзы могут быть использованы в этой виртуальной сети.
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: Create virtual network peering
  azure_rm_virtualnetworkpeering:
    resource_group: myResourceGroup
    virtual_network: myVirtualNetwork
    name: myPeering
    remote_virtual_network:
      resource_group: mySecondResourceGroup
      name: myRemoteVirtualNetwork
    allow_virtual_network_access: false
    allow_forwarded_traffic: true

- name: Delete the virtual network peering
  azure_rm_virtualnetworkpeering:
    resource_group: myResourceGroup
    virtual_network: myVirtualNetwork
    name: myPeering
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
id словарь	всегда	Идентификатор взаимного подключения виртуальных сетей Azure

Статус

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

Авторы

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