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 для удаленного подключения. Только 1 подключение может иметь этот флаг включенным. Не может быть установлено, если у виртуальной сети уже есть шлюз.
allow_virtual_network_access логическое	Варианты: нет ← да	Разрешает виртуальным машинам в удаленной виртуальной сети доступ ко всем виртуальным машинам в локальной виртуальной сети.
api_profile строка добавлен в 2.5	Значение по умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source строка добавлен в 2.5	Варианты: авто 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. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualN etwork/virtualNetworkPeerings/myPeering

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Данный модуль поддерживается сообществом 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.9/modules/azure_rm_virtualnetworkpeering_module.html