Microsoft.Network virtualNetworkGateways

Bicep-Ressourcendefinition

Der Ressourcentyp "virtualNetworkGateways" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

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

Ressourcenformat

Um eine Microsoft.Network/virtualNetworkGateways-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2024-05-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    activeActive: bool
    adminState: 'string'
    allowRemoteVnetTraffic: bool
    allowVirtualWanTraffic: bool
    autoScaleConfiguration: {
      bounds: {
        max: int
        min: int
      }
    }
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    customRoutes: {
      addressPrefixes: [
        'string'
      ]
      ipamPoolPrefixAllocations: [
        {
          numberOfIpAddresses: 'string'
          pool: {
            id: 'string'
          }
        }
      ]
    }
    disableIPSecReplayProtection: bool
    enableBgp: bool
    enableBgpRouteTranslationForNat: bool
    enableDnsForwarding: bool
    enablePrivateIpAddress: bool
    gatewayDefaultSite: {
      id: 'string'
    }
    gatewayType: 'string'
    ipConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateIPAllocationMethod: 'string'
          publicIPAddress: {
            id: 'string'
          }
          subnet: {
            id: 'string'
          }
        }
      }
    ]
    natRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          externalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          internalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          ipConfigurationId: 'string'
          mode: 'string'
          type: 'string'
        }
      }
    ]
    resiliencyModel: 'string'
    sku: {
      name: 'string'
      tier: 'string'
    }
    virtualNetworkGatewayPolicyGroups: [
      {
        id: 'string'
        name: 'string'
        properties: {
          isDefault: bool
          policyMembers: [
            {
              attributeType: 'string'
              attributeValue: 'string'
              name: 'string'
            }
          ]
          priority: int
        }
      }
    ]
    vNetExtendedLocationResourceId: 'string'
    vpnClientConfiguration: {
      aadAudience: 'string'
      aadIssuer: 'string'
      aadTenant: 'string'
      radiusServerAddress: 'string'
      radiusServers: [
        {
          radiusServerAddress: 'string'
          radiusServerScore: int
          radiusServerSecret: 'string'
        }
      ]
      radiusServerSecret: 'string'
      vngClientConnectionConfigurations: [
        {
          id: 'string'
          name: 'string'
          properties: {
            virtualNetworkGatewayPolicyGroups: [
              {
                id: 'string'
              }
            ]
            vpnClientAddressPool: {
              addressPrefixes: [
                'string'
              ]
              ipamPoolPrefixAllocations: [
                {
                  numberOfIpAddresses: 'string'
                  pool: {
                    id: 'string'
                  }
                }
              ]
            }
          }
        }
      ]
      vpnAuthenticationTypes: [
        'string'
      ]
      vpnClientAddressPool: {
        addressPrefixes: [
          'string'
        ]
        ipamPoolPrefixAllocations: [
          {
            numberOfIpAddresses: 'string'
            pool: {
              id: 'string'
            }
          }
        ]
      }
      vpnClientIpsecPolicies: [
        {
          dhGroup: 'string'
          ikeEncryption: 'string'
          ikeIntegrity: 'string'
          ipsecEncryption: 'string'
          ipsecIntegrity: 'string'
          pfsGroup: 'string'
          saDataSizeKilobytes: int
          saLifeTimeSeconds: int
        }
      ]
      vpnClientProtocols: [
        'string'
      ]
      vpnClientRevokedCertificates: [
        {
          id: 'string'
          name: 'string'
          properties: {
            thumbprint: 'string'
          }
        }
      ]
      vpnClientRootCertificates: [
        {
          id: 'string'
          name: 'string'
          properties: {
            publicCertData: 'string'
          }
        }
      ]
    }
    vpnGatewayGeneration: 'string'
    vpnType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschaftswerte

AddressSpace

BgpSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ExtendedLocation

IpamPoolPrefixAllocation

IpamPoolPrefixAllocationPool

IPConfigurationBgpPeeringAddress

IpsecPolicy

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Network/virtualNetworkGateways

RadiusServer

ResourceTags

Unterressource

VirtualNetworkGatewayAutoScaleBounds

VirtualNetworkGatewayAutoScaleConfiguration

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroupMember

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration

VpnClientRevokedCertificate

VpnClientRevokedCertificatePropertiesFormat

VpnClientRootCertificate

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "virtualNetworkGateways" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

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

Ressourcenformat

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

