Virtual Hubs - Create Or Update

Odwołanie

Usługa:: Virtual WAN

Wersja interfejsu API:: 2024-05-01

Tworzy zasób usługi VirtualHub, jeśli jeszcze nie istnieje, aktualizuje istniejącą usługę VirtualHub.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów usługi VirtualHub.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
virtualHubName	path	True	string	Nazwa usługi VirtualHub.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja zasobu.
id		string	Identyfikator zasobu.
properties.addressPrefix		string	Prefiks adresu dla tej usługi VirtualHub.
properties.allowBranchToBranchTraffic		boolean	Flaga do kontrolowania tranzytu dla koncentratora VirtualRouter.
properties.azureFirewall		SubResource	AzureFirewall skojarzone z tą usługą VirtualHub.
properties.expressRouteGateway		SubResource	Brama expressRouteGateway skojarzona z tą usługą VirtualHub.
properties.hubRoutingPreference		HubRoutingPreference	HubRoutingPreference dla tej usługi VirtualHub.
properties.p2SVpnGateway		SubResource	Brama P2SVpnGateway skojarzona z tą usługą VirtualHub.
properties.preferredRoutingGateway		PreferredRoutingGateway	Preferowana brama do kierowania ruchu lokalnego
properties.routeTable		VirtualHubRouteTable	Tabela routeTable skojarzona z tym koncentratorem wirtualnym.
properties.securityPartnerProvider		SubResource	Dostawca securityPartnerProvider skojarzony z tą usługą VirtualHub.
properties.securityProviderName		string	Nazwa dostawcy zabezpieczeń.
properties.sku		string	Jednostka SKU tej usługi VirtualHub.
properties.virtualHubRouteTableV2s		VirtualHubRouteTableV2[]	Lista wszystkich tabel tras koncentratora wirtualnego w wersji 2 skojarzonych z tą usługą VirtualHub.
properties.virtualRouterAsn		integer	VirtualRouter ASN.
properties.virtualRouterAutoScaleConfiguration		VirtualRouterAutoScaleConfiguration	Konfiguracja automatycznego skalowania routera usługi VirtualHub.
properties.virtualRouterIps		string[]	Wirtualne adresy IP.
properties.virtualWan		SubResource	Wirtualna siećWAN, do której należy usługa VirtualHub.
properties.vpnGateway		SubResource	Brama VpnGateway skojarzona z tą usługą VirtualHub.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VirtualHub	Żądanie powiodło się. Zwraca szczegóły utworzone lub zaktualizowane w usłudze VirtualHub.
201 Created	VirtualHub	Żądanie zostało odebrane pomyślnie. Zwraca szczegóły utworzone lub zaktualizowane w usłudze VirtualHub.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

VirtualHubPut

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
    }
  }
}

Kod stanu:: 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
    }
  }
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi.
CloudErrorBody	Odpowiedź na błąd z usługi.
HubRoutingPreference	Typy bram preferencji routingu koncentratora
PreferredRoutingGateway	Preferowane typy bram routingu
ProvisioningState	Bieżący stan aprowizacji.
RoutingState	Bieżący stan routingu usługi VirtualHub.
SubResource	Odwołanie do innego podźródła.
VirtualHub	Zasób usługi VirtualHub.
VirtualHubRoute	Trasa usługi VirtualHub.
VirtualHubRouteTable	Tabela tras usługi VirtualHub.
VirtualHubRouteTableV2	Zasób VirtualHubRouteTableV2.
VirtualHubRouteV2	Trasa VirtualHubRouteTableV2.
VirtualRouterAutoScaleConfiguration	Konfiguracja automatycznego skalowania routera usługi VirtualHub.

CloudError

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść błędu chmury.

CloudErrorBody

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

HubRoutingPreference

Typy bram preferencji routingu koncentratora

Nazwa	Typ	Opis
ASPath	string
ExpressRoute	string
VpnGateway	string

PreferredRoutingGateway

Preferowane typy bram routingu

Nazwa	Typ	Opis
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

Bieżący stan aprowizacji.

Nazwa	Typ	Opis
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingState

Bieżący stan routingu usługi VirtualHub.

Nazwa	Typ	Opis
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

