azure.azcollection.azure_rm_virtualnetworkpeering модуль — Управление соединением Azure Virtual Network Peering

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные требования, см. Требования для подробностей.

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

Новая в azure.azcollection 0.0.1

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

Описание

Создание, обновление и удаление соединения Azure Virtual Network Peering.

Требования

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

python >= 2.7
На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS.
allow_forwarded_traffic булево	Разрешает переадресованный трафик из виртуальных машин в удалённой виртуальной сети. Варианты: `false` ← (по умолчанию) `true`
allow_gateway_transit булево	Разрешает виртуальной сети использовать шлюз удалённой виртуальной сети. Удалённый шлюз виртуальной сети должен иметь –allow-gateway-transit включённым для удалённого подключения. Только 1 подключение может иметь этот флаг включенным. Не может быть установлено, если у виртуальной сети уже есть шлюз. Варианты: `false` ← (по умолчанию) `true`
allow_virtual_network_access булево	Разрешает виртуальным машинам в удалённой виртуальной сети доступ ко всем виртуальным машинам в локальной виртуальной сети. Варианты: `false` ← (по умолчанию) `true`
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`

END_OF_DOCUMENT_MARKER

пароль строка	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
профиль строка	Профиль безопасности, найденный в файле ~/.azure/credentials.
удаленная_виртуальная_сеть любой	Удаленная виртуальная сеть, с которой нужно установить подключение. Может быть именем удаленной виртуальной сети в той же группе ресурсов. Может быть идентификатором ресурса удаленной виртуальной сети. Может быть словарем, содержащим имя и группу ресурсов удаленной виртуальной сети. Требуется при создании.
группа_ресурсов строка / обязательно	Имя группы ресурсов, в которой существует виртуальная сеть.
секрет строка	Служебный секрет Azure. Используется при аутентификации с помощью служебного принципала.
состояние строка	Состояние подключения виртуальных сетей. Используйте `present` для создания или обновления подключения и `absent` для его удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
идентификатор_подписки строка	Ваш идентификатор подписки Azure.
арендатор строка	Идентификатор арендатора Azure. Используется при аутентификации с помощью служебного принципала.
отпечаток_пальца строка добавлен в azure.azcollection 1.14.0	Отпечаток пальца закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью служебного принципала. Требуется, если определен x509_certificate_path.
использовать_удаленные_шлюзы логическое	Если удаленные шлюзы могут использоваться в этой виртуальной сети. Варианты: `false` ← (по умолчанию) `true`
виртуальная_сеть любой / обязательно	Имя или идентификатор ресурса виртуальной сети, с которой нужно установить подключение.
x509_certificate_path путь добавлен в azure.azcollection 1.14.0	Путь к X509 сертификату, используемому для создания служебного принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью служебного принципала.

Примечания

Примечание

Для аутентификации в Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед выполнением задач или игры с помощью az login.
Аутентификация также возможна с помощью служебного принципала или пользователя Active Directory.
Для аутентификации через служебный принципал передайте идентификатор подписки, идентификатор клиента, секрет и арендатор или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы данные учетных данных могут храниться в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: идентификатор подписки, идентификатор клиента, секрет и арендатор или идентификатор подписки, ad_user и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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

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

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

Ключ	Описание
идентификатор строка	Идентификатор подключения виртуальных сетей Azure. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualN etwork/virtualNetworkPeerings/myPeering"`
уровень_синхронизации_подключения строка	Уровень синхронизации подключения Возвращается: всегда Пример: `"FullyInSync"`

Авторы

Yunge Zhu (@yungezz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_virtualnetworkpeering_module.html