你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Network vpnSites 2018-10-01

• 最新
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01

Bicep 资源定义

可以使用目标操作部署 vpnSites 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Network/vpnSites 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Network/vpnSites@2018-10-01' = {
  location: 'string'
  name: 'string'
  properties: {
    addressSpace: {
      addressPrefixes: [
        'string'
      ]
    }
    bgpProperties: {
      asn: int
      bgpPeeringAddress: 'string'
      peerWeight: int
    }
    deviceProperties: {
      deviceModel: 'string'
      deviceVendor: 'string'
      linkSpeedInMbps: int
    }
    ipAddress: 'string'
    isSecuritySite: bool
    provisioningState: 'string'
    siteKey: 'string'
    virtualWan: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AddressSpace

名字	描述	价值
addressPrefixes	CIDR 表示法中为此虚拟网络保留的地址块列表。	string[]

BgpSettings

名字	描述	价值
asn	BGP 扬声器的 ASN。	int
bgpPeeringAddress	此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。	字符串
peerWeight	添加到从此 BGP 扬声器中学习的路由的权重。	int

DeviceProperties

名字	描述	价值
deviceModel	设备的型号。	字符串
deviceVendor	设备供应商的名称。	字符串
linkSpeedInMbps	链接速度。	int

Microsoft.Network/vpnSites

名字	描述	价值
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	VpnSite 的参数	VpnSiteProperties
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

ResourceTags

名字	描述	价值

SubResource

名字	描述	价值
id	资源 ID。	字符串

VpnSiteProperties

名字	描述	价值
addressSpace	包含 IP 地址范围的数组的 AddressSpace。	AddressSpace
bgpProperties	bgp 属性集。	BgpSettings
deviceProperties	设备属性	DeviceProperties
ipAddress	vpn 站点的 IP 地址。	字符串
isSecuritySite	IsSecuritySite 标志	bool
provisioningState	资源的预配状态。	“删除” “Failed” “Succeeded” “正在更新”
siteKey	可用于连接的 vpn 站点的密钥。	字符串
virtualWan	vpnSite 所属的 VirtualWAN	SubResource

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
创建虚拟 WAN 资源	使用此模板可以创建虚拟 WAN 资源，包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。

ARM 模板资源定义

可以使用目标操作部署 vpnSites 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Network/vpnSites 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Network/vpnSites",
  "apiVersion": "2018-10-01",
  "name": "string",
  "location": "string",
  "properties": {
    "addressSpace": {
      "addressPrefixes": [ "string" ]
    },
    "bgpProperties": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "peerWeight": "int"
    },
    "deviceProperties": {
      "deviceModel": "string",
      "deviceVendor": "string",
      "linkSpeedInMbps": "int"
    },
    "ipAddress": "string",
    "isSecuritySite": "bool",
    "provisioningState": "string",
    "siteKey": "string",
    "virtualWan": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AddressSpace

名字	描述	价值
addressPrefixes	CIDR 表示法中为此虚拟网络保留的地址块列表。	string[]

BgpSettings

名字	描述	价值
asn	BGP 扬声器的 ASN。	int
bgpPeeringAddress	此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。	字符串
peerWeight	添加到从此 BGP 扬声器中学习的路由的权重。	int

DeviceProperties

名字	描述	价值
deviceModel	设备的型号。	字符串
deviceVendor	设备供应商的名称。	字符串
linkSpeedInMbps	链接速度。	int

Microsoft.Network/vpnSites

名字	描述	价值
apiVersion	API 版本	'2018-10-01'
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	VpnSite 的参数	VpnSiteProperties
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.Network/vpnSites”

ResourceTags

名字	描述	价值

SubResource

名字	描述	价值
id	资源 ID。	字符串

VpnSiteProperties

名字	描述	价值
addressSpace	包含 IP 地址范围的数组的 AddressSpace。	AddressSpace
bgpProperties	bgp 属性集。	BgpSettings
deviceProperties	设备属性	DeviceProperties
ipAddress	vpn 站点的 IP 地址。	字符串
isSecuritySite	IsSecuritySite 标志	bool
provisioningState	资源的预配状态。	“删除” “Failed” “Succeeded” “正在更新”
siteKey	可用于连接的 vpn 站点的密钥。	字符串
virtualWan	vpnSite 所属的 VirtualWAN	SubResource

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
创建虚拟 WAN 资源	使用此模板可以创建虚拟 WAN 资源，包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 vpnSites 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Network/vpnSites 资源，请将以下 Terraform 添加到模板中。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnSites@2018-10-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      addressSpace = {
        addressPrefixes = [
          "string"
        ]
      }
      bgpProperties = {
        asn = int
        bgpPeeringAddress = "string"
        peerWeight = int
      }
      deviceProperties = {
        deviceModel = "string"
        deviceVendor = "string"
        linkSpeedInMbps = int
      }
      ipAddress = "string"
      isSecuritySite = bool
      provisioningState = "string"
      siteKey = "string"
      virtualWan = {
        id = "string"
      }
    }
  })
}

属性值

AddressSpace

名字	描述	价值
addressPrefixes	CIDR 表示法中为此虚拟网络保留的地址块列表。	string[]

BgpSettings

名字	描述	价值
asn	BGP 扬声器的 ASN。	int
bgpPeeringAddress	此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。	字符串
peerWeight	添加到从此 BGP 扬声器中学习的路由的权重。	int

DeviceProperties

名字	描述	价值
deviceModel	设备的型号。	字符串
deviceVendor	设备供应商的名称。	字符串
linkSpeedInMbps	链接速度。	int

Microsoft.Network/vpnSites

名字	描述	价值
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	VpnSite 的参数	VpnSiteProperties
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Network/vpnSites@2018-10-01”

ResourceTags

名字	描述	价值

SubResource

名字	描述	价值
id	资源 ID。	字符串

VpnSiteProperties

名字	描述	价值
addressSpace	包含 IP 地址范围的数组的 AddressSpace。	AddressSpace
bgpProperties	bgp 属性集。	BgpSettings
deviceProperties	设备属性	DeviceProperties
ipAddress	vpn 站点的 IP 地址。	字符串
isSecuritySite	IsSecuritySite 标志	bool
provisioningState	资源的预配状态。	“删除” “Failed” “Succeeded” “正在更新”
siteKey	可用于连接的 vpn 站点的密钥。	字符串
virtualWan	vpnSite 所属的 VirtualWAN	SubResource