Microsoft.Network vpnGateways 2021-03-01

Статья
05/07/2024

Определение ресурса Bicep

Тип ресурса vpnGateways можно развернуть с помощью операций, предназначенных для:

Группы ресурсов — см. команды развертывания групп ресурсов.

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Network/vpnGateways, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.Network/vpnGateways@2021-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    connections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          connectionBandwidth: int
          dpdTimeoutSeconds: int
          enableBgp: bool
          enableInternetSecurity: bool
          enableRateLimiting: bool
          ipsecPolicies: [
            {
              dhGroup: 'string'
              ikeEncryption: 'string'
              ikeIntegrity: 'string'
              ipsecEncryption: 'string'
              ipsecIntegrity: 'string'
              pfsGroup: 'string'
              saDataSizeKilobytes: int
              saLifeTimeSeconds: int
            }
          ]
          remoteVpnSite: {
            id: 'string'
          }
          routingConfiguration: {
            associatedRouteTable: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: 'string'
                }
              ]
            }
          }
          routingWeight: int
          sharedKey: 'string'
          trafficSelectorPolicies: [
            {
              localAddressRanges: [
                'string'
              ]
              remoteAddressRanges: [
                'string'
              ]
            }
          ]
          useLocalAzureIpAddress: bool
          usePolicyBasedTrafficSelectors: bool
          vpnConnectionProtocolType: 'string'
          vpnLinkConnections: [
            {
              id: 'string'
              name: 'string'
              properties: {
                connectionBandwidth: int
                egressNatRules: [
                  {
                    id: 'string'
                  }
                ]
                enableBgp: bool
                enableRateLimiting: bool
                ingressNatRules: [
                  {
                    id: 'string'
                  }
                ]
                ipsecPolicies: [
                  {
                    dhGroup: 'string'
                    ikeEncryption: 'string'
                    ikeIntegrity: 'string'
                    ipsecEncryption: 'string'
                    ipsecIntegrity: 'string'
                    pfsGroup: 'string'
                    saDataSizeKilobytes: int
                    saLifeTimeSeconds: int
                  }
                ]
                routingWeight: int
                sharedKey: 'string'
                useLocalAzureIpAddress: bool
                usePolicyBasedTrafficSelectors: bool
                vpnConnectionProtocolType: 'string'
                vpnLinkConnectionMode: 'string'
                vpnSiteLink: {
                  id: 'string'
                }
              }
            }
          ]
        }
      }
    ]
    enableBgpRouteTranslationForNat: bool
    isRoutingPreferenceInternet: bool
    natRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          externalMappings: [
            {
              addressSpace: 'string'
            }
          ]
          internalMappings: [
            {
              addressSpace: 'string'
            }
          ]
          ipConfigurationId: 'string'
          mode: 'string'
          type: 'string'
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
    vpnGatewayScaleUnit: int
  }
}

Значения свойств

vpnGateways

Имя	Описание	Значение
name	имя ресурса.	string (обязательно) Ограничение символов: 1-80 Допустимые символы: Буквенно-цифровые символы, символы подчеркивания, точки и дефисы. Начинается с буквенно-цифрового символа. Заканчивается буквенно-цифровым символом или символом подчеркивания.
location	Расположение ресурса.	строка
tags	Теги ресурсов.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Свойства VPN-шлюза.	Свойства VpnGateway

Свойства VpnGateway

Имя	Описание	Значение
bgpSettings	Параметры динамиков BGP шлюза локальной сети.	BgpSettings
connections	Список всех VPN-подключений к шлюзу.	VpnConnection[]
enableBgpRouteTranslationForNat	Включите преобразование маршрутов BGP для NAT на этом vpnGateway.	bool
isRoutingPreferenceInternet	Включите свойство Предпочтения маршрутизации для общедоступного IP-интерфейса VpnGateway.	bool
natRules	Список всех правил NAT, связанных со шлюзом.	VpnGatewayNatRule[]
virtualHub	VirtualHub, к которому принадлежит шлюз.	SubResource
vpnGatewayScaleUnit	Единица масштабирования для этого VPN-шлюза.	INT

BgpSettings

Имя	Описание	Значение
Asn	ASN говорящего BGP.	INT Ограничения: Минимальное значение = 0 Максимальное значение = 4294967295
bgpPeeringAddress	Адрес пиринга BGP и идентификатор BGP этого говорящего BGP.	строка
bgpPeeringAddresses	Адрес пиринга BGP с идентификатором IP-конфигурации для шлюза виртуальной сети.	IPConfigurationBgpPeeringAddress[]
peerWeight	Вес, добавленный к маршрутам, полученным от этого говорящего BGP.	INT

IPConfigurationBgpPeeringAddress

Имя	Описание	Значение
customBgpIpAddresses	Список пользовательских адресов пиринга BGP, которые относятся к IP-конфигурации.	string[]
ipconfigurationId	Идентификатор IP-конфигурации, которая принадлежит шлюзу.	строка

