Freigeben über


Microsoft.Network vpnGateways 2023-06-01

Bicep-Ressourcendefinition

Der vpnGateways-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Network/vpnGateways-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Network/vpnGateways@2023-06-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'
  }
}

Eigenschaftswerte

BgpSettings

Name Beschreibung Wert
asn Der ASN des BGP-Sprechers. Int

Zwänge:
Min.-Wert = 0
Max. Wert = 4294967295
bgpPeeringAddress Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers. Schnur
bgpPeeringAddresses BGP-Peeringadresse mit IP-Konfigurations-ID für virtuelles Netzwerkgateway. IPConfigurationBgpPeeringAddress[]
PeerWeight Das Gewicht, das zu Routen hinzugefügt wurde, die von diesem BGP-Lautsprecher gelernt wurden. Int

GatewayCustomBgpIpAddressIpConfiguration

Name Beschreibung Wert
customBgpIpAddress Die benutzerdefinierte BgpPeeringAddress, die zu IpconfigurationId gehört. Zeichenfolge (erforderlich)
ipConfigurationId Die IpconfigurationId der ipconfiguration, die zum Gateway gehört. Zeichenfolge (erforderlich)

IPConfigurationBgpPeeringAddress

Name Beschreibung Wert
customBgpIpAddresses Die Liste der benutzerdefinierten BGP-Peeringadressen, die zur IP-Konfiguration gehören. string[]
ipconfigurationId Die ID der IP-Konfiguration, die zum Gateway gehört. Schnur

IpsecPolicy

Name Beschreibung Wert
dhGroup Die DH Group wurde in IKE Phase 1 für die erste SA verwendet. "DHGroup1"
"DHGroup14"
"DHGroup2"
"DHGroup2048"
"DHGroup24"
"ECP256"
"ECP384"
'None' (erforderlich)
ikeEncryption Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2). "AES128"
"AES192"
"AES256"
'DES'
'DES3'
"GCMAES128"
"GCMAES256" (erforderlich)
ikeIntegrity Der IKE-Integritätsalgorithmus (IKE Phase 2). "GCMAES128"
"GCMAES256"
"MD5"
'SHA1'
'SHA256'
'SHA384' (erforderlich)
ipsecEncryption Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1). "AES128"
"AES192"
"AES256"
'DES'
'DES3'
"GCMAES128"
"GCMAES192"
"GCMAES256"
'None' (erforderlich)
ipsecIntegrity Der IPSec-Integritätsalgorithmus (IKE Phase 1). "GCMAES128"
"GCMAES192"
"GCMAES256"
"MD5"
'SHA1'
'SHA256' (erforderlich)
pfsGroup Die Pfs Group, die in IKE Phase 2 für neue untergeordnete SA verwendet wird. "ECP256"
"ECP384"
'None'
"PFS1"
'PFS14'
'PFS2'
"PFS2048"
'PFS24'
"PFSMM" (erforderlich)
saDataSizeKilobytes Die Nutzlastgröße der IPSec-Sicherheitszuordnung (auch als Schnellmodus oder Phase 2 SA bezeichnet) in KB für einen Standort-zu-Standort-VPN-Tunnel. int (erforderlich)
saLifeTimeSeconds Die IPSec Security Association (auch als Schnellmodus oder Phase 2 SA bezeichnet) Lebensdauer in Sekunden für einen Standort-zu-Standort-VPN-Tunnel. int (erforderlich)

Microsoft.Network/vpnGateways

Name Beschreibung Wert
Ort Ressourcenspeicherort. Schnur
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften des VPN-Gateways. VpnGatewayProperties
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

PropagatedRouteTable

Name Beschreibung Wert
Ids Die Liste der Ressourcen-IDs aller RouteTables. SubResource-[]
etiketten Die Liste der Bezeichnungen. string[]

ResourceTags

Name Beschreibung Wert

RoutingConfiguration

