Microsoft.Network vpnСайты 2025-01-01

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

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

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

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

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

resource symbolicname 'Microsoft.Network/vpnSites@2025-01-01' = {
  location: 'string'
  name: 'string'
  properties: {
    addressSpace: {
      addressPrefixes: [
        'string'
      ]
      ipamPoolPrefixAllocations: [
        {
          numberOfIpAddresses: 'string'
          pool: {
            id: 'string'
          }
        }
      ]
    }
    bgpProperties: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    deviceProperties: {
      deviceModel: 'string'
      deviceVendor: 'string'
      linkSpeedInMbps: int
    }
    ipAddress: 'string'
    isSecuritySite: bool
    o365Policy: {
      breakOutCategories: {
        allow: bool
        default: bool
        optimize: bool
      }
    }
    siteKey: 'string'
    virtualWan: {
      id: 'string'
    }
    vpnSiteLinks: [
      {
        id: 'string'
        name: 'string'
        properties: {
          bgpProperties: {
            asn: int
            bgpPeeringAddress: 'string'
          }
          fqdn: 'string'
          ipAddress: 'string'
          linkProperties: {
            linkProviderName: 'string'
            linkSpeedInMbps: int
          }
        }
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

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

Microsoft.Network/vpnSites

Имя Description Ценность
location Расположение ресурса. струна
имя имя ресурса. строка (обязательно)
properties Свойства VPN-сайта. VpnSiteProperties
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. инт

DeviceProperties

Имя Description Ценность
модель устройства Модель устройства. струна
deviceVendor Имя поставщика устройства. струна
linkСкоростьМбит/с Скорость связи. инт

IpamPoolPrefixAllocation

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

IpamPoolPrefixAllocationPool

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

IPConfigurationBgpPeeringAddress

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

O365BreakOutCategoryPolicies

Имя Description Ценность
разрешать Флаг для управления категорией разрешений. bool
default Пометка для управления категорией по умолчанию. bool
optimize Флаг для управления категорией оптимизации. bool

O365PolicyProperties

Имя Description Ценность
breakOutCategories Категории останова Office365. O365BreakOutCategoryPolicies

ResourceTags

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

Подресурс

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

VpnLinkBgpНастройки

Имя Description Ценность
асн ASN докладчика BGP. инт
bgpPeeringAddress Адрес пиринга BGP и идентификатор BGP этого докладчика BGP. струна

VpnLinkProviderProperTies

Имя Description Ценность
linkИмяПровайдера Имя поставщика ссылок. струна
linkСкоростьМбит/с Скорость связи. инт
Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства ссылки VPN-сайта. Свойства vpnSiteLink

Свойства vpnSiteLink

Имя Description Ценность
bgpСвойства Набор свойств bgp. VpnLinkBgpНастройки
Полное доменное имя (FQDN) Полное доменное имя vpn-сайта-link. струна
ipAddress IP-адрес для vpn-site-link. струна
linkСвойства Свойства поставщика ссылок. VpnLinkProviderProperTies

VpnSiteProperties

Имя Description Ценность
адресное пространство Адресное пространство, содержащее массив диапазонов IP-адресов. Адресное пространство
bgpСвойства Набор свойств bgp. Настройки Bgp
свойства_устройства Свойства устройства. Свойства устройства
ipAddress IP-адрес vpn-сайта. струна
isSecuritySite Флаг IsSecuritySite. bool
o365Политика Политика Office365. O365PolicyProperties
siteKey Ключ vpn-сайта, который можно использовать для подключений. струна
virtualWan Виртуальная глобальная сеть, к которой принадлежит vpnSite. Подресурс
vpnSiteLinks Список всех ссылок vpn-сайта. VpnSiteLink[]

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

Примеры Bicep

Простой пример развертывания VPN сайта.

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

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

resource vpnSite 'Microsoft.Network/vpnSites@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.0.1.0/24'
      ]
    }
    virtualWan: {
      id: virtualWan.id
    }
    vpnSiteLinks: [
      {
        name: 'link1'
        properties: {
          fqdn: ''
          ipAddress: '10.0.1.1'
          linkProperties: {
            linkProviderName: ''
            linkSpeedInMbps: 0
          }
        }
      }
      {
        name: 'link2'
        properties: {
          fqdn: ''
          ipAddress: '10.0.1.2'
          linkProperties: {
            linkProviderName: ''
            linkSpeedInMbps: 0
          }
        }
      }
    ]
  }
}

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

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