VpnConnection

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства VPN-подключения.	VpnConnectionProperties

VpnConnectionProperties

Имя	Описание	Значение
connectionBandwidth	Ожидаемая пропускная способность в Мбит/с.	INT
dpdTimeoutSeconds	Время ожидания DPD в секундах для VPN-подключения.	INT
enableBgp	Флаг EnableBgp.	bool
enableInternetSecurity	Включите безопасность в Интернете.	bool
enableRateLimiting	Флаг EnableBgp.	bool
ipsecPolicies	Политики IPSec, которые будут учитываться этим подключением.	IpsecPolicy[]
remoteVpnSite	Идентификатор подключенного vpn-сайта.	SubResource
routingConfiguration	Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.	RoutingConfiguration
routingWeight	Вес маршрутизации для VPN-подключения.	INT
sharedKey	SharedKey для VPN-подключения.	строка
trafficSelectorPolicies	Политики выбора трафика, которые будут учитываться этим подключением.	TrafficSelectorPolicy[]
useLocalAzureIpAddress	Используйте локальный IP-адрес Azure для запуска подключения.	bool
usePolicyBasedTrafficSelectors	Включите селекторы трафика на основе политик.	bool
vpnConnectionProtocolType	Протокол подключения, используемый для этого подключения.	'IKEv1' 'IKEv2'
vpnLinkConnections	Список всех подключений vpn-сайта к шлюзу.	VpnSiteLinkConnection[]

IpsecPolicy

Имя	Описание	Значение
dhGroup	Группа DH, используемая на этапе IKE 1 для начального sa.	"DHGroup1" "DHGroup14" "DHGroup2" DHGroup2048 "DHGroup24" 'ECP256' 'ECP384' None (обязательно)
ikeEncryption	Алгоритм шифрования IKE (этап 2 IKE).	'AES128' 'AES192' 'AES256' "DES" "DES3" 'GCMAES128' "GCMAES256" (обязательно)
ikeIntegrity	Алгоритм целостности IKE (этап 2 IKE).	'GCMAES128' 'GCMAES256' MD5 'SHA1' 'SHA256' SHA384 (обязательно)
ipsecEncryption	Алгоритм шифрования IPSec (этап 1 IKE).	'AES128' 'AES192' 'AES256' "DES" "DES3" 'GCMAES128' 'GCMAES192' 'GCMAES256' None (обязательно)
ipsecIntegrity	Алгоритм целостности IPSec (этап 1 IKE).	'GCMAES128' 'GCMAES192' 'GCMAES256' MD5 'SHA1' SHA256 (обязательно)
pfsGroup	Группа Pfs, используемая на этапе 2 IKE для нового дочернего SA.	'ECP256' 'ECP384' "Нет" 'PFS1' 'PFS14' 'PFS2' 'PFS2048' 'PFS24' PFSMM (обязательно)
saDataSizeKilobytes	Размер полезных данных сопоставления безопасности IPSec (также называемого быстрым режимом или этапом 2 SA) в КБ для vpn-туннеля типа "сеть — сеть".	int (обязательно)
saLifeTimeSeconds	Время существования связи безопасности IPSec (также называемое быстрым режимом или этапом 2 SA) в секундах для vpn-туннеля типа "сеть — сеть".	int (обязательно)

SubResource

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка

RoutingConfiguration

Имя	Описание	Значение
associatedRouteTable	Идентификатор ресурса RouteTable, связанный с данной routingConfiguration.	SubResource
propagatedRouteTables	Список таблиц RouteTable для объявления маршрутов.	PropagatedRouteTable
vnetRoutes	Список маршрутов, управляющих маршрутизацией из VirtualHub в подключение к виртуальной сети.	VnetRoute

PropagatedRouteTable

Имя	Описание	Значение
ids	Список идентификаторов ресурсов всех таблиц RouteTable.	SubResource[]
метки;	Список меток.	string[]

VnetRoute

Имя	Описание	Значение
staticRoutes	Список всех статических маршрутов.	StaticRoute[]

StaticRoute

Имя	Описание	Значение
addressPrefixes	Список всех префиксов адресов.	string[]
name	Имя StaticRoute, уникальное в пределах VnetRoute.	строка
nextHopIpAddress	IP-адрес следующего прыжка.	строка

TrafficSelectorPolicy

Имя	Описание	Значение
localAddressRanges	Коллекция локальных адресных пространств в формате CIDR.	string[] (обязательно)
remoteAddressRanges	Коллекция удаленных адресных пространств в формате CIDR.	string[] (обязательно)