Name Beschreibung Wert
associatedRouteTable Die Ressourcen-ID RouteTable, die dieser RoutingConfiguration zugeordnet ist. SubResource-
inboundRouteMap Die Ressourcen-ID der RouteMap, die dieser RoutingConfiguration für eingehende gelernte Routen zugeordnet ist. SubResource-
outboundRouteMap Die Ressourcen-ID der RouteMap, die dieser RoutingConfiguration für ausgehende angekündigte Routen zugeordnet ist. SubResource-
propagatedRouteTables Die Liste der RouteTables, an die die Routen angekündigt werden sollen. verteilteRouteTable-
vnetRoutes Liste der Routen, die das Routing von VirtualHub in eine virtuelle Netzwerkverbindung steuern. VnetRoute-

StaticRoute

Name Beschreibung Wert
addressPrefixes Liste aller Adresspräfixe. string[]
Name Der Name der StaticRoute, die innerhalb einer VnetRoute eindeutig ist. Schnur
nextHopIpAddress Die IP-Adresse des nächsten Hops. Schnur

StaticRoutesConfig

Name Beschreibung Wert
vnetLocalRouteOverrideCriteria Parameter, der bestimmt, ob NVA im Speichen-vnet für datenverkehr mit Ziel in Spoke umgangen wird. 'Contains'
"Gleich"

Unterressource

Name Beschreibung Wert
id Ressourcen-ID. Schnur

TrafficSelectorPolicy

Name Beschreibung Wert
localAddressRanges Eine Sammlung lokaler Adressräume im CIDR-Format. string[] (erforderlich)
remoteAddressRanges Eine Sammlung von Remoteadressräumen im CIDR-Format. string[] (erforderlich)

VnetRoute

Name Beschreibung Wert
staticRoutes Liste aller statischen Routen. StaticRoute-[]
staticRoutesConfig Konfiguration für statische Routen für diese HubVnetConnection. StaticRoutesConfig-

VpnConnection

Name Beschreibung Wert
id Ressourcen-ID. Schnur
Name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Schnur
Eigenschaften Eigenschaften der VPN-Verbindung. VpnConnectionProperties-

VpnConnectionProperties

Name Beschreibung Wert
connectionBandwidth Erwartete Bandbreite in MBPS. Int
dpdTimeoutSeconds DPD-Timeout in Sekunden für vpn-Verbindung. Int
enableBgp EnableBgp-Flag. Bool
enableInternetSecurity Internetsicherheit aktivieren. Bool
enableRateLimiting EnableBgp-Flag. Bool
ipsecPolicies Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen. IpsecPolicy-[]
remoteVpnSite ID der verbundenen VPN-Website. SubResource-
routingConfiguration Die Routingkonfiguration, die die zugeordneten und verteilten Routentabellen für diese Verbindung angibt. RoutingConfiguration-
routingWeight Routinggewichtung für vpn-Verbindung. Int
sharedKey SharedKey für die VPN-Verbindung. Schnur
trafficSelectorPolicies Die Datenverkehrsauswahlrichtlinien, die von dieser Verbindung berücksichtigt werden sollen. TrafficSelectorPolicy[]
useLocalAzureIpAddress Verwenden Sie die lokale Azure-IP, um die Verbindung zu initiieren. Bool
usePolicyBasedTrafficSelectors Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer. Bool
vpnConnectionProtocolType Verbindungsprotokoll, das für diese Verbindung verwendet wird. 'IKEv1'
'IKEv2'
vpnLinkConnections Liste aller Vpn-Standortlinkverbindungen mit dem Gateway. VpnSiteLinkConnection[]

VpnGatewayNatRule

Name Beschreibung Wert
id Ressourcen-ID. Schnur
Name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Schnur
Eigenschaften Eigenschaften der VPNGateway-NAT-Regel. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Name Beschreibung Wert
externalMappings Die externe Zuordnung der privaten IP-Adresse für NAT. VpnNatRuleMapping[]
internalMappings Die interne Zuordnung der privaten IP-Adresse für NAT. VpnNatRuleMapping[]
ipConfigurationId Die IP-Konfigurations-ID, für die diese NAT-Regel gilt. Schnur
Modus Die Quell-NAT-Richtung eines VPN-NAT. 'EgressSnat'
'IngressSnat'
Art Der Typ der NAT-Regel für VPN NAT. "Dynamisch"
"Statisch"

VpnGatewayProperties

