Microsoft.Network virtualNetworkGateways 2023-04-01

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

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

• группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2023-04-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    activeActive: bool
    adminState: 'string'
    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'
  }
}

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

Microsoft.Network/виртуальные сетевые шлюзы

Адресное пространство

Настройки Bgp

Расширенное местоположение

IPConfigurationBgpPeeringAddress

Политика IPSEC

Сервер RadiusServer

Теги ресурса

Подресурс

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

Правило VirtualNetworkGatewayNatRule

Свойства VirtualNetworkGatewayNatRule

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyУчастник группы

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku (Виртуальный сетевой шлюз)

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration (Конфигурация VPN)

VpnClientотозванныйСертификат

VpnClientRevokedCertificatePropertiesFormat

Сертификат VpnClientRoot

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping

Примеры использования

Проверенные модули Azure

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

Примеры быстрого запуска Azure

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

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

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

• группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

{
  "type": "Microsoft.Network/virtualNetworkGateways",
  "apiVersion": "2023-04-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "activeActive": "bool",
    "adminState": "string",
    "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"
  }
}

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

Microsoft.Network/виртуальные сетевые шлюзы

Адресное пространство

Настройки Bgp

Расширенное местоположение

IPConfigurationBgpPeeringAddress

Политика IPSEC

Сервер RadiusServer

Теги ресурса

Подресурс

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

Правило VirtualNetworkGatewayNatRule

Свойства VirtualNetworkGatewayNatRule

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyУчастник группы

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku (Виртуальный сетевой шлюз)

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration (Конфигурация VPN)

VpnClientотозванныйСертификат

VpnClientRevokedCertificatePropertiesFormat

Сертификат VpnClientRoot

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping

Примеры использования

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

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

Шаблон	Описание
среда службы приложений с серверной SQL Azure развертывание	Этот шаблон создает среду службы приложений с серверной частью SQL Azure вместе с частными конечными точками вместе с связанными ресурсами, обычно используемыми в частной или изолированной среде.
BOSH CF Кросс-регион развертывание	Этот шаблон помогает настроить ресурсы, необходимые для развертывания BOSH и Cloud Foundry в двух регионах в Azure.
подключение канала ExpressRoute к виртуальной сети развертывание	Этот шаблон создает виртуальную сеть, шлюз ExpresRoute и подключение к подготовленному каналу ExpressRoute с настроенным AzurePrivatePeering.
создание виртуальной сети BGP для подключения виртуальной сети развертывание	Этот шаблон позволяет подключить два виртуальных сети с помощью шлюзов виртуальной сети и BGP.
создание среды DevTest с помощью VPN-подключения P2S и IIS развертывание	Этот шаблон создает простую среду DevTest с VPN типа "точка — сеть" и IIS на сервере Windows, который является отличным способом приступить к работе.
создание шлюза "точка — сеть" развертывание	Этот шаблон позволяет создать подключение типа "точка — сеть" с помощью VirtualNetworkGateways
создание шлюза "точка — сеть" с помощью Azure AD развертывание	Этот шаблон развертывает шлюз виртуальной сети VPN, настроенный с подключением типа "точка — сеть" Azure Active Directory
создание VPN-подключения типа "сеть — сеть" развертывание	Этот шаблон позволяет создать VPN-подключение типа "сеть — сеть" с помощью шлюзов виртуальной сети
создание VPN-подключения типа "сеть — сеть" с помощью виртуальной машины развертывание	Этот шаблон позволяет создать VPN-подключение типа "сеть — сеть" с помощью шлюзов виртуальной сети
создание подключения виртуальной сети к виртуальной сети между двумя регионами развертывание	Этот шаблон позволяет подключать два виртуальных сети в разных регионах с помощью шлюзов виртуальной сети
Создание SQL MI с настроенным подключением типа "точка — сеть" развертывание	Разверните управляемый экземпляр Базы данных SQL Azure (SQL MI) и шлюз виртуальной сети, настроенный для подключения типа "точка — сеть" в новой виртуальной сети.
создание трех виртуальных сетей для демонстрации транзитивных подключений BGP развертывание	Этот шаблон развертывает три виртуальных сети, подключенных с помощью шлюзов виртуальной сети и подключений с поддержкой BGP
Создание виртуальной сети с двумя подсетями, локальной сетью и шлюзом развертывание	Этот шаблон создает виртуальную сеть, 2 подсети и шлюз
Развертывание изолированной топологии концентратора и периферийной топологии развертывание	Этот шаблон создает базовую настройку топологии концентратора и периферийной топологии. Она создает виртуальную сеть концентратора с подсетями DMZ, управления, общего доступа и шлюза (при необходимости) с двумя периферийными виртуальными сетями (разработка и производство), содержащим подсеть рабочей нагрузки. Он также развертывает Jump-Host Windows в подсети управления концентратора и устанавливает пиринги виртуальной сети между концентратором и двумя периферийными устройствами.
Развертывание георепликации HBase развертывание	Этот шаблон позволяет настроить среду Azure для репликации HBase в двух разных регионах с подключением VPN к виртуальной сети.
канал ExpressRoute с частным пирингом и виртуальной сетью Azure развертывание	Этот шаблон настраивает пиринг Microsoft ExpressRoute, развертывает виртуальную сеть Azure с помощью шлюза Expressroute и связывает виртуальную сеть с каналом ExpressRoute.
расширение существующей виртуальной сети Azure до конфигурации нескольких виртуальных сетей развертывание	Этот шаблон позволяет расширить существующую среду виртуальной сети в среду с несколькими виртуальными сетями, которая расширяется между двумя регионами центра обработки данных с помощью шлюзов виртуальной сети и виртуальной сети.
VPN типа "сеть — сеть" с помощью vpn-шлюзов active-active с BGP развертывание	Этот шаблон позволяет развернуть VPN типа "сеть — сеть" между двумя виртуальными сетями с VPN-шлюзами в конфигурации active-active с помощью BGP. Каждый VPN-шлюз Azure разрешает полное доменное имя удаленных одноранговых узлов, чтобы определить общедоступный IP-адрес удаленного VPN-шлюза. Шаблон выполняется должным образом в регионах Azure с зонами доступности.
использовать брандмауэр Azure в качестве DNS-прокси в топологии & периферийных концентратора развертывание	В этом примере показано, как развернуть звездообразную топологию в Azure с помощью брандмауэра Azure. Виртуальная сеть концентратора выступает в качестве центральной точки подключения ко многим периферийным виртуальным сетям, подключенным к центральной виртуальной сети через пиринг между виртуальными сетями.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworkGateways@2023-04-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      activeActive = bool
      adminState = "string"
      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"
    }
  }
}

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

Microsoft.Network/виртуальные сетевые шлюзы

Адресное пространство

Настройки Bgp

Расширенное местоположение

IPConfigurationBgpPeeringAddress

Политика IPSEC

Сервер RadiusServer

Теги ресурса

Подресурс

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfigurationPropertiesFormat

Правило VirtualNetworkGatewayNatRule

Свойства VirtualNetworkGatewayNatRule

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyУчастник группы

VirtualNetworkGatewayPolicyGroupProperties

VirtualNetworkGatewayPropertiesFormat

VirtualNetworkGatewaySku (Виртуальный сетевой шлюз)

VngClientConnectionConfiguration

VngClientConnectionConfigurationProperties

VpnClientConfiguration (Конфигурация VPN)

VpnClientотозванныйСертификат

VpnClientRevokedCertificatePropertiesFormat

Сертификат VpnClientRoot

VpnClientRootCertificatePropertiesFormat

VpnNatRuleMapping