VpnSiteLinkConnection

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства подключения к vpn-сайту.	VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Имя	Описание	Значение
connectionBandwidth	Ожидаемая пропускная способность в Мбит/с.	INT
egressNatRules	Список исходящих NatRules.	SubResource[]
enableBgp	Флаг EnableBgp.	bool
enableRateLimiting	Флаг EnableBgp.	bool
ingressNatRules	Список NatRules входящего трафика.	SubResource[]
ipsecPolicies	Политики IPSec, которые будут учитываться этим подключением.	IpsecPolicy[]
routingWeight	Вес маршрутизации для VPN-подключения.	INT
sharedKey	SharedKey для VPN-подключения.	строка
useLocalAzureIpAddress	Используйте локальный IP-адрес Azure для запуска подключения.	bool
usePolicyBasedTrafficSelectors	Включите селекторы трафика на основе политик.	bool
vpnConnectionProtocolType	Протокол подключения, используемый для этого подключения.	'IKEv1' 'IKEv2'
vpnLinkConnectionMode	Режим подключения vpn-канала.	'Default' 'InitiatorOnly' "ResponderOnly"
vpnSiteLink	Идентификатор ссылки на подключенный vpn-сайт.	SubResource

VpnGatewayNatRule

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства правила NAT VpnGateway.	VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Имя	Описание	Значение
externalMappings	Внешнее сопоставление частного IP-адреса для NAT.	VpnNatRuleMapping[]
internalMappings	Внутреннее сопоставление частных IP-адресов для NAT.	VpnNatRuleMapping[]
ipConfigurationId	Идентификатор IP-конфигурации, к которому применяется правило NAT.	строка
mode	Направление NAT источника для NAT VPN.	"EgressSnat" 'IngressSnat'
тип	Тип правила NAT для VPN NAT.	"Динамический" "Статический"

VpnNatRuleMapping

Имя	Описание	Значение
addressSpace	Адресное пространство для сопоставления Vpn NatRule.	строка

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
Создание Виртуальная глобальная сеть ресурсов	Этот шаблон позволяет создавать ресурсы виртуальной глобальной сети, включая Виртуальная глобальная сеть, виртуальный концентратор, VPN-шлюз, VPN-сайт и VPN Connecton.
Намерения и политики маршрутизации azure Виртуальная глобальная сеть	Этот шаблон подготавливает Виртуальная глобальная сеть Azure с двумя концентраторами с включенными функциями намерения и политик маршрутизации.
Развертывание azure Виртуальная глобальная сеть (vWAN) с несколькими концентраторами	Этот шаблон позволяет создать развертывание Azure Виртуальная глобальная сеть (vWAN) с несколькими концентраторами, включая все шлюзы и подключения к виртуальной сети.
Развертывание с несколькими концентраторами виртуальной глобальной сети Azure с настраиваемыми таблицами маршрутизации	Этот шаблон позволяет создать развертывание azure Виртуальная глобальная сеть (vWAN) с несколькими концентраторами, включая все шлюзы и подключения к виртуальной сети, и продемонстрировать использование таблиц маршрутизации для настраиваемой маршрутизации.

Определение ресурса шаблона ARM

Тип ресурса vpnGateways можно развернуть с помощью операций, предназначенных для:

Группы ресурсов — см. команды развертывания группы ресурсов.

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Network/vpnGateways, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Network/vpnGateways",
  "apiVersion": "2021-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "connections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "connectionBandwidth": "int",
          "dpdTimeoutSeconds": "int",
          "enableBgp": "bool",
          "enableInternetSecurity": "bool",
          "enableRateLimiting": "bool",
          "ipsecPolicies": [
            {
              "dhGroup": "string",
              "ikeEncryption": "string",
              "ikeIntegrity": "string",
              "ipsecEncryption": "string",
              "ipsecIntegrity": "string",
              "pfsGroup": "string",
              "saDataSizeKilobytes": "int",
              "saLifeTimeSeconds": "int"
            }
          ],
          "remoteVpnSite": {
            "id": "string"
          },
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "string"
                }
              ]
            }
          },
          "routingWeight": "int",
          "sharedKey": "string",
          "trafficSelectorPolicies": [
            {
              "localAddressRanges": [ "string" ],
              "remoteAddressRanges": [ "string" ]
            }
          ],
          "useLocalAzureIpAddress": "bool",
          "usePolicyBasedTrafficSelectors": "bool",
          "vpnConnectionProtocolType": "string",
          "vpnLinkConnections": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "connectionBandwidth": "int",
                "egressNatRules": [
                  {
                    "id": "string"
                  }
                ],
                "enableBgp": "bool",
                "enableRateLimiting": "bool",
                "ingressNatRules": [
                  {
                    "id": "string"
                  }
                ],
                "ipsecPolicies": [
                  {
                    "dhGroup": "string",
                    "ikeEncryption": "string",
                    "ikeIntegrity": "string",
                    "ipsecEncryption": "string",
                    "ipsecIntegrity": "string",
                    "pfsGroup": "string",
                    "saDataSizeKilobytes": "int",
                    "saLifeTimeSeconds": "int"
                  }
                ],
                "routingWeight": "int",
                "sharedKey": "string",
                "useLocalAzureIpAddress": "bool",
                "usePolicyBasedTrafficSelectors": "bool",
                "vpnConnectionProtocolType": "string",
                "vpnLinkConnectionMode": "string",
                "vpnSiteLink": {
                  "id": "string"
                }
              }
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": "bool",
    "isRoutingPreferenceInternet": "bool",
    "natRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "externalMappings": [
            {
              "addressSpace": "string"
            }
          ],
          "internalMappings": [
            {
              "addressSpace": "string"
            }
          ],
          "ipConfigurationId": "string",
          "mode": "string",
          "type": "string"
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    },
    "vpnGatewayScaleUnit": "int"
  }
}