Name Beschreibung Wert
bgpSettings BGP-Lautsprechereinstellungen des lokalen Netzwerkgateways. BgpSettings-
Verbindungen Liste aller VPN-Verbindungen mit dem Gateway. VpnConnection-[]
enableBgpRouteTranslationForNat Aktivieren Sie die BGP-Routenübersetzung für NAT auf diesem VpnGateway. Bool
isRoutingPreferenceInternet Enable Routing Preference property for the Public IP Interface of the VpnGateway. Bool
natRules Liste aller nat-Regeln, die dem Gateway zugeordnet sind. VpnGatewayNatRule[]
virtualHub Der VirtualHub, zu dem das Gateway gehört. SubResource-
vpnGatewayScaleUnit Die Skalierungseinheit für dieses VPN-Gateway. Int

VpnNatRuleMapping

Name Beschreibung Wert
addressSpace Adressraum für vpn NatRule-Zuordnung. Schnur
portRange Portbereich für vpn NatRule-Zuordnung. Schnur

VpnSiteLinkConnection

Name Beschreibung Wert
id Ressourcen-ID. Schnur
Name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Schnur
Eigenschaften Eigenschaften der VPN-Standortverbindung. VpnSiteLinkConnectionProperties-

VpnSiteLinkConnectionProperties

Name Beschreibung Wert
connectionBandwidth Erwartete Bandbreite in MBPS. Int
egressNatRules Liste des Ausgangs natRules. SubResource-[]
enableBgp EnableBgp-Flag. Bool
enableRateLimiting EnableBgp-Flag. Bool
ingressNatRules Liste der Eingangs natRules. SubResource-[]
ipsecPolicies Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen. IpsecPolicy-[]
routingWeight Routinggewichtung für vpn-Verbindung. Int
sharedKey SharedKey für die VPN-Verbindung. Schnur
useLocalAzureIpAddress Verwenden Sie die lokale Azure-IP, um die Verbindung zu initiieren. Bool
usePolicyBasedTrafficSelectors Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer. Bool
vpnConnectionProtocolType Verbindungsprotokoll, das für diese Verbindung verwendet wird. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses, die von dieser Verbindung verwendet werden. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Verbindungsmodus für VPN-Verbindungen. 'Standard'
"InitiatorOnly"
"ResponderOnly"
vpnSiteLink ID des verbundenen VPN-Standortlinks. SubResource-

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

Bicep-Datei Beschreibung
erstellt virtuelle WAN-Ressourcen Mit dieser Vorlage können Sie virtuelle WAN-Ressourcen erstellen, einschließlich Virtual WAN, Virtual Hub, VPN-Gateway, VPN-Standort und vpn Connecton.

ARM-Vorlagenressourcendefinition

Der vpnGateways-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Network/vpnGateways-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Network/vpnGateways",
  "apiVersion": "2023-06-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"
  }
}

Eigenschaftswerte

BgpSettings

Name Beschreibung Wert
asn Der ASN des BGP-Sprechers. Int

Zwänge:
Min.-Wert = 0
Max. Wert = 4294967295
bgpPeeringAddress Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers. Schnur
bgpPeeringAddresses BGP-Peeringadresse mit IP-Konfigurations-ID für virtuelles Netzwerkgateway. IPConfigurationBgpPeeringAddress[]
PeerWeight Das Gewicht, das zu Routen hinzugefügt wurde, die von diesem BGP-Lautsprecher gelernt wurden. Int

GatewayCustomBgpIpAddressIpConfiguration

Name Beschreibung Wert
customBgpIpAddress Die benutzerdefinierte BgpPeeringAddress, die zu IpconfigurationId gehört. Zeichenfolge (erforderlich)
ipConfigurationId Die IpconfigurationId der ipconfiguration, die zum Gateway gehört. Zeichenfolge (erforderlich)

IPConfigurationBgpPeeringAddress

Name Beschreibung Wert
customBgpIpAddresses Die Liste der benutzerdefinierten BGP-Peeringadressen, die zur IP-Konfiguration gehören. string[]
ipconfigurationId Die ID der IP-Konfiguration, die zum Gateway gehört. Schnur

IpsecPolicy

