Virtual Hubs - Update Tags

Service:

Virtual WAN

API Version:

2023-09-01

Atualizações marcas do VirtualHub.

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

Parâmetros de URI

Nome	Em	Obrigató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. A ID da assinatura faz parte do URI para cada chamada de serviço.
virtualHubName	path	True	string	O nome do VirtualHub.
api-version	query	True	string	Versão de API do cliente.

Corpo da solicitação

Nome	Tipo	Description
tags	object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	VirtualHub	Solicitação bem-sucedida. Retorna os detalhes do VirtualHub atualizado.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

VirtualHubUpdate

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2?api-version=2023-09-01

{
  "tags": {
    "key1": "value1",
    "key2": "value2"
  }
}

Java

import com.azure.resourcemanager.network.models.TagsObject;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for VirtualHubs UpdateTags.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubUpdateTags.json
     */
    /**
     * Sample code: VirtualHubUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualHubUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualHubs().updateTagsWithResponse("rg1", "virtualHub2",
            new TagsObject().withTags(mapOf("key1", "fakeTokenPlaceholder", "key2", "fakeTokenPlaceholder")),
            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

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_update_tags.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.update_tags(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub2",
        virtual_hub_parameters={"tags": {"key1": "value1", "key2": "value2"}},
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubUpdateTags.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubUpdateTags.json
func ExampleVirtualHubsClient_UpdateTags() {
	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().UpdateTags(ctx, "rg1", "virtualHub2", armnetwork.TagsObject{
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
			"key2": to.Ptr("value2"),
		},
	}, 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("virtualHub2"),
	// 	Type: to.Ptr("Microsoft.Network/virtualHubs"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	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),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		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 Updates VirtualHub tags.
 *
 * @summary Updates VirtualHub tags.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubUpdateTags.json
 */
async function virtualHubUpdate() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub2";
  const virtualHubParameters = {
    tags: { key1: "value1", key2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualHubs.updateTags(
    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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubUpdateTags.json
// this example is just showing the usage of "VirtualHubs_UpdateTags" 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 = "virtualHub2";
ResourceIdentifier virtualHubResourceId = VirtualHubResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualHubName);
VirtualHubResource virtualHub = client.GetVirtualHubResource(virtualHubResourceId);

// invoke the operation
NetworkTagsObject virtualHubParameters = new NetworkTagsObject()
{
    Tags =
    {
    ["key1"] = "value1",
    ["key2"] = "value2",
    },
};
VirtualHubResource result = await virtualHub.UpdateAsync(virtualHubParameters);

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

Sample Response

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",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    },
    "virtualHubRouteTableV2s": [],
    "addressPrefix": "10.168.0.0/24",
    "sku": "Basic",
    "virtualRouterAsn": 65515,
    "virtualRouterIps": [
      "10.10.1.12",
      "10.10.1.13"
    ],
    "allowBranchToBranchTraffic": false,
    "hubRoutingPreference": "ExpressRoute",
    "virtualRouterAutoScaleConfiguration": {
      "minCapacity": 2
    }
  }
}

Definições

Nome	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 preferenciais
ProvisioningState	O estado de provisionamento atual.
RoutingState	O estado de roteamento atual do VirtualHub.
SubResource	Referência a outro sub-recurso.
TagsObject	Objeto Tags para operações de patch.
VirtualHub	Recurso do 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 do VirtualHub.

CloudError

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Corpo do erro de nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

HubRoutingPreference

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

Nome	Tipo	Description
ASPath	string
ExpressRoute	string
VpnGateway	string

PreferredRoutingGateway

Os tipos de gateway de roteamento preferenciais

Nome	Tipo	Description
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

O estado de provisionamento atual.

Nome	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingState

O estado de roteamento atual do VirtualHub.

Nome	Tipo	Description
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

Referência a outro sub-recurso.

Nome	Tipo	Description
id	string	ID do recurso.

TagsObject

Objeto Tags para operações de patch.

Nome	Tipo	Description
tags	object	Marcas de recurso.

VirtualHub

Recurso do VirtualHub.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada 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 portal do Azure para o Servidor de Rota.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.addressPrefix	string	Prefixo de endereço 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 ao bgp Connections.
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 do hub virtual.
properties.routeMaps	SubResource[]	Lista de referências a RouteMaps.
properties.routeTable	VirtualHubRouteTable	A routeTable associada a esse 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 do hub virtual v2s associadas a este VirtualHub.
properties.virtualRouterAsn	integer	VirtualRouter ASN.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	A configuração de dimensionamento automático do Roteador do VirtualHub.
properties.virtualRouterIps	string[]	IPs do VirtualRouter.
properties.virtualWan	SubResource	O VirtualWAN ao qual o VirtualHub pertence.
properties.vpnGateway	SubResource	O VpnGateway associado a este VirtualHub.
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

VirtualHubRoute

Rota do VirtualHub.

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

VirtualHubRouteTable

Tabela de rotas do VirtualHub.

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

VirtualHubRouteTableV2

Recurso VirtualHubRouteTableV2.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo em 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 da tabela de rotas do hub virtual v2.
properties.routes	VirtualHubRouteV2[]	Lista de todas as rotas.

VirtualHubRouteV2

Rota VirtualHubRouteTableV2.

Nome	Tipo	Description
destinationType	string	O tipo de destinos.
destinations	string[]	Lista de todos os destinos.
nextHopType	string	O tipo de próximo salto.
nextHops	string[]	Endereço ip NextHops.

VirtualRouterAutoScaleConfiguration

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

Nome	Tipo	Description
minCapacity	integer	O número mínimo de unidades de escala para o Roteador do VirtualHub.