Значения свойств

vpnGateways

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.Network/vpnGateways
версия_API	Версия API ресурсов	'2021-03-01'
name	имя ресурса.	строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые символы, символы подчеркивания, точки и дефисы. Начинается с буквенно-цифрового символа. Заканчивается буквенно-цифровым символом или символом подчеркивания.
location	Расположение ресурса.	строка
tags	Теги ресурсов.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Свойства VPN-шлюза.	Свойства VpnGateway

Свойства VpnGateway

Имя	Описание	Значение
bgpSettings	Параметры динамиков BGP шлюза локальной сети.	BgpSettings
connections	Список всех VPN-подключений к шлюзу.	VpnConnection[]
enableBgpRouteTranslationForNat	Включите преобразование маршрутов BGP для NAT в этом VpnGateway.	bool
isRoutingPreferenceInternet	Включите свойство Предпочтения маршрутизации для интерфейса общедоступного IP-адреса VpnGateway.	bool
natRules	Список всех правил NAT, связанных со шлюзом.	VpnGatewayNatRule[]
virtualHub	VirtualHub, к которому принадлежит шлюз.	SubResource
vpnGatewayScaleUnit	Единица масштабирования для этого VPN-шлюза.	INT

BgpSettings

Имя	Описание	Значение
Asn	ASN говорящего BGP.	INT Ограничения: Минимальное значение = 0 Максимальное значение = 4294967295
bgpPeeringAddress	Адрес пиринга BGP и идентификатор BGP этого говорящего BGP.	строка
bgpPeeringAddresses	Адрес пиринга BGP с идентификатором IP-конфигурации для шлюза виртуальной сети.	IPConfigurationBgpPeeringAddress[]
peerWeight	Вес, добавленный к маршрутам, полученным от этого говорящего BGP.	INT

IPConfigurationBgpPeeringAddress

Имя	Описание	Значение
customBgpIpAddresses	Список пользовательских адресов пиринга BGP, принадлежащих IP-конфигурации.	string[]
ipconfigurationId	Идентификатор IP-конфигурации, принадлежавшей шлюзу.	строка

VpnConnection

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства VPN-подключения.	Свойства VpnConnection

Свойства VpnConnection

Имя	Описание	Значение
connectionBandwidth	Ожидаемая пропускная способность в Мбит/с.	INT
dpdTimeoutSeconds	Время ожидания DPD для VPN-подключения в секундах.	INT
enableBgp	Флаг EnableBgp.	bool
enableInternetSecurity	Включите безопасность в Интернете.	bool
enableRateLimiting	Флаг EnableBgp.	bool
ipsecPolicies	Политики IPSec, которые будут учитываться этим подключением.	IpsecPolicy[]
remoteVpnSite	Идентификатор подключенного vpn-сайта.	SubResource
routingConfiguration	Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.	RoutingConfiguration
routingWeight	Вес маршрутизации для VPN-подключения.	INT
sharedKey	SharedKey для VPN-подключения.	строка
trafficSelectorPolicies	Политики выбора трафика, которые будут учитываться этим подключением.	TrafficSelectorPolicy[]
useLocalAzureIpAddress	Используйте локальный IP-адрес Azure для запуска подключения.	bool
usePolicyBasedTrafficSelectors	Включите селекторы трафика на основе политик.	bool
vpnConnectionProtocolType	Протокол подключения, используемый для этого подключения.	'IKEv1' 'IKEv2'
vpnLinkConnections	Список всех подключений vpn-сайта к шлюзу.	VpnSiteLinkConnection[]

IpsecPolicy