Name Beschreibung Wert
dhGroup Die DH Group wurde in IKE Phase 1 für die erste SA verwendet. "DHGroup1"
"DHGroup14"
"DHGroup2"
"DHGroup2048"
"DHGroup24"
"ECP256"
"ECP384"
'None' (erforderlich)
ikeEncryption Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2). "AES128"
"AES192"
"AES256"
'DES'
'DES3'
"GCMAES128"
"GCMAES256" (erforderlich)
ikeIntegrity Der IKE-Integritätsalgorithmus (IKE Phase 2). "GCMAES128"
"GCMAES256"
"MD5"
'SHA1'
'SHA256'
'SHA384' (erforderlich)
ipsecEncryption Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1). "AES128"
"AES192"
"AES256"
'DES'
'DES3'
"GCMAES128"
"GCMAES192"
"GCMAES256"
'None' (erforderlich)
ipsecIntegrity Der IPSec-Integritätsalgorithmus (IKE Phase 1). "GCMAES128"
"GCMAES192"
"GCMAES256"
"MD5"
'SHA1'
'SHA256' (erforderlich)
pfsGroup Die Pfs Group, die in IKE Phase 2 für neue untergeordnete SA verwendet wird. "ECP256"
"ECP384"
'None'
"PFS1"
'PFS14'
'PFS2'
"PFS2048"
'PFS24'
"PFSMM" (erforderlich)
saDataSizeKilobytes Die Nutzlastgröße der IPSec-Sicherheitszuordnung (auch als Schnellmodus oder Phase 2 SA bezeichnet) in KB für einen Standort-zu-Standort-VPN-Tunnel. int (erforderlich)
saLifeTimeSeconds Die IPSec Security Association (auch als Schnellmodus oder Phase 2 SA bezeichnet) Lebensdauer in Sekunden für einen Standort-zu-Standort-VPN-Tunnel. int (erforderlich)

Microsoft.Network/vpnGateways

Name Beschreibung Wert
apiVersion Die API-Version '2023-06-01'
Ort Ressourcenspeicherort. Schnur
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften des VPN-Gateways. VpnGatewayProperties
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp "Microsoft.Network/vpnGateways"

PropagatedRouteTable

Name Beschreibung Wert
Ids Die Liste der Ressourcen-IDs aller RouteTables. SubResource-[]
etiketten Die Liste der Bezeichnungen. string[]

ResourceTags

Name Beschreibung Wert

RoutingConfiguration

Name Beschreibung Wert
associatedRouteTable Die Ressourcen-ID RouteTable, die dieser RoutingConfiguration zugeordnet ist. SubResource-
inboundRouteMap Die Ressourcen-ID der RouteMap, die dieser RoutingConfiguration für eingehende gelernte Routen zugeordnet ist. SubResource-
outboundRouteMap Die Ressourcen-ID der RouteMap, die dieser RoutingConfiguration für ausgehende angekündigte Routen zugeordnet ist. SubResource-
propagatedRouteTables Die Liste der RouteTables, an die die Routen angekündigt werden sollen. verteilteRouteTable-
vnetRoutes Liste der Routen, die das Routing von VirtualHub in eine virtuelle Netzwerkverbindung steuern. VnetRoute-

StaticRoute

Name Beschreibung Wert
addressPrefixes Liste aller Adresspräfixe. string[]
Name Der Name der StaticRoute, die innerhalb einer VnetRoute eindeutig ist. Schnur
nextHopIpAddress Die IP-Adresse des nächsten Hops. Schnur

StaticRoutesConfig

Name Beschreibung Wert
vnetLocalRouteOverrideCriteria Parameter, der bestimmt, ob NVA im Speichen-vnet für datenverkehr mit Ziel in Spoke umgangen wird. 'Contains'
"Gleich"

Unterressource

Name Beschreibung Wert
id Ressourcen-ID. Schnur

TrafficSelectorPolicy

Name Beschreibung Wert
localAddressRanges Eine Sammlung lokaler Adressräume im CIDR-Format. string[] (erforderlich)
remoteAddressRanges Eine Sammlung von Remoteadressräumen im CIDR-Format. string[] (erforderlich)

VnetRoute

Name Beschreibung Wert
staticRoutes Liste aller statischen Routen. StaticRoute-[]
staticRoutesConfig Konfiguration für statische Routen für diese HubVnetConnection. StaticRoutesConfig-

