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


VpnSites Microsoft.Network 2024-03-01

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

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

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

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

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

resource symbolicname 'Microsoft.Network/vpnSites@2024-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    addressSpace: {
      addressPrefixes: [
        '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/vpnСайты

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

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

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

Настройки Bgp

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

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

Свойства устройства

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

IPConfigurationBgpPeeringAddress

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

O365BreakOutCategoryPolicies

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

O365PolicyProperties

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

Теги ресурса

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

Подресурс

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

VpnLinkBgpНастройки

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

VpnLinkProviderProperTies

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

Свойства vpnSiteLink

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

VpnSiteProperties

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

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

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

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

Модуль Описание
VPN-сайт Модуль ресурсов AVM для VPN-сайта

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.Network/vpnSites",
  "apiVersion": "2024-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "addressSpace": {
      "addressPrefixes": [ "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/vpnСайты

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

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

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

Настройки Bgp

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

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

Свойства устройства

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

IPConfigurationBgpPeeringAddress

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

O365BreakOutCategoryPolicies

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

O365PolicyProperties

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

Теги ресурса

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

Подресурс

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

VpnLinkBgpНастройки

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

VpnLinkProviderProperTies

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

Свойства vpnSiteLink

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

VpnSiteProperties

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

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

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

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

Шаблон Описание
Создание ресурсов виртуальной глобальной сети

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnSites@2024-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = [
          "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/vpnСайты

Имя Описание Ценность
местоположение Расположение ресурса. струна
имя Имя ресурса строка (обязательно)
свойства Свойства VPN-сайта. VpnSiteProperties
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.Network/vpnSites@2024-03-01"

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

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

Настройки Bgp

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

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

Свойства устройства

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

IPConfigurationBgpPeeringAddress

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

O365BreakOutCategoryPolicies

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

O365PolicyProperties

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

Теги ресурса

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

Подресурс

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

VpnLinkBgpНастройки

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

VpnLinkProviderProperTies

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

Свойства vpnSiteLink

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

VpnSiteProperties

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