Microsoft.Network vpnSites 2022-05-01

Статья
05/07/2024

Определение ресурса Bicep

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

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

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

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

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

resource symbolicname 'Microsoft.Network/vpnSites@2022-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  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
          }
        }
      }
    ]
  }
}

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

vpnSites

Имя	Описание	Значение
name	имя ресурса.	string (обязательно) Ограничение символов: 1-80 Допустимые символы: Буквенно-цифровые символы, символы подчеркивания, точки и дефисы. Начинается с буквенно-цифрового символа. Заканчивается буквенно-цифровым символом или символом подчеркивания.
location	Расположение ресурса.	строка
tags	Теги ресурсов.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Свойства сайта VPN.	VpnSiteProperties

VpnSiteProperties

Имя	Описание	Значение
addressSpace	Адресное пространство, содержащее массив диапазонов IP-адресов.	AddressSpace
bgpProperties	Набор свойств bgp.	BgpSettings
deviceProperties	Свойства устройства.	Свойства устройства
ipAddress	IP-адрес vpn-сайта.	строка
isSecuritySite	Флаг IsSecuritySite.	bool
o365Policy	Политика Office365.	O365PolicyProperties
siteKey	Ключ vpn-сайта, который можно использовать для подключений.	строка
виртуальная глобальная сеть	Виртуальная глобальная сеть, к которой принадлежит vpnSite.	SubResource
vpnSiteLinks	Список всех ссылок на сайты VPN.	VpnSiteLink[]

AddressSpace

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

BgpSettings

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

IPConfigurationBgpPeeringAddress

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

DeviceProperties

Имя	Описание	Значение
deviceModel	Модель устройства.	строка
deviceVendor	Имя поставщика устройства.	строка
linkSpeedInMbps	Скорость связи.	INT

O365PolicyProperties

Имя	Описание	Значение
Категории breakOut	Категории прорывов Office365.	O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

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

SubResource

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

VpnSiteLink

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства ссылки на сайт VPN.	VpnSiteLinkProperties

VpnSiteLinkProperties

Имя	Описание	Значение
bgpProperties	Набор свойств bgp.	VpnLinkBgpSettings
fqdn	Полное доменное имя vpn-site-link.	строка
ipAddress	IP-адрес vpn-site-link.	строка
linkProperties	Свойства поставщика ссылок.	Свойства VpnLinkProvider

VpnLinkBgpSettings

Имя	Описание	Значение
Asn	ASN говорящего BGP.	INT
bgpPeeringAddress	Адрес пиринга BGP и идентификатор BGP этого говорящего BGP.	строка

Свойства VpnLinkProvider

Имя	Описание	Значение
linkProviderName	Имя поставщика ссылок.	строка
linkSpeedInMbps	Скорость связи.	INT

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

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.Network/vpnSites",
  "apiVersion": "2022-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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"
          }
        }
      }
    ]
  }
}

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

vpnSites

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.Network/vpnSites
версия_API	Версия API ресурсов	'2022-05-01'
name	имя ресурса.	string (обязательно) Ограничение символов: 1-80 Допустимые символы: Буквенно-цифровые символы, символы подчеркивания, точки и дефисы. Начинается с буквенно-цифрового символа. Заканчивается буквенно-цифровым символом или символом подчеркивания.
location	Расположение ресурса.	строка
tags	Теги ресурсов.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Свойства сайта VPN.	VpnSiteProperties

VpnSiteProperties

Имя	Описание	Значение
addressSpace	Адресное пространство, содержащее массив диапазонов IP-адресов.	AddressSpace
bgpProperties	Набор свойств bgp.	BgpSettings
deviceProperties	Свойства устройства.	Свойства устройства
ipAddress	IP-адрес vpn-сайта.	строка
isSecuritySite	Флаг IsSecuritySite.	bool
o365Policy	Политика Office365.	O365PolicyProperties
siteKey	Ключ vpn-сайта, который можно использовать для подключений.	строка
виртуальная глобальная сеть	Виртуальная глобальная сеть, к которой принадлежит vpnSite.	SubResource
vpnSiteLinks	Список всех ссылок на сайты VPN.	VpnSiteLink[]

AddressSpace

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

BgpSettings

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

IPConfigurationBgpPeeringAddress

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

DeviceProperties

Имя	Описание	Значение
deviceModel	Модель устройства.	строка
deviceVendor	Имя поставщика устройства.	строка
linkSpeedInMbps	Скорость связи.	INT

O365PolicyProperties

Имя	Описание	Значение
Категории breakOut	Категории прорывов Office365.	O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

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

SubResource

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

VpnSiteLink

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства ссылки на сайт VPN.	VpnSiteLinkProperties

VpnSiteLinkProperties

