Поделиться через

Microsoft.Network virtualNetworkGateways 2021-03-01

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2021-03-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    activeActive: bool
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    customRoutes: {
      addressPrefixes: [
        'string'
      ]
    }
    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'
            }
          ]
          internalMappings: [
            {
              addressSpace: 'string'
            }
          ]
          ipConfigurationId: 'string'
          mode: 'string'
          type: 'string'
        }
      }
    ]
    sku: {
      name: 'string'
      tier: 'string'
    }
    vNetExtendedLocationResourceId: 'string'
    vpnClientConfiguration: {
      aadAudience: 'string'
      aadIssuer: 'string'
      aadTenant: 'string'
      radiusServerAddress: 'string'
      radiusServers: [
        {
          radiusServerAddress: 'string'
          radiusServerScore: int
          radiusServerSecret: 'string'
        }
      ]
      radiusServerSecret: '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'
  }
}

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

AddressSpace

Имя Описание Ценность
addressPrefixes Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR. string[]

BgpSettings

Имя Описание Ценность
asn ASN докладчика BGP. int

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 4294967295
bgpPeeringAddress Адрес пиринга BGP и идентификатор BGP этого докладчика BGP. струна
bgpPeeringAddresses Адрес пиринга BGP с идентификатором IP-конфигурации для шлюза виртуальной сети. IPConfigurationBgpPeeringAddress[]
одноранговый вес Вес, добавленный к маршрутам, извлеченным из этого докладчика BGP. int

ExtendedLocation

Имя Описание Ценность
имя Имя расширенного расположения. струна
тип Тип расширенного расположения. EdgeZone

IPConfigurationBgpPeeringAddress

Имя Описание Ценность
customBgpIpAddresses Список пользовательских адресов пиринга BGP, принадлежащих ip-конфигурации. string[]
ipconfigurationId Идентификатор конфигурации IP-адресов, принадлежавшей шлюзу. струна

IpsecPolicy

Имя Описание Ценность
dhGroup Группа DH, используемая на этапе IKE 1 для начального sa. DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
"ECP256"
"ECP384"
"Нет" (обязательно)
ikeEncryption Алгоритм шифрования IKE (этап IKE 2). "AES128"
"AES192"
"AES256"
"DES"
DES3
"GCMAES128"
"GCMAES256" (обязательно)
ikeIntegrity Алгоритм целостности IKE (этап IKE 2). "GCMAES128"
"GCMAES256"
"MD5"
"SHA1"
Sha256
SHA384 (обязательно)
ipsecEncryption Алгоритм шифрования IPSec (этап IKE 1). "AES128"
"AES192"
"AES256"
"DES"
DES3
"GCMAES128"
"GCMAES192"
"GCMAES256"
"Нет" (обязательно)
ipsecIntegrity Алгоритм целостности IPSec (этап IKE 1). "GCMAES128"
"GCMAES192"
"GCMAES256"
"MD5"
"SHA1"
SHA256 (обязательно)
pfsGroup Группа Pfs, используемая на этапе IKE 2 для нового дочернего SA. "ECP256"
"ECP384"
"Нет"
'PFS1'
'PFS14'
'PFS2'
"PFS2048"
'PFS24'
PFSMM (обязательно)
saDataSizeKilobytes Размер полезных данных IPSec (также называемый быстрым режимом или этапом 2 SA) в КБ для сайта vpn-туннеля. int (обязательно)
saLifeTimeSeconds Связь безопасности IPSec (также называемая быстрым режимом или этапом 2 SA) в секундах для сайта vpn-туннеля сайта. int (обязательно)

Microsoft.Network/virtualNetworkGateways

