Microsoft.Network vpnSites 2023-11-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@2023-11-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'
  }
}

屬性值

AddressSpace

名字	描述	價值
addressPrefixes	以 CIDR 表示法保留給此虛擬網路的位址區塊清單。	string[]

BgpSettings

名字	描述	價值
asn	BGP 喇叭的 ASN。	int 約束： 最小值 = 0 最大值 = 4294967295
bgpPeeringAddress	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。	字串
bgpPeeringAddresses	具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。	IPConfigurationBgpPeeringAddress[]
peerWeight	新增至此 BGP 喇叭所學習路由的權數。	int

DeviceProperties

名字	描述	價值
deviceModel	裝置的模型。	字串
deviceVendor	裝置廠商的名稱。	字串
linkSpeedInMbps	連結速度。	int

IPConfigurationBgpPeeringAddress

名字	描述	價值
customBgpIpAddresses	屬於IP組態的自訂BGP對等互連位址清單。	string[]
ipconfigurationId	屬於閘道的IP組態標識碼。	字串

Microsoft.Network/vpnSites

名字	描述	價值
位置	資源位置。	字串
名字	資源名稱	字串 （必要）
性能	VPN 月臺的屬性。	VpnSiteProperties
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤

O365BreakOutCategoryPolicies

名字	描述	價值
允許	用來控制允許類別的旗標。	bool
違約	用來控制預設類別的旗標。	bool
優化	用來控制優化類別的旗標。	bool

O365PolicyProperties

名字	描述	價值
breakOutCategories	Office365 分組類別。	O365BreakOutCategoryPolicies

ResourceTags

名字	描述	價值

SubResource

名字	描述	價值
id	資源標識碼。	字串

VpnLinkBgpSettings

名字	描述	價值
asn	BGP 喇叭的 ASN。	int
bgpPeeringAddress	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。	字串

VpnLinkProviderProperties

名字	描述	價值
linkProviderName	連結提供者的名稱。	字串
linkSpeedInMbps	連結速度。	int

VpnSiteLink

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	VPN 網站鏈接的屬性。	VpnSiteLinkProperties

VpnSiteLinkProperties

名字	描述	價值
bgpProperties	bgp 屬性集。	VpnLinkBgpSettings
fqdn	vpn-site-link 的 FQDN。	字串
ipAddress	vpn-site-link 的 ip-address。	字串
linkProperties	連結提供者屬性。	VpnLinkProviderProperties

VpnSiteProperties

名字	描述	價值
addressSpace	包含IP位址範圍數位的AddressSpace。	AddressSpace
bgpProperties	bgp 屬性集。	BgpSettings
deviceProperties	裝置屬性。	DeviceProperties
ipAddress	vpn-site 的 ip-address。	字串
isSecuritySite	IsSecuritySite 旗標。	bool
o365Policy	Office365 原則。	O365PolicyProperties
siteKey	VPN 月臺的金鑰，可用於連線。	字串
virtualWan	vpnSite 所屬的 VirtualWAN。	SubResource
vpnSiteLinks	所有 VPN 網站連結的清單。	VpnSiteLink[]

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
建立虛擬 WAN 資源	此範本可讓您建立虛擬 WAN 資源，包括虛擬 WAN、虛擬中樞、VPN 閘道、VPN 網站和 VPN Connecton。

ARM 樣本資源定義

vpnSites 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/vpnSites 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Network/vpnSites",
  "apiVersion": "2023-11-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"
  }
}

屬性值

AddressSpace

名字	描述	價值
addressPrefixes	以 CIDR 表示法保留給此虛擬網路的位址區塊清單。	string[]

BgpSettings

名字	描述	價值
asn	BGP 喇叭的 ASN。	int 約束： 最小值 = 0 最大值 = 4294967295
bgpPeeringAddress	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。	字串
bgpPeeringAddresses	具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。	IPConfigurationBgpPeeringAddress[]
peerWeight	新增至此 BGP 喇叭所學習路由的權數。	int

DeviceProperties

名字	描述	價值
deviceModel	裝置的模型。	字串
deviceVendor	裝置廠商的名稱。	字串
linkSpeedInMbps	連結速度。	int

IPConfigurationBgpPeeringAddress

名字	描述	價值
customBgpIpAddresses	屬於IP組態的自訂BGP對等互連位址清單。	string[]
ipconfigurationId	屬於閘道的IP組態標識碼。	字串

Microsoft.Network/vpnSites

名字	描述	價值
apiVersion	API 版本	'2023-11-01'
位置	資源位置。	字串
名字	資源名稱	字串 （必要）
性能	VPN 月臺的屬性。	VpnSiteProperties
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤
類型	資源類型	'Microsoft.Network/vpnSites'

O365BreakOutCategoryPolicies

名字	描述	價值
允許	用來控制允許類別的旗標。	bool
違約	用來控制預設類別的旗標。	bool
優化	用來控制優化類別的旗標。	bool

O365PolicyProperties

名字	描述	價值
breakOutCategories	Office365 分組類別。	O365BreakOutCategoryPolicies