Имя	Описание	Значение
dhGroup	Группа DH, используемая на этапе 1 IKE для начального sa.	DHGroup1 DHGroup14 DHGroup2 DHGroup2048 DHGroup24 'ECP256' 'ECP384' None (обязательно)
ikeEncryption	Алгоритм шифрования IKE (этап 2 IKE).	'AES128' 'AES192' 'AES256' DES DES3 "GCMAES128" "GCMAES256" (обязательно)
ikeIntegrity	Алгоритм целостности IKE (этап 2 IKE).	"GCMAES128" "GCMAES256" MD5 SHA1 SHA256 SHA384 (обязательно)
ipsecEncryption	Алгоритм шифрования IPSec (этап 1 IKE).	'AES128' 'AES192' 'AES256' "DES" "DES3" 'GCMAES128' 'GCMAES192' 'GCMAES256' None (обязательно)
ipsecIntegrity	Алгоритм целостности IPSec (этап 1 IKE).	'GCMAES128' 'GCMAES192' 'GCMAES256' MD5 'SHA1' SHA256 (обязательно)
pfsGroup	Группа Pfs, используемая на этапе 2 IKE для нового дочернего SA.	'ECP256' 'ECP384' "Нет" 'PFS1' 'PFS14' 'PFS2' 'PFS2048' 'PFS24' PFSMM (обязательно)
saDataSizeKilobytes	Размер полезных данных сопоставления безопасности IPSec (также называемого быстрым режимом или этапом 2 SA) в КБ для vpn-туннеля типа "сеть — сеть".	int (обязательно)
saLifeTimeSeconds	Время существования связи безопасности IPSec (также называемое быстрым режимом или этапом 2 SA) в секундах для vpn-туннеля типа "сеть — сеть".	int (обязательно)

SubResource

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка

RoutingConfiguration

Имя	Описание	Значение
associatedRouteTable	Идентификатор ресурса RouteTable, связанный с данной routingConfiguration.	SubResource
propagatedRouteTables	Список таблиц RouteTable для объявления маршрутов.	PropagatedRouteTable
vnetRoutes	Список маршрутов, управляющих маршрутизацией из VirtualHub в подключение к виртуальной сети.	VnetRoute

PropagatedRouteTable

Имя	Описание	Значение
ids	Список идентификаторов ресурсов всех таблиц RouteTable.	SubResource[]
метки;	Список меток.	string[]

VnetRoute

Имя	Описание	Значение
staticRoutes	Список всех статических маршрутов.	StaticRoute[]

StaticRoute

Имя	Описание	Значение
addressPrefixes	Список всех префиксов адресов.	string[]
name	Имя StaticRoute, уникальное в пределах VnetRoute.	строка
nextHopIpAddress	IP-адрес следующего прыжка.	строка

TrafficSelectorPolicy

Имя	Описание	Значение
localAddressRanges	Коллекция локальных адресных пространств в формате CIDR.	string[] (обязательно)
remoteAddressRanges	Коллекция удаленных адресных пространств в формате CIDR.	string[] (обязательно)

VpnSiteLinkConnection

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства подключения к vpn-сайту.	VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Имя	Описание	Значение
connectionBandwidth	Ожидаемая пропускная способность в Мбит/с.	INT
egressNatRules	Список исходящих NatRules.	SubResource[]
enableBgp	Флаг EnableBgp.	bool
enableRateLimiting	Флаг EnableBgp.	bool
ingressNatRules	Список NatRules входящего трафика.	SubResource[]
ipsecPolicies	Политики IPSec, которые будут учитываться этим подключением.	IpsecPolicy[]
routingWeight	Вес маршрутизации для VPN-подключения.	INT
sharedKey	SharedKey для VPN-подключения.	строка
useLocalAzureIpAddress	Используйте локальный IP-адрес Azure для запуска подключения.	bool
usePolicyBasedTrafficSelectors	Включите селекторы трафика на основе политик.	bool
vpnConnectionProtocolType	Протокол подключения, используемый для этого подключения.	'IKEv1' 'IKEv2'
vpnLinkConnectionMode	Режим подключения vpn-канала.	'Default' 'InitiatorOnly' "ResponderOnly"
vpnSiteLink	Идентификатор ссылки на подключенный vpn-сайт.	SubResource

VpnGatewayNatRule

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства правила NAT VpnGateway.	VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Имя	Описание	Значение
externalMappings	Внешнее сопоставление частного IP-адреса для NAT.	VpnNatRuleMapping[]
internalMappings	Внутреннее сопоставление частных IP-адресов для NAT.	VpnNatRuleMapping[]
ipConfigurationId	Идентификатор IP-конфигурации, к которому применяется правило NAT.	строка
mode	Направление NAT источника для NAT VPN.	"EgressSnat" 'IngressSnat'
тип	Тип правила NAT для VPN NAT.	"Динамический" "Статический"

VpnNatRuleMapping

