Virtual Hubs - Create Or Update

Referencia

Servicio:: Virtual WAN

Versión de la API:: 2024-05-01

Crea un recurso de VirtualHub si no existe, actualiza el centro virtual existente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}?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.
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.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación del recurso.
id		string	Identificador de recurso.
properties.addressPrefix		string	Prefijo de dirección para este VirtualHub.
properties.allowBranchToBranchTraffic		boolean	Marca para controlar el tránsito del centro de VirtualRouter.
properties.azureFirewall		SubResource	AzureFirewall asociado a este VirtualHub.
properties.expressRouteGateway		SubResource	ExpressRouteGateway asociado a este VirtualHub.
properties.hubRoutingPreference		HubRoutingPreference	HubRoutingPreference de este VirtualHub.
properties.p2SVpnGateway		SubResource	P2SVpnGateway asociado a este VirtualHub.
properties.preferredRoutingGateway		PreferredRoutingGateway	La puerta de enlace preferida para enrutar el tráfico local
properties.routeTable		VirtualHubRouteTable	RouteTable asociado a este centro virtual.
properties.securityPartnerProvider		SubResource	SecurityPartnerProvider asociado a este VirtualHub.
properties.securityProviderName		string	Nombre del proveedor de seguridad.
properties.sku		string	SKU de este VirtualHub.
properties.virtualHubRouteTableV2s		VirtualHubRouteTableV2[]	Lista de todas las tablas de rutas del centro de conectividad virtual v2 asociadas a este VirtualHub.
properties.virtualRouterAsn		integer	ASN de VirtualRouter.
properties.virtualRouterAutoScaleConfiguration		VirtualRouterAutoScaleConfiguration	Configuración de escalabilidad automática del enrutador de VirtualHub.
properties.virtualRouterIps		string[]	Direcciones IP de VirtualRouter.
properties.virtualWan		SubResource	VirtualWAN al que pertenece VirtualHub.
properties.vpnGateway		SubResource	VpnGateway asociado a este VirtualHub.
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualHub	Solicitud correcta. Devuelve los detalles de VirtualHub creados o actualizados.
201 Created	VirtualHub	Solicitud recibida correctamente. Devuelve los detalles de VirtualHub creados o actualizados.
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

VirtualHubPut

Solicitud de ejemplo

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

{
  "location": "West US",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    },
    "addressPrefix": "10.168.0.0/24",
    "sku": "Basic"
  }
}


import com.azure.core.management.SubResource;
import com.azure.resourcemanager.network.fluent.models.VirtualHubInner;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for VirtualHubs CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualHubPut.json
     */
    /**
     * Sample code: VirtualHubPut.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualHubPut(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualHubs().createOrUpdate("rg1", "virtualHub2",
            new VirtualHubInner().withLocation("West US").withTags(mapOf("key1", "fakeTokenPlaceholder"))
                .withVirtualWan(new SubResource().withId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"))
                .withAddressPrefix("10.168.0.0/24").withSku("Basic"),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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_put.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.begin_create_or_update(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub2",
        virtual_hub_parameters={
            "location": "West US",
            "properties": {
                "addressPrefix": "10.168.0.0/24",
                "sku": "Basic",
                "virtualWan": {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
                },
            },
            "tags": {"key1": "value1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualHubPut.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/azcore/to"
	"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/VirtualHubPut.json
func ExampleVirtualHubsClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewVirtualHubsClient().BeginCreateOrUpdate(ctx, "rg1", "virtualHub2", armnetwork.VirtualHub{
		Location: to.Ptr("West US"),
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
		},
		Properties: &armnetwork.VirtualHubProperties{
			AddressPrefix: to.Ptr("10.168.0.0/24"),
			SKU:           to.Ptr("Basic"),
			VirtualWan: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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("virtualHub2"),
	// 	Type: to.Ptr("Microsoft.Network/virtualHubs"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2"),
	// 	Location: to.Ptr("West US"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VirtualHubProperties{
	// 		AddressPrefix: to.Ptr("10.168.0.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 Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.
 *
 * @summary Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualHubPut.json
 */
async function virtualHubPut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub2";
  const virtualHubParameters = {
    addressPrefix: "10.168.0.0/24",
    location: "West US",
    sku: "Basic",
    tags: { key1: "value1" },
    virtualWan: {
      id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualHubs.beginCreateOrUpdateAndWait(
    resourceGroupName,
    virtualHubName,
    virtualHubParameters,
  );
  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

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "name": "virtualHub2",
  "type": "Microsoft.Network/virtualHubs",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    },
    "virtualHubRouteTableV2s": [],
    "addressPrefix": "10.168.0.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
    }
  }
}