Имя	Описание	Значение
bgpProperties	Набор свойств bgp.	VpnLinkBgpSettings
fqdn	Полное доменное имя vpn-site-link.	строка
ipAddress	IP-адрес vpn-site-link.	строка
linkProperties	Свойства поставщика ссылок.	Свойства VpnLinkProvider

VpnLinkBgpSettings

Имя	Описание	Значение
Asn	ASN говорящего BGP.	INT
bgpPeeringAddress	Адрес пиринга BGP и идентификатор BGP этого говорящего BGP.	строка

Свойства VpnLinkProvider

Имя	Описание	Значение
linkProviderName	Имя поставщика ссылок.	строка
linkSpeedInMbps	Скорость связи.	INT

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

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

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnSites@2022-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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
            }
          }
        }
      ]
    }
  })
}

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

vpnSites

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.Network/vpnSites@2022-05-01"
name	имя ресурса.	string (обязательно) Ограничение символов: 1-80 Допустимые символы: Буквенно-цифровые символы, символы подчеркивания, точки и дефисы. Начинается с буквенно-цифрового символа. Заканчивается буквенно-цифровым символом или символом подчеркивания.
location	Расположение ресурса.	строка
parent_id	Для развертывания в группе ресурсов используйте идентификатор этой группы ресурсов.	string (обязательно)
tags	Теги ресурсов.	Словарь имен и значений тегов.
properties	Свойства сайта VPN.	VpnSiteProperties

VpnSiteProperties

Имя	Описание	Значение
addressSpace	Адресное пространство, содержащее массив диапазонов IP-адресов.	AddressSpace
bgpProperties	Набор свойств bgp.	BgpSettings
deviceProperties	Свойства устройства.	Свойства устройства
ipAddress	IP-адрес vpn-сайта.	строка
isSecuritySite	Флаг IsSecuritySite.	bool
o365Policy	Политика Office365.	O365PolicyProperties
siteKey	Ключ vpn-сайта, который можно использовать для подключений.	строка
виртуальная глобальная сеть	Виртуальная глобальная сеть, к которой принадлежит vpnSite.	SubResource
vpnSiteLinks	Список всех ссылок на сайты VPN.	VpnSiteLink[]

AddressSpace

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

BgpSettings

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

IPConfigurationBgpPeeringAddress

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

DeviceProperties

Имя	Описание	Значение
deviceModel	Модель устройства.	строка
deviceVendor	Имя поставщика устройства.	строка
linkSpeedInMbps	Скорость соединения.	INT

O365PolicyProperties

Имя	Описание	Значение
BreakOutCategories	Категории прорывов Office365.	O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

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

SubResource

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

VpnSiteLink

Имя	Описание	Значение
идентификатор	Идентификатор ресурса.	строка
name	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.	строка
properties	Свойства ссылки на сайт VPN.	VpnSiteLinkProperties

VpnSiteLinkProperties

Имя	Описание	Значение
bgpProperties	Набор свойств bgp.	VpnLinkBgpSettings
fqdn	Полное доменное имя vpn-site-link.	строка
ipAddress	IP-адрес vpn-site-link.	строка
linkProperties	Свойства поставщика ссылок.	Свойства VpnLinkProvider

VpnLinkBgpSettings

Имя	Описание	Значение
Asn	ASN говорящего BGP.	INT
bgpPeeringAddress	Адрес пиринга BGP и идентификатор BGP этого говорящего BGP.	строка

Свойства VpnLinkProvider

Имя	Описание	Значение
linkProviderName	Имя поставщика ссылок.	строка
linkSpeedInMbps	Скорость связи.	INT

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

Microsoft.Network vpnSites 2022-05-01

Определение ресурса Bicep

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

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

vpnSites

VpnSiteProperties

AddressSpace

BgpSettings

IPConfigurationBgpPeeringAddress

DeviceProperties

O365PolicyProperties

O365BreakOutCategoryPolicies

SubResource

VpnSiteLink

VpnSiteLinkProperties

VpnLinkBgpSettings

Свойства VpnLinkProvider

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

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

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

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

vpnSites

VpnSiteProperties

AddressSpace

BgpSettings

IPConfigurationBgpPeeringAddress

DeviceProperties

O365PolicyProperties

O365BreakOutCategoryPolicies

SubResource

VpnSiteLink

VpnSiteLinkProperties

VpnLinkBgpSettings

Свойства VpnLinkProvider

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

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

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

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

vpnSites

VpnSiteProperties

AddressSpace

BgpSettings

IPConfigurationBgpPeeringAddress

DeviceProperties

O365PolicyProperties

O365BreakOutCategoryPolicies

SubResource

VpnSiteLink

VpnSiteLinkProperties

VpnLinkBgpSettings

Свойства VpnLinkProvider

Обратная связь

Дополнительные ресурсы