Microsoft.Network localNetworkGateways 2025-01-01

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

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

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

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

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

resource symbolicname 'Microsoft.Network/localNetworkGateways@2025-01-01' = {
  location: 'string'
  name: 'string'
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    fqdn: 'string'
    gatewayIpAddress: 'string'
    localNetworkAddressSpace: {
      addressPrefixes: [
        'string'
      ]
      ipamPoolPrefixAllocations: [
        {
          numberOfIpAddresses: 'string'
          pool: {
            id: 'string'
          }
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

Microsoft.Network/localNetworkGateways

Имя Description Ценность
location Расположение ресурса. струна
имя имя ресурса. string

Constraints:
Минимальная длина = 1 (обязательно)
properties Свойства шлюза локальной сети. LocalNetworkGatewayPropertiesFormat (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

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

Имя Description Ценность
addressПрефиксы Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR. строка[]
ipamPoolPrefixAllocations Список пулов IPAM, выделяющих префиксы IP-адресов. IpamPoolPrefixAllocation[]

Настройки Bgp

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

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

IpamPoolPrefixAllocation

Имя Description Ценность
numberOfIpAddresses Количество выделенных IP-адресов. струна
бассейн IpamPoolPrefixAllocationPool

IpamPoolPrefixAllocationPool

Имя Description Ценность
id Идентификатор ресурса связанного ресурса Azure IpamPool. струна

IPConfigurationBgpPeeringAddress

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

Формат свойств локального сетевого шлюза

Имя Description Ценность
bgpНастройки Параметры динамиков BGP шлюза локальной сети. Настройки Bgp
Полное доменное имя (FQDN) Полное доменное имя шлюза локальной сети. струна
gatewayIpAddress IP-адрес шлюза локальной сети. струна
localNetworkAddressSpace Адресное пространство локального сетевого сайта. Адресное пространство

ResourceTags

Имя Description Ценность

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

Примеры Bicep

Простой пример развертывания подключения к шлюзу локальной сети, для которого могут быть настроены определенные соединения.

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

resource localNetworkGateway 'Microsoft.Network/localNetworkGateways@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    gatewayIpAddress: '168.62.225.23'
    localNetworkAddressSpace: {
      addressPrefixes: [
        '10.1.1.0/24'
      ]
    }
  }
}

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

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

Модуль Description
шлюз локальной сети Модуль ресурсов AVM для шлюза локальной сети

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.Network/localNetworkGateways",
  "apiVersion": "2025-01-01",
  "name": "string",
  "location": "string",
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "fqdn": "string",
    "gatewayIpAddress": "string",
    "localNetworkAddressSpace": {
      "addressPrefixes": [ "string" ],
      "ipamPoolPrefixAllocations": [
        {
          "numberOfIpAddresses": "string",
          "pool": {
            "id": "string"
          }
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

Microsoft.Network/localNetworkGateways

Имя Description Ценность
apiVersion Версия API '2025-01-01'
location Расположение ресурса. струна
имя имя ресурса. string

Constraints:
Минимальная длина = 1 (обязательно)
properties Свойства шлюза локальной сети. LocalNetworkGatewayPropertiesFormat (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
type Тип ресурса "Microsoft.Network/localNetworkGateways"

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

Имя Description Ценность
addressПрефиксы Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR. строка[]
ipamPoolPrefixAllocations Список пулов IPAM, выделяющих префиксы IP-адресов. IpamPoolPrefixAllocation[]

Настройки Bgp

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

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

IpamPoolPrefixAllocation

Имя Description Ценность
numberOfIpAddresses Количество выделенных IP-адресов. струна
бассейн IpamPoolPrefixAllocationPool

IpamPoolPrefixAllocationPool

Имя Description Ценность
id Идентификатор ресурса связанного ресурса Azure IpamPool. струна

IPConfigurationBgpPeeringAddress

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

Формат свойств локального сетевого шлюза

Имя Description Ценность
bgpНастройки Параметры динамиков BGP шлюза локальной сети. Настройки Bgp
Полное доменное имя (FQDN) Полное доменное имя шлюза локальной сети. струна
gatewayIpAddress IP-адрес шлюза локальной сети. струна
localNetworkAddressSpace Адресное пространство локального сетевого сайта. Адресное пространство

ResourceTags

Имя Description Ценность

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

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

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

Template Description
создание VPN-подключения типа "сеть — сеть"

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

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

Развертывание в Azure
Этот шаблон создает виртуальную сеть, 2 подсети и шлюз
VPN типа "сеть — сеть" с помощью vpn-шлюзов active-active с BGP

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

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

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

  • Группы ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/localNetworkGateways@2025-01-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      fqdn = "string"
      gatewayIpAddress = "string"
      localNetworkAddressSpace = {
        addressPrefixes = [
          "string"
        ]
        ipamPoolPrefixAllocations = [
          {
            numberOfIpAddresses = "string"
            pool = {
              id = "string"
            }
          }
        ]
      }
    }
  }
}

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

Microsoft.Network/localNetworkGateways

Имя Description Ценность
location Расположение ресурса. струна
имя имя ресурса. string

Constraints:
Минимальная длина = 1 (обязательно)
properties Свойства шлюза локальной сети. LocalNetworkGatewayPropertiesFormat (обязательно)
tags Теги ресурсов Словарь имен и значений тегов.
type Тип ресурса "Microsoft.Network/localNetworkGateways@2025-01-01"

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

Имя Description Ценность
addressПрефиксы Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR. строка[]
ipamPoolPrefixAllocations Список пулов IPAM, выделяющих префиксы IP-адресов. IpamPoolPrefixAllocation[]

Настройки Bgp

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

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

IpamPoolPrefixAllocation

Имя Description Ценность
numberOfIpAddresses Количество выделенных IP-адресов. струна
бассейн IpamPoolPrefixAllocationPool

IpamPoolPrefixAllocationPool

Имя Description Ценность
id Идентификатор ресурса связанного ресурса Azure IpamPool. струна

IPConfigurationBgpPeeringAddress

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

Формат свойств локального сетевого шлюза

Имя Description Ценность
bgpНастройки Параметры динамиков BGP шлюза локальной сети. Настройки Bgp
Полное доменное имя (FQDN) Полное доменное имя шлюза локальной сети. струна
gatewayIpAddress IP-адрес шлюза локальной сети. струна
localNetworkAddressSpace Адресное пространство локального сетевого сайта. Адресное пространство

ResourceTags

Имя Description Ценность

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

Примеры Terraform

Простой пример развертывания подключения к шлюзу локальной сети, для которого могут быть настроены определенные соединения.

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" "localNetworkGateway" {
  type      = "Microsoft.Network/localNetworkGateways@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      gatewayIpAddress = "168.62.225.23"
      localNetworkAddressSpace = {
        addressPrefixes = [
          "10.1.1.0/24",
        ]
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

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

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

Модуль Description
шлюз локальной сети Модуль ресурсов AVM для шлюза локальной сети