Virtual Hubs - Get

Service:

Virtual WAN

API Version:

2023-09-01

VirtualHub의 세부 정보를 검색합니다.

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

URI 매개 변수

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

응답

Name	형식	Description
200 OK	VirtualHub	요청이 성공했습니다. 검색된 VirtualHub의 세부 정보를 반환합니다.
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	사용자 계정 가장

예제

VirtualHubGet

Sample Request

HTTP

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

Java

/**
 * Samples for VirtualHubs GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubGet.json
     */
    /**
     * Sample code: VirtualHubGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualHubGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualHubs().getByResourceGroupWithResponse("rg1", "virtualHub1",
            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 virtual_hub_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.virtual_hubs.get(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubGet.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/VirtualHubGet.json
func ExampleVirtualHubsClient_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.NewVirtualHubsClient().Get(ctx, "rg1", "virtualHub1", 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.VirtualHub = armnetwork.VirtualHub{
	// 	Name: to.Ptr("virtualHub1"),
	// 	Type: to.Ptr("Microsoft.Network/virtualHubs"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
	// 	Location: to.Ptr("West US"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VirtualHubProperties{
	// 		AddressPrefix: to.Ptr("10.10.1.0/24"),
	// 		AllowBranchToBranchTraffic: to.Ptr(false),
	// 		HubRoutingPreference: to.Ptr(armnetwork.HubRoutingPreferenceExpressRoute),
	// 		PreferredRoutingGateway: to.Ptr(armnetwork.PreferredRoutingGatewayExpressRoute),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		RoutingState: to.Ptr(armnetwork.RoutingStateProvisioned),
	// 		SKU: to.Ptr("Basic"),
	// 		VirtualHubRouteTableV2S: []*armnetwork.VirtualHubRouteTableV2{
	// 		},
	// 		VirtualRouterAsn: to.Ptr[int64](65515),
	// 		VirtualRouterAutoScaleConfiguration: &armnetwork.VirtualRouterAutoScaleConfiguration{
	// 			MinCapacity: to.Ptr[int32](2),
	// 		},
	// 		VirtualRouterIPs: []*string{
	// 			to.Ptr("10.10.1.12"),
	// 			to.Ptr("10.10.1.13")},
	// 			VirtualWan: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"),
	// 			},
	// 		},
	// 	}
}

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 VirtualHub.
 *
 * @summary Retrieves the details of a VirtualHub.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubGet.json
 */
async function virtualHubGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualHubs.get(resourceGroupName, virtualHubName);
  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/VirtualHubGet.json
// this example is just showing the usage of "VirtualHubs_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 VirtualHubResource created on azure
// for more information of creating VirtualHubResource, please refer to the document of VirtualHubResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualHubName = "virtualHub1";
ResourceIdentifier virtualHubResourceId = VirtualHubResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualHubName);
VirtualHubResource virtualHub = client.GetVirtualHubResource(virtualHubResourceId);

// invoke the operation
VirtualHubResource result = await virtualHub.GetAsync();

// 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
VirtualHubData 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/virtualHubs/virtualHub1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "name": "virtualHub1",
  "type": "Microsoft.Network/virtualHubs",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    },
    "virtualHubRouteTableV2s": [],
    "addressPrefix": "10.10.1.0/24",
    "sku": "Basic",
    "routingState": "Provisioned",
    "virtualRouterAsn": 65515,
    "virtualRouterIps": [
      "10.10.1.12",
      "10.10.1.13"
    ],
    "allowBranchToBranchTraffic": false,
    "preferredRoutingGateway": "ExpressRoute",
    "hubRoutingPreference": "ExpressRoute",
    "virtualRouterAutoScaleConfiguration": {
      "minCapacity": 2
    }
  }
}

정의

Name	Description
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
HubRoutingPreference	허브 라우팅 기본 설정 게이트웨이 유형
PreferredRoutingGateway	기본 라우팅 게이트웨이 유형
ProvisioningState	현재 프로비저닝 상태입니다.
RoutingState	VirtualHub의 현재 라우팅 상태입니다.
SubResource	다른 하위 리소스에 대한 참조입니다.
VirtualHub	VirtualHub 리소스.
VirtualHubRoute	VirtualHub 경로.
VirtualHubRouteTable	VirtualHub 경로 테이블입니다.
VirtualHubRouteTableV2	VirtualHubRouteTableV2 리소스.
VirtualHubRouteV2	VirtualHubRouteTableV2 경로.
VirtualRouterAutoScaleConfiguration	VirtualHub 라우터 자동 크기 조정 구성입니다.

CloudError

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

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

CloudErrorBody

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

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