{
  "type": "Microsoft.Network/virtualNetworkGateways",
  "apiVersion": "2024-05-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "activeActive": "bool",
    "adminState": "string",
    "allowRemoteVnetTraffic": "bool",
    "allowVirtualWanTraffic": "bool",
    "autoScaleConfiguration": {
      "bounds": {
        "max": "int",
        "min": "int"
      }
    },
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "customRoutes": {
      "addressPrefixes": [ "string" ],
      "ipamPoolPrefixAllocations": [
        {
          "numberOfIpAddresses": "string",
          "pool": {
            "id": "string"
          }
        }
      ]
    },
    "disableIPSecReplayProtection": "bool",
    "enableBgp": "bool",
    "enableBgpRouteTranslationForNat": "bool",
    "enableDnsForwarding": "bool",
    "enablePrivateIpAddress": "bool",
    "gatewayDefaultSite": {
      "id": "string"
    },
    "gatewayType": "string",
    "ipConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateIPAllocationMethod": "string",
          "publicIPAddress": {
            "id": "string"
          },
          "subnet": {
            "id": "string"
          }
        }
      }
    ],
    "natRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "externalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "internalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "ipConfigurationId": "string",
          "mode": "string",
          "type": "string"
        }
      }
    ],
    "resiliencyModel": "string",
    "sku": {
      "name": "string",
      "tier": "string"
    },
    "virtualNetworkGatewayPolicyGroups": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "isDefault": "bool",
          "policyMembers": [
            {
              "attributeType": "string",
              "attributeValue": "string",
              "name": "string"
            }
          ],
          "priority": "int"
        }
      }
    ],
    "vNetExtendedLocationResourceId": "string",
    "vpnClientConfiguration": {
      "aadAudience": "string",
      "aadIssuer": "string",
      "aadTenant": "string",
      "radiusServerAddress": "string",
      "radiusServers": [
        {
          "radiusServerAddress": "string",
          "radiusServerScore": "int",
          "radiusServerSecret": "string"
        }
      ],
      "radiusServerSecret": "string",
      "vngClientConnectionConfigurations": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "virtualNetworkGatewayPolicyGroups": [
              {
                "id": "string"
              }
            ],
            "vpnClientAddressPool": {
              "addressPrefixes": [ "string" ],
              "ipamPoolPrefixAllocations": [
                {
                  "numberOfIpAddresses": "string",
                  "pool": {
                    "id": "string"
                  }
                }
              ]
            }
          }
        }
      ],
      "vpnAuthenticationTypes": [ "string" ],
      "vpnClientAddressPool": {
        "addressPrefixes": [ "string" ],
        "ipamPoolPrefixAllocations": [
          {
            "numberOfIpAddresses": "string",
            "pool": {
              "id": "string"
            }
          }
        ]
      },
      "vpnClientIpsecPolicies": [
        {
          "dhGroup": "string",
          "ikeEncryption": "string",
          "ikeIntegrity": "string",
          "ipsecEncryption": "string",
          "ipsecIntegrity": "string",
          "pfsGroup": "string",
          "saDataSizeKilobytes": "int",
          "saLifeTimeSeconds": "int"
        }
      ],
      "vpnClientProtocols": [ "string" ],
      "vpnClientRevokedCertificates": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "thumbprint": "string"
          }
        }
      ],
      "vpnClientRootCertificates": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "publicCertData": "string"
          }
        }
      ]
    },
    "vpnGatewayGeneration": "string",
    "vpnType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschaftswerte

AddressSpace

BgpSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ExtendedLocation

IpamPoolPrefixAllocation

IpamPoolPrefixAllocationPool

IPConfigurationBgpPeeringAddress

IpsecPolicy

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Network/virtualNetworkGateways

RadiusServer

ResourceTags

Unterressource

VirtualNetworkGatewayAutoScaleBounds

VirtualNetworkGatewayAutoScaleConfiguration

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroupMember

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration

VpnClientRevokedCertificate

VpnClientRevokedCertificatePropertiesFormat

