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

Microsoft.Network vpnGateways 2023-02-01

  • Статья

Определение ресурсов Bicep

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

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

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

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

resource symbolicname 'Microsoft.Network/vpnGateways@2023-02-01' = {
  location: 'string'
  name: 'string'
  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'
            }
            inboundRouteMap: {
              id: 'string'
            }
            outboundRouteMap: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: 'string'
                }
              ]
              staticRoutesConfig: {
                vnetLocalRouteOverrideCriteria: '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'
                vpnGatewayCustomBgpAddresses: [
                  {
                    customBgpIpAddress: 'string'
                    ipConfigurationId: 'string'
                  }
                ]
                vpnLinkConnectionMode: 'string'
                vpnSiteLink: {
                  id: 'string'
                }
              }
            }
          ]
        }
      }
    ]
    enableBgpRouteTranslationForNat: bool
    isRoutingPreferenceInternet: bool
    natRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          externalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          internalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          ipConfigurationId: 'string'
          mode: 'string'
          type: 'string'
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
    vpnGatewayScaleUnit: int
  }
  tags: {
    {customized property}: 'string'
  }
}

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

BgpSettings

Имя Описание Ценность
asn ASN докладчика BGP. int

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

GatewayCustomBgpIpAddressIpConfiguration

Имя Описание Ценность
customBgpIpAddress Пользовательский объект BgpPeeringAddress, принадлежащий IpconfigurationId. строка (обязательно)
ipConfigurationId IpconfigurationId ipconfiguration, который принадлежит шлюзу. строка (обязательно)

IPConfigurationBgpPeeringAddress

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

IpsecPolicy

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

Microsoft.Network/vpnGateways

Имя Описание Ценность
местоположение Расположение ресурса. струна
имя Имя ресурса строка (обязательно)
свойства Свойства VPN-шлюза. VpnGatewayProperties
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

РаспространениеRouteTable

Имя Описание Ценность
Идентификаторы Список идентификаторов ресурсов всех маршрутов. SubResource[]
Метки Список меток. string[]

ResourceTags

Имя Описание Ценность

МаршрутизацияConfiguration

Имя Описание Ценность
associatedRouteTable Идентификатор ресурса RouteTable, связанный с этой конфигурацией маршрутизации. SubResource
inboundRouteMap Идентификатор ресурса RouteMap, связанный с этой маршрутизациейConfiguration для входящих наученных маршрутов. SubResource
outboundRouteMap Идентификатор ресурса объектаRouteMap, связанного с этой маршрутизациейConfiguration для исходящих объявленных маршрутов. SubResource
распространениеrouteTables Список маршрутов для объявления маршрутов. распространение
vnetRoutes Список маршрутов, которые управляют маршрутизацией из VirtualHub в подключение к виртуальной сети. VnetRoute

StaticRoute

Имя Описание Ценность
addressPrefixes Список всех префиксов адресов. string[]
имя Имя staticRoute, уникальное в виртуальной сети. струна
nextHopIpAddress Ip-адрес следующего прыжка. струна

StaticRoutesConfig

Имя Описание Ценность
vnetLocalRouteOverrideCriteria Параметр, определяющий, пропускается ли NVA в периферийной виртуальной сети для трафика с назначением в периферийной сети. "Содержит"
"Равно"

SubResource

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

TrafficSelectorPolicy

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

VnetRoute

Имя Описание Ценность
staticRoutes Список всех статических маршрутов. StaticRoute[]
staticRoutesConfig Конфигурация статических маршрутов в этом HubVnetConnection. StaticRoutesConfig

VpnConnection

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

VpnConnectionProperties

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

VpnGatewayNatRule

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

VpnGatewayNatRuleProperties

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

VpnGatewayProperties

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

VpnNatRuleMapping

Имя Описание Ценность
адресное пространство Адресное пространство для сопоставления Vpn NatRule. струна
portRange Диапазон портов для сопоставления Vpn NatRule. струна

VpnSiteLinkConnection

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

VpnSiteLinkConnectionProperties

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

Примеры краткого руководства

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

Bicep-файл Описание
Создание ресурсов виртуальной глобальной сети Этот шаблон позволяет создавать ресурсы виртуальной глобальной сети, включая виртуальную глобальную сеть, виртуальный концентратор, VPN-шлюз, VPN-сайт и VPN-подключение.

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

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

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

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

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