Модуль Description
VPN-сайт Модуль ресурсов AVM для VPN-сайта

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

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

Файл Bicep Description
Создает ресурсы Виртуальной глобальной сети Этот шаблон позволяет создавать ресурсы виртуальной глобальной сети, включая виртуальную глобальную сеть, виртуальный концентратор, VPN-шлюз, VPN-сайт и VPN-соединение.

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

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

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

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

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

{
  "type": "Microsoft.Network/vpnSites",
  "apiVersion": "2025-01-01",
  "name": "string",
  "location": "string",
  "properties": {
    "addressSpace": {
      "addressPrefixes": [ "string" ],
      "ipamPoolPrefixAllocations": [
        {
          "numberOfIpAddresses": "string",
          "pool": {
            "id": "string"
          }
        }
      ]
    },
    "bgpProperties": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "deviceProperties": {
      "deviceModel": "string",
      "deviceVendor": "string",
      "linkSpeedInMbps": "int"
    },
    "ipAddress": "string",
    "isSecuritySite": "bool",
    "o365Policy": {
      "breakOutCategories": {
        "allow": "bool",
        "default": "bool",
        "optimize": "bool"
      }
    },
    "siteKey": "string",
    "virtualWan": {
      "id": "string"
    },
    "vpnSiteLinks": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "bgpProperties": {
            "asn": "int",
            "bgpPeeringAddress": "string"
          },
          "fqdn": "string",
          "ipAddress": "string",
          "linkProperties": {
            "linkProviderName": "string",
            "linkSpeedInMbps": "int"
          }
        }
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

Microsoft.Network/vpnSites

Имя Description Ценность
apiVersion Версия API '2025-01-01'
location Расположение ресурса. струна
имя имя ресурса. строка (обязательно)
properties Свойства VPN-сайта. VpnSiteProperties
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
type Тип ресурса "Microsoft.Network/vpnSites"

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

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

Настройки Bgp

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

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

DeviceProperties

Имя Description Ценность
модель устройства Модель устройства. струна
deviceVendor Имя поставщика устройства. струна
linkСкоростьМбит/с Скорость связи. инт

IpamPoolPrefixAllocation

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

IpamPoolPrefixAllocationPool

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

IPConfigurationBgpPeeringAddress

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

O365BreakOutCategoryPolicies

Имя Description Ценность
разрешать Флаг для управления категорией разрешений. bool
default Пометка для управления категорией по умолчанию. bool
optimize Флаг для управления категорией оптимизации. bool

O365PolicyProperties

Имя Description Ценность
breakOutCategories Категории останова Office365. O365BreakOutCategoryPolicies

ResourceTags

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

Подресурс

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

VpnLinkBgpНастройки

Имя Description Ценность
асн ASN докладчика BGP. инт
bgpPeeringAddress Адрес пиринга BGP и идентификатор BGP этого докладчика BGP. струна

VpnLinkProviderProperTies

Имя Description Ценность
linkИмяПровайдера Имя поставщика ссылок. струна
linkСкоростьМбит/с Скорость связи. инт
Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства ссылки VPN-сайта. Свойства vpnSiteLink

Свойства vpnSiteLink

Имя Description Ценность
bgpСвойства Набор свойств bgp. VpnLinkBgpНастройки
Полное доменное имя (FQDN) Полное доменное имя vpn-сайта-link. струна
ipAddress IP-адрес для vpn-site-link. струна
linkСвойства Свойства поставщика ссылок. VpnLinkProviderProperTies

VpnSiteProperties

Имя Description Ценность
адресное пространство Адресное пространство, содержащее массив диапазонов IP-адресов. Адресное пространство
bgpСвойства Набор свойств bgp. Настройки Bgp
свойства_устройства Свойства устройства. Свойства устройства
ipAddress IP-адрес vpn-сайта. струна
isSecuritySite Флаг IsSecuritySite. bool
o365Политика Политика Office365. O365PolicyProperties
siteKey Ключ vpn-сайта, который можно использовать для подключений. струна
virtualWan Виртуальная глобальная сеть, к которой принадлежит vpnSite. Подресурс
vpnSiteLinks Список всех ссылок vpn-сайта. VpnSiteLink[]

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

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

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

Template Description
Создает ресурсы Виртуальной глобальной сети

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnSites@2025-01-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = [
          "string"
        ]
        ipamPoolPrefixAllocations = [
          {
            numberOfIpAddresses = "string"
            pool = {
              id = "string"
            }
          }
        ]
      }
      bgpProperties = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      deviceProperties = {
        deviceModel = "string"
        deviceVendor = "string"
        linkSpeedInMbps = int
      }
      ipAddress = "string"
      isSecuritySite = bool
      o365Policy = {
        breakOutCategories = {
          allow = bool
          default = bool
          optimize = bool
        }
      }
      siteKey = "string"
      virtualWan = {
        id = "string"
      }
      vpnSiteLinks = [
        {
          id = "string"
          name = "string"
          properties = {
            bgpProperties = {
              asn = int
              bgpPeeringAddress = "string"
            }
            fqdn = "string"
            ipAddress = "string"
            linkProperties = {
              linkProviderName = "string"
              linkSpeedInMbps = int
            }
          }
        }
      ]
    }
  }
}

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