Имя Описание Ценность
extendedLocation Расширенное расположение шлюза локальной виртуальной сети типа. ExtendedLocation
местоположение Расположение ресурса. струна
имя Имя ресурса строка (обязательно)
свойства Свойства шлюза виртуальной сети. VirtualNetworkGatewayPropertiesFormat (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

RadiusServer

Имя Описание Ценность
radiusServerAddress Адрес этого сервера radius. строка (обязательно)
radiusServerScore Начальная оценка, назначенная этому серверу radius. int
radiusServerSecret Секрет, используемый для этого сервера radius. струна

ResourceTags

Имя Описание Ценность

SubResource

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна

VirtualNetworkGatewayIPConfiguration

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства IP-конфигурации шлюза виртуальной сети. VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

Имя Описание Ценность
privateIPAllocationMethod Метод выделения частных IP-адресов. Dynamic
"Статический"
publicIPAddress Ссылка на ресурс общедоступного IP-адреса. SubResource
подсеть Ссылка на ресурс подсети. SubResource

VirtualNetworkGatewayNatRule

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства правила NAT шлюза виртуальной сети. VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayNatRuleProperties

Имя Описание Ценность
externalMappings Внешнее сопоставление частных IP-адресов для NAT. VpnNatRuleMapping[]
internalMappings Внутреннее сопоставление частных IP-адресов для NAT. VpnNatRuleMapping[]
ipConfigurationId Идентификатор конфигурации IP-адресов, к этому правилу NAT применяется. струна
режим Направление исходного NAT ДЛЯ VPN-NAT. EgressSnat
'IngressSnat'
тип Тип правила NAT для VPN NAT. Dynamic
"Статический"

VirtualNetworkGatewayPropertiesFormat

Имя Описание Ценность
activeActive Флаг ActiveActive. bool
bgpSettings Параметры динамиков BGP шлюза виртуальной сети. BgpSettings
customRoutes Ссылка на ресурс адресного пространства, представляющий адресное пространство пользовательских маршрутов, указанное клиентом для шлюза виртуальной сети и VpnClient. AddressSpace
enableBgp Включена ли BGP для этого шлюза виртуальной сети или нет. bool
enableBgpRouteTranslationForNat Флаг EnableBgpRouteTranslationForNat. bool
enableDnsForwarding Включена ли переадресация DNS. bool
enablePrivateIpAddress Необходимо ли включить частный IP-адрес в этом шлюзе для подключений или нет. bool
gatewayDefaultSite Ссылка на ресурс LocalNetworkGateway, представляющий локальный сетевой сайт с маршрутами по умолчанию. Назначьте значение NULL в случае удаления существующего параметра сайта по умолчанию. SubResource
gatewayType Тип этого шлюза виртуальной сети. ExpressRoute
'LocalGateway'
"Vpn"
ipConfigurations IP-конфигурации для шлюза виртуальной сети. VirtualNetworkGatewayIPConfiguration[]
natRules NatRules для шлюза виртуальной сети. VirtualNetworkGatewayNatRule[]
SKU Ссылка на ресурс VirtualNetworkGatewaySku, представляющий номер SKU, выбранный для шлюза виртуальной сети. VirtualNetworkGatewaySku
vNetExtendedLocationResourceId Идентификатор ресурса виртуальной сети клиента. VirtualNetworkGateway типа локальный шлюз связан с виртуальной сетью клиента. струна
vpnClientConfiguration Ссылка на ресурс VpnClientConfiguration, представляющий конфигурации VPNClient P2S. VpnClientConfiguration
vpnGatewayGeneration Поколение для этого VirtualNetworkGateway. Значение None, если gatewayType не является VPN. "Поколение1"
"Поколение2"
"Нет"
vpnType Тип этого шлюза виртуальной сети. PolicyBased
RouteBased

VirtualNetworkGatewaySku

Имя Описание Ценность
имя Имя SKU шлюза. "Базовый"
'ErGw1AZ'
'ErGw2AZ'
'ErGw3AZ'
"HighPerformance"
"Стандартный"
"UltraPerformance"
VpnGw1
VpnGw1AZ
VpnGw2
VpnGw2AZ
VpnGw3
VpnGw3AZ
VpnGw4
VpnGw4AZ
VpnGw5
VpnGw5AZ
ярус Уровень SKU шлюза. "Базовый"
'ErGw1AZ'
'ErGw2AZ'
'ErGw3AZ'
"HighPerformance"
"Стандартный"
"UltraPerformance"
VpnGw1
VpnGw1AZ
VpnGw2
VpnGw2AZ
VpnGw3
VpnGw3AZ
VpnGw4
VpnGw4AZ
VpnGw5
VpnGw5AZ

VpnClientConfiguration

Имя Описание Ценность
aadAudience Свойство AADAudience ресурса VirtualNetworkGateway для подключения vpn-клиента, используемого для проверки подлинности AAD. струна
aadIssuer Свойство AADIssuer ресурса VirtualNetworkGateway для подключения vpn-клиента, используемого для проверки подлинности AAD. струна
aadTenant Свойство AADTenant ресурса VirtualNetworkGateway для подключения vpn-клиента, используемого для проверки подлинности AAD. струна
radiusServerAddress Свойство адреса сервера радиуса ресурса VirtualNetworkGateway для подключения vpn-клиента. струна
radiusServers Свойство radiusServers для конфигурации нескольких серверов радиуса. RadiusServer[]
radiusServerSecret Свойство секрета радиуса ресурса VirtualNetworkGateway для подключения vpn-клиента. струна
vpnAuthenticationTypes Типы проверки подлинности VPN для шлюза виртуальной сети.. Массив строк, содержащий любой из:
AAD
"Сертификат"
"Radius"
vpnClientAddressPool Ссылка на ресурс адресного пространства, представляющий адресное пространство для VpnClient P2S. AddressSpace
vpnClientIpsecPolicies VpnClientIpsecPolicies для клиента P2S шлюза виртуальной сети. IpsecPolicy[]
vpnClientProtocols VpnClientProtocols для шлюза виртуальной сети. Массив строк, содержащий любой из:
'IkeV2'
OpenVPN
SSTP
vpnClientRevokedCertificates VpnClientRevokedCertificate для шлюза виртуальной сети. VpnClientRevokedCertificate[]
vpnClientRootCertificates VpnClientRootCertificate для шлюза виртуальной сети. VpnClientRootCertificate[]

VpnClientRevokedCertificate

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства отозванного сертификата vpn-клиента. VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

Имя Описание Ценность
Отпечаток Отпечаток отозванного сертификата VPN-клиента. струна

VpnClientRootCertificate

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства корневого сертификата vpn-клиента. VpnClientRootCertificatePropertiesFormat (обязательно)

VpnClientRootCertificatePropertiesFormat

Имя Описание Ценность
publicCertData Общедоступные данные сертификата. строка (обязательно)

VpnNatRuleMapping

Имя Описание Ценность
адресное пространство Адресное пространство для сопоставления Vpn NatRule. струна

Примеры краткого руководства

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

Bicep-файл Описание
создание виртуальной сети BGP для подключения виртуальной сети Этот шаблон позволяет подключить два виртуальных сети с помощью шлюзов виртуальной сети и BGP.
создание шлюза "точка — сеть" с помощью Azure AD Этот шаблон развертывает шлюз виртуальной сети VPN, настроенный с подключением типа "точка — сеть" Azure Active Directory
канал ExpressRoute с частным пирингом и виртуальной сетью Azure Этот шаблон настраивает пиринг Microsoft ExpressRoute, развертывает виртуальную сеть Azure с помощью шлюза Expressroute и связывает виртуальную сеть с каналом ExpressRoute.
VPN типа "сеть — сеть" с помощью vpn-шлюзов active-active с BGP Этот шаблон позволяет развернуть VPN типа "сеть — сеть" между двумя виртуальными сетями с VPN-шлюзами в конфигурации active-active с помощью BGP. Каждый VPN-шлюз Azure разрешает полное доменное имя удаленных одноранговых узлов, чтобы определить общедоступный IP-адрес удаленного VPN-шлюза. Шаблон выполняется должным образом в регионах Azure с зонами доступности.
использовать брандмауэр Azure в качестве DNS-прокси в топологии & периферийных концентратора В этом примере показано, как развернуть звездообразную топологию в Azure с помощью брандмауэра Azure. Виртуальная сеть концентратора выступает в качестве центральной точки подключения ко многим периферийным виртуальным сетям, подключенным к центральной виртуальной сети через пиринг между виртуальными сетями.

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

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

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

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

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

{
  "type": "Microsoft.Network/virtualNetworkGateways",
  "apiVersion": "2021-03-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "activeActive": "bool",
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "customRoutes": {
      "addressPrefixes": [ "string" ]
    },
    "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"
            }
          ],
          "internalMappings": [
            {
              "addressSpace": "string"
            }
          ],
          "ipConfigurationId": "string",
          "mode": "string",
          "type": "string"
        }
      }
    ],
    "sku": {
      "name": "string",
      "tier": "string"
    },
    "vNetExtendedLocationResourceId": "string",
    "vpnClientConfiguration": {
      "aadAudience": "string",
      "aadIssuer": "string",
      "aadTenant": "string",
      "radiusServerAddress": "string",
      "radiusServers": [
        {
          "radiusServerAddress": "string",
          "radiusServerScore": "int",
          "radiusServerSecret": "string"
        }
      ],
      "radiusServerSecret": "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"
  }
}

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

