azure.azcollection.azure_rm_virtualnetworkpeering – Управление совместным доступом к виртуальным сетям Azure

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

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

Новое в версии 0.0.1: of azure.azcollection

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

Описание

Создание, обновление и удаление совместного доступа к виртуальным сетям Azure.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в 0.0.1 of azure.azcollection		URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
allow_forwarded_traffic логическое	Варианты: нет ← да	Разрешает передачу трафика из ВМ в удаленной виртуальной сети.
allow_gateway_transit логическое	Варианты: нет ← да	Разрешает виртуальной сети использовать шлюз удаленной виртуальной сети. Удаленный шлюз виртуальной сети должен иметь включенный параметр --allow-gateway-transit для удаленного совместного доступа. Только 1 совместный доступ может иметь этот флаг включенным. Не может быть установлен, если у виртуальной сети уже есть шлюз.
allow_virtual_network_access логическое	Варианты: нет ← да	Разрешает ВМ в удаленной виртуальной сети доступ ко всем ВМ в локальной виртуальной сети.
api_profile строка добавлено в 0.0.1 of azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлено в 0.0.1 of azure.azcollection	Варианты: авто ← 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 of azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или против Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 of azure.azcollection	По умолчанию: "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

Авторы

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/azure/azcollection/azure_rm_virtualnetworkpeering_module.html