Express Route Cross Connections - Create Or Update

Service:

ExpressRoute

API Version:

2024-03-01

Update the specified ExpressRouteCrossConnection.

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

URI Parameters

Name	In	Required	Type	Description
crossConnectionName	path	True	string	The name of the ExpressRouteCrossConnection.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Request Body

Name	Type	Description
id	string	Resource ID.
location	string	Resource location.
properties.expressRouteCircuit	ExpressRouteCircuitReference	The ExpressRouteCircuit.
properties.peerings	ExpressRouteCrossConnectionPeering[]	The list of peerings.
properties.serviceProviderNotes	string	Additional read only notes set by the connectivity provider.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	The provisioning state of the circuit in the connectivity provider system.
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	ExpressRouteCrossConnection	Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

UpdateExpressRouteCrossConnection

Sample request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>?api-version=2024-03-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/2024-03-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/2024-03-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/network/resource-manager/Microsoft.Network/stable/2024-03-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/2024-03-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-03-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"
  }
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	The advertised public prefix state of the Peering resource.
ExpressRouteCircuitPeeringConfig	Specifies the peering configuration.
ExpressRouteCircuitPeeringState	The state of peering.
ExpressRouteCircuitReference	Reference to an express route circuit.
ExpressRouteCrossConnection	ExpressRouteCrossConnection resource.
ExpressRouteCrossConnectionPeering	Peering in an ExpressRoute Cross Connection resource.
ExpressRoutePeeringState	The state of peering.
ExpressRoutePeeringType	The peering type.
Ipv6ExpressRouteCircuitPeeringConfig	Contains IPv6 peering config.
ProvisioningState	The current provisioning state.
ServiceProviderProvisioningState	The ServiceProviderProvisioningState state of the resource.
SubResource	Reference to another subresource.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

The advertised public prefix state of the Peering resource.

Name	Type	Description
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Specifies the peering configuration.

Name	Type	Description
advertisedCommunities	string[]	The communities of bgp peering. Specified for microsoft peering.
advertisedPublicPrefixes	string[]	The reference to AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	The advertised public prefix state of the Peering resource.
customerASN	integer	The CustomerASN of the peering.
legacyMode	integer	The legacy mode of the peering.
routingRegistryName	string	The RoutingRegistryName of the configuration.

ExpressRouteCircuitPeeringState

The state of peering.

Name	Type	Description
Disabled	string
Enabled	string

ExpressRouteCircuitReference

Reference to an express route circuit.

Name	Type	Description
id	string	Corresponding Express Route Circuit Id.

ExpressRouteCrossConnection

ExpressRouteCrossConnection resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.bandwidthInMbps	integer	The circuit bandwidth In Mbps.
properties.expressRouteCircuit	ExpressRouteCircuitReference	The ExpressRouteCircuit.
properties.peeringLocation	string	The peering location of the ExpressRoute circuit.
properties.peerings	ExpressRouteCrossConnectionPeering[]	The list of peerings.
properties.primaryAzurePort	string	The name of the primary port.
properties.provisioningState	ProvisioningState	The provisioning state of the express route cross connection resource.
properties.sTag	integer	The identifier of the circuit traffic.
properties.secondaryAzurePort	string	The name of the secondary port.
properties.serviceProviderNotes	string	Additional read only notes set by the connectivity provider.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	The provisioning state of the circuit in the connectivity provider system.
tags	object	Resource tags.
type	string	Resource type.

ExpressRouteCrossConnectionPeering

Peering in an ExpressRoute Cross Connection resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.azureASN	integer	The Azure ASN.
properties.gatewayManagerEtag	string	The GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	The IPv6 peering configuration.
properties.lastModifiedBy	string	Who was the last to modify the peering.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	The Microsoft peering configuration.
properties.peerASN	integer	The peer ASN.
properties.peeringType	ExpressRoutePeeringType	The peering type.
properties.primaryAzurePort	string	The primary port.
properties.primaryPeerAddressPrefix	string	The primary address prefix.
properties.provisioningState	ProvisioningState	The provisioning state of the express route cross connection peering resource.
properties.secondaryAzurePort	string	The secondary port.
properties.secondaryPeerAddressPrefix	string	The secondary address prefix.
properties.sharedKey	string	The shared key.
properties.state	ExpressRoutePeeringState	The peering state.
properties.vlanId	integer	The VLAN ID.

ExpressRoutePeeringState

The state of peering.

Name	Type	Description
Disabled	string
Enabled	string

ExpressRoutePeeringType

The peering type.

Name	Type	Description
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6ExpressRouteCircuitPeeringConfig

Contains IPv6 peering config.

Name	Type	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	The Microsoft peering configuration.
primaryPeerAddressPrefix	string	The primary address prefix.
routeFilter	SubResource	The reference to the RouteFilter resource.
secondaryPeerAddressPrefix	string	The secondary address prefix.
state	ExpressRouteCircuitPeeringState	The state of peering.

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

ServiceProviderProvisioningState

The ServiceProviderProvisioningState state of the resource.

Name	Type	Description
Deprovisioning	string
NotProvisioned	string
Provisioned	string
Provisioning	string

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.