ResourceTags

名字	描述	價值

SubResource

名字	描述	價值
id	資源標識碼。	字串

VpnLinkBgpSettings

名字	描述	價值
asn	BGP 喇叭的 ASN。	int
bgpPeeringAddress	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。	字串

VpnLinkProviderProperties

名字	描述	價值
linkProviderName	連結提供者的名稱。	字串
linkSpeedInMbps	連結速度。	int

VpnSiteLink

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	VPN 網站鏈接的屬性。	VpnSiteLinkProperties

VpnSiteLinkProperties

名字	描述	價值
bgpProperties	bgp 屬性集。	VpnLinkBgpSettings
fqdn	vpn-site-link 的 FQDN。	字串
ipAddress	vpn-site-link 的 ip-address。	字串
linkProperties	連結提供者屬性。	VpnLinkProviderProperties

VpnSiteProperties

名字	描述	價值
addressSpace	包含IP位址範圍數位的AddressSpace。	AddressSpace
bgpProperties	bgp 屬性集。	BgpSettings
deviceProperties	裝置屬性。	DeviceProperties
ipAddress	vpn-site 的 ip-address。	字串
isSecuritySite	IsSecuritySite 旗標。	bool
o365Policy	Office365 原則。	O365PolicyProperties
siteKey	VPN 月臺的金鑰，可用於連線。	字串
virtualWan	vpnSite 所屬的 VirtualWAN。	SubResource
vpnSiteLinks	所有 VPN 網站連結的清單。	VpnSiteLink[]

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
建立虛擬 WAN 資源	此範本可讓您建立虛擬 WAN 資源，包括虛擬 WAN、虛擬中樞、VPN 閘道、VPN 網站和 VPN Connecton。

Terraform （AzAPI 提供者） 資源定義

vpnSites 資源類型可以使用目標作業來部署：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/vpnSites 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnSites@2023-11-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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
            }
          }
        }
      ]
    }
  })
}

屬性值

AddressSpace

名字	描述	價值
addressPrefixes	以 CIDR 表示法保留給此虛擬網路的位址區塊清單。	string[]

BgpSettings

名字	描述	價值
asn	BGP 喇叭的 ASN。	int 約束： 最小值 = 0 最大值 = 4294967295
bgpPeeringAddress	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。	字串
bgpPeeringAddresses	具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。	IPConfigurationBgpPeeringAddress[]
peerWeight	新增至此 BGP 喇叭所學習路由的權數。	int

DeviceProperties

名字	描述	價值
deviceModel	裝置的模型。	字串
deviceVendor	裝置廠商的名稱。	字串
linkSpeedInMbps	連結速度。	int

IPConfigurationBgpPeeringAddress

名字	描述	價值
customBgpIpAddresses	屬於IP組態的自訂BGP對等互連位址清單。	string[]
ipconfigurationId	屬於閘道的IP組態標識碼。	字串

Microsoft.Network/vpnSites

名字	描述	價值
位置	資源位置。	字串
名字	資源名稱	字串 （必要）
性能	VPN 月臺的屬性。	VpnSiteProperties
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.Network/vpnSites@2023-11-01”

O365BreakOutCategoryPolicies

名字	描述	價值
允許	用來控制允許類別的旗標。	bool
違約	用來控制預設類別的旗標。	bool
優化	用來控制優化類別的旗標。	bool

O365PolicyProperties

名字	描述	價值
breakOutCategories	Office365 分組類別。	O365BreakOutCategoryPolicies

ResourceTags

名字	描述	價值

SubResource

名字	描述	價值
id	資源標識碼。	字串

VpnLinkBgpSettings

名字	描述	價值
asn	BGP 喇叭的 ASN。	int
bgpPeeringAddress	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。	字串

VpnLinkProviderProperties

名字	描述	價值
linkProviderName	連結提供者的名稱。	字串
linkSpeedInMbps	連結速度。	int

VpnSiteLink

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	VPN 網站鏈接的屬性。	VpnSiteLinkProperties

VpnSiteLinkProperties

名字	描述	價值
bgpProperties	bgp 屬性集。	VpnLinkBgpSettings
fqdn	vpn-site-link 的 FQDN。	字串
ipAddress	vpn-site-link 的 ip-address。	字串
linkProperties	連結提供者屬性。	VpnLinkProviderProperties

VpnSiteProperties

名字	描述	價值
addressSpace	包含IP位址範圍數位的AddressSpace。	AddressSpace
bgpProperties	bgp 屬性集。	BgpSettings
deviceProperties	裝置屬性。	DeviceProperties
ipAddress	vpn-site 的 ip-address。	字串
isSecuritySite	IsSecuritySite 旗標。	bool
o365Policy	Office365 原則。	O365PolicyProperties
siteKey	VPN 月臺的金鑰，可用於連線。	字串
virtualWan	vpnSite 所屬的 VirtualWAN。	SubResource
vpnSiteLinks	所有 VPN 網站連結的清單。	VpnSiteLink[]