Имя	Описание	Значение
addressSpace	Адресное пространство для сопоставления Vpn NatRule.	строка

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
Создание Виртуальная глобальная сеть ресурсов	Этот шаблон позволяет создавать ресурсы виртуальной глобальной сети, включая Виртуальная глобальная сеть, виртуальный концентратор, VPN-шлюз, VPN-сайт и VPN Connecton.
Намерения и политики маршрутизации azure Виртуальная глобальная сеть	Этот шаблон подготавливает Виртуальная глобальная сеть Azure с двумя концентраторами с включенными функциями намерения и политик маршрутизации.
Развертывание azure Виртуальная глобальная сеть (vWAN) с несколькими концентраторами	Этот шаблон позволяет создать развертывание Azure Виртуальная глобальная сеть (vWAN) с несколькими концентраторами, включая все шлюзы и подключения к виртуальной сети.
Развертывание с несколькими концентраторами виртуальной глобальной сети Azure с настраиваемыми таблицами маршрутизации	Этот шаблон позволяет создать развертывание azure Виртуальная глобальная сеть (vWAN) с несколькими концентраторами, включая все шлюзы и подключения к виртуальной сети, и продемонстрировать использование таблиц маршрутизации для настраиваемой маршрутизации.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса vpnGateways можно развернуть с помощью операций, предназначенных для:

Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Network/vpnGateways, добавьте в шаблон следующую terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnGateways@2021-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      connections = [
        {
          id = "string"
          name = "string"
          properties = {
            connectionBandwidth = int
            dpdTimeoutSeconds = int
            enableBgp = bool
            enableInternetSecurity = bool
            enableRateLimiting = bool
            ipsecPolicies = [
              {
                dhGroup = "string"
                ikeEncryption = "string"
                ikeIntegrity = "string"
                ipsecEncryption = "string"
                ipsecIntegrity = "string"
                pfsGroup = "string"
                saDataSizeKilobytes = int
                saLifeTimeSeconds = int
              }
            ]
            remoteVpnSite = {
              id = "string"
            }
            routingConfiguration = {
              associatedRouteTable = {
                id = "string"
              }
              propagatedRouteTables = {
                ids = [
                  {
                    id = "string"
                  }
                ]
                labels = [
                  "string"
                ]
              }
              vnetRoutes = {
                staticRoutes = [
                  {
                    addressPrefixes = [
                      "string"
                    ]
                    name = "string"
                    nextHopIpAddress = "string"
                  }
                ]
              }
            }
            routingWeight = int
            sharedKey = "string"
            trafficSelectorPolicies = [
              {
                localAddressRanges = [
                  "string"
                ]
                remoteAddressRanges = [
                  "string"
                ]
              }
            ]
            useLocalAzureIpAddress = bool
            usePolicyBasedTrafficSelectors = bool
            vpnConnectionProtocolType = "string"
            vpnLinkConnections = [
              {
                id = "string"
                name = "string"
                properties = {
                  connectionBandwidth = int
                  egressNatRules = [
                    {
                      id = "string"
                    }
                  ]
                  enableBgp = bool
                  enableRateLimiting = bool
                  ingressNatRules = [
                    {
                      id = "string"
                    }
                  ]
                  ipsecPolicies = [
                    {
                      dhGroup = "string"
                      ikeEncryption = "string"
                      ikeIntegrity = "string"
                      ipsecEncryption = "string"
                      ipsecIntegrity = "string"
                      pfsGroup = "string"
                      saDataSizeKilobytes = int
                      saLifeTimeSeconds = int
                    }
                  ]
                  routingWeight = int
                  sharedKey = "string"
                  useLocalAzureIpAddress = bool
                  usePolicyBasedTrafficSelectors = bool
                  vpnConnectionProtocolType = "string"
                  vpnLinkConnectionMode = "string"
                  vpnSiteLink = {
                    id = "string"
                  }
                }
              }
            ]
          }
        }
      ]
      enableBgpRouteTranslationForNat = bool
      isRoutingPreferenceInternet = bool
      natRules = [
        {
          id = "string"
          name = "string"
          properties = {
            externalMappings = [
              {
                addressSpace = "string"
              }
            ]
            internalMappings = [
              {
                addressSpace = "string"
              }
            ]
            ipConfigurationId = "string"
            mode = "string"
            type = "string"
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
      vpnGatewayScaleUnit = int
    }
  })
}

Значения свойств

vpnGateways

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.Network/vpnGateways@2021-03-01"
name	имя ресурса.	строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые символы, символы подчеркивания, точки и дефисы. Начинается с буквенно-цифрового символа. Заканчивается буквенно-цифровым символом или символом подчеркивания.
location	Расположение ресурса.	строка
parent_id	Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов.	строка (обязательно)
tags	Теги ресурсов.	Словарь имен и значений тегов.
properties	Свойства VPN-шлюза.	Свойства VpnGateway

Свойства VpnGateway

Имя	Описание	Значение
bgpSettings	Параметры динамиков BGP шлюза локальной сети.	BgpSettings
connections	Список всех VPN-подключений к шлюзу.	VpnConnection[]
enableBgpRouteTranslationForNat	Включите преобразование маршрутов BGP для NAT в этом VpnGateway.	bool
isRoutingPreferenceInternet	Включите свойство Предпочтения маршрутизации для интерфейса общедоступного IP-адреса VpnGateway.	bool
natRules	Список всех правил NAT, связанных со шлюзом.	VpnGatewayNatRule[]
virtualHub	VirtualHub, к которому принадлежит шлюз.	SubResource
vpnGatewayScaleUnit	Единица масштабирования для этого VPN-шлюза.	INT

