Vpn Sites - Create Or Update

Service:

Virtual WAN

API Version:

2023-09-01

如果 VpnSite 資源不存在，請建立 VpnSite 資源，否則會更新現有的 VpnSite。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}?api-version=2023-09-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	VpnSite 的資源組名。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
vpnSiteName	path	True	string	要建立或更新之 VpnSite 的名稱。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源位置。
id		string	資源識別碼。
properties.addressSpace		AddressSpace	AddressSpace，其中包含IP位址範圍的數位。
properties.bgpProperties		BgpSettings	bgp 屬性集。
properties.deviceProperties		DeviceProperties	裝置屬性。
properties.ipAddress		string	vpn-site 的IP位址。
properties.isSecuritySite		boolean	IsSecuritySite 旗標。
properties.o365Policy		O365PolicyProperties	Office365 原則。
properties.siteKey		string	可用於連線的 vpn 月臺金鑰。
properties.virtualWan		SubResource	vpnSite 所屬的 VirtualWAN。
properties.vpnSiteLinks		VpnSiteLink[]	所有 VPN 網站連結的清單。
tags		object	資源標籤。

回應

名稱	類型	Description
200 OK	VpnSite	要求成功。 傳回 VpnSite 建立或更新的詳細數據。
201 Created	VpnSite	已成功收到要求。 傳回 VpnSite 建立或更新的詳細數據。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

VpnSiteCreate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1?api-version=2023-09-01

{
  "tags": {
    "key1": "value1"
  },
  "location": "West US",
  "properties": {
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
    },
    "addressSpace": {
      "addressPrefixes": [
        "10.0.0.0/16"
      ]
    },
    "isSecuritySite": false,
    "vpnSiteLinks": [
      {
        "name": "vpnSiteLink1",
        "properties": {
          "ipAddress": "50.50.50.56",
          "fqdn": "link1.vpnsite1.contoso.com",
          "linkProperties": {
            "linkProviderName": "vendor1",
            "linkSpeedInMbps": 0
          },
          "bgpProperties": {
            "bgpPeeringAddress": "192.168.0.0",
            "asn": 1234
          }
        }
      }
    ],
    "o365Policy": {
      "breakOutCategories": {
        "allow": true,
        "optimize": true,
        "default": false
      }
    }
  }
}

Java

