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

Vpn Sites - Get

Service:

Virtual WAN

API Version:

2023-09-01

检索 VPN 站点的详细信息。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	VpnSite 的资源组名称。
subscriptionId	path	True	string	可以唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
vpnSiteName	path	True	string	正在检索的 VpnSite 的名称。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	VpnSite	请求成功。 返回检索到的 VpnSite 的详细信息。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

VpnSiteGet

Sample Request

HTTP

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

Java

/**
 * Samples for VpnSites GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteGet.json
     */
    /**
     * Sample code: VpnSiteGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnSiteGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnSites().getByResourceGroupWithResponse("rg1", "vpnSite1",
            com.azure.core.util.Context.NONE);
    }
}

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_get.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.get(
        resource_group_name="rg1",
        vpn_site_name="vpnSite1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteGet.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/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/VpnSiteGet.json
func ExampleVPNSitesClient_Get() {
	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)
	}
	res, err := clientFactory.NewVPNSitesClient().Get(ctx, "rg1", "vpnSite1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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 Retrieves the details of a VPN site.
 *
 * @summary Retrieves the details of a VPN site.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteGet.json
 */
async function vpnSiteGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const vpnSiteName = "vpnSite1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnSites.get(resourceGroupName, vpnSiteName);
  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/VpnSiteGet.json
// this example is just showing the usage of "VpnSites_Get" 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";
NullableResponse<VpnSiteResource> response = await collection.GetIfExistsAsync(vpnSiteName);
VpnSiteResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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",
        "type": "Microsoft.Network/vpnSites/vpnSiteLinks",
        "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
          }
        }
      }
    ]
  }
}

定义

名称	说明
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 地址范围的数组。

名称	类型	说明
addressPrefixes	string[]	以 CIDR 表示法为此虚拟网络保留的地址块列表。

BgpSettings

BGP 设置详细信息。

名称	类型	说明
asn	integer	BGP 扬声器的 ASN。
bgpPeeringAddress	string	此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	具有虚拟网络网关的 IP 配置 ID 的 BGP 对等互连地址。
peerWeight	integer	添加到从此 BGP 扬声器获知的路由的权重。

CloudError

来自服务的错误响应。

名称	类型	说明
error	CloudErrorBody	云错误正文。

CloudErrorBody

来自服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，该消息适用于在用户界面中显示。
target	string	特定错误的目标。 例如，属性的名称出错。

DeviceProperties

设备的属性列表。

名称	类型	说明
deviceModel	string	设备型号。
deviceVendor	string	设备供应商的名称。
linkSpeedInMbps	integer	链接速度。

IPConfigurationBgpPeeringAddress

IPConfigurationBgpPeeringAddress 的属性。

名称	类型	说明
customBgpIpAddresses	string[]	属于 IP 配置的自定义 BGP 对等互连地址的列表。
defaultBgpIpAddresses	string[]	属于 IP 配置的默认 BGP 对等互连地址的列表。
ipconfigurationId	string	属于网关的 IP 配置的 ID。
tunnelIpAddresses	string[]	属于 IP 配置的隧道公共 IP 地址的列表。

O365BreakOutCategoryPolicies

Office365 分组讨论类别。

名称	类型	说明
allow	boolean	用于控制允许类别的标志。
default	boolean	用于控制默认类别的标志。
optimize	boolean	用于控制优化类别的标志。

O365PolicyProperties

Office365 分组讨论策略。

名称	类型	说明
breakOutCategories	O365BreakOutCategoryPolicies	Office365 分组讨论类别。

ProvisioningState

当前预配状态。

名称	类型	说明
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

对另一个子资源的引用。

名称	类型	说明
id	string	资源 ID。

VpnLinkBgpSettings

链接的 BGP 设置详细信息。

名称	类型	说明
asn	integer	BGP 扬声器的 ASN。
bgpPeeringAddress	string	此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。

VpnLinkProviderProperties

链接提供程序的属性列表。

名称	类型	说明
linkProviderName	string	链接提供程序的名称。
linkSpeedInMbps	integer	链接速度。

VpnSite

VpnSite 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.addressSpace	AddressSpace	包含 IP 地址范围数组的 AddressSpace。
properties.bgpProperties	BgpSettings	bgp 属性集。
properties.deviceProperties	DeviceProperties	设备属性。
properties.ipAddress	string	vpn 站点的 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 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当资源更新时都会更改。
id	string	资源 ID。
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	资源类型。