Virtual Hubs - Get

Service:

Virtual WAN

API-versie:

2024-05-01

Haalt de details van een VirtualHub op.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep van de VirtualHub.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
virtualHubName	path	True	string	De naam van de VirtualHub.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	VirtualHub	Aanvraag is voltooid. Retourneert de details van de opgehaalde VirtualHub.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

VirtualHubGet

Voorbeeldaanvraag

HTTP

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

Java

/**
 * Samples for VirtualHubs GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-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/2024-05-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-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/2024-05-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
HubRoutingPreference	De gatewaytypen voor routeringsvoorkeur voor hubs
PreferredRoutingGateway	De voorkeursrouteringsgatewaytypen
ProvisioningState	De huidige inrichtingsstatus.
RoutingState	De huidige routeringsstatus van de VirtualHub.
SubResource	Verwijzing naar een andere subresource.
VirtualHub	VirtualHub-resource.
VirtualHubRoute	VirtualHub-route.
VirtualHubRouteTable	VirtualHub-routetabel.
VirtualHubRouteTableV2	VirtualHubRouteTableV2-resource.
VirtualHubRouteV2	VirtualHubRouteTableV2-route.
VirtualRouterAutoScaleConfiguration	De configuratie voor automatische schaalaanpassing van de VirtualHub-router.

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

Object

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

HubRoutingPreference

Inventarisatie

De gatewaytypen voor routeringsvoorkeur voor hubs

Waarde	Description
ASPath
ExpressRoute
VpnGateway

PreferredRoutingGateway

Inventarisatie

De voorkeursrouteringsgatewaytypen

Waarde	Description
ExpressRoute
None
VpnGateway

ProvisioningState

Inventarisatie

De huidige inrichtingsstatus.

Waarde	Description
Deleting
Failed
Succeeded
Updating

RoutingState

Inventarisatie

De huidige routeringsstatus van de VirtualHub.

Waarde	Description
Failed
None
Provisioned
Provisioning

SubResource

Object

Verwijzing naar een andere subresource.

Name	Type	Description
id	string	Resource-id.

VirtualHub

Object

VirtualHub-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
kind	string	Soort virtuele hub van de service. Dit zijn metagegevens die worden gebruikt voor de Azure Portal-ervaring voor Route Server.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.addressPrefix	string	Adresvoorvoegsel voor deze VirtualHub.
properties.allowBranchToBranchTraffic	boolean	Vlag voor het beheren van doorvoer voor VirtualRouter-hub.
properties.azureFirewall	SubResource	De azureFirewall die aan deze VirtualHub is gekoppeld.
properties.bgpConnections	SubResource[]	Lijst met verwijzingen naar Bgp-verbindingen.
properties.expressRouteGateway	SubResource	De expressRouteGateway die is gekoppeld aan deze VirtualHub.
properties.hubRoutingPreference	HubRoutingPreference	De hubRoutingPreference van deze VirtualHub.
properties.ipConfigurations	SubResource[]	Lijst met verwijzingen naar IpConfigurations.
properties.p2SVpnGateway	SubResource	De P2SVpnGateway die is gekoppeld aan deze VirtualHub.
properties.preferredRoutingGateway	PreferredRoutingGateway	De voorkeursgateway om on-premises verkeer te routeren
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de virtuele hubresource.
properties.routeMaps	SubResource[]	Lijst met verwijzingen naar RouteMaps.
properties.routeTable	VirtualHubRouteTable	De routeTable die is gekoppeld aan deze virtuele hub.
properties.routingState	RoutingState	De routeringsstatus.
properties.securityPartnerProvider	SubResource	De securityPartnerProvider die is gekoppeld aan deze VirtualHub.
properties.securityProviderName	string	De naam van de beveiligingsprovider.
properties.sku	string	De SKU van deze VirtualHub.
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	Lijst met alle virtuele hubroutetabel v2's die aan deze VirtualHub zijn gekoppeld.
properties.virtualRouterAsn	integer (int64) minimum: 0 maximum: 4294967295	VirtualRouter ASN.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	De configuratie voor automatische schaalaanpassing van de VirtualHub-router.
properties.virtualRouterIps	string[]	VirtualRouter-IP's.
properties.virtualWan	SubResource	De VirtualWAN waartoe de VirtualHub behoort.
properties.vpnGateway	SubResource	De VpnGateway die is gekoppeld aan deze VirtualHub.
tags	object	Resourcetags.
type	string	Resourcetype.

VirtualHubRoute

Object

VirtualHub-route.

Name	Type	Description
addressPrefixes	string[]	Lijst met alle addressPrefixes.
nextHopIpAddress	string	NextHop ip-adres.

VirtualHubRouteTable

Object

VirtualHub-routetabel.

Name	Type	Description
routes	VirtualHubRoute[]	Lijst met alle routes.

VirtualHubRouteTableV2

Object

VirtualHubRouteTableV2-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.attachedConnections	string[]	Lijst met alle verbindingen die zijn gekoppeld aan deze routetabel v2.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de routetabel v2 van de virtuele hub.
properties.routes	VirtualHubRouteV2[]	Lijst met alle routes.

VirtualHubRouteV2

Object

VirtualHubRouteTableV2-route.

Name	Type	Description
destinationType	string	Het type bestemmingen.
destinations	string[]	Lijst met alle bestemmingen.
nextHopType	string	Het type volgende hop.
nextHops	string[]	NextHops IP-adres.

VirtualRouterAutoScaleConfiguration

Object

De configuratie voor automatische schaalaanpassing van de VirtualHub-router.

Name	Type	Description
minCapacity	integer (int32) minimum: 0	Het minimale aantal schaaleenheden voor VirtualHub Router.