BgpSettings

Имя	Описание	Значение
Asn	ASN говорящего BGP.	INT Ограничения: Минимальное значение = 0 Максимальное значение = 4294967295
bgpPeeringAddress	Адрес пиринга BGP и идентификатор BGP этого говорящего BGP.	строка
bgpPeeringAddresses	Адрес пиринга BGP с идентификатором IP-конфигурации для шлюза виртуальной сети.	IPConfigurationBgpPeeringAddress[]
peerWeight	Вес, добавленный к маршрутам, полученным от этого говорящего BGP.	INT

IPConfigurationBgpPeeringAddress

Имя	Описание	Значение
customBgpIpAddresses	Список пользовательских адресов пиринга BGP, принадлежащих IP-конфигурации.	string[]
ipconfigurationId	Идентификатор IP-конфигурации, принадлежавшей шлюзу.	строка

VpnConnection

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства VPN-подключения.	Свойства VpnConnection

Свойства VpnConnection

Имя	Описание	Значение
connectionBandwidth	Ожидаемая пропускная способность в Мбит/с.	INT
dpdTimeoutSeconds	Время ожидания DPD для VPN-подключения в секундах.	INT
enableBgp	Флаг EnableBgp.	bool
enableInternetSecurity	Включите безопасность в Интернете.	bool
enableRateLimiting	Флаг EnableBgp.	bool
ipsecPolicies	Политики IPSec, которые будут учитываться этим подключением.	IpsecPolicy[]
remoteVpnSite	Идентификатор подключенного vpn-сайта.	SubResource
routingConfiguration	Конфигурация маршрутизации, указывающая связанные и распространяемые таблицы маршрутов для этого подключения.	RoutingConfiguration
routingWeight	Вес маршрутизации для VPN-подключения.	INT
sharedKey	SharedKey для VPN-подключения.	строка
trafficSelectorPolicies	Политики выбора трафика, которые будут учитываться этим подключением.	TrafficSelectorPolicy[]
useLocalAzureIpAddress	Используйте локальный IP-адрес Azure для запуска подключения.	bool
usePolicyBasedTrafficSelectors	Включите селекторы трафика на основе политик.	bool
vpnConnectionProtocolType	Протокол подключения, используемый для этого подключения.	"IKEv1" "IKEv2"
vpnLinkConnections	Список всех подключений vpn-сайта к шлюзу.	VpnSiteLinkConnection[]

IpsecPolicy

Имя	Описание	Значение
dhGroup	Группа DH, используемая на этапе 1 IKE для начального sa.	"DHGroup1" "DHGroup14" "DHGroup2" "DHGroup2048" "DHGroup24" "ECP256" "ECP384" "None" (обязательно)
ikeEncryption	Алгоритм шифрования IKE (этап 2 IKE).	"AES128" "AES192" "AES256" "DES" "DES3" "GCMAES128" "GCMAES256" (обязательно)
ikeIntegrity	Алгоритм целостности IKE (этап 2 IKE).	"GCMAES128" "GCMAES256" "MD5" "SHA1" "SHA256" "SHA384" (обязательно)
ipsecEncryption	Алгоритм шифрования IPSec (этап 1 IKE).	"AES128" "AES192" "AES256" "DES" "DES3" "GCMAES128" "GCMAES192" "GCMAES256" "None" (обязательно)
ipsecIntegrity	Алгоритм целостности IPSec (этап 1 IKE).	"GCMAES128" "GCMAES192" "GCMAES256" "MD5" "SHA1" "SHA256" (обязательно)
pfsGroup	Группа Pfs, используемая на этапе 2 IKE для нового дочернего SA.	"ECP256" "ECP384" "None" "PFS1" "PFS14" "PFS2" "PFS2048" "PFS24" "PFSMM" (обязательно)
saDataSizeKilobytes	Размер полезных данных сопоставления безопасности IPSec (также называемого быстрым режимом или этапом 2 SA) в КБ для vpn-туннеля типа "сеть — сеть".	int (обязательно)
saLifeTimeSeconds	Время существования связи безопасности IPSec (также называемое быстрым режимом или этапом 2 SA) в секундах для vpn-туннеля типа "сеть — сеть".	int (обязательно)

SubResource

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка

RoutingConfiguration

Имя	Описание	Значение
associatedRouteTable	Идентификатор ресурса RouteTable, связанный с данной routingConfiguration.	SubResource
propagatedRouteTables	Список таблиц RouteTable для объявления маршрутов.	PropagatedRouteTable
vnetRoutes	Список маршрутов, управляющих маршрутизацией из VirtualHub в подключение к виртуальной сети.	VnetRoute