AddressSpace

Имя Описание Ценность
addressPrefixes Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR. string[]

BgpSettings

Имя Описание Ценность
asn ASN докладчика BGP. int

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 4294967295
bgpPeeringAddress Адрес пиринга BGP и идентификатор BGP этого докладчика BGP. струна
bgpPeeringAddresses Адрес пиринга BGP с идентификатором IP-конфигурации для шлюза виртуальной сети. IPConfigurationBgpPeeringAddress[]
одноранговый вес Вес, добавленный к маршрутам, извлеченным из этого докладчика BGP. int

ExtendedLocation

Имя Описание Ценность
имя Имя расширенного расположения. струна
тип Тип расширенного расположения. EdgeZone

IPConfigurationBgpPeeringAddress

Имя Описание Ценность
customBgpIpAddresses Список пользовательских адресов пиринга BGP, принадлежащих ip-конфигурации. string[]
ipconfigurationId Идентификатор конфигурации IP-адресов, принадлежавшей шлюзу. струна

IpsecPolicy

Имя Описание Ценность
dhGroup Группа DH, используемая на этапе IKE 1 для начального sa. DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
"ECP256"
"ECP384"
"Нет" (обязательно)
ikeEncryption Алгоритм шифрования IKE (этап IKE 2). "AES128"
"AES192"
"AES256"
"DES"
DES3
"GCMAES128"
"GCMAES256" (обязательно)
ikeIntegrity Алгоритм целостности IKE (этап IKE 2). "GCMAES128"
"GCMAES256"
"MD5"
"SHA1"
Sha256
SHA384 (обязательно)
ipsecEncryption Алгоритм шифрования IPSec (этап IKE 1). "AES128"
"AES192"
"AES256"
"DES"
DES3
"GCMAES128"
"GCMAES192"
"GCMAES256"
"Нет" (обязательно)
ipsecIntegrity Алгоритм целостности IPSec (этап IKE 1). "GCMAES128"
"GCMAES192"
"GCMAES256"
"MD5"
"SHA1"
SHA256 (обязательно)
pfsGroup Группа Pfs, используемая на этапе IKE 2 для нового дочернего SA. "ECP256"
"ECP384"
"Нет"
'PFS1'
'PFS14'
'PFS2'
"PFS2048"
'PFS24'
PFSMM (обязательно)
saDataSizeKilobytes Размер полезных данных IPSec (также называемый быстрым режимом или этапом 2 SA) в КБ для сайта vpn-туннеля. int (обязательно)
saLifeTimeSeconds Связь безопасности IPSec (также называемая быстрым режимом или этапом 2 SA) в секундах для сайта vpn-туннеля сайта. int (обязательно)