VpnClientRootCertificate

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
App Service Environment mit Azure SQL-Back-End-	Diese Vorlage erstellt eine App Service-Umgebung mit einem Azure SQL-Back-End zusammen mit privaten Endpunkten sowie zugeordneten Ressourcen, die normalerweise in einer privaten/isolierten Umgebung verwendet werden.
BOSH CF Cross Region	Mit dieser Vorlage können Sie die ressourcen einrichten, die für die Bereitstellung von BOSH und Cloud Foundry in zwei Regionen in Azure erforderlich sind.
Verbinden einer ExpressRoute-Verbindung mit einem VNET-	Diese Vorlage erstellt ein VNET, ein ExpresRoute-Gateway und eine Verbindung mit einem bereitgestellten und aktivierten ExpressRoute-Schaltkreis, wobei AzurePrivatePeering konfiguriert ist.
Erstellen einer BGP-VNET-zu-VNET-Verbindung	Mit dieser Vorlage können Sie zwei VNETs mithilfe von Virtual Network Gateways und BGP verbinden.
Erstellen einer DevTest-Umgebung mit P2S-VPN- und IIS-	Diese Vorlage erstellt eine einfache DevTest-Umgebung mit einem Point-to-Site-VPN und IIS auf einem Windows-Server, der eine hervorragende Möglichkeit für die ersten Schritte ist.
Erstellen eines Point-to-Site-Gateways	Mit dieser Vorlage können Sie eine Point-to-Site-Verbindung mit VirtualNetworkGateways erstellen.
Erstellen eines Point-to-Site-Gateways mit Azure AD	Diese Vorlage stellt ein VPN Virtual Network Gateway bereit, das mit einer Azure Active Directory-Point-to-Site-Verbindung konfiguriert ist.
Erstellen einer Standort-zu-Standort-VPN-Verbindung	Mit dieser Vorlage können Sie eine Standort-zu-Standort-VPN-Verbindung mit virtuellen Netzwerkgateways erstellen.
Erstellen einer Standort-zu-Standort-VPN-Verbindung mit VM-	Mit dieser Vorlage können Sie eine Standort-zu-Standort-VPN-Verbindung mit virtuellen Netzwerkgateways erstellen.
Erstellen einer VNET-zu-VNET-Verbindung über zwei Regionen	Mit dieser Vorlage können Sie zwei VNETs in verschiedenen Regionen mithilfe von Virtual Network Gateways verbinden.
Erstellen von SQL MI mit konfigurierter Point-to-Site-Verbindung	Stellen Sie azure Sql Database Managed Instance (SQL MI) und das virtuelle Netzwerkgateway bereit, das für die Point-to-Site-Verbindung innerhalb des neuen virtuellen Netzwerks konfiguriert ist.
Erstellen von drei vNets zum Veranschaulichen transitiver BGP-Verbindungen	Diese Vorlage stellt drei vNets bereit, die mit virtuellen Netzwerkgateways und BGP-fähigen Verbindungen verbunden sind.
Erstellen von VNet mit zwei Subnetzen, lokalen Netzwerken und Gateway-	Diese Vorlage erstellt ein VNet-, 2-Subnetz und ein Gateway.
Bereitstellen eines Hub- und Spoke-Topologie-	Diese Vorlage erstellt eine grundlegende Einrichtung der Hub-and-Spoke-Topologie. Es erstellt ein Hub-VNet mit Subnetzen DMZ, Management, Shared and Gateway (optional), mit zwei Spoke VNets (Entwicklung und Produktion), die jeweils ein Workload-Subnetz enthalten. Außerdem wird ein Windows Jump-Host im Verwaltungssubnetz des HUB bereitgestellt und VNet-Peerings zwischen dem Hub und den beiden Speichen eingerichtet.
Bereitstellen der HBase-Georeplikation	Mit dieser Vorlage können Sie eine Azure-Umgebung für die HBase-Replikation in zwei verschiedenen Regionen mit VPN-vnet-zu-vnet-Verbindung konfigurieren.
ExpressRoute-Schaltkreis mit privatem Peering und Azure VNet-	Diese Vorlage konfiguriert ExpressRoute Microsoft-Peering, stellt ein Azure VNet mit Expressroute-Gateway bereit und verknüpft das VNet mit dem ExpressRoute-Schaltkreis.
Erweitern eines vorhandenen Azure VNET auf eine Multi-VNET-Konfiguration	Mit dieser Vorlage können Sie eine vorhandene einzelne VNET-Umgebung auf eine Multi-VNET-Umgebung erweitern, die sich über zwei Rechenzentrumsregionen mit VNET-zu-VNET-Gateways erstreckt.
Standort-zu-Standort-VPN mit aktiven VPN-Gateways mit BGP-	Mit dieser Vorlage können Sie ein Standort-zu-Standort-VPN zwischen zwei VNets mit VPN-Gateways in der Konfiguration aktiv mit BGP bereitstellen. Jedes Azure VPN-Gateway löst den FQDN der Remotepeers auf, um die öffentliche IP des Remote-VPN-Gateways zu ermitteln. Die Vorlage wird in Azure-Regionen mit Verfügbarkeitszonen wie erwartet ausgeführt.
Verwenden der Azure Firewall als DNS-Proxy in einer Hub-& Speichentopologie	In diesem Beispiel wird gezeigt, wie Sie eine Hub-Spoke-Topologie in Azure mithilfe der Azure-Firewall bereitstellen. Das virtuelle Hubnetzwerk fungiert als zentraler Punkt der Konnektivität mit vielen speichen virtuellen Netzwerken, die über virtuelles Peering mit dem virtuellen Hubnetzwerk verbunden sind.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "virtualNetworkGateways" 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/virtualNetworkGateways-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworkGateways@2024-05-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      activeActive = bool
      adminState = "string"
      allowRemoteVnetTraffic = bool
      allowVirtualWanTraffic = bool
      autoScaleConfiguration = {
        bounds = {
          max = int
          min = int
        }
      }
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      customRoutes = {
        addressPrefixes = [
          "string"
        ]
        ipamPoolPrefixAllocations = [
          {
            numberOfIpAddresses = "string"
            pool = {
              id = "string"
            }
          }
        ]
      }
      disableIPSecReplayProtection = bool
      enableBgp = bool
      enableBgpRouteTranslationForNat = bool
      enableDnsForwarding = bool
      enablePrivateIpAddress = bool
      gatewayDefaultSite = {
        id = "string"
      }
      gatewayType = "string"
      ipConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            privateIPAllocationMethod = "string"
            publicIPAddress = {
              id = "string"
            }
            subnet = {
              id = "string"
            }
          }
        }
      ]
      natRules = [
        {
          id = "string"
          name = "string"
          properties = {
            externalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            internalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            ipConfigurationId = "string"
            mode = "string"
            type = "string"
          }
        }
      ]
      resiliencyModel = "string"
      sku = {
        name = "string"
        tier = "string"
      }
      virtualNetworkGatewayPolicyGroups = [
        {
          id = "string"
          name = "string"
          properties = {
            isDefault = bool
            policyMembers = [
              {
                attributeType = "string"
                attributeValue = "string"
                name = "string"
              }
            ]
            priority = int
          }
        }
      ]
      vNetExtendedLocationResourceId = "string"
      vpnClientConfiguration = {
        aadAudience = "string"
        aadIssuer = "string"
        aadTenant = "string"
        radiusServerAddress = "string"
        radiusServers = [
          {
            radiusServerAddress = "string"
            radiusServerScore = int
            radiusServerSecret = "string"
          }
        ]
        radiusServerSecret = "string"
        vngClientConnectionConfigurations = [
          {
            id = "string"
            name = "string"
            properties = {
              virtualNetworkGatewayPolicyGroups = [
                {
                  id = "string"
                }
              ]
              vpnClientAddressPool = {
                addressPrefixes = [
                  "string"
                ]
                ipamPoolPrefixAllocations = [
                  {
                    numberOfIpAddresses = "string"
                    pool = {
                      id = "string"
                    }
                  }
                ]
              }
            }
          }
        ]
        vpnAuthenticationTypes = [
          "string"
        ]
        vpnClientAddressPool = {
          addressPrefixes = [
            "string"
          ]
          ipamPoolPrefixAllocations = [
            {
              numberOfIpAddresses = "string"
              pool = {
                id = "string"
              }
            }
          ]
        }
        vpnClientIpsecPolicies = [
          {
            dhGroup = "string"
            ikeEncryption = "string"
            ikeIntegrity = "string"
            ipsecEncryption = "string"
            ipsecIntegrity = "string"
            pfsGroup = "string"
            saDataSizeKilobytes = int
            saLifeTimeSeconds = int
          }
        ]
        vpnClientProtocols = [
          "string"
        ]
        vpnClientRevokedCertificates = [
          {
            id = "string"
            name = "string"
            properties = {
              thumbprint = "string"
            }
          }
        ]
        vpnClientRootCertificates = [
          {
            id = "string"
            name = "string"
            properties = {
              publicCertData = "string"
            }
          }
        ]
      }
      vpnGatewayGeneration = "string"
      vpnType = "string"
    }
  })
}

Eigenschaftswerte

AddressSpace

BgpSettings

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ExtendedLocation

IpamPoolPrefixAllocation

IpamPoolPrefixAllocationPool

IPConfigurationBgpPeeringAddress

IpsecPolicy

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Network/virtualNetworkGateways

RadiusServer

ResourceTags

Unterressource

VirtualNetworkGatewayAutoScaleBounds

VirtualNetworkGatewayAutoScaleConfiguration

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroupMember

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration

VpnClientRevokedCertificate

VpnClientRevokedCertificatePropertiesFormat

VpnClientRootCertificate

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping