Microsoft.Network virtualNetworkGateways 2022-05-01

Definizione di risorsa Bicep

Il tipo di risorsa virtualNetworkGateways può essere distribuito con operazioni destinate a:

• gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Network/virtualNetworkGateways, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2022-05-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    activeActive: bool
    allowRemoteVnetTraffic: bool
    allowVirtualWanTraffic: bool
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    customRoutes: {
      addressPrefixes: [
        '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'
        }
      }
    ]
    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'
              ]
            }
          }
        }
      ]
      vpnAuthenticationTypes: [
        'string'
      ]
      vpnClientAddressPool: {
        addressPrefixes: [
          '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'
  }
}

Valori delle proprietà

AddressSpace

BgpSettings

ExtendedLocation

IPConfigurationBgpPeeringAddress

IpsecPolicy

Microsoft.Network/virtualNetworkGateways

RadiusServer

ResourceTags

Sottorisorsa

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroupMember

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration

VpnClientRevokedCertificate

VpnClientRevokedCertificatePropertiesFormat

VpnClientRootCertificate

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping

Esempi di avvio rapido

Gli esempi di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa virtualNetworkGateways può essere distribuito con operazioni destinate a:

• gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Network/virtualNetworkGateways, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.Network/virtualNetworkGateways",
  "apiVersion": "2022-05-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "activeActive": "bool",
    "allowRemoteVnetTraffic": "bool",
    "allowVirtualWanTraffic": "bool",
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "customRoutes": {
      "addressPrefixes": [ "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"
        }
      }
    ],
    "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" ]
            }
          }
        }
      ],
      "vpnAuthenticationTypes": [ "string" ],
      "vpnClientAddressPool": {
        "addressPrefixes": [ "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"
  }
}

Valori delle proprietà

AddressSpace

BgpSettings

ExtendedLocation

IPConfigurationBgpPeeringAddress

IpsecPolicy

Microsoft.Network/virtualNetworkGateways

RadiusServer

ResourceTags

Sottorisorsa

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroupMember

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration

VpnClientRevokedCertificate

VpnClientRevokedCertificatePropertiesFormat

VpnClientRootCertificate

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma	Descrizione
'ambiente del servizio app con back-end SQL di Azure	Questo modello crea un ambiente del servizio app con un back-end SQL di Azure insieme agli endpoint privati insieme alle risorse associate in genere usate in un ambiente privato/isolato.
DI BOSH CF	Questo modello consente di configurare le risorse necessarie per distribuire BOSH e Cloud Foundry in due aree in Azure.
Connettere un circuito ExpressRoute a una rete virtuale	Questo modello crea una rete virtuale, un gateway ExpresRoute e una connessione a un circuito ExpressRoute con provisioning e abilitato con AzurePrivatePeering configurato.
Creare una connessione da rete virtuale BGP a rete virtuale	Questo modello consente di connettere due reti virtuali usando gateway di rete virtuale e BGP
Creare un ambiente DevTest con VPN da sito a sito e iis	Questo modello crea un ambiente DevTest semplice con una VPN da punto a sito e IIS in un server Windows, un ottimo modo per iniziare.
Creare un gateway da punto a sito	Questo modello consente di creare una connessione da punto a sito usando VirtualNetworkGateways
Creare un gateway da punto a sito con Azure AD	Questo modello distribuisce un gateway di rete virtuale VPN configurato con una connessione da punto a sito di Azure Active Directory
Creare una connessione VPN da sito a sito	Questo modello consente di creare una connessione VPN da sito a sito usando i gateway di rete virtuale
Creare una connessione VPN da sito a sito con di macchine virtuali	Questo modello consente di creare una connessione VPN da sito a sito usando i gateway di rete virtuale
Creare una connessione da rete virtuale a rete virtuale tra due aree	Questo modello consente di connettere due reti virtuali in aree diverse usando i gateway di rete virtuale
Creare l'istanza gestita di SQL con connessione da punto a sito configurata	Distribuire Istanza gestita di database SQL di Azure e gateway di rete virtuale configurati per la connessione da punto a sito all'interno della nuova rete virtuale.
Creare tre reti virtuali per illustrare le connessioni BGP transitive	Questo modello distribuisce tre reti virtuali connesse tramite gateway di rete virtuale e connessioni abilitate per BGP
Creare una rete virtuale con due subnet, una rete locale e un gateway	Questo modello crea una rete virtuale, 2 subnet e un gateway
Distribuire una sandbox della topologia Hub e Spoke	Questo modello crea una configurazione di topologia hub-spoke di base. Crea una rete virtuale hub con subnet dmz, gestione, condivisi e gateway (facoltativamente), con due reti virtuali spoke (sviluppo e produzione) contenenti ognuna una subnet del carico di lavoro. Distribuisce anche un Jump-Host Windows nella subnet di gestione dell'HUB e stabilisce i peering di reti virtuali tra l'hub e i due spoke.
Distribuire la replica geografica HBase	Questo modello consente di configurare un ambiente di Azure per la replica HBase in due aree diverse con connessione VPN da rete virtuale a rete virtuale.
circuito ExpressRoute con peering privato e di rete virtuale di Azure	Questo modello configura il peering Microsoft ExpressRoute, distribuisce una rete virtuale di Azure con il gateway Expressroute e collega la rete virtuale al circuito ExpressRoute
Estendere una rete virtuale di Azure esistente a una configurazione multi-VNET	Questo modello consente di estendere un ambiente di rete virtuale singola esistente a un ambiente multi-VNET che si estende in due aree del data center usando gateway da rete virtuale a rete virtuale
VPN da sito a sito con gateway VPN attivi con BGP	Questo modello consente di distribuire una VPN da sito a sito tra due reti virtuali con gateway VPN nella configurazione attiva-attiva con BGP. Ogni gateway VPN di Azure risolve il nome di dominio completo dei peer remoti per determinare l'indirizzo IP pubblico del gateway VPN remoto. Il modello viene eseguito come previsto nelle aree di Azure con zone di disponibilità.
Usare Firewall di Azure come proxy DNS in una topologia hub & spoke	Questo esempio illustra come distribuire una topologia hub-spoke in Azure usando Firewall di Azure. La rete virtuale hub funge da punto centrale di connettività a molte reti virtuali spoke connesse alla rete virtuale hub tramite peering di rete virtuale.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa virtualNetworkGateways può essere distribuito con operazioni destinate a:

• gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Network/virtualNetworkGateways, aggiungere il comando Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworkGateways@2022-05-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      activeActive = bool
      allowRemoteVnetTraffic = bool
      allowVirtualWanTraffic = bool
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      customRoutes = {
        addressPrefixes = [
          "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"
          }
        }
      ]
      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"
                ]
              }
            }
          }
        ]
        vpnAuthenticationTypes = [
          "string"
        ]
        vpnClientAddressPool = {
          addressPrefixes = [
            "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"
    }
  })
}

Valori delle proprietà

AddressSpace

BgpSettings

ExtendedLocation

IPConfigurationBgpPeeringAddress

IpsecPolicy

Microsoft.Network/virtualNetworkGateways

RadiusServer

ResourceTags

Sottorisorsa

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroupMember

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration

VpnClientRevokedCertificate

VpnClientRevokedCertificatePropertiesFormat

VpnClientRootCertificate

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping