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 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	VpnSite의 리소스 그룹 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
vpnSiteName	path	True	string	검색할 VpnSite의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

응답

Name	형식	Description
200 OK	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

Name	Description
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
          }
        }
      }
    ]
  }
}

정의

Name	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 주소 범위 배열이 포함됩니다.

Name	형식	Description
addressPrefixes	string[]	CIDR 표기법으로 이 가상 네트워크에 예약된 주소 블록 목록입니다.

BgpSettings

BGP 설정 세부 정보입니다.

Name	형식	Description
asn	integer	BGP 스피커의 ASN입니다.
bgpPeeringAddress	string	이 BGP 스피커의 BGP 피어링 주소 및 BGP 식별자입니다.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	가상 네트워크 게이트웨이에 대한 IP 구성 ID가 있는 BGP 피어링 주소입니다.
peerWeight	integer	이 BGP 스피커에서 학습한 경로에 추가된 가중치입니다.

CloudError

서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	클라우드 오류 본문.

CloudErrorBody

서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target	string	특정 오류의 대상입니다. 예를 들어 오류에 있는 속성의 이름입니다.

DeviceProperties

디바이스의 속성 목록입니다.

Name	형식	Description
deviceModel	string	디바이스 모델
deviceVendor	string	디바이스 공급업체의 이름입니다.
linkSpeedInMbps	integer	연결 속도.

IPConfigurationBgpPeeringAddress

IPConfigurationBgpPeeringAddress의 속성입니다.

Name	형식	Description
customBgpIpAddresses	string[]	IP 구성에 속하는 사용자 지정 BGP 피어링 주소 목록입니다.
defaultBgpIpAddresses	string[]	IP 구성에 속하는 기본 BGP 피어링 주소 목록입니다.
ipconfigurationId	string	게이트웨이에 속하는 IP 구성의 ID입니다.
tunnelIpAddresses	string[]	IP 구성에 속하는 터널 공용 IP 주소 목록입니다.

O365BreakOutCategoryPolicies

Office365 소규모 범주.

Name	형식	Description
allow	boolean	허용 범주를 제어하는 플래그입니다.
default	boolean	기본 범주를 제어하는 플래그입니다.
optimize	boolean	범주 최적화를 제어하는 플래그입니다.

O365PolicyProperties

Office365 소규모 정책입니다.

Name	형식	Description
breakOutCategories	O365BreakOutCategoryPolicies	Office365 소규모 범주.

ProvisioningState

현재 프로비저닝 상태입니다.

Name	형식	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

다른 하위 리소스에 대한 참조입니다.

Name	형식	Description
id	string	리소스 ID입니다.

VpnLinkBgpSettings

링크에 대한 BGP 설정 세부 정보입니다.

Name	형식	Description
asn	integer	BGP 스피커의 ASN입니다.
bgpPeeringAddress	string	이 BGP 스피커의 BGP 피어링 주소 및 BGP 식별자입니다.

VpnLinkProviderProperties

링크 공급자의 속성 목록입니다.

Name	형식	Description
linkProviderName	string	링크 공급자의 이름입니다.
linkSpeedInMbps	integer	연결 속도.

VpnSite

VpnSite 리소스.

Name	형식	Description
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-site의 ip-address입니다.
properties.isSecuritySite	boolean	IsSecuritySite 플래그입니다.
properties.o365Policy	O365PolicyProperties	Office365 정책.
properties.provisioningState	ProvisioningState	VPN 사이트 리소스의 프로비전 상태입니다.
properties.siteKey	string	연결에 사용할 수 있는 vpn-site의 키입니다.
properties.virtualWan	SubResource	vpnSite가 속한 VirtualWAN입니다.
properties.vpnSiteLinks	VpnSiteLink[]	모든 vpn 사이트 링크 목록입니다.
tags	object	리소스 태그.
type	string	리소스 종류.

VpnSiteLink

VpnSiteLink 리소스.

Name	형식	Description
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-address입니다.
properties.linkProperties	VpnLinkProviderProperties	링크 공급자 속성입니다.
properties.provisioningState	ProvisioningState	VPN 사이트 링크 리소스의 프로비저닝 상태입니다.
type	string	리소스 종류.