Express Route Cross Connections - Update Tags

Service:

ExpressRoute

API Version:

2023-09-01

Atualizações uma rota expressa entre marcas de conexão.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
crossConnectionName	path	True	string	O nome da conexão cruzada.
resourceGroupName	path	True	string	O nome do grupo de recursos.
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.
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	ExpressRouteCrossConnection	Atualização bem-sucedida. A operação retorna o recurso ExpressRouteCrossConnection resultante.
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

UpdateExpressRouteCrossConnectionTags

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>?api-version=2023-09-01

{
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Java

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

/**
 * Samples for ExpressRouteCrossConnections UpdateTags.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * ExpressRouteCrossConnectionUpdateTags.json
     */
    /**
     * Sample code: UpdateExpressRouteCrossConnectionTags.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateExpressRouteCrossConnectionTags(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCrossConnections().updateTagsWithResponse(
            "CrossConnection-SiliconValley", "<circuitServiceKey>",
            new TagsObject().withTags(mapOf("tag1", "value1", "tag2", "value2")), 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 express_route_cross_connection_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.express_route_cross_connections.update_tags(
        resource_group_name="CrossConnection-SiliconValley",
        cross_connection_name="<circuitServiceKey>",
        cross_connection_parameters={"tags": {"tag1": "value1", "tag2": "value2"}},
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionUpdateTags.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/ExpressRouteCrossConnectionUpdateTags.json
func ExampleExpressRouteCrossConnectionsClient_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.NewExpressRouteCrossConnectionsClient().UpdateTags(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", armnetwork.TagsObject{
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": 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.ExpressRouteCrossConnection = armnetwork.ExpressRouteCrossConnection{
	// 	Name: to.Ptr("er1"),
	// 	Type: to.Ptr("Microsoft.Network/expressRouteCrossConnections"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>"),
	// 	Location: to.Ptr("brazilsouth"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armnetwork.ExpressRouteCrossConnectionProperties{
	// 		BandwidthInMbps: to.Ptr[int32](1000),
	// 		ExpressRouteCircuit: &armnetwork.ExpressRouteCircuitReference{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1"),
	// 		},
	// 		PeeringLocation: to.Ptr("SiliconValley"),
	// 		Peerings: []*armnetwork.ExpressRouteCrossConnectionPeering{
	// 		},
	// 		PrimaryAzurePort: to.Ptr("bvtazureixp01"),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		STag: to.Ptr[int32](2),
	// 		SecondaryAzurePort: to.Ptr("bvtazureixp01"),
	// 		ServiceProviderProvisioningState: to.Ptr(armnetwork.ServiceProviderProvisioningStateNotProvisioned),
	// 	},
	// }
}

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 an express route cross connection tags.
 *
 * @summary Updates an express route cross connection tags.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionUpdateTags.json
 */
async function updateExpressRouteCrossConnectionTags() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName =
    process.env["NETWORK_RESOURCE_GROUP"] || "CrossConnection-SiliconValley";
  const crossConnectionName = "<circuitServiceKey>";
  const crossConnectionParameters = {
    tags: { tag1: "value1", tag2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteCrossConnections.updateTags(
    resourceGroupName,
    crossConnectionName,
    crossConnectionParameters,
  );
  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.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/ExpressRouteCrossConnectionUpdateTags.json
// this example is just showing the usage of "ExpressRouteCrossConnections_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 ExpressRouteCrossConnectionResource created on azure
// for more information of creating ExpressRouteCrossConnectionResource, please refer to the document of ExpressRouteCrossConnectionResource
string subscriptionId = "subid";
string resourceGroupName = "CrossConnection-SiliconValley";
string crossConnectionName = "<circuitServiceKey>";
ResourceIdentifier expressRouteCrossConnectionResourceId = ExpressRouteCrossConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, crossConnectionName);
ExpressRouteCrossConnectionResource expressRouteCrossConnection = client.GetExpressRouteCrossConnectionResource(expressRouteCrossConnectionResourceId);

// invoke the operation
NetworkTagsObject crossConnectionParameters = new NetworkTagsObject()
{
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2",
    },
};
ExpressRouteCrossConnectionResource result = await expressRouteCrossConnection.UpdateAsync(crossConnectionParameters);

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

{
  "name": "er1",
  "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>",
  "type": "Microsoft.Network/expressRouteCrossConnections",
  "location": "brazilsouth",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Failed",
    "expressRouteCircuit": {
      "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1"
    },
    "peerings": [],
    "peeringLocation": "SiliconValley",
    "bandwidthInMbps": 1000,
    "primaryAzurePort": "bvtazureixp01",
    "secondaryAzurePort": "bvtazureixp01",
    "sTag": 2,
    "serviceProviderProvisioningState": "NotProvisioned"
  }
}

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	O estado de prefixo público anunciado do recurso emparelhamento.
ExpressRouteCircuitPeeringConfig	Especifica a configuração de emparelhamento.
ExpressRouteCircuitPeeringState	O estado do emparelhamento.
ExpressRouteCircuitReference	Referência a um circuito de rota expressa.
ExpressRouteCrossConnection	Recurso ExpressRouteCrossConnection.
ExpressRouteCrossConnectionPeering	Emparelhamento em um recurso de Conexão Cruzada do ExpressRoute.
ExpressRoutePeeringState	O estado do emparelhamento.
ExpressRoutePeeringType	O tipo de emparelhamento.
Ipv6ExpressRouteCircuitPeeringConfig	Contém a configuração de emparelhamento IPv6.
ProvisioningState	O estado de provisionamento atual.
ServiceProviderProvisioningState	O estado ServiceProviderProvisioningState do recurso.
SubResource	Referência a outro sub-recurso.
TagsObject	Objeto Tags para operações de patch.

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.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