VpnConnection

Name Beschreibung Wert
id Ressourcen-ID. Schnur
Name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Schnur
Eigenschaften Eigenschaften der VPN-Verbindung. VpnConnectionProperties-

VpnConnectionProperties

Name Beschreibung Wert
connectionBandwidth Erwartete Bandbreite in MBPS. Int
dpdTimeoutSeconds DPD-Timeout in Sekunden für vpn-Verbindung. Int
enableBgp EnableBgp-Flag. Bool
enableInternetSecurity Internetsicherheit aktivieren. Bool
enableRateLimiting EnableBgp-Flag. Bool
ipsecPolicies Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen. IpsecPolicy-[]
remoteVpnSite ID der verbundenen VPN-Website. SubResource-
routingConfiguration Die Routingkonfiguration, die die zugeordneten und verteilten Routentabellen für diese Verbindung angibt. RoutingConfiguration-
routingWeight Routinggewichtung für vpn-Verbindung. Int
sharedKey SharedKey für die VPN-Verbindung. Schnur
trafficSelectorPolicies Die Datenverkehrsauswahlrichtlinien, die von dieser Verbindung berücksichtigt werden sollen. TrafficSelectorPolicy[]
useLocalAzureIpAddress Verwenden Sie die lokale Azure-IP, um die Verbindung zu initiieren. Bool
usePolicyBasedTrafficSelectors Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer. Bool
vpnConnectionProtocolType Verbindungsprotokoll, das für diese Verbindung verwendet wird. 'IKEv1'
'IKEv2'
vpnLinkConnections Liste aller Vpn-Standortlinkverbindungen mit dem Gateway. VpnSiteLinkConnection[]

VpnGatewayNatRule

Name Beschreibung Wert
id Ressourcen-ID. Schnur
Name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Schnur
Eigenschaften Eigenschaften der VPNGateway-NAT-Regel. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Name Beschreibung Wert
externalMappings Die externe Zuordnung der privaten IP-Adresse für NAT. VpnNatRuleMapping[]
internalMappings Die interne Zuordnung der privaten IP-Adresse für NAT. VpnNatRuleMapping[]
ipConfigurationId Die IP-Konfigurations-ID, für die diese NAT-Regel gilt. Schnur
Modus Die Quell-NAT-Richtung eines VPN-NAT. 'EgressSnat'
'IngressSnat'
Art Der Typ der NAT-Regel für VPN NAT. "Dynamisch"
"Statisch"

VpnGatewayProperties

Name Beschreibung Wert
bgpSettings BGP-Lautsprechereinstellungen des lokalen Netzwerkgateways. BgpSettings-
Verbindungen Liste aller VPN-Verbindungen mit dem Gateway. VpnConnection-[]
enableBgpRouteTranslationForNat Aktivieren Sie die BGP-Routenübersetzung für NAT auf diesem VpnGateway. Bool
isRoutingPreferenceInternet Enable Routing Preference property for the Public IP Interface of the VpnGateway. Bool
natRules Liste aller nat-Regeln, die dem Gateway zugeordnet sind. VpnGatewayNatRule[]
virtualHub Der VirtualHub, zu dem das Gateway gehört. SubResource-
vpnGatewayScaleUnit Die Skalierungseinheit für dieses VPN-Gateway. Int

VpnNatRuleMapping

Name Beschreibung Wert
addressSpace Adressraum für vpn NatRule-Zuordnung. Schnur
portRange Portbereich für vpn NatRule-Zuordnung. Schnur

VpnSiteLinkConnection

Name Beschreibung Wert
id Ressourcen-ID. Schnur
Name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Schnur
Eigenschaften Eigenschaften der VPN-Standortverbindung. VpnSiteLinkConnectionProperties-

VpnSiteLinkConnectionProperties

