Microsoft. Network vpnGateways/natRules 2023-04-01

Bicep-Ressourcendefinition

Der ressourcentyp vpnGateways/natRules kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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

Verwendungsbeispiele

Bicep-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung der VPN Gateway-NAT-Regel.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource virtualHub 'Microsoft.Network/virtualHubs@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    addressPrefix: '10.0.0.0/24'
    hubRoutingPreference: 'ExpressRoute'
    virtualRouterAutoScaleConfiguration: {
      minCapacity: 2
    }
    virtualWan: {
      id: virtualWan.id
    }
  }
}

resource virtualWan 'Microsoft.Network/virtualWans@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    allowBranchToBranchTraffic: true
    disableVpnEncryption: false
    office365LocalBreakoutCategory: 'None'
    type: 'Standard'
  }
}

resource vpnGateway 'Microsoft.Network/vpnGateways@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    enableBgpRouteTranslationForNat: false
    isRoutingPreferenceInternet: false
    virtualHub: {
      id: virtualHub.id
    }
    vpnGatewayScaleUnit: 1
  }
}

resource natRule 'Microsoft.Network/vpnGateways/natRules@2022-07-01' = {
  name: resourceName
  parent: vpnGateway
  properties: {
    externalMappings: [
      {
        addressSpace: '192.168.21.0/26'
      }
    ]
    internalMappings: [
      {
        addressSpace: '10.4.0.0/26'
      }
    ]
    mode: 'EgressSnat'
    type: 'Static'
  }
}

Von Azure verifizierte Module

Die folgenden Azure Verified Modules können verwendet werden, um diesen Ressourcentyp bereitzustellen.

Module Beschreibung
VPN Gateway – Nat-Regel AVM-Kindermodul für VPN Gateway – Nat-Regel

Ressourcenformat

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

resource symbolicname 'Microsoft.Network/vpnGateways/natRules@2023-04-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    externalMappings: [
      {
        addressSpace: 'string'
        portRange: 'string'
      }
    ]
    internalMappings: [
      {
        addressSpace: 'string'
        portRange: 'string'
      }
    ]
    ipConfigurationId: 'string'
    mode: 'string'
    type: 'string'
  }
}

Eigenschaftswerte

Microsoft.Network/vpnGateways/natRules

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Ressource vom Typ: vpnGateways
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"

VpnNatRuleMapping

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

ARM-Vorlagenressourcendefinition

Der ressourcentyp vpnGateways/natRules kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Verwendungsbeispiele

Ressourcenformat

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

{
  "type": "Microsoft.Network/vpnGateways/natRules",
  "apiVersion": "2023-04-01",
  "name": "string",
  "properties": {
    "externalMappings": [
      {
        "addressSpace": "string",
        "portRange": "string"
      }
    ],
    "internalMappings": [
      {
        "addressSpace": "string",
        "portRange": "string"
      }
    ],
    "ipConfigurationId": "string",
    "mode": "string",
    "type": "string"
  }
}

Eigenschaftswerte

Microsoft.Network/vpnGateways/natRules

Name Beschreibung Wert
apiVersion (Englisch) Die API-Version '2023-04-01'
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften der VPNGateway-NAT-Regel. VpnGatewayNatRuleProperties
Art Der Ressourcentyp 'Microsoft.Network/vpnGateways/natRules'

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"

VpnNatRuleMapping

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

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der ressourcentyp vpnGateways/natRules kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Change Log.

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung der VPN Gateway-NAT-Regel.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "virtualWan" {
  type      = "Microsoft.Network/virtualWans@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      allowBranchToBranchTraffic     = true
      disableVpnEncryption           = false
      office365LocalBreakoutCategory = "None"
      type                           = "Standard"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "virtualHub" {
  type      = "Microsoft.Network/virtualHubs@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      addressPrefix        = "10.0.0.0/24"
      hubRoutingPreference = "ExpressRoute"
      virtualRouterAutoScaleConfiguration = {
        minCapacity = 2
      }
      virtualWan = {
        id = azapi_resource.virtualWan.id
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "vpnGateway" {
  type      = "Microsoft.Network/vpnGateways@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      enableBgpRouteTranslationForNat = false
      isRoutingPreferenceInternet     = false
      virtualHub = {
        id = azapi_resource.virtualHub.id
      }
      vpnGatewayScaleUnit = 1
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  timeouts {
    create = "180m"
    update = "180m"
    delete = "60m"
  }
}

resource "azapi_resource" "natRule" {
  type      = "Microsoft.Network/vpnGateways/natRules@2022-07-01"
  parent_id = azapi_resource.vpnGateway.id
  name      = var.resource_name
  body = {
    properties = {
      externalMappings = [
        {
          addressSpace = "192.168.21.0/26"
        },
      ]
      internalMappings = [
        {
          addressSpace = "10.4.0.0/26"
        },
      ]
      mode = "EgressSnat"
      type = "Static"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Ressourcenformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnGateways/natRules@2023-04-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      externalMappings = [
        {
          addressSpace = "string"
          portRange = "string"
        }
      ]
      internalMappings = [
        {
          addressSpace = "string"
          portRange = "string"
        }
      ]
      ipConfigurationId = "string"
      mode = "string"
      type = "string"
    }
  }
}

Eigenschaftswerte

Microsoft.Network/vpnGateways/natRules

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eltern-ID Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: vpnGateways
Eigenschaften Eigenschaften der VPNGateway-NAT-Regel. VpnGatewayNatRuleProperties
Art Der Ressourcentyp "Microsoft.Network/vpnGateways/natRules@2023-04-01"

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"

VpnNatRuleMapping

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