Модуль azure.azcollection.azure_rm_virtualnetworkgateway – Управление шлюзами Azure виртуальных сетей

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_virtualnetworkgateway.

Новая функция в azure.azcollection 0.0.1

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

Обзор

Создание, обновление или удаление шлюза виртуальной сети (шлюза VPN).
При создании шлюза VPN необходимо указать имя существующей виртуальной сети.

Требования

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

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.
api_profile строка добавлен в azure.azcollection 0.0.1	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
append_tags логическое	Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
auth_source строка добавлен в azure.azcollection 0.0.1	Управление источником учетных данных для аутентификации. Также может быть задан через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (по умолчанию) приоритет модульных параметров -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные будут читаться из переменных среды. При значении `credential_file`, профиль будет читаться из `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для указания идентификатора подписки, если их несколько; в противном случае используется стандартная подписка az cli. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
bgp_settings словарь	Настройки BGP-спикера виртуального шлюза.
asn целое число / обязательно	ASN BGP-спикера.
cert_validation_mode строка добавлен в azure.azcollection 0.0.1	Контролирует поведение проверки сертификатов для Azure-точек конечных. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала или управляемой учетной записи (msi). Также может быть установлен через переменную среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлен в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery логическое добавлен в azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляра при попытке аутентификации. Установка в true полностью отключит как обнаружение экземпляра, так и проверку полномочий. Эта функция предназначена для использования в сценариях, где конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных полномочий с https://login.microsoft.com/ для проверки полномочий. Установив это в True, проверка полномочий отключается. Поэтому крайне важно убедиться, что указанный хост полномочий действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
enable_bgp логическое	Включено ли BGP для данного виртуального шлюза. Варианты: `false` ← (по умолчанию) `true`
gateway_type строка	Тип виртуального шлюза. Варианты: `"vpn"` ← (по умолчанию) `"express_route"`
ip_configurations список / элементы=словарь	Список IP-конфигураций.

name строка / обязательно	Имя конфигурации IP.
private_ip_allocation_method строка	Метод выделения частного IP-адреса. Варианты: `"Dynamic"` ← (по умолчанию) `"Static"`
public_ip_address_name строка	Имя общедоступного IP-адреса. Используйте ‘None’, чтобы отключить общедоступный IP-адрес.
subnet строка	Идентификатор подсети шлюза VPN.
location строка	Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.
log_mode строка	Аргумент родительского уровня.
log_path строка	Аргумент родительского уровня.
name строка / обязательно	Имя шлюза VPN.
password строка	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы.
profile строка	Профиль безопасности, находящийся в файле ~/.azure/credentials.
resource_group строка / обязательно	Имя группы ресурсов, в которой существует или будет создан шлюз VPN.
secret строка	Секретный ключ клиента Azure. Используется при аутентификации с главным принципом службы.
sku строка	Ссылка на ресурс VirtualNetworkGatewaySku, представляющий выбранный SKU для виртуального сетевого шлюза. Варианты: `"VpnGw1"` ← (по умолчанию) `"VpnGw2"` `"VpnGw3"` `"Standard"` `"Basic"` `"HighPerformance"`
state строка	Состояние шлюза VPN. Используйте `present` для создания или обновления шлюза VPN и `absent` для удаления шлюза VPN. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id строка	Ваш идентификатор подписки Azure.
tags словарь	Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите значение параметра append_tags в false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.
tenant строка	Идентификатор клиента Azure. Используется при аутентификации с главным принципом службы.
thumbprint строка добавлен в azure.azcollection 1.14.0	Отпечаток цифрового сертификата закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с главным принципом службы. Требуется, если определен параметр x509_certificate_path.
virtual_network псевдонимы: virtual_network_name любой	Существующая виртуальная сеть, с которой будет связан шлюз VPN. Обязательно при создании шлюза VPN. Может быть именем виртуальной сети. Должен находиться в той же группе ресурсов, что и шлюз VPN, при указании имени. Может быть идентификатором ресурса виртуальной сети. Может быть словарем, содержащим name и resource_group виртуальной сети. Обязательно при создании.
vpn_gateway_generation строка	Поколение для этого VirtualNetworkGateway. Должно быть `None`, если `gateway_type` не является VPN. Варианты: `"None"` `"Generation1"` ← (по умолчанию) `"Generation2"`

vpn_type string	Тип этой виртуальной частной сети. Выбор: `"route_based"` ← (по умолчанию) `"policy_based"`
x509_certificate_path path добавлен в azure.azcollection 1.14.0	Путь к сертификату X509, используемому для создания управляющего принципа в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью управляющего принципа.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, задавать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или выполнить вход перед запуском задач или playbook с помощью 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 gateway without bgp settings
  azure_rm_virtualnetworkgateway:
    resource_group: myResourceGroup
    name: myVirtualNetworkGateway
    ip_configurations:
      - name: testipconfig
        private_ip_allocation_method: Dynamic
        public_ip_address_name: testipaddr
    virtual_network: myVirtualNetwork
    tags:
      common: "xyz"

- name: Create virtual network gateway Generation2
  azure_rm_virtualnetworkgateway:
    resource_group: myResourceGroup
    name: myVirtualNetworkGateway
    sku: vpn_gw2
    vpn_gateway_generation: Generation2
    ip_configurations:
      - name: testipconfig
        private_ip_allocation_method: Dynamic
        public_ip_address_name: testipaddr
    virtual_network: myVirtualNetwork
    tags:
      common: "xyz"

- name: Create virtual network gateway with bgp
  azure_rm_virtualnetworkgateway:
    resource_group: myResourceGroup
    name: myVirtualNetworkGateway
    sku: vpn_gw1
    ip_configurations:
      - name: testipconfig
        private_ip_allocation_method: Dynamic
        public_ip_address_name: testipaddr
    enable_bgp: true
    virtual_network: myVirtualNetwork
    bgp_settings:
      asn: 65515
      bgp_peering_address: "169.254.54.209"
    tags:
      common: "xyz"

- name: Delete instance of virtual network gateway
  azure_rm_virtualnetworkgateway:
    resource_group: myResourceGroup
    name: myVirtualNetworkGateway
    state: absent

Значения возврата

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

Ключ	Описание
id string	Идентификатор ресурса шлюза виртуальной сети. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworkGateways/myV irtualNetworkGateway"`

Авторы

Madhura Naniwadekar (@Madhura-CSI)

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

© 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_virtualnetworkgateway_module.html