Virtual Hubs - Get

Service:

Virtual WAN

API Version:

2023-09-01

Hämtar information om en VirtualHub.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Resursgruppens namn på VirtualHub.
subscriptionId	path	True	string	Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
virtualHubName	path	True	string	Namnet på VirtualHub.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	VirtualHub	Begäran lyckades. Returnerar informationen om den VirtualHub som hämtats.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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
    }
  }
}

Definitioner

Name	Description
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
HubRoutingPreference	Gatewaytyperna för hubbdirigeringsprioritet
PreferredRoutingGateway	De önskade typerna av routningsgatewayer
ProvisioningState	Det aktuella etableringstillståndet.
RoutingState	Det aktuella routningstillståndet för VirtualHub.
SubResource	Referens till en annan underresurs.
VirtualHub	VirtualHub-resurs.
VirtualHubRoute	VirtualHub-väg.
VirtualHubRouteTable	Routningstabell för VirtualHub.
VirtualHubRouteTableV2	VirtualHubRouteTableV2-resurs.
VirtualHubRouteV2	VirtualHubRouteTableV2-väg.
VirtualRouterAutoScaleConfiguration	Autoskalningskonfigurationen för VirtualHub Router.

CloudError

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Molnfeltext.

CloudErrorBody

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

HubRoutingPreference

Gatewaytyperna för hubbdirigeringsprioritet

Name	Typ	Description
ASPath	string
ExpressRoute	string
VpnGateway	string

PreferredRoutingGateway

De önskade typerna av routningsgatewayer

Name	Typ	Description
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingState

Det aktuella routningstillståndet för VirtualHub.

Name	Typ	Description
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

Referens till en annan underresurs.

Name	Typ	Description
id	string	Resurs-ID.

VirtualHub

VirtualHub-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
kind	string	Typ av virtuell tjänsthubb. Det här är metadata som används för Azure Portal för routningsservern.
location	string	Resursplats.
name	string	Resursnamn.
properties.addressPrefix	string	Adressprefix för denna VirtualHub.
properties.allowBranchToBranchTraffic	boolean	Flagga för att styra överföring för VirtualRouter-hubben.
properties.azureFirewall	SubResource	AzureFirewall som är associerad med denna VirtualHub.
properties.bgpConnections	SubResource[]	Lista över referenser till Bgp-Connections.
properties.expressRouteGateway	SubResource	ExpressRouteGateway som är associerad med denna VirtualHub.
properties.hubRoutingPreference	HubRoutingPreference	HubRoutingPreference för denna VirtualHub.
properties.ipConfigurations	SubResource[]	Lista över referenser till IpConfigurations.
properties.p2SVpnGateway	SubResource	P2SVpnGateway som är associerad med denna VirtualHub.
properties.preferredRoutingGateway	PreferredRoutingGateway	Önskad gateway för att dirigera lokal trafik
properties.provisioningState	ProvisioningState	Etableringstillståndet för den virtuella hubbresursen.
properties.routeMaps	SubResource[]	Lista över referenser till RouteMaps.
properties.routeTable	VirtualHubRouteTable	RouteTable som är associerad med den här virtuella hubben.
properties.routingState	RoutingState	Routningstillståndet.
properties.securityPartnerProvider	SubResource	SecurityPartnerProvider som är associerad med denna VirtualHub.
properties.securityProviderName	string	Namnet på säkerhetsprovidern.
properties.sku	string	SKU:n för denna VirtualHub.
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	Lista över alla routningstabeller för virtuella hubbar som är associerade med denna VirtualHub.
properties.virtualRouterAsn	integer	VirtualRouter ASN.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	Autoskalningskonfigurationen för VirtualHub Router.
properties.virtualRouterIps	string[]	IP-adresser för VirtualRouter.
properties.virtualWan	SubResource	VirtualWAN som VirtualHub tillhör.
properties.vpnGateway	SubResource	VpnGateway som är associerad med denna VirtualHub.
tags	object	Resurstaggar.
type	string	Resurstyp.

VirtualHubRoute

VirtualHub-väg.

Name	Typ	Description
addressPrefixes	string[]	Lista över alla addressPrefixes.
nextHopIpAddress	string	NextHop ip-adress.

VirtualHubRouteTable

Routningstabell för VirtualHub.

Name	Typ	Description
routes	VirtualHubRoute[]	Lista över alla vägar.

VirtualHubRouteTableV2

VirtualHubRouteTableV2-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.attachedConnections	string[]	Lista över alla anslutningar som är kopplade till den här routningstabellen v2.
properties.provisioningState	ProvisioningState	Etableringstillståndet för v2-resursen för routningstabellen för den virtuella hubben.
properties.routes	VirtualHubRouteV2[]	Lista över alla vägar.

VirtualHubRouteV2

VirtualHubRouteTableV2-väg.

Name	Typ	Description
destinationType	string	Typ av mål.
destinations	string[]	Lista över alla mål.
nextHopType	string	Typ av nästa hopp.
nextHops	string[]	NextHops ip-adress.

VirtualRouterAutoScaleConfiguration

Autoskalningskonfigurationen för VirtualHub Router.

Name	Typ	Description
minCapacity	integer	Det minsta antalet skalningsenheter för VirtualHub Router.