Name Beschreibung Wert
connectionBandwidth Erwartete Bandbreite in MBPS. Int
egressNatRules Liste des Ausgangs natRules. SubResource-[]
enableBgp EnableBgp-Flag. Bool
enableRateLimiting EnableBgp-Flag. Bool
ingressNatRules Liste der Eingangs natRules. SubResource-[]
ipsecPolicies Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen. IpsecPolicy-[]
routingWeight Routinggewichtung für vpn-Verbindung. Int
sharedKey SharedKey für die VPN-Verbindung. Schnur
useLocalAzureIpAddress Verwenden Sie die lokale Azure-IP, um die Verbindung zu initiieren. Bool
usePolicyBasedTrafficSelectors Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer. Bool
vpnConnectionProtocolType Verbindungsprotokoll, das für diese Verbindung verwendet wird. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses, die von dieser Verbindung verwendet werden. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Verbindungsmodus für VPN-Verbindungen. 'Standard'
"InitiatorOnly"
"ResponderOnly"
vpnSiteLink ID des verbundenen VPN-Standortlinks. SubResource-

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone Beschreibung
Azure Virtual WAN (vWAN) Multi-Hub-Bereitstellung

Bereitstellen in Azure
Mit dieser Vorlage können Sie eine Azure Virtual WAN (vWAN)-Multi-Hub-Bereitstellung einschließlich aller Gateways und VNET-Verbindungen erstellen.
Azure vWAN Multi-Hub-Bereitstellung mit benutzerdefinierten Routingtabellen

Bereitstellen in Azure
Mit dieser Vorlage können Sie eine Azure Virtual WAN (vWAN)-Multi-Hub-Bereitstellung erstellen, einschließlich aller Gateways und VNET-Verbindungen, und die Verwendung von Routingtabellen für benutzerdefiniertes Routing veranschaulichen.
erstellt virtuelle WAN-Ressourcen

Bereitstellen in Azure
Mit dieser Vorlage können Sie virtuelle WAN-Ressourcen erstellen, einschließlich Virtual WAN, Virtual Hub, VPN-Gateway, VPN-Standort und vpn Connecton.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der vpnGateways-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Network/vpnGateways-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnGateways@2023-06-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"
  }
}

Eigenschaftswerte

BgpSettings

Name Beschreibung Wert
asn Der ASN des BGP-Sprechers. Int

Zwänge:
Min.-Wert = 0
Max. Wert = 4294967295
bgpPeeringAddress Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers. Schnur
bgpPeeringAddresses BGP-Peeringadresse mit IP-Konfigurations-ID für virtuelles Netzwerkgateway. IPConfigurationBgpPeeringAddress[]
PeerWeight Das Gewicht, das zu Routen hinzugefügt wurde, die von diesem BGP-Lautsprecher gelernt wurden. Int

GatewayCustomBgpIpAddressIpConfiguration

Name Beschreibung Wert
customBgpIpAddress Die benutzerdefinierte BgpPeeringAddress, die zu IpconfigurationId gehört. Zeichenfolge (erforderlich)
ipConfigurationId Die IpconfigurationId der ipconfiguration, die zum Gateway gehört. Zeichenfolge (erforderlich)

IPConfigurationBgpPeeringAddress

Name Beschreibung Wert
customBgpIpAddresses Die Liste der benutzerdefinierten BGP-Peeringadressen, die zur IP-Konfiguration gehören. string[]
ipconfigurationId Die ID der IP-Konfiguration, die zum Gateway gehört. Schnur

IpsecPolicy

Name Beschreibung Wert
dhGroup Die DH Group wurde in IKE Phase 1 für die erste SA verwendet. "DHGroup1"
"DHGroup14"
"DHGroup2"
"DHGroup2048"
"DHGroup24"
"ECP256"
"ECP384"
'None' (erforderlich)
ikeEncryption Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2). "AES128"
"AES192"
"AES256"
'DES'
'DES3'
"GCMAES128"
"GCMAES256" (erforderlich)
ikeIntegrity Der IKE-Integritätsalgorithmus (IKE Phase 2). "GCMAES128"
"GCMAES256"
"MD5"
'SHA1'
'SHA256'
'SHA384' (erforderlich)
ipsecEncryption Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1). "AES128"
"AES192"
"AES256"
'DES'
'DES3'
"GCMAES128"
"GCMAES192"
"GCMAES256"
'None' (erforderlich)
ipsecIntegrity Der IPSec-Integritätsalgorithmus (IKE Phase 1). "GCMAES128"
"GCMAES192"
"GCMAES256"
"MD5"
'SHA1'
'SHA256' (erforderlich)
pfsGroup Die Pfs Group, die in IKE Phase 2 für neue untergeordnete SA verwendet wird. "ECP256"
"ECP384"
'None'
"PFS1"
'PFS14'
'PFS2'
"PFS2048"
'PFS24'
"PFSMM" (erforderlich)
saDataSizeKilobytes Die Nutzlastgröße der IPSec-Sicherheitszuordnung (auch als Schnellmodus oder Phase 2 SA bezeichnet) in KB für einen Standort-zu-Standort-VPN-Tunnel. int (erforderlich)
saLifeTimeSeconds Die IPSec Security Association (auch als Schnellmodus oder Phase 2 SA bezeichnet) Lebensdauer in Sekunden für einen Standort-zu-Standort-VPN-Tunnel. int (erforderlich)