import com.azure.core.management.SubResource;
import com.azure.resourcemanager.network.fluent.models.VpnSiteInner;
import com.azure.resourcemanager.network.fluent.models.VpnSiteLinkInner;
import com.azure.resourcemanager.network.models.AddressSpace;
import com.azure.resourcemanager.network.models.O365BreakOutCategoryPolicies;
import com.azure.resourcemanager.network.models.O365PolicyProperties;
import com.azure.resourcemanager.network.models.VpnLinkBgpSettings;
import com.azure.resourcemanager.network.models.VpnLinkProviderProperties;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for VpnSites CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSitePut.json
     */
    /**
     * Sample code: VpnSiteCreate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnSiteCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnSites().createOrUpdate("rg1", "vpnSite1",
            new VpnSiteInner().withLocation("West US").withTags(mapOf("key1", "fakeTokenPlaceholder"))
                .withVirtualWan(new SubResource()
                    .withId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"))
                .withAddressSpace(new AddressSpace().withAddressPrefixes(Arrays.asList("10.0.0.0/16")))
                .withIsSecuritySite(false)
                .withVpnSiteLinks(Arrays.asList(new VpnSiteLinkInner().withName("vpnSiteLink1")
                    .withLinkProperties(
                        new VpnLinkProviderProperties().withLinkProviderName("vendor1").withLinkSpeedInMbps(0))
                    .withIpAddress("50.50.50.56").withFqdn("link1.vpnsite1.contoso.com")
                    .withBgpProperties(new VpnLinkBgpSettings().withAsn(1234L).withBgpPeeringAddress("192.168.0.0"))))
                .withO365Policy(new O365PolicyProperties().withBreakOutCategories(
                    new O365BreakOutCategoryPolicies().withAllow(true).withOptimize(true).withDefaultProperty(false))),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python vpn_site_put.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.vpn_sites.begin_create_or_update(
        resource_group_name="rg1",
        vpn_site_name="vpnSite1",
        vpn_site_parameters={
            "location": "West US",
            "properties": {
                "addressSpace": {"addressPrefixes": ["10.0.0.0/16"]},
                "isSecuritySite": False,
                "o365Policy": {"breakOutCategories": {"allow": True, "default": False, "optimize": True}},
                "virtualWan": {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
                },
                "vpnSiteLinks": [
                    {
                        "name": "vpnSiteLink1",
                        "properties": {
                            "bgpProperties": {"asn": 1234, "bgpPeeringAddress": "192.168.0.0"},
                            "fqdn": "link1.vpnsite1.contoso.com",
                            "ipAddress": "50.50.50.56",
                            "linkProperties": {"linkProviderName": "vendor1", "linkSpeedInMbps": 0},
                        },
                    }
                ],
            },
            "tags": {"key1": "value1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSitePut.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSitePut.json
func ExampleVPNSitesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVPNSitesClient().BeginCreateOrUpdate(ctx, "rg1", "vpnSite1", armnetwork.VPNSite{
		Location: to.Ptr("West US"),
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
		},
		Properties: &armnetwork.VPNSiteProperties{
			AddressSpace: &armnetwork.AddressSpace{
				AddressPrefixes: []*string{
					to.Ptr("10.0.0.0/16")},
			},
			IsSecuritySite: to.Ptr(false),
			O365Policy: &armnetwork.O365PolicyProperties{
				BreakOutCategories: &armnetwork.O365BreakOutCategoryPolicies{
					Default:  to.Ptr(false),
					Allow:    to.Ptr(true),
					Optimize: to.Ptr(true),
				},
			},
			VirtualWan: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"),
			},
			VPNSiteLinks: []*armnetwork.VPNSiteLink{
				{
					Name: to.Ptr("vpnSiteLink1"),
					Properties: &armnetwork.VPNSiteLinkProperties{
						BgpProperties: &armnetwork.VPNLinkBgpSettings{
							Asn:               to.Ptr[int64](1234),
							BgpPeeringAddress: to.Ptr("192.168.0.0"),
						},
						Fqdn:      to.Ptr("link1.vpnsite1.contoso.com"),
						IPAddress: to.Ptr("50.50.50.56"),
						LinkProperties: &armnetwork.VPNLinkProviderProperties{
							LinkProviderName: to.Ptr("vendor1"),
							LinkSpeedInMbps:  to.Ptr[int32](0),
						},
					},
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VPNSite = armnetwork.VPNSite{
	// 	Name: to.Ptr("vpnSite1"),
	// 	Type: to.Ptr("Microsoft.Network/vpnSites"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 	},
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VPNSiteProperties{
	// 		AddressSpace: &armnetwork.AddressSpace{
	// 			AddressPrefixes: []*string{
	// 				to.Ptr("10.0.0.0/16")},
	// 			},
	// 			DeviceProperties: &armnetwork.DeviceProperties{
	// 				LinkSpeedInMbps: to.Ptr[int32](0),
	// 			},
	// 			IsSecuritySite: to.Ptr(false),
	// 			ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 			VirtualWan: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"),
	// 			},
	// 			VPNSiteLinks: []*armnetwork.VPNSiteLink{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1"),
	// 					Name: to.Ptr("vpnSiteLink1"),
	// 					Type: to.Ptr("Microsoft.Network/vpnSites/vpnSiteLinks"),
	// 					Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 					Properties: &armnetwork.VPNSiteLinkProperties{
	// 						BgpProperties: &armnetwork.VPNLinkBgpSettings{
	// 							Asn: to.Ptr[int64](1234),
	// 							BgpPeeringAddress: to.Ptr("192.168.0.0"),
	// 						},
	// 						IPAddress: to.Ptr("50.50.50.56"),
	// 						LinkProperties: &armnetwork.VPNLinkProviderProperties{
	// 							LinkProviderName: to.Ptr("vendor1"),
	// 							LinkSpeedInMbps: to.Ptr[int32](0),
	// 						},
	// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					},
	// 			}},
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
 *
 * @summary Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSitePut.json
 */
