Hub Route Tables - Get

Servicio:

Virtual WAN

Versión de la API:

2024-05-01

Recupera los detalles de una RouteTable.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos de VirtualHub.
routeTableName	path	True	string	Nombre de routeTable.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
virtualHubName	path	True	string	Nombre de VirtualHub.
api-version	query	True	string	Versión de la API de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	HubRouteTable	Solicitud correcta. Devuelve los detalles de routeTable recuperados.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

RouteTableGet

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for HubRouteTables Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/HubRouteTableGet.json
     */
    /**
     * Sample code: RouteTableGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void routeTableGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getHubRouteTables().getWithResponse("rg1", "virtualHub1",
            "hubRouteTable1", 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 hub_route_table_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.hub_route_tables.get(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub1",
        route_table_name="hubRouteTable1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/HubRouteTableGet.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/HubRouteTableGet.json
func ExampleHubRouteTablesClient_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.NewHubRouteTablesClient().Get(ctx, "rg1", "virtualHub1", "hubRouteTable1", 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.HubRouteTable = armnetwork.HubRouteTable{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
	// 	Name: to.Ptr("hubRouteTable1"),
	// 	Type: to.Ptr("Microsoft.Network/virtualHubs/hubRouteTables"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.HubRouteTableProperties{
	// 		AssociatedConnections: []*string{
	// 			to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1"),
	// 			to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2")},
	// 			Labels: []*string{
	// 				to.Ptr("label1"),
	// 				to.Ptr("label2")},
	// 				PropagatingConnections: []*string{
	// 					to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1"),
	// 					to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2")},
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					Routes: []*armnetwork.HubRoute{
	// 						{
	// 							Name: to.Ptr("route1"),
	// 							DestinationType: to.Ptr("CIDR"),
	// 							Destinations: []*string{
	// 								to.Ptr("10.0.0.0/8"),
	// 								to.Ptr("20.0.0.0/8"),
	// 								to.Ptr("30.0.0.0/8")},
	// 								NextHop: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1"),
	// 								NextHopType: to.Ptr("ResourceId"),
	// 						}},
	// 					},
	// 				}
}

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 RouteTable.
 *
 * @summary Retrieves the details of a RouteTable.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/HubRouteTableGet.json
 */
async function routeTableGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub1";
  const routeTableName = "hubRouteTable1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.hubRouteTables.get(resourceGroupName, virtualHubName, routeTableName);
  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/HubRouteTableGet.json
// this example is just showing the usage of "HubRouteTables_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);

// get the collection of this HubRouteTableResource
HubRouteTableCollection collection = virtualHub.GetHubRouteTables();

// invoke the operation
string routeTableName = "hubRouteTable1";
NullableResponse<HubRouteTableResource> response = await collection.GetIfExistsAsync(routeTableName);
HubRouteTableResource 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
    HubRouteTableData 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

Respuesta de muestra

status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "name": "hubRouteTable1",
  "properties": {
    "provisioningState": "Succeeded",
    "routes": [
      {
        "name": "route1",
        "destinationType": "CIDR",
        "destinations": [
          "10.0.0.0/8",
          "20.0.0.0/8",
          "30.0.0.0/8"
        ],
        "nextHopType": "ResourceId",
        "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1"
      }
    ],
    "labels": [
      "label1",
      "label2"
    ],
    "associatedConnections": [
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1",
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2"
    ],
    "propagatingConnections": [
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1",
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2"
    ]
  },
  "type": "Microsoft.Network/virtualHubs/hubRouteTables"
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
HubRoute	Ruta routeTable.
HubRouteTable	Recurso RouteTable en un centro virtual.
ProvisioningState	Estado de aprovisionamiento actual.

CloudError

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo del error en la nube.

CloudErrorBody

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

HubRoute

Object

Ruta routeTable.

Nombre	Tipo	Description
destinationType	string	Tipo de destinos (por ejemplo: CIDR, ResourceId, Service).
destinations	string[]	Lista de todos los destinos.
name	string	Nombre de la ruta que es única dentro de una RouteTable. Este nombre se puede usar para acceder a esta ruta.
nextHop	string	Identificador del recurso NextHop.
nextHopType	string	Tipo de próximo salto (por ejemplo, ResourceId).

HubRouteTable

Object

Recurso RouteTable en un centro virtual.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador de recurso.
name	string	Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso.
properties.associatedConnections	string[]	Lista de todas las conexiones asociadas a esta tabla de rutas.
properties.labels	string[]	Lista de etiquetas asociadas a esta tabla de rutas.
properties.propagatingConnections	string[]	Lista de todas las conexiones que anuncian a esta tabla de rutas.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso RouteTable.
properties.routes	HubRoute[]	Lista de todas las rutas.
type	string	Tipo de recurso.

ProvisioningState

Enumeración

Estado de aprovisionamiento actual.

Valor	Description
Deleting
Failed
Succeeded
Updating