{
  "type": "Microsoft.Network/vpnGateways",
  "apiVersion": "2023-02-01",
  "name": "string",
  "location": "string",
  "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"
            },
            "inboundRouteMap": {
              "id": "string"
            },
            "outboundRouteMap": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "string"
                }
              ],
              "staticRoutesConfig": {
                "vnetLocalRouteOverrideCriteria": "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",
                "vpnGatewayCustomBgpAddresses": [
                  {
                    "customBgpIpAddress": "string",
                    "ipConfigurationId": "string"
                  }
                ],
                "vpnLinkConnectionMode": "string",
                "vpnSiteLink": {
                  "id": "string"
                }
              }
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": "bool",
    "isRoutingPreferenceInternet": "bool",
    "natRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "externalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "internalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "ipConfigurationId": "string",
          "mode": "string",
          "type": "string"
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    },
    "vpnGatewayScaleUnit": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

BgpSettings

Имя Описание Ценность
asn ASN докладчика BGP. int

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

GatewayCustomBgpIpAddressIpConfiguration

Имя Описание Ценность
customBgpIpAddress Пользовательский объект BgpPeeringAddress, принадлежащий IpconfigurationId. строка (обязательно)
ipConfigurationId IpconfigurationId ipconfiguration, который принадлежит шлюзу. строка (обязательно)

IPConfigurationBgpPeeringAddress

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

IpsecPolicy

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

Microsoft.Network/vpnGateways

Имя Описание Ценность
apiVersion Версия API '2023-02-01'
местоположение Расположение ресурса. струна
имя Имя ресурса строка (обязательно)
свойства Свойства VPN-шлюза. VpnGatewayProperties
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.Network/vpnGateways"

РаспространениеRouteTable

Имя Описание Ценность
Идентификаторы Список идентификаторов ресурсов всех маршрутов. SubResource[]
Метки Список меток. string[]

ResourceTags

Имя Описание Ценность

МаршрутизацияConfiguration

Имя Описание Ценность
associatedRouteTable Идентификатор ресурса RouteTable, связанный с этой конфигурацией маршрутизации. SubResource
inboundRouteMap Идентификатор ресурса RouteMap, связанный с этой маршрутизациейConfiguration для входящих наученных маршрутов. SubResource
outboundRouteMap Идентификатор ресурса объектаRouteMap, связанного с этой маршрутизациейConfiguration для исходящих объявленных маршрутов. SubResource
распространениеrouteTables Список маршрутов для объявления маршрутов. распространение
vnetRoutes Список маршрутов, которые управляют маршрутизацией из VirtualHub в подключение к виртуальной сети. VnetRoute

StaticRoute

Имя Описание Ценность
addressPrefixes Список всех префиксов адресов. string[]
имя Имя staticRoute, уникальное в виртуальной сети. струна
nextHopIpAddress Ip-адрес следующего прыжка. струна

StaticRoutesConfig

Имя Описание Ценность
vnetLocalRouteOverrideCriteria Параметр, определяющий, пропускается ли NVA в периферийной виртуальной сети для трафика с назначением в периферийной сети. "Содержит"
"Равно"

SubResource

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

TrafficSelectorPolicy

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

VnetRoute

Имя Описание Ценность
staticRoutes Список всех статических маршрутов. StaticRoute[]
staticRoutesConfig Конфигурация статических маршрутов в этом HubVnetConnection. StaticRoutesConfig

VpnConnection

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

VpnConnectionProperties

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

VpnGatewayNatRule

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

VpnGatewayNatRuleProperties

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

VpnGatewayProperties

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

VpnNatRuleMapping

Имя Описание Ценность
адресное пространство Адресное пространство для сопоставления Vpn NatRule. струна
portRange Диапазон портов для сопоставления Vpn NatRule. струна

VpnSiteLinkConnection

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

VpnSiteLinkConnectionProperties

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

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

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

Шаблон Описание
развертывание виртуальной глобальной сети Azure (vWAN) с несколькими центрами

развертывание в Azure		 Этот шаблон позволяет создать развертывание виртуальной глобальной сети Azure (vWAN), включая все шлюзы и подключения виртуальной сети.
развертывании нескольких концентраторов Azure vWAN с пользовательскими таблицами маршрутизации

развертывание в Azure		 Этот шаблон позволяет создать развертывание виртуальной глобальной сети Azure (vWAN), включая все шлюзы и подключения виртуальной сети, и продемонстрировать использование таблиц маршрутов для пользовательской маршрутизации.
Создание ресурсов виртуальной глобальной сети