Microsoft.Network/vpnSites

Имя Description Ценность
location Расположение ресурса. струна
имя имя ресурса. строка (обязательно)
properties Свойства VPN-сайта. VpnSiteProperties
tags Теги ресурсов Словарь имен и значений тегов.
type Тип ресурса "Microsoft.Network/vpnSites@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. инт

DeviceProperties

Имя Description Ценность
модель устройства Модель устройства. струна
deviceVendor Имя поставщика устройства. струна
linkСкоростьМбит/с Скорость связи. инт

IpamPoolPrefixAllocation

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

IpamPoolPrefixAllocationPool

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

IPConfigurationBgpPeeringAddress

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

O365BreakOutCategoryPolicies

Имя Description Ценность
разрешать Флаг для управления категорией разрешений. bool
default Пометка для управления категорией по умолчанию. bool
optimize Флаг для управления категорией оптимизации. bool

O365PolicyProperties

Имя Description Ценность
breakOutCategories Категории останова Office365. O365BreakOutCategoryPolicies

ResourceTags

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

Подресурс

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

VpnLinkBgpНастройки

Имя Description Ценность
асн ASN докладчика BGP. инт
bgpPeeringAddress Адрес пиринга BGP и идентификатор BGP этого докладчика BGP. струна

VpnLinkProviderProperTies

Имя Description Ценность
linkИмяПровайдера Имя поставщика ссылок. струна
linkСкоростьМбит/с Скорость связи. инт
Имя Description Ценность
id Идентификатор ресурса. струна
имя Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу. струна
properties Свойства ссылки VPN-сайта. Свойства vpnSiteLink

Свойства vpnSiteLink

Имя Description Ценность
bgpСвойства Набор свойств bgp. VpnLinkBgpНастройки
Полное доменное имя (FQDN) Полное доменное имя vpn-сайта-link. струна
ipAddress IP-адрес для vpn-site-link. струна
linkСвойства Свойства поставщика ссылок. VpnLinkProviderProperTies

VpnSiteProperties

Имя Description Ценность
адресное пространство Адресное пространство, содержащее массив диапазонов IP-адресов. Адресное пространство
bgpСвойства Набор свойств bgp. Настройки Bgp
свойства_устройства Свойства устройства. Свойства устройства
ipAddress IP-адрес vpn-сайта. струна
isSecuritySite Флаг IsSecuritySite. bool
o365Политика Политика Office365. O365PolicyProperties
siteKey Ключ vpn-сайта, который можно использовать для подключений. струна
virtualWan Виртуальная глобальная сеть, к которой принадлежит vpnSite. Подресурс
vpnSiteLinks Список всех ссылок vpn-сайта. VpnSiteLink[]

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

Примеры Terraform

Простой пример развертывания VPN сайта.

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

provider "azapi" {
  skip_provider_registration = false
}

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

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

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

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

resource "azapi_resource" "vpnSite" {
  type      = "Microsoft.Network/vpnSites@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = [
          "10.0.1.0/24",
        ]
      }
      virtualWan = {
        id = azapi_resource.virtualWan.id
      }
      vpnSiteLinks = [
        {
          name = "link1"
          properties = {
            fqdn      = ""
            ipAddress = "10.0.1.1"
            linkProperties = {
              linkProviderName = ""
              linkSpeedInMbps  = 0
            }
          }
        },
        {
          name = "link2"
          properties = {
            fqdn      = ""
            ipAddress = "10.0.1.2"
            linkProperties = {
              linkProviderName = ""
              linkSpeedInMbps  = 0
            }
          }
        },
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}