Microsoft.Network/virtualNetworkGateways

Имя Описание Ценность
apiVersion Версия API '2021-03-01'
extendedLocation Расширенное расположение шлюза локальной виртуальной сети типа. ExtendedLocation
местоположение Расположение ресурса. струна
имя Имя ресурса строка (обязательно)
свойства Свойства шлюза виртуальной сети. VirtualNetworkGatewayPropertiesFormat (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.Network/virtualNetworkGateways"

RadiusServer

Имя Описание Ценность
radiusServerAddress Адрес этого сервера radius. строка (обязательно)
radiusServerScore Начальная оценка, назначенная этому серверу radius. int
radiusServerSecret Секрет, используемый для этого сервера radius. струна

ResourceTags

Имя Описание Ценность

SubResource

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна

VirtualNetworkGatewayIPConfiguration

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства IP-конфигурации шлюза виртуальной сети. VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

Имя Описание Ценность
privateIPAllocationMethod Метод выделения частных IP-адресов. Dynamic
"Статический"
publicIPAddress Ссылка на ресурс общедоступного IP-адреса. SubResource
подсеть Ссылка на ресурс подсети. SubResource

VirtualNetworkGatewayNatRule

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства правила NAT шлюза виртуальной сети. VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayNatRuleProperties

Имя Описание Ценность
externalMappings Внешнее сопоставление частных IP-адресов для NAT. VpnNatRuleMapping[]
internalMappings Внутреннее сопоставление частных IP-адресов для NAT. VpnNatRuleMapping[]
ipConfigurationId Идентификатор конфигурации IP-адресов, к этому правилу NAT применяется. струна
режим Направление исходного NAT ДЛЯ VPN-NAT. EgressSnat
'IngressSnat'
тип Тип правила NAT для VPN NAT. Dynamic
"Статический"

VirtualNetworkGatewayPropertiesFormat

Имя Описание Ценность
activeActive Флаг ActiveActive. bool
bgpSettings Параметры динамиков BGP шлюза виртуальной сети. BgpSettings
customRoutes Ссылка на ресурс адресного пространства, представляющий адресное пространство пользовательских маршрутов, указанное клиентом для шлюза виртуальной сети и VpnClient. AddressSpace
enableBgp Включена ли BGP для этого шлюза виртуальной сети или нет. bool
enableBgpRouteTranslationForNat Флаг EnableBgpRouteTranslationForNat. bool
enableDnsForwarding Включена ли переадресация DNS. bool
enablePrivateIpAddress Необходимо ли включить частный IP-адрес в этом шлюзе для подключений или нет. bool
gatewayDefaultSite Ссылка на ресурс LocalNetworkGateway, представляющий локальный сетевой сайт с маршрутами по умолчанию. Назначьте значение NULL в случае удаления существующего параметра сайта по умолчанию. SubResource
gatewayType Тип этого шлюза виртуальной сети. ExpressRoute
'LocalGateway'
"Vpn"
ipConfigurations IP-конфигурации для шлюза виртуальной сети. VirtualNetworkGatewayIPConfiguration[]
natRules NatRules для шлюза виртуальной сети. VirtualNetworkGatewayNatRule[]
SKU Ссылка на ресурс VirtualNetworkGatewaySku, представляющий номер SKU, выбранный для шлюза виртуальной сети. VirtualNetworkGatewaySku
vNetExtendedLocationResourceId Идентификатор ресурса виртуальной сети клиента. VirtualNetworkGateway типа локальный шлюз связан с виртуальной сетью клиента. струна
vpnClientConfiguration Ссылка на ресурс VpnClientConfiguration, представляющий конфигурации VPNClient P2S. VpnClientConfiguration
vpnGatewayGeneration Поколение для этого VirtualNetworkGateway. Значение None, если gatewayType не является VPN. "Поколение1"
"Поколение2"
"Нет"
vpnType Тип этого шлюза виртуальной сети. PolicyBased
RouteBased

VirtualNetworkGatewaySku

Имя Описание Ценность
имя Имя SKU шлюза. "Базовый"
'ErGw1AZ'
'ErGw2AZ'
'ErGw3AZ'
"HighPerformance"
"Стандартный"
"UltraPerformance"
VpnGw1
VpnGw1AZ
VpnGw2
VpnGw2AZ
VpnGw3
VpnGw3AZ
VpnGw4
VpnGw4AZ
VpnGw5
VpnGw5AZ
ярус Уровень SKU шлюза. "Базовый"
'ErGw1AZ'
'ErGw2AZ'
'ErGw3AZ'
"HighPerformance"
"Стандартный"
"UltraPerformance"
VpnGw1
VpnGw1AZ
VpnGw2
VpnGw2AZ
VpnGw3
VpnGw3AZ
VpnGw4
VpnGw4AZ
VpnGw5
VpnGw5AZ

VpnClientConfiguration

Имя Описание Ценность
aadAudience Свойство AADAudience ресурса VirtualNetworkGateway для подключения vpn-клиента, используемого для проверки подлинности AAD. струна
aadIssuer Свойство AADIssuer ресурса VirtualNetworkGateway для подключения vpn-клиента, используемого для проверки подлинности AAD. струна
aadTenant Свойство AADTenant ресурса VirtualNetworkGateway для подключения vpn-клиента, используемого для проверки подлинности AAD. струна
radiusServerAddress Свойство адреса сервера радиуса ресурса VirtualNetworkGateway для подключения vpn-клиента. струна
radiusServers Свойство radiusServers для конфигурации нескольких серверов радиуса. RadiusServer[]
radiusServerSecret Свойство секрета радиуса ресурса VirtualNetworkGateway для подключения vpn-клиента. струна
vpnAuthenticationTypes Типы проверки подлинности VPN для шлюза виртуальной сети.. Массив строк, содержащий любой из:
AAD
"Сертификат"
"Radius"
vpnClientAddressPool Ссылка на ресурс адресного пространства, представляющий адресное пространство для VpnClient P2S. AddressSpace
vpnClientIpsecPolicies VpnClientIpsecPolicies для клиента P2S шлюза виртуальной сети. IpsecPolicy[]
vpnClientProtocols VpnClientProtocols для шлюза виртуальной сети. Массив строк, содержащий любой из:
'IkeV2'
OpenVPN
SSTP
vpnClientRevokedCertificates VpnClientRevokedCertificate для шлюза виртуальной сети. VpnClientRevokedCertificate[]
vpnClientRootCertificates VpnClientRootCertificate для шлюза виртуальной сети. VpnClientRootCertificate[]

VpnClientRevokedCertificate

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства отозванного сертификата vpn-клиента. VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

Имя Описание Ценность
Отпечаток Отпечаток отозванного сертификата VPN-клиента. струна

VpnClientRootCertificate

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства корневого сертификата vpn-клиента. VpnClientRootCertificatePropertiesFormat (обязательно)

VpnClientRootCertificatePropertiesFormat

Имя Описание Ценность
publicCertData Общедоступные данные сертификата. строка (обязательно)

VpnNatRuleMapping

Имя Описание Ценность
адресное пространство Адресное пространство для сопоставления Vpn NatRule. струна

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

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

Шаблон Описание
среда службы приложений с серверной SQL Azure

развертывание в Azure		 Этот шаблон создает среду службы приложений с серверной частью SQL Azure вместе с частными конечными точками вместе с связанными ресурсами, обычно используемыми в частной или изолированной среде.
BOSH CF Cross Region

развертывание в Azure		 Этот шаблон помогает настроить ресурсы, необходимые для развертывания BOSH и Cloud Foundry в двух регионах в Azure.
подключение канала ExpressRoute к виртуальной сети

развертывание в Azure		 Этот шаблон создает виртуальную сеть, шлюз ExpresRoute и подключение к подготовленному каналу ExpressRoute с настроенным AzurePrivatePeering.
создание виртуальной сети BGP для подключения виртуальной сети

развертывание в Azure		 Этот шаблон позволяет подключить два виртуальных сети с помощью шлюзов виртуальной сети и BGP.
создание среды DevTest с помощью VPN-подключения P2S и IIS

развертывание в Azure		 Этот шаблон создает простую среду DevTest с VPN типа "точка — сеть" и IIS на сервере Windows, который является отличным способом приступить к работе.
создание шлюза "точка — сеть"

развертывание в Azure		 Этот шаблон позволяет создать подключение типа "точка — сеть" с помощью VirtualNetworkGateways
создание шлюза "точка — сеть" с помощью Azure AD

развертывание в Azure		 Этот шаблон развертывает шлюз виртуальной сети VPN, настроенный с подключением типа "точка — сеть" Azure Active Directory
создание VPN-подключения типа "сеть — сеть"

развертывание в Azure		 Этот шаблон позволяет создать VPN-подключение типа "сеть — сеть" с помощью шлюзов виртуальной сети
создание VPN-подключения типа "сеть — сеть" с помощью виртуальной машины

развертывание в Azure		 Этот шаблон позволяет создать VPN-подключение типа "сеть — сеть" с помощью шлюзов виртуальной сети
создание подключения виртуальной сети к виртуальной сети между двумя регионами

развертывание в Azure		 Этот шаблон позволяет подключать два виртуальных сети в разных регионах с помощью шлюзов виртуальной сети
Создание SQL MI с настроенным подключением типа "точка — сеть"

развертывание в Azure		 Разверните управляемый экземпляр Базы данных SQL Azure (SQL MI) и шлюз виртуальной сети, настроенный для подключения типа "точка — сеть" в новой виртуальной сети.
создание трех виртуальных сетей для демонстрации транзитивных подключений BGP

развертывание в Azure		 Этот шаблон развертывает три виртуальных сети, подключенных с помощью шлюзов виртуальной сети и подключений с поддержкой BGP
Создание виртуальной сети с двумя подсетями, локальной сетью и шлюзом

развертывание в Azure		 Этот шаблон создает виртуальную сеть, 2 подсети и шлюз
Развертывание изолированной топологии концентратора и периферийной топологии

развертывание в Azure		 Этот шаблон создает базовую настройку топологии концентратора и периферийной топологии. Она создает виртуальную сеть концентратора с подсетями DMZ, управления, общего доступа и шлюза (при необходимости) с двумя периферийными виртуальными сетями (разработка и производство), содержащим подсеть рабочей нагрузки. Он также развертывает Jump-Host Windows в подсети управления концентратора и устанавливает пиринги виртуальной сети между концентратором и двумя периферийными устройствами.
Развертывание георепликации HBase

развертывание в Azure		 Этот шаблон позволяет настроить среду Azure для репликации HBase в двух разных регионах с подключением VPN к виртуальной сети.
канал ExpressRoute с частным пирингом и виртуальной сетью Azure

развертывание в Azure		 Этот шаблон настраивает пиринг Microsoft ExpressRoute, развертывает виртуальную сеть Azure с помощью шлюза Expressroute и связывает виртуальную сеть с каналом ExpressRoute.
расширение существующей виртуальной сети Azure до конфигурации нескольких виртуальных сетей

развертывание в Azure		 Этот шаблон позволяет расширить существующую среду виртуальной сети в среду с несколькими виртуальными сетями, которая расширяется между двумя регионами центра обработки данных с помощью шлюзов виртуальной сети и виртуальной сети.
VPN типа "сеть — сеть" с помощью vpn-шлюзов active-active с BGP

развертывание в Azure		 Этот шаблон позволяет развернуть VPN типа "сеть — сеть" между двумя виртуальными сетями с VPN-шлюзами в конфигурации active-active с помощью BGP. Каждый VPN-шлюз Azure разрешает полное доменное имя удаленных одноранговых узлов, чтобы определить общедоступный IP-адрес удаленного VPN-шлюза. Шаблон выполняется должным образом в регионах Azure с зонами доступности.
использовать брандмауэр Azure в качестве DNS-прокси в топологии & периферийных концентратора

развертывание в Azure		 В этом примере показано, как развернуть звездообразную топологию в Azure с помощью брандмауэра Azure. Виртуальная сеть концентратора выступает в качестве центральной точки подключения ко многим периферийным виртуальным сетям, подключенным к центральной виртуальной сети через пиринг между виртуальными сетями.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworkGateways@2021-03-01"
  name = "string"
  extendedLocation = {
    name = "string"
    type = "string"
  }
  location = "string"
  body = jsonencode({
    properties = {
      activeActive = bool
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      customRoutes = {
        addressPrefixes = [
          "string"
        ]
      }
      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"
              }
            ]
            internalMappings = [
              {
                addressSpace = "string"
              }
            ]
            ipConfigurationId = "string"
            mode = "string"
            type = "string"
          }
        }
      ]
      sku = {
        name = "string"
        tier = "string"
      }
      vNetExtendedLocationResourceId = "string"
      vpnClientConfiguration = {
        aadAudience = "string"
        aadIssuer = "string"
        aadTenant = "string"
        radiusServerAddress = "string"
        radiusServers = [
          {
            radiusServerAddress = "string"
            radiusServerScore = int
            radiusServerSecret = "string"
          }
        ]
        radiusServerSecret = "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"
  }
}

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