HubRoutingPreference

허브 라우팅 기본 설정 게이트웨이 유형

Name	형식	Description
ASPath	string
ExpressRoute	string
VpnGateway	string

PreferredRoutingGateway

기본 라우팅 게이트웨이 유형

Name	형식	Description
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

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

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

RoutingState

VirtualHub의 현재 라우팅 상태입니다.

Name	형식	Description
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

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

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

VirtualHub

VirtualHub 리소스.

Name	형식	Description
etag	string	리소스를 업데이트할 때마다 변경되는 고유한 읽기 전용 문자열입니다.
id	string	리소스 ID입니다.
kind	string	서비스 가상 허브의 종류입니다. 이는 Route Server의 Azure Portal 환경에 사용되는 메타데이터입니다.
location	string	리소스 위치.
name	string	리소스 이름입니다.
properties.addressPrefix	string	이 VirtualHub의 주소 접두사입니다.
properties.allowBranchToBranchTraffic	boolean	VirtualRouter 허브에 대한 전송을 제어하는 플래그입니다.
properties.azureFirewall	SubResource	이 VirtualHub와 연결된 azureFirewall입니다.
properties.bgpConnections	SubResource[]	Bgp Connections 대한 참조 목록입니다.
properties.expressRouteGateway	SubResource	이 VirtualHub와 연결된 expressRouteGateway입니다.
properties.hubRoutingPreference	HubRoutingPreference	이 VirtualHub의 hubRoutingPreference입니다.
properties.ipConfigurations	SubResource[]	IpConfigurations에 대한 참조 목록입니다.
properties.p2SVpnGateway	SubResource	이 VirtualHub와 연결된 P2SVpnGateway입니다.
properties.preferredRoutingGateway	PreferredRoutingGateway	온-프레미스 트래픽을 라우팅하는 기본 게이트웨이
properties.provisioningState	ProvisioningState	가상 허브 리소스의 프로비저닝 상태입니다.
properties.routeMaps	SubResource[]	RouteMaps에 대한 참조 목록입니다.
properties.routeTable	VirtualHubRouteTable	이 가상 허브와 연결된 routeTable입니다.
properties.routingState	RoutingState	라우팅 상태입니다.
properties.securityPartnerProvider	SubResource	이 VirtualHub와 연결된 securityPartnerProvider입니다.
properties.securityProviderName	string	보안 공급자 이름입니다.
properties.sku	string	이 VirtualHub의 sku입니다.
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	이 VirtualHub와 연결된 모든 가상 허브 경로 테이블 v2 목록입니다.
properties.virtualRouterAsn	integer	VirtualRouter ASN.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	VirtualHub 라우터 자동 크기 조정 구성입니다.
properties.virtualRouterIps	string[]	VirtualRouter IP.
properties.virtualWan	SubResource	VirtualHub가 속한 VirtualWAN입니다.
properties.vpnGateway	SubResource	이 VirtualHub와 연결된 VpnGateway입니다.
tags	object	리소스 태그.
type	string	리소스 종류.

VirtualHubRoute

VirtualHub 경로.

Name	형식	Description
addressPrefixes	string[]	모든 addressPrefixes 목록입니다.
nextHopIpAddress	string	NextHop ip 주소입니다.

VirtualHubRouteTable

VirtualHub 경로 테이블입니다.

Name	형식	Description
routes	VirtualHubRoute[]	모든 경로 목록입니다.

VirtualHubRouteTableV2

VirtualHubRouteTableV2 리소스.

Name	형식	Description
etag	string	리소스를 업데이트할 때마다 변경되는 고유한 읽기 전용 문자열입니다.
id	string	리소스 ID입니다.
name	string	리소스 그룹 내에서 고유한 리소스의 이름입니다. 이 이름은 리소스에 액세스하는 데 사용할 수 있습니다.
properties.attachedConnections	string[]	이 경로 테이블 v2에 연결된 모든 연결 목록입니다.
properties.provisioningState	ProvisioningState	가상 허브 경로 테이블 v2 리소스의 프로비저닝 상태입니다.
properties.routes	VirtualHubRouteV2[]	모든 경로 목록입니다.

VirtualHubRouteV2

VirtualHubRouteTableV2 경로.

Name	형식	Description
destinationType	string	대상의 유형입니다.
destinations	string[]	모든 대상 목록입니다.
nextHopType	string	다음 홉의 유형입니다.
nextHops	string[]	NextHops ip 주소입니다.

VirtualRouterAutoScaleConfiguration

VirtualHub 라우터 자동 크기 조정 구성입니다.

Name	형식	Description
minCapacity	integer	VirtualHub 라우터의 최소 배율 단위 수입니다.