Microsoft.Network/vpnGateways

Name Beschreibung Wert
Ort Ressourcenspeicherort. Schnur
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften des VPN-Gateways. VpnGatewayProperties
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.Network/vpnGateways@2023-06-01"

PropagatedRouteTable

Name Beschreibung Wert
Ids Die Liste der Ressourcen-IDs aller RouteTables. SubResource-[]
etiketten Die Liste der Bezeichnungen. string[]

ResourceTags

Name Beschreibung Wert

RoutingConfiguration

Name Beschreibung Wert
associatedRouteTable Die Ressourcen-ID RouteTable, die dieser RoutingConfiguration zugeordnet ist. SubResource-
inboundRouteMap Die Ressourcen-ID der RouteMap, die dieser RoutingConfiguration für eingehende gelernte Routen zugeordnet ist. SubResource-
outboundRouteMap Die Ressourcen-ID der RouteMap, die dieser RoutingConfiguration für ausgehende angekündigte Routen zugeordnet ist. SubResource-
propagatedRouteTables Die Liste der RouteTables, an die die Routen angekündigt werden sollen. verteilteRouteTable-
vnetRoutes Liste der Routen, die das Routing von VirtualHub in eine virtuelle Netzwerkverbindung steuern. VnetRoute-

StaticRoute

Name Beschreibung Wert
addressPrefixes Liste aller Adresspräfixe. string[]
Name Der Name der StaticRoute, die innerhalb einer VnetRoute eindeutig ist. Schnur
nextHopIpAddress Die IP-Adresse des nächsten Hops. Schnur

StaticRoutesConfig

Name Beschreibung Wert
vnetLocalRouteOverrideCriteria Parameter, der bestimmt, ob NVA im Speichen-vnet für datenverkehr mit Ziel in Spoke umgangen wird. 'Contains'
"Gleich"

Unterressource

Name Beschreibung Wert
id Ressourcen-ID. Schnur

TrafficSelectorPolicy

Name Beschreibung Wert
localAddressRanges Eine Sammlung lokaler Adressräume im CIDR-Format. string[] (erforderlich)
remoteAddressRanges Eine Sammlung von Remoteadressräumen im CIDR-Format. string[] (erforderlich)

VnetRoute

Name Beschreibung Wert
staticRoutes Liste aller statischen Routen. StaticRoute-[]
staticRoutesConfig Konfiguration für statische Routen für diese HubVnetConnection. StaticRoutesConfig-

VpnConnection

Name Beschreibung Wert
id Ressourcen-ID. Schnur
Name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Schnur
Eigenschaften Eigenschaften der VPN-Verbindung. VpnConnectionProperties-

VpnConnectionProperties