status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "name": "virtualHub2",
  "type": "Microsoft.Network/virtualHubs",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    },
    "virtualHubRouteTableV2s": [],
    "addressPrefix": "10.168.0.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
    }
  }
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
HubRoutingPreference	Los tipos de puerta de enlace de preferencias de enrutamiento del centro
PreferredRoutingGateway	Los tipos de puerta de enlace de enrutamiento preferidos
ProvisioningState	Estado de aprovisionamiento actual.
RoutingState	Estado de enrutamiento actual de VirtualHub.
SubResource	Referencia a otro subrecurso.
VirtualHub	Recurso de VirtualHub.
VirtualHubRoute	Ruta de VirtualHub.
VirtualHubRouteTable	Tabla de rutas de VirtualHub.
VirtualHubRouteTableV2	Recurso VirtualHubRouteTableV2.
VirtualHubRouteV2	Ruta VirtualHubRouteTableV2.
VirtualRouterAutoScaleConfiguration	Configuración de escalabilidad automática del enrutador de VirtualHub.

CloudError

Respuesta de error del servicio.

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

CloudErrorBody

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.

HubRoutingPreference

Los tipos de puerta de enlace de preferencias de enrutamiento del centro

Nombre	Tipo	Description
ASPath	string
ExpressRoute	string
VpnGateway	string

PreferredRoutingGateway

Los tipos de puerta de enlace de enrutamiento preferidos

Nombre	Tipo	Description
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

Estado de aprovisionamiento actual.

Nombre	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingState

Estado de enrutamiento actual de VirtualHub.

Nombre	Tipo	Description
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

Referencia a otro subrecurso.

Nombre	Tipo	Description
id	string	Identificador de recurso.

VirtualHub

Recurso de VirtualHub.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador de recurso.
kind	string	Tipo de centro virtual de servicio. Estos son los metadatos que se usan para la experiencia de Azure Portal para Route Server.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.addressPrefix	string	Prefijo de dirección para este VirtualHub.
properties.allowBranchToBranchTraffic	boolean	Marca para controlar el tránsito del centro de VirtualRouter.
properties.azureFirewall	SubResource	AzureFirewall asociado a este VirtualHub.
properties.bgpConnections	SubResource[]	Lista de referencias a conexiones Bgp.
properties.expressRouteGateway	SubResource	ExpressRouteGateway asociado a este VirtualHub.
properties.hubRoutingPreference	HubRoutingPreference	HubRoutingPreference de este VirtualHub.
properties.ipConfigurations	SubResource[]	Lista de referencias a IpConfigurations.
properties.p2SVpnGateway	SubResource	P2SVpnGateway asociado a este VirtualHub.
properties.preferredRoutingGateway	PreferredRoutingGateway	La puerta de enlace preferida para enrutar el tráfico local
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso del centro virtual.
properties.routeMaps	SubResource[]	Lista de referencias a RouteMaps.
properties.routeTable	VirtualHubRouteTable	RouteTable asociado a este centro virtual.
properties.routingState	RoutingState	Estado de enrutamiento.
properties.securityPartnerProvider	SubResource	SecurityPartnerProvider asociado a este VirtualHub.
properties.securityProviderName	string	Nombre del proveedor de seguridad.
properties.sku	string	SKU de este VirtualHub.
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	Lista de todas las tablas de rutas del centro de conectividad virtual v2 asociadas a este VirtualHub.
properties.virtualRouterAsn	integer	ASN de VirtualRouter.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	Configuración de escalabilidad automática del enrutador de VirtualHub.
properties.virtualRouterIps	string[]	Direcciones IP de VirtualRouter.
properties.virtualWan	SubResource	VirtualWAN al que pertenece VirtualHub.
properties.vpnGateway	SubResource	VpnGateway asociado a este VirtualHub.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

VirtualHubRoute

Ruta de VirtualHub.

Nombre	Tipo	Description
addressPrefixes	string[]	Lista de todos los addressPrefixes.
nextHopIpAddress	string	Dirección IP nextHop.

VirtualHubRouteTable

Tabla de rutas de VirtualHub.

Nombre	Tipo	Description
routes	VirtualHubRoute[]	Lista de todas las rutas.

VirtualHubRouteTableV2

Recurso VirtualHubRouteTableV2.

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.attachedConnections	string[]	Lista de todas las conexiones conectadas a esta tabla de rutas v2.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de la tabla de rutas del centro de conectividad virtual v2.
properties.routes	VirtualHubRouteV2[]	Lista de todas las rutas.

VirtualHubRouteV2

Ruta VirtualHubRouteTableV2.

Nombre	Tipo	Description
destinationType	string	Tipo de destinos.
destinations	string[]	Lista de todos los destinos.
nextHopType	string	Tipo de próximo salto.
nextHops	string[]	Dirección IP de NextHops.

VirtualRouterAutoScaleConfiguration

Configuración de escalabilidad automática del enrutador de VirtualHub.

Nombre	Tipo	Description
minCapacity	integer	Número mínimo de unidades de escalado para el enrutador de VirtualHub.

Compartir a través de

Virtual Hubs - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

VirtualHubPut

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

CloudErrorBody

HubRoutingPreference

PreferredRoutingGateway

ProvisioningState

RoutingState

SubResource

VirtualHub

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

Recursos adicionales