Virtual Hubs - Get

Referência

Serviço:: Virtual WAN

Versão da API:: 2024-05-01

Recupera os detalhes de um VirtualHub.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos do VirtualHub.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
virtualHubName	path	True	string	O nome do VirtualHub.
api-version	query	True	string	Versão da API do cliente.

Respostas

Name	Tipo	Description
200 OK	VirtualHub	Pedido bem-sucedido. Retorna os detalhes do VirtualHub recuperado.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

VirtualHubGet

Pedido de amostra

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


/**
 * 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

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

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

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

Resposta da amostra

Código de estado:: 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
    }
  }
}

Definições

Name	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
HubRoutingPreference	Os tipos de gateway de preferência de roteamento de hub
PreferredRoutingGateway	Os tipos de gateway de roteamento preferidos
ProvisioningState	O estado de provisionamento atual.
RoutingState	O estado de roteamento atual do VirtualHub.
SubResource	Referência a outro subrecurso.
VirtualHub	Recurso VirtualHub.
VirtualHubRoute	Rota do VirtualHub.
VirtualHubRouteTable	Tabela de rotas do VirtualHub.
VirtualHubRouteTableV2	Recurso VirtualHubRouteTableV2.
VirtualHubRouteV2	Rota VirtualHubRouteTableV2.
VirtualRouterAutoScaleConfiguration	A configuração de dimensionamento automático do Roteador VirtualHub.

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro na nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

HubRoutingPreference

Os tipos de gateway de preferência de roteamento de hub

Name	Tipo	Description
ASPath	string
ExpressRoute	string
VpnGateway	string

PreferredRoutingGateway

Os tipos de gateway de roteamento preferidos

Name	Tipo	Description
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

O estado de provisionamento atual.

Name	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingState

O estado de roteamento atual do VirtualHub.

Name	Tipo	Description
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

Referência a outro subrecurso.

Name	Tipo	Description
id	string	ID do recurso.

VirtualHub

Recurso VirtualHub.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
kind	string	Tipo de hub virtual de serviço. Esses são metadados usados para a experiência do portal do Azure para o Route Server.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.addressPrefix	string	Endereço-prefixo para este VirtualHub.
properties.allowBranchToBranchTraffic	boolean	Sinalizador para controlar o trânsito para o hub VirtualRouter.
properties.azureFirewall	SubResource	O azureFirewall associado a este VirtualHub.
properties.bgpConnections	SubResource[]	Lista de referências a Conexões Bgp.
properties.expressRouteGateway	SubResource	O expressRouteGateway associado a este VirtualHub.
properties.hubRoutingPreference	HubRoutingPreference	O hubRoutingPreference deste VirtualHub.
properties.ipConfigurations	SubResource[]	Lista de referências a IpConfigurations.
properties.p2SVpnGateway	SubResource	O P2SVpnGateway associado a este VirtualHub.
properties.preferredRoutingGateway	PreferredRoutingGateway	O gateway preferencial para rotear o tráfego local
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de hub virtual.
properties.routeMaps	SubResource[]	Lista de referências a RouteMaps.
properties.routeTable	VirtualHubRouteTable	A routeTable associada a este hub virtual.
properties.routingState	RoutingState	O estado de roteamento.
properties.securityPartnerProvider	SubResource	O securityPartnerProvider associado a este VirtualHub.
properties.securityProviderName	string	O nome do provedor de segurança.
properties.sku	string	O sku deste VirtualHub.
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	Lista de todas as tabelas de rotas de hub virtual v2s associadas a este VirtualHub.
properties.virtualRouterAsn	integer	ASN do VirtualRouter.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	A configuração de dimensionamento automático do Roteador VirtualHub.
properties.virtualRouterIps	string[]	IPs do VirtualRouter.
properties.virtualWan	SubResource	A VirtualWAN à qual o VirtualHub pertence.
properties.vpnGateway	SubResource	O VpnGateway associado a este VirtualHub.
tags	object	Tags de recursos.
type	string	Tipo de recurso.

VirtualHubRoute

Rota do VirtualHub.

Name	Tipo	Description
addressPrefixes	string[]	Lista de todos os addressPrefixes.
nextHopIpAddress	string	Endereço IP NextHop.

VirtualHubRouteTable

Tabela de rotas do VirtualHub.

Name	Tipo	Description
routes	VirtualHubRoute[]	Lista de todas as rotas.

VirtualHubRouteTableV2

Recurso VirtualHubRouteTableV2.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.attachedConnections	string[]	Lista de todas as conexões anexadas a esta tabela de rotas v2.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso v2 da tabela de rotas do hub virtual.
properties.routes	VirtualHubRouteV2[]	Lista de todas as rotas.

VirtualHubRouteV2

Rota VirtualHubRouteTableV2.

Name	Tipo	Description
destinationType	string	O tipo de destinos.
destinations	string[]	Lista de todos os destinos.
nextHopType	string	O tipo de próximo lúpulo.
nextHops	string[]	Endereço IP NextHops.

VirtualRouterAutoScaleConfiguration

A configuração de dimensionamento automático do Roteador VirtualHub.

Name	Tipo	Description
minCapacity	integer	O número mínimo de unidades de escala para o VirtualHub Router.

Partilhar via

Virtual Hubs - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

VirtualHubGet

Pedido de amostra

Resposta da amostra

Definições

CloudError

CloudErrorBody

HubRoutingPreference

PreferredRoutingGateway

ProvisioningState

RoutingState

SubResource

VirtualHub

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

Recursos adicionais