async function vpnSiteCreate() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const vpnSiteName = "vpnSite1";
  const vpnSiteParameters = {
    addressSpace: { addressPrefixes: ["10.0.0.0/16"] },
    isSecuritySite: false,
    location: "West US",
    o365Policy: {
      breakOutCategories: { default: false, allow: true, optimize: true },
    },
    tags: { key1: "value1" },
    virtualWan: {
      id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
    },
    vpnSiteLinks: [
      {
        name: "vpnSiteLink1",
        bgpProperties: { asn: 1234, bgpPeeringAddress: "192.168.0.0" },
        fqdn: "link1.vpnsite1.contoso.com",
        ipAddress: "50.50.50.56",
        linkProperties: { linkProviderName: "vendor1", linkSpeedInMbps: 0 },
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnSites.beginCreateOrUpdateAndWait(
    resourceGroupName,
    vpnSiteName,
    vpnSiteParameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSitePut.json
// this example is just showing the usage of "VpnSites_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VpnSiteResource
VpnSiteCollection collection = resourceGroupResource.GetVpnSites();

// invoke the operation
string vpnSiteName = "vpnSite1";
VpnSiteData data = new VpnSiteData()
{
    VirtualWanId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"),
    AddressPrefixes =
    {
    "10.0.0.0/16"
    },
    IsSecuritySite = false,
    VpnSiteLinks =
    {
    new VpnSiteLinkData()
    {
    LinkProperties = new VpnLinkProviderProperties()
    {
    LinkProviderName = "vendor1",
    LinkSpeedInMbps = 0,
    },
    IPAddress = "50.50.50.56",
    Fqdn = "link1.vpnsite1.contoso.com",
    BgpProperties = new VpnLinkBgpSettings()
    {
    Asn = 1234,
    BgpPeeringAddress = "192.168.0.0",
    },
    Name = "vpnSiteLink1",
    }
    },
    O365BreakOutCategories = new O365BreakOutCategoryPolicies()
    {
        Allow = true,
        Optimize = true,
        Default = false,
    },
    Location = new AzureLocation("West US"),
    Tags =
    {
    ["key1"] = "value1",
    },
};
ArmOperation<VpnSiteResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, vpnSiteName, data);
VpnSiteResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VpnSiteData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "name": "vpnSite1",
  "type": "Microsoft.Network/vpnSites",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
    },
    "deviceProperties": {
      "linkSpeedInMbps": 0
    },
    "addressSpace": {
      "addressPrefixes": [
        "10.0.0.0/16"
      ]
    },
    "isSecuritySite": false,
    "vpnSiteLinks": [
      {
        "name": "vpnSiteLink1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "type": "Microsoft.Network/vpnSites/vpnSiteLinks",
        "properties": {
          "provisioningState": "Succeeded",
          "ipAddress": "50.50.50.56",
          "linkProperties": {
            "linkProviderName": "vendor1",
            "linkSpeedInMbps": 0
          },
          "bgpProperties": {
            "bgpPeeringAddress": "192.168.0.0",
            "asn": 1234
          }
        }
      }
    ]
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "name": "vpnSite1",
  "type": "Microsoft.Network/vpnSites",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
    },
    "deviceProperties": {
      "linkSpeedInMbps": 0
    },
    "addressSpace": {
      "addressPrefixes": [
        "10.0.0.0/16"
      ]
    },
    "isSecuritySite": false,
    "vpnSiteLinks": [
      {
        "name": "vpnSiteLink1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "ipAddress": "50.50.50.56",
          "linkProperties": {
            "linkProviderName": "vendor1",
            "linkSpeedInMbps": 0
          },
          "bgpProperties": {
            "bgpPeeringAddress": "192.168.0.0",
            "asn": 1234
          }
        }
      }
    ]
  }
}

定義