AddressSpace

Имя Описание Ценность
addressPrefixes Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR. string[]

BgpSettings

Имя Описание Ценность
asn ASN докладчика BGP. int

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 4294967295
bgpPeeringAddress Адрес пиринга BGP и идентификатор BGP этого докладчика BGP. струна
bgpPeeringAddresses Адрес пиринга BGP с идентификатором IP-конфигурации для шлюза виртуальной сети. IPConfigurationBgpPeeringAddress[]
одноранговый вес Вес, добавленный к маршрутам, извлеченным из этого докладчика BGP. int

ExtendedLocation

Имя Описание Ценность
имя Имя расширенного расположения. струна
тип Тип расширенного расположения. EdgeZone

IPConfigurationBgpPeeringAddress

Имя Описание Ценность
customBgpIpAddresses Список пользовательских адресов пиринга BGP, принадлежащих ip-конфигурации. string[]
ipconfigurationId Идентификатор конфигурации IP-адресов, принадлежавшей шлюзу. струна

IpsecPolicy

Имя Описание Ценность
dhGroup Группа DH, используемая на этапе IKE 1 для начального sa. DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
"ECP256"
"ECP384"
"Нет" (обязательно)
ikeEncryption Алгоритм шифрования IKE (этап IKE 2). "AES128"
"AES192"
"AES256"
"DES"
DES3
"GCMAES128"
"GCMAES256" (обязательно)
ikeIntegrity Алгоритм целостности IKE (этап IKE 2). "GCMAES128"
"GCMAES256"
"MD5"
"SHA1"
Sha256
SHA384 (обязательно)
ipsecEncryption Алгоритм шифрования IPSec (этап IKE 1). "AES128"
"AES192"
"AES256"
"DES"
DES3
"GCMAES128"
"GCMAES192"
"GCMAES256"
"Нет" (обязательно)
ipsecIntegrity Алгоритм целостности IPSec (этап IKE 1). "GCMAES128"
"GCMAES192"
"GCMAES256"
"MD5"
"SHA1"
SHA256 (обязательно)
pfsGroup Группа Pfs, используемая на этапе IKE 2 для нового дочернего SA. "ECP256"
"ECP384"
"Нет"
'PFS1'
'PFS14'
'PFS2'
"PFS2048"
'PFS24'
PFSMM (обязательно)
saDataSizeKilobytes Размер полезных данных IPSec (также называемый быстрым режимом или этапом 2 SA) в КБ для сайта vpn-туннеля. int (обязательно)
saLifeTimeSeconds Связь безопасности IPSec (также называемая быстрым режимом или этапом 2 SA) в секундах для сайта vpn-туннеля сайта. int (обязательно)