Odwołanie do innego podźródła.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.

VirtualHub

Zasób usługi VirtualHub.

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
id	string	Identyfikator zasobu.
kind	string	Rodzaj koncentratora wirtualnego usługi. Są to metadane używane w środowisku witryny Azure Portal dla usługi Route Server.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.addressPrefix	string	Prefiks adresu dla tej usługi VirtualHub.
properties.allowBranchToBranchTraffic	boolean	Flaga do kontrolowania tranzytu dla koncentratora VirtualRouter.
properties.azureFirewall	SubResource	AzureFirewall skojarzone z tą usługą VirtualHub.
properties.bgpConnections	SubResource[]	Lista odwołań do połączeń Bgp.
properties.expressRouteGateway	SubResource	Brama expressRouteGateway skojarzona z tą usługą VirtualHub.
properties.hubRoutingPreference	HubRoutingPreference	HubRoutingPreference dla tej usługi VirtualHub.
properties.ipConfigurations	SubResource[]	Lista odwołań do obiektów IpConfigurations.
properties.p2SVpnGateway	SubResource	Brama P2SVpnGateway skojarzona z tą usługą VirtualHub.
properties.preferredRoutingGateway	PreferredRoutingGateway	Preferowana brama do kierowania ruchu lokalnego
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu koncentratora wirtualnego.
properties.routeMaps	SubResource[]	Lista odwołań do routeMaps.
properties.routeTable	VirtualHubRouteTable	Tabela routeTable skojarzona z tym koncentratorem wirtualnym.
properties.routingState	RoutingState	Stan routingu.
properties.securityPartnerProvider	SubResource	Dostawca securityPartnerProvider skojarzony z tą usługą VirtualHub.
properties.securityProviderName	string	Nazwa dostawcy zabezpieczeń.
properties.sku	string	Jednostka SKU tej usługi VirtualHub.
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	Lista wszystkich tabel tras koncentratora wirtualnego w wersji 2 skojarzonych z tą usługą VirtualHub.
properties.virtualRouterAsn	integer	VirtualRouter ASN.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	Konfiguracja automatycznego skalowania routera usługi VirtualHub.
properties.virtualRouterIps	string[]	Wirtualne adresy IP.
properties.virtualWan	SubResource	Wirtualna siećWAN, do której należy usługa VirtualHub.
properties.vpnGateway	SubResource	Brama VpnGateway skojarzona z tą usługą VirtualHub.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

VirtualHubRoute

Trasa usługi VirtualHub.

Nazwa	Typ	Opis
addressPrefixes	string[]	Lista wszystkich adresówPrefiksy.
nextHopIpAddress	string	Adres IP elementu NextHop.

VirtualHubRouteTable

Tabela tras usługi VirtualHub.

Nazwa	Typ	Opis
routes	VirtualHubRoute[]	Lista wszystkich tras.

VirtualHubRouteTableV2

Zasób VirtualHubRouteTableV2.

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu, który jest unikatowy w grupie zasobów. Ta nazwa może służyć do uzyskiwania dostępu do zasobu.
properties.attachedConnections	string[]	Lista wszystkich połączeń dołączonych do tej tabeli tras w wersji 2.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu tabeli tras koncentratora wirtualnego w wersji 2.
properties.routes	VirtualHubRouteV2[]	Lista wszystkich tras.

VirtualHubRouteV2

Trasa VirtualHubRouteTableV2.

Nazwa	Typ	Opis
destinationType	string	Typ miejsc docelowych.
destinations	string[]	Lista wszystkich miejsc docelowych.
nextHopType	string	Typ następnego przeskoku.
nextHops	string[]	NextHops adres IP.

VirtualRouterAutoScaleConfiguration

Konfiguracja automatycznego skalowania routera usługi VirtualHub.

Nazwa	Typ	Opis
minCapacity	integer	Minimalna liczba jednostek skalowania dla routera usługi VirtualHub.

Udostępnij za pośrednictwem

Virtual Hubs - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

VirtualHubPut

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CloudError

CloudErrorBody

HubRoutingPreference

PreferredRoutingGateway

ProvisioningState

RoutingState

SubResource

VirtualHub

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

Dodatkowe zasoby