Name Beschreibung Wert
connectionBandwidth Erwartete Bandbreite in MBPS. Int
dpdTimeoutSeconds DPD-Timeout in Sekunden für vpn-Verbindung. Int
enableBgp EnableBgp-Flag. Bool
enableInternetSecurity Internetsicherheit aktivieren. Bool
enableRateLimiting EnableBgp-Flag. Bool
ipsecPolicies Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen. IpsecPolicy-[]
remoteVpnSite ID der verbundenen VPN-Website. SubResource-
routingConfiguration Die Routingkonfiguration, die die zugeordneten und verteilten Routentabellen für diese Verbindung angibt. RoutingConfiguration-
routingWeight Routinggewichtung für vpn-Verbindung. Int
sharedKey SharedKey für die VPN-Verbindung. Schnur
trafficSelectorPolicies Die Datenverkehrsauswahlrichtlinien, die von dieser Verbindung berücksichtigt werden sollen. TrafficSelectorPolicy[]
useLocalAzureIpAddress Verwenden Sie die lokale Azure-IP, um die Verbindung zu initiieren. Bool
usePolicyBasedTrafficSelectors Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer. Bool
vpnConnectionProtocolType Verbindungsprotokoll, das für diese Verbindung verwendet wird. 'IKEv1'
'IKEv2'
vpnLinkConnections Liste aller Vpn-Standortlinkverbindungen mit dem Gateway. VpnSiteLinkConnection[]

VpnGatewayNatRule

Name Beschreibung Wert
id Ressourcen-ID. Schnur
Name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Schnur
Eigenschaften Eigenschaften der VPNGateway-NAT-Regel. VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

Name Beschreibung Wert
externalMappings Die externe Zuordnung der privaten IP-Adresse für NAT. VpnNatRuleMapping[]
internalMappings Die interne Zuordnung der privaten IP-Adresse für NAT. VpnNatRuleMapping[]
ipConfigurationId Die IP-Konfigurations-ID, für die diese NAT-Regel gilt. Schnur
Modus Die Quell-NAT-Richtung eines VPN-NAT. 'EgressSnat'
'IngressSnat'
Art Der Typ der NAT-Regel für VPN NAT. "Dynamisch"
"Statisch"

VpnGatewayProperties

Name Beschreibung Wert
bgpSettings BGP-Lautsprechereinstellungen des lokalen Netzwerkgateways. BgpSettings-
Verbindungen Liste aller VPN-Verbindungen mit dem Gateway. VpnConnection-[]
enableBgpRouteTranslationForNat Aktivieren Sie die BGP-Routenübersetzung für NAT auf diesem VpnGateway. Bool
isRoutingPreferenceInternet Enable Routing Preference property for the Public IP Interface of the VpnGateway. Bool
natRules Liste aller nat-Regeln, die dem Gateway zugeordnet sind. VpnGatewayNatRule[]
virtualHub Der VirtualHub, zu dem das Gateway gehört. SubResource-
vpnGatewayScaleUnit Die Skalierungseinheit für dieses VPN-Gateway. Int

VpnNatRuleMapping

Name Beschreibung Wert
addressSpace Adressraum für vpn NatRule-Zuordnung. Schnur
portRange Portbereich für vpn NatRule-Zuordnung. Schnur

VpnSiteLinkConnection

Name Beschreibung Wert
id Ressourcen-ID. Schnur
Name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Schnur
Eigenschaften Eigenschaften der VPN-Standortverbindung. VpnSiteLinkConnectionProperties-

VpnSiteLinkConnectionProperties

Name Beschreibung Wert
connectionBandwidth Erwartete Bandbreite in MBPS. Int
egressNatRules Liste des Ausgangs natRules. SubResource-[]
enableBgp EnableBgp-Flag. Bool
enableRateLimiting EnableBgp-Flag. Bool
ingressNatRules Liste der Eingangs natRules. SubResource-[]
ipsecPolicies Die IPSec-Richtlinien, die von dieser Verbindung berücksichtigt werden sollen. IpsecPolicy-[]
routingWeight Routinggewichtung für vpn-Verbindung. Int
sharedKey SharedKey für die VPN-Verbindung. Schnur
useLocalAzureIpAddress Verwenden Sie die lokale Azure-IP, um die Verbindung zu initiieren. Bool
usePolicyBasedTrafficSelectors Aktivieren Sie richtlinienbasierte Datenverkehrsmarkierer. Bool
vpnConnectionProtocolType Verbindungsprotokoll, das für diese Verbindung verwendet wird. 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses vpnGatewayCustomBgpAddresses, die von dieser Verbindung verwendet werden. GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Verbindungsmodus für VPN-Verbindungen. 'Standard'
"InitiatorOnly"
"ResponderOnly"
vpnSiteLink ID des verbundenen VPN-Standortlinks. SubResource-