Microsoft.Network/virtualNetworkGateways

Имя Описание Ценность
extendedLocation Расширенное расположение шлюза локальной виртуальной сети типа. ExtendedLocation
местоположение Расположение ресурса. струна
имя Имя ресурса строка (обязательно)
свойства Свойства шлюза виртуальной сети. VirtualNetworkGatewayPropertiesFormat (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.Network/virtualNetworkGateways@2021-03-01"

RadiusServer

Имя Описание Ценность
radiusServerAddress Адрес этого сервера radius. строка (обязательно)
radiusServerScore Начальная оценка, назначенная этому серверу radius. int
radiusServerSecret Секрет, используемый для этого сервера radius. струна

ResourceTags

Имя Описание Ценность

SubResource

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна

VirtualNetworkGatewayIPConfiguration

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства IP-конфигурации шлюза виртуальной сети. VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

Имя Описание Ценность
privateIPAllocationMethod Метод выделения частных IP-адресов. Dynamic
"Статический"
publicIPAddress Ссылка на ресурс общедоступного IP-адреса. SubResource
подсеть Ссылка на ресурс подсети. SubResource

VirtualNetworkGatewayNatRule

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства правила NAT шлюза виртуальной сети. VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayNatRuleProperties

Имя Описание Ценность
externalMappings Внешнее сопоставление частных IP-адресов для NAT. VpnNatRuleMapping[]
internalMappings Внутреннее сопоставление частных IP-адресов для NAT. VpnNatRuleMapping[]
ipConfigurationId Идентификатор конфигурации IP-адресов, к этому правилу NAT применяется. струна
режим Направление исходного NAT ДЛЯ VPN-NAT. EgressSnat
'IngressSnat'
тип Тип правила NAT для VPN NAT. Dynamic
"Статический"

VirtualNetworkGatewayPropertiesFormat

Имя Описание Ценность
activeActive Флаг ActiveActive. bool
bgpSettings Параметры динамиков BGP шлюза виртуальной сети. BgpSettings
customRoutes Ссылка на ресурс адресного пространства, представляющий адресное пространство пользовательских маршрутов, указанное клиентом для шлюза виртуальной сети и VpnClient. AddressSpace
enableBgp Включена ли BGP для этого шлюза виртуальной сети или нет. bool
enableBgpRouteTranslationForNat Флаг EnableBgpRouteTranslationForNat. bool
enableDnsForwarding Включена ли переадресация DNS. bool
enablePrivateIpAddress Необходимо ли включить частный IP-адрес в этом шлюзе для подключений или нет. bool
gatewayDefaultSite Ссылка на ресурс LocalNetworkGateway, представляющий локальный сетевой сайт с маршрутами по умолчанию. Назначьте значение NULL в случае удаления существующего параметра сайта по умолчанию. SubResource
gatewayType Тип этого шлюза виртуальной сети. ExpressRoute
'LocalGateway'
"Vpn"
ipConfigurations IP-конфигурации для шлюза виртуальной сети. VirtualNetworkGatewayIPConfiguration[]
natRules NatRules для шлюза виртуальной сети. VirtualNetworkGatewayNatRule[]
SKU Ссылка на ресурс VirtualNetworkGatewaySku, представляющий номер SKU, выбранный для шлюза виртуальной сети. VirtualNetworkGatewaySku
vNetExtendedLocationResourceId Идентификатор ресурса виртуальной сети клиента. VirtualNetworkGateway типа локальный шлюз связан с виртуальной сетью клиента. струна
vpnClientConfiguration Ссылка на ресурс VpnClientConfiguration, представляющий конфигурации VPNClient P2S. VpnClientConfiguration
vpnGatewayGeneration Поколение для этого VirtualNetworkGateway. Значение None, если gatewayType не является VPN. "Поколение1"
"Поколение2"
"Нет"
vpnType Тип этого шлюза виртуальной сети. PolicyBased
RouteBased

VirtualNetworkGatewaySku

Имя Описание Ценность
имя Имя SKU шлюза. "Базовый"
'ErGw1AZ'
'ErGw2AZ'
'ErGw3AZ'
"HighPerformance"
"Стандартный"
"UltraPerformance"
VpnGw1
VpnGw1AZ
VpnGw2
VpnGw2AZ
VpnGw3
VpnGw3AZ
VpnGw4
VpnGw4AZ
VpnGw5
VpnGw5AZ
ярус Уровень SKU шлюза. "Базовый"
'ErGw1AZ'
'ErGw2AZ'
'ErGw3AZ'
"HighPerformance"
"Стандартный"
"UltraPerformance"
VpnGw1
VpnGw1AZ
VpnGw2
VpnGw2AZ
VpnGw3
VpnGw3AZ
VpnGw4
VpnGw4AZ
VpnGw5
VpnGw5AZ

VpnClientConfiguration

Имя Описание Ценность
aadAudience Свойство AADAudience ресурса VirtualNetworkGateway для подключения vpn-клиента, используемого для проверки подлинности AAD. струна
aadIssuer Свойство AADIssuer ресурса VirtualNetworkGateway для подключения vpn-клиента, используемого для проверки подлинности AAD. струна
aadTenant Свойство AADTenant ресурса VirtualNetworkGateway для подключения vpn-клиента, используемого для проверки подлинности AAD. струна
radiusServerAddress Свойство адреса сервера радиуса ресурса VirtualNetworkGateway для подключения vpn-клиента. струна
radiusServers Свойство radiusServers для конфигурации нескольких серверов радиуса. RadiusServer[]
radiusServerSecret Свойство секрета радиуса ресурса VirtualNetworkGateway для подключения vpn-клиента. струна
vpnAuthenticationTypes Типы проверки подлинности VPN для шлюза виртуальной сети.. Массив строк, содержащий любой из:
AAD
"Сертификат"
"Radius"
vpnClientAddressPool Ссылка на ресурс адресного пространства, представляющий адресное пространство для VpnClient P2S. AddressSpace
vpnClientIpsecPolicies VpnClientIpsecPolicies для клиента P2S шлюза виртуальной сети. IpsecPolicy[]
vpnClientProtocols VpnClientProtocols для шлюза виртуальной сети. Массив строк, содержащий любой из:
'IkeV2'
OpenVPN
SSTP
vpnClientRevokedCertificates VpnClientRevokedCertificate для шлюза виртуальной сети. VpnClientRevokedCertificate[]
vpnClientRootCertificates VpnClientRootCertificate для шлюза виртуальной сети. VpnClientRootCertificate[]

VpnClientRevokedCertificate

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства отозванного сертификата vpn-клиента. VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

Имя Описание Ценность
Отпечаток Отпечаток отозванного сертификата VPN-клиента. струна

VpnClientRootCertificate

Имя Описание Ценность
идентификатор Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
свойства Свойства корневого сертификата vpn-клиента. VpnClientRootCertificatePropertiesFormat (обязательно)

VpnClientRootCertificatePropertiesFormat

Имя Описание Ценность
publicCertData Общедоступные данные сертификата. строка (обязательно)

VpnNatRuleMapping

Имя Описание Ценность
адресное пространство Адресное пространство для сопоставления Vpn NatRule. струна