Express Route Cross Connections - Create Or Update

Service:

ExpressRoute

API Version:

2023-09-01

Atualize o ExpressRouteCrossConnection especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
crossConnectionName	path	True	string	O nome do ExpressRouteCrossConnection.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	As credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Tipo	Description
id	string	ID do Recurso.
location	string	Localização do recurso.
properties.expressRouteCircuit	ExpressRouteCircuitReference	O ExpressRouteCircuit.
properties.peerings	ExpressRouteCrossConnectionPeering[]	A lista de peerings.
properties.serviceProviderNotes	string	Notas só de leitura adicionais definidas pelo fornecedor de conectividade.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	O estado de aprovisionamento do circuito no sistema do fornecedor de conectividade.
tags	object	Etiquetas de recursos.

Respostas

Name	Tipo	Description
200 OK	ExpressRouteCrossConnection	Atualização bem-sucedida. A operação devolve o recurso expressRouteCrossConnection resultante.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual 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

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

UpdateExpressRouteCrossConnection

Sample Request

HTTP

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

{
  "properties": {
    "serviceProviderProvisioningState": "NotProvisioned"
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.ExpressRouteCrossConnectionInner;
import com.azure.resourcemanager.network.models.ServiceProviderProvisioningState;

/**
 * Samples for ExpressRouteCrossConnections CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * ExpressRouteCrossConnectionUpdate.json
     */
    /**
     * Sample code: UpdateExpressRouteCrossConnection.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateExpressRouteCrossConnection(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCrossConnections().createOrUpdate(
            "CrossConnection-SiliconValley", "<circuitServiceKey>", new ExpressRouteCrossConnectionInner()
                .withServiceProviderProvisioningState(ServiceProviderProvisioningState.NOT_PROVISIONED),
            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 express_route_cross_connection_update.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.begin_create_or_update(
        resource_group_name="CrossConnection-SiliconValley",
        cross_connection_name="<circuitServiceKey>",
        parameters={"properties": {"serviceProviderProvisioningState": "NotProvisioned"}},
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionUpdate.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/ExpressRouteCrossConnectionUpdate.json
func ExampleExpressRouteCrossConnectionsClient_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.NewExpressRouteCrossConnectionsClient().BeginCreateOrUpdate(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", armnetwork.ExpressRouteCrossConnection{
		Properties: &armnetwork.ExpressRouteCrossConnectionProperties{
			ServiceProviderProvisioningState: to.Ptr(armnetwork.ServiceProviderProvisioningStateNotProvisioned),
		},
	}, 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.ExpressRouteCrossConnection = armnetwork.ExpressRouteCrossConnection{
	// 	Name: to.Ptr("<circuitServiceKey>"),
	// 	Type: to.Ptr("Microsoft.Network/expressRouteCrossConnections"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>"),
	// 	Location: to.Ptr("brazilsouth"),
	// 	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 Update the specified ExpressRouteCrossConnection.
 *
 * @summary Update the specified ExpressRouteCrossConnection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionUpdate.json
 */
async function updateExpressRouteCrossConnection() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName =
    process.env["NETWORK_RESOURCE_GROUP"] || "CrossConnection-SiliconValley";
  const crossConnectionName = "<circuitServiceKey>";
  const parameters = {
    serviceProviderProvisioningState: "NotProvisioned",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteCrossConnections.beginCreateOrUpdateAndWait(
    resourceGroupName,
    crossConnectionName,
    parameters,
  );
  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/ExpressRouteCrossConnectionUpdate.json
// this example is just showing the usage of "ExpressRouteCrossConnections_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "CrossConnection-SiliconValley";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ExpressRouteCrossConnectionResource
ExpressRouteCrossConnectionCollection collection = resourceGroupResource.GetExpressRouteCrossConnections();

// invoke the operation
string crossConnectionName = "<circuitServiceKey>";
ExpressRouteCrossConnectionData data = new ExpressRouteCrossConnectionData()
{
    ServiceProviderProvisioningState = ServiceProviderProvisioningState.NotProvisioned,
};
ArmOperation<ExpressRouteCrossConnectionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, crossConnectionName, data);
ExpressRouteCrossConnectionResource result = lro.Value;

// 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": "<circuitServiceKey>",
  "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>",
  "type": "Microsoft.Network/expressRouteCrossConnections",
  "location": "brazilsouth",
  "properties": {
    "provisioningState": "Enabled",
    "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

Name	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 peering.
ExpressRouteCircuitPeeringConfig	Especifica a configuração do peering.
ExpressRouteCircuitPeeringState	O estado do peering.
ExpressRouteCircuitReference	Referência a um circuito do ExpressRoute.
ExpressRouteCrossConnection	Recurso ExpressRouteCrossConnection.
ExpressRouteCrossConnectionPeering	Peering num recurso de Ligação Cruzada do ExpressRoute.
ExpressRoutePeeringState	O estado do peering.
ExpressRoutePeeringType	O tipo de peering.
Ipv6ExpressRouteCircuitPeeringConfig	Contém a configuração de peering IPv6.
ProvisioningState	O estado de aprovisionamento atual.
ServiceProviderProvisioningState	O estado ServiceProviderProvisioningState do recurso.
SubResource	Referência a outra sub-origem.

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro da cloud.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.
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 peering.

Name	Tipo	Description
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Especifica a configuração do peering.

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

ExpressRouteCircuitPeeringState

O estado do peering.

Name	Tipo	Description
Disabled	string
Enabled	string

ExpressRouteCircuitReference

Referência a um circuito do ExpressRoute.

Name	Tipo	Description
id	string	ID do Circuito do ExpressRoute correspondente.

ExpressRouteCrossConnection

Recurso ExpressRouteCrossConnection.

Name	Tipo	Description
etag	string	Uma cadeia só de leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do Recurso.
location	string	Localização 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	A localização do peering do circuito do ExpressRoute.
properties.peerings	ExpressRouteCrossConnectionPeering[]	A lista de peerings.
properties.primaryAzurePort	string	O nome da porta primária.
properties.provisioningState	ProvisioningState	O estado de aprovisionamento do recurso de ligação cruzada do expressroute.
properties.sTag	integer	O identificador do tráfego do circuito.
properties.secondaryAzurePort	string	O nome da porta secundária.
properties.serviceProviderNotes	string	Notas só de leitura adicionais definidas pelo fornecedor de conectividade.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	O estado de aprovisionamento do circuito no sistema do fornecedor de conectividade.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

ExpressRouteCrossConnectionPeering

Peering num recurso de Ligação Cruzada do ExpressRoute.

Name	Tipo	Description
etag	string	Uma cadeia só de leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do Recurso.
name	string	O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.
properties.azureASN	integer	O ASN do Azure.
properties.gatewayManagerEtag	string	O GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	A configuração de peering IPv6.
properties.lastModifiedBy	string	Quem foi o último a modificar o peering.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	A configuração do peering da Microsoft.
properties.peerASN	integer	O ASN do elemento da rede.
properties.peeringType	ExpressRoutePeeringType	O tipo de peering.
properties.primaryAzurePort	string	A porta primária.
properties.primaryPeerAddressPrefix	string	O prefixo do endereço principal.
properties.provisioningState	ProvisioningState	O estado de aprovisionamento do recurso de peering de ligação entre rotas rápidas.
properties.secondaryAzurePort	string	A porta secundária.
properties.secondaryPeerAddressPrefix	string	O prefixo de endereço secundário.
properties.sharedKey	string	A chave partilhada.
properties.state	ExpressRoutePeeringState	O estado do peering.
properties.vlanId	integer	O ID da VLAN.

ExpressRoutePeeringState

O estado do peering.

Name	Tipo	Description
Disabled	string
Enabled	string

ExpressRoutePeeringType

O tipo de peering.

Name	Tipo	Description
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6ExpressRouteCircuitPeeringConfig

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

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

ProvisioningState

O estado de aprovisionamento atual.

Name	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

ServiceProviderProvisioningState

O estado ServiceProviderProvisioningState do recurso.

Name	Tipo	Description
Deprovisioning	string
NotProvisioned	string
Provisioned	string
Provisioning	string

SubResource

Referência a outra sub-origem.

Name	Tipo	Description
id	string	ID do Recurso.