名稱	Description
AddressSpace	Addressspace 包含可供虛擬網路的子網路使用的 IP 位址範圍陣列。
BgpSettings	BGP 設定詳細數據。
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
DeviceProperties	裝置的屬性清單。
IPConfigurationBgpPeeringAddress	IPConfigurationBgpPeeringAddress 的屬性。
O365BreakOutCategoryPolicies	Office365 分項類別。
O365PolicyProperties	Office365 中斷原則。
ProvisioningState	目前的布建狀態。
SubResource	另一個子資源的參考。
VpnLinkBgpSettings	連結的 BGP 設定詳細數據。
VpnLinkProviderProperties	連結提供者的屬性清單。
VpnSite	VpnSite 資源。
VpnSiteLink	VpnSiteLink 資源。

AddressSpace

Addressspace 包含可供虛擬網路的子網路使用的 IP 位址範圍陣列。

名稱	類型	Description
addressPrefixes	string[]	在 CIDR 表示法中保留給此虛擬網路的位址區塊清單。

BgpSettings

BGP 設定詳細數據。

名稱	類型	Description
asn	integer	BGP 說話者的 ASN。
bgpPeeringAddress	string	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。
peerWeight	integer	新增至從這個 BGP 說話者學到之路由的權數。

CloudError

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤本文。

CloudErrorBody

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。 例如，錯誤中屬性的名稱。

DeviceProperties

裝置的屬性清單。

名稱	類型	Description
deviceModel	string	裝置的型號。
deviceVendor	string	裝置廠商的名稱。
linkSpeedInMbps	integer	連結速度。

IPConfigurationBgpPeeringAddress

IPConfigurationBgpPeeringAddress 的屬性。

名稱	類型	Description
customBgpIpAddresses	string[]	屬於IP組態的自訂BGP對等互連位址清單。
defaultBgpIpAddresses	string[]	屬於IP組態的預設 BGP 對等互連位址清單。
ipconfigurationId	string	屬於閘道的IP組態標識碼。
tunnelIpAddresses	string[]	屬於IP組態的通道公用IP位址清單。

O365BreakOutCategoryPolicies

Office365 分項類別。

名稱	類型	Description
allow	boolean	要控制允許類別的旗標。
default	boolean	用來控制預設類別的旗標。
optimize	boolean	用來控制優化類別的旗標。

O365PolicyProperties

Office365 中斷原則。

名稱	類型	Description
breakOutCategories	O365BreakOutCategoryPolicies	Office365 分項類別。

ProvisioningState

目前的布建狀態。

名稱	類型	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

另一個子資源的參考。

名稱	類型	Description
id	string	資源識別碼。

VpnLinkBgpSettings

連結的 BGP 設定詳細數據。

名稱	類型	Description
asn	integer	BGP 說話者的 ASN。
bgpPeeringAddress	string	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。

VpnLinkProviderProperties

連結提供者的屬性清單。

名稱	類型	Description
linkProviderName	string	連結提供者的名稱。
linkSpeedInMbps	integer	連結速度。

VpnSite

VpnSite 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
location	string	資源位置。
name	string	資源名稱。
properties.addressSpace	AddressSpace	AddressSpace，其中包含IP位址範圍的數位。
properties.bgpProperties	BgpSettings	bgp 屬性集。
properties.deviceProperties	DeviceProperties	裝置屬性。
properties.ipAddress	string	vpn-site 的IP位址。
properties.isSecuritySite	boolean	IsSecuritySite 旗標。
properties.o365Policy	O365PolicyProperties	Office365 原則。
properties.provisioningState	ProvisioningState	VPN 月臺資源的布建狀態。
properties.siteKey	string	可用於連線的 vpn 月臺金鑰。
properties.virtualWan	SubResource	vpnSite 所屬的 VirtualWAN。
properties.vpnSiteLinks	VpnSiteLink[]	所有 VPN 網站連結的清單。
tags	object	資源標籤。
type	string	資源類型。

VpnSiteLink

VpnSiteLink 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	資源群組內唯一的資源名稱。 此名稱可用來存取資源。
properties.bgpProperties	VpnLinkBgpSettings	bgp 屬性集。
properties.fqdn	string	vpn-site-link 的 FQDN。
properties.ipAddress	string	vpn-site-link 的 IP 位址。
properties.linkProperties	VpnLinkProviderProperties	連結提供者屬性。
properties.provisioningState	ProvisioningState	VPN 網站鏈接資源的布建狀態。
type	string	資源類型。