PropagatedRouteTable

Имя	Описание	Значение
ids	Список идентификаторов ресурсов всех таблиц RouteTable.	SubResource[]
метки;	Список меток.	string[]

VnetRoute

Имя	Описание	Значение
staticRoutes	Список всех статических маршрутов.	StaticRoute[]

StaticRoute

Имя	Описание	Значение
addressPrefixes	Список всех префиксов адресов.	string[]
name	Имя StaticRoute, уникальное в пределах VnetRoute.	строка
nextHopIpAddress	IP-адрес следующего прыжка.	строка

TrafficSelectorPolicy

Имя	Описание	Значение
localAddressRanges	Коллекция локальных адресных пространств в формате CIDR.	string[] (обязательно)
remoteAddressRanges	Коллекция удаленных адресных пространств в формате CIDR.	string[] (обязательно)

VpnSiteLinkConnection

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства подключения к vpn-сайту.	VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

Имя	Описание	Значение
connectionBandwidth	Ожидаемая пропускная способность в Мбит/с.	INT
egressNatRules	Список исходящих NatRules.	SubResource[]
enableBgp	Флаг EnableBgp.	bool
enableRateLimiting	Флаг EnableBgp.	bool
ingressNatRules	Список объектов NatRules для входящего трафика.	SubResource[]
ipsecPolicies	Политики IPSec, которые будут учитываться этим подключением.	IpsecPolicy[]
routingWeight	Вес маршрутизации для VPN-подключения.	INT
sharedKey	SharedKey для VPN-подключения.	строка
useLocalAzureIpAddress	Используйте локальный IP-адрес Azure для запуска подключения.	bool
usePolicyBasedTrafficSelectors	Включите селекторы трафика на основе политик.	bool
vpnConnectionProtocolType	Протокол подключения, используемый для этого подключения.	"IKEv1" "IKEv2"
vpnLinkConnectionMode	Режим подключения vpn-канала.	"По умолчанию" "InitiatorOnly" "ResponderOnly"
vpnSiteLink	Идентификатор ссылки на подключенный vpn-сайт.	SubResource

VpnGatewayNatRule

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства правила NAT VpnGateway.	VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Имя	Описание	Значение
externalMappings	Внешнее сопоставление частного IP-адреса для NAT.	VpnNatRuleMapping[]
internalMappings	Внутреннее сопоставление частных IP-адресов для NAT.	VpnNatRuleMapping[]
ipConfigurationId	Идентификатор IP-конфигурации, к которому применяется правило NAT.	строка
mode	Направление NAT источника NAT VPN.	"EgressSnat" "IngressSnat"
тип	Тип правила NAT для NAT VPN.	"Динамическая" "Static"

VpnNatRuleMapping

Имя	Описание	Значение
addressSpace	Адресное пространство для сопоставления Vpn NatRule.	строка

Поделиться через

Microsoft.Network vpnGateways 2021-03-01

Определение ресурса Bicep

Формат ресурсов

Значения свойств

vpnGateways

Свойства VpnGateway

BgpSettings

IPConfigurationBgpPeeringAddress

VpnConnection

VpnConnectionProperties

IpsecPolicy

SubResource

RoutingConfiguration

PropagatedRouteTable

VnetRoute

StaticRoute

TrafficSelectorPolicy

VpnSiteLinkConnection

VpnSiteLinkConnectionProperties

VpnGatewayNatRule

VpnGatewayNatRuleProperties

VpnNatRuleMapping

Шаблоны быстрого запуска

Определение ресурса шаблона ARM

Формат ресурсов

Значения свойств

vpnGateways

Свойства VpnGateway

BgpSettings

IPConfigurationBgpPeeringAddress

VpnConnection

Свойства VpnConnection

IpsecPolicy

SubResource

RoutingConfiguration

PropagatedRouteTable

VnetRoute

StaticRoute

TrafficSelectorPolicy

VpnSiteLinkConnection

VpnSiteLinkConnectionProperties

VpnGatewayNatRule

VpnGatewayNatRuleProperties

VpnNatRuleMapping

Шаблоны быстрого запуска

Определение ресурса Terraform (поставщик AzAPI)

Формат ресурсов

Значения свойств

vpnGateways

Свойства VpnGateway

BgpSettings

IPConfigurationBgpPeeringAddress

VpnConnection

Свойства VpnConnection

IpsecPolicy

SubResource

RoutingConfiguration

PropagatedRouteTable

VnetRoute

StaticRoute

TrafficSelectorPolicy

VpnSiteLinkConnection

VpnSiteLinkConnectionProperties

VpnGatewayNatRule

VpnGatewayNatRuleProperties

VpnNatRuleMapping

Обратная связь

Обратная связь

Дополнительные ресурсы