развертывание в Azure		 Этот шаблон позволяет создавать ресурсы виртуальной глобальной сети, включая виртуальную глобальную сеть, виртуальный концентратор, VPN-шлюз, VPN-сайт и VPN-подключение.

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

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

  • групп ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnGateways@2023-02-01"
  name = "string"
  location = "string"
  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"
              }
              inboundRouteMap = {
                id = "string"
              }
              outboundRouteMap = {
                id = "string"
              }
              propagatedRouteTables = {
                ids = [
                  {
                    id = "string"
                  }
                ]
                labels = [
                  "string"
                ]
              }
              vnetRoutes = {
                staticRoutes = [
                  {
                    addressPrefixes = [
                      "string"
                    ]
                    name = "string"
                    nextHopIpAddress = "string"
                  }
                ]
                staticRoutesConfig = {
                  vnetLocalRouteOverrideCriteria = "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"
                  vpnGatewayCustomBgpAddresses = [
                    {
                      customBgpIpAddress = "string"
                      ipConfigurationId = "string"
                    }
                  ]
                  vpnLinkConnectionMode = "string"
                  vpnSiteLink = {
                    id = "string"
                  }
                }
              }
            ]
          }
        }
      ]
      enableBgpRouteTranslationForNat = bool
      isRoutingPreferenceInternet = bool
      natRules = [
        {
          id = "string"
          name = "string"
          properties = {
            externalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            internalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            ipConfigurationId = "string"
            mode = "string"
            type = "string"
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
      vpnGatewayScaleUnit = int
    }
  })
  tags = {
    {customized property} = "string"
  }
}

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

BgpSettings

Имя Описание Ценность
asn ASN докладчика BGP. int

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

GatewayCustomBgpIpAddressIpConfiguration

Имя Описание Ценность
customBgpIpAddress Пользовательский объект BgpPeeringAddress, принадлежащий IpconfigurationId. строка (обязательно)
ipConfigurationId IpconfigurationId ipconfiguration, который принадлежит шлюзу. строка (обязательно)

IPConfigurationBgpPeeringAddress

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

IpsecPolicy

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

Microsoft.Network/vpnGateways

Имя Описание Ценность
местоположение Расположение ресурса. струна
имя Имя ресурса строка (обязательно)
свойства Свойства VPN-шлюза. VpnGatewayProperties
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.Network/vpnGateways@2023-02-01"

РаспространениеRouteTable

Имя Описание Ценность
Идентификаторы Список идентификаторов ресурсов всех маршрутов. SubResource[]
Метки Список меток. string[]

ResourceTags

Имя Описание Ценность

МаршрутизацияConfiguration

Имя Описание Ценность
associatedRouteTable Идентификатор ресурса RouteTable, связанный с этой конфигурацией маршрутизации. SubResource
inboundRouteMap Идентификатор ресурса RouteMap, связанный с этой маршрутизациейConfiguration для входящих наученных маршрутов. SubResource
outboundRouteMap Идентификатор ресурса объектаRouteMap, связанного с этой маршрутизациейConfiguration для исходящих объявленных маршрутов. SubResource
распространениеrouteTables Список маршрутов для объявления маршрутов. распространение
vnetRoutes Список маршрутов, которые управляют маршрутизацией из VirtualHub в подключение к виртуальной сети. VnetRoute

StaticRoute

Имя Описание Ценность
addressPrefixes Список всех префиксов адресов. string[]
имя Имя staticRoute, уникальное в виртуальной сети. струна
nextHopIpAddress Ip-адрес следующего прыжка. струна

StaticRoutesConfig

Имя Описание Ценность
vnetLocalRouteOverrideCriteria Параметр, определяющий, пропускается ли NVA в периферийной виртуальной сети для трафика с назначением в периферийной сети. "Содержит"
"Равно"

SubResource

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

TrafficSelectorPolicy

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

VnetRoute

Имя Описание Ценность
staticRoutes Список всех статических маршрутов. StaticRoute[]
staticRoutesConfig Конфигурация статических маршрутов в этом HubVnetConnection. StaticRoutesConfig

VpnConnection

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

VpnConnectionProperties

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

VpnGatewayNatRule

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

VpnGatewayNatRuleProperties

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

VpnGatewayProperties

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

VpnNatRuleMapping

Имя Описание Ценность
адресное пространство Адресное пространство для сопоставления Vpn NatRule. струна
portRange Диапазон портов для сопоставления Vpn NatRule. струна

VpnSiteLinkConnection

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

VpnSiteLinkConnectionProperties

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