O estado de prefixo público anunciado do recurso emparelhamento.

Nome	Tipo	Description
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Especifica a configuração de emparelhamento.

Nome	Tipo	Description
advertisedCommunities	string[]	As comunidades de emparelhamento bgp. Especificado para emparelhamento da Microsoft.
advertisedPublicPrefixes	string[]	A referência a AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	O estado de prefixo público anunciado do recurso emparelhamento.
customerASN	integer	O CustomerASN do emparelhamento.
legacyMode	integer	O modo herdado do emparelhamento.
routingRegistryName	string	O RoutingRegistryName da configuração.

ExpressRouteCircuitPeeringState

O estado do emparelhamento.

Nome	Tipo	Description
Disabled	string
Enabled	string

ExpressRouteCircuitReference

Referência a um circuito de rota expressa.

Nome	Tipo	Description
id	string	ID do Circuito de Rota Expressa correspondente.

ExpressRouteCrossConnection

Recurso ExpressRouteCrossConnection.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.bandwidthInMbps	integer	A largura de banda do circuito em Mbps.
properties.expressRouteCircuit	ExpressRouteCircuitReference	O ExpressRouteCircuit.
properties.peeringLocation	string	O local de emparelhamento do circuito do ExpressRoute.
properties.peerings	ExpressRouteCrossConnectionPeering[]	A lista de emparelhamentos.
properties.primaryAzurePort	string	O nome da porta primária.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de conexão cruzada de rota expressa.
properties.sTag	integer	O identificador do tráfego do circuito.
properties.secondaryAzurePort	string	O nome da porta secundária.
properties.serviceProviderNotes	string	Anotações adicionais somente leitura definidas pelo provedor de conectividade.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	O estado de provisionamento do circuito no sistema do provedor de conectividade.
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

ExpressRouteCrossConnectionPeering

Emparelhamento em um recurso de Conexão Cruzada do ExpressRoute.

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.azureASN	integer	O ASN do Azure.
properties.gatewayManagerEtag	string	O GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	A configuração de emparelhamento IPv6.
properties.lastModifiedBy	string	Quem foi o último a modificar o emparelhamento.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	A configuração de emparelhamento da Microsoft.
properties.peerASN	integer	O ASN par.
properties.peeringType	ExpressRoutePeeringType	O tipo de emparelhamento.
properties.primaryAzurePort	string	A porta primária.
properties.primaryPeerAddressPrefix	string	O prefixo de endereço primário.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de emparelhamento de conexão cruzada de rota expressa.
properties.secondaryAzurePort	string	A porta secundária.
properties.secondaryPeerAddressPrefix	string	O prefixo de endereço secundário.
properties.sharedKey	string	A chave compartilhada.
properties.state	ExpressRoutePeeringState	O estado de emparelhamento.
properties.vlanId	integer	A ID da VLAN.

ExpressRoutePeeringState

O estado do emparelhamento.

Nome	Tipo	Description
Disabled	string
Enabled	string

ExpressRoutePeeringType

O tipo de emparelhamento.

Nome	Tipo	Description
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6ExpressRouteCircuitPeeringConfig

Contém a configuração de emparelhamento IPv6.

Nome	Tipo	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	A configuração de emparelhamento da Microsoft.
primaryPeerAddressPrefix	string	O prefixo de endereço primário.
routeFilter	SubResource	A referência ao recurso RouteFilter.
secondaryPeerAddressPrefix	string	O prefixo de endereço secundário.
state	ExpressRouteCircuitPeeringState	O estado do emparelhamento.

ProvisioningState

O estado de provisionamento atual.

Nome	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

ServiceProviderProvisioningState

O estado ServiceProviderProvisioningState do recurso.

Nome	Tipo	Description
Deprovisioning	string
NotProvisioned	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.