Express Route Cross Connections - Create Or Update

Service:

ExpressRoute

API Version:

2023-09-01

Обновите указанный ExpressRouteCrossConnection.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
crossConnectionName	path	True	string	Имя ExpressRouteCrossConnection.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Тип	Описание
id	string	Идентификатор ресурса.
location	string	Расположение ресурса.
properties.expressRouteCircuit	ExpressRouteCircuitReference	The ExpressRouteCircuit.
properties.peerings	ExpressRouteCrossConnectionPeering[]	Список пирингов.
properties.serviceProviderNotes	string	Дополнительные заметки только для чтения, заданные поставщиком услуг подключения.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	Состояние подготовки канала в системе поставщика услуг подключения.
tags	object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	ExpressRouteCrossConnection	Обновление выполнено успешно. Операция возвращает полученный ресурс ExpressRouteCrossConnection.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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"
  }
}

Определения

Имя	Описание
CloudError	Ответ об ошибке от службы.
CloudErrorBody	Ответ об ошибке от службы.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	Состояние объявленного общедоступного префикса ресурса пиринга.
ExpressRouteCircuitPeeringConfig	Задает конфигурацию пиринга.
ExpressRouteCircuitPeeringState	Состояние пиринга.
ExpressRouteCircuitReference	Ссылка на канал express route.
ExpressRouteCrossConnection	Ресурс ExpressRouteCrossConnection.
ExpressRouteCrossConnectionPeering	Пиринг в ресурсе Перекрестного подключения ExpressRoute.
ExpressRoutePeeringState	Состояние пиринга.
ExpressRoutePeeringType	Тип пиринга.
Ipv6ExpressRouteCircuitPeeringConfig	Содержит конфигурацию пиринга IPv6.
ProvisioningState	Текущее состояние подготовки.
ServiceProviderProvisioningState	Состояние Ресурса ServiceProviderProvisioningState.
SubResource	Ссылка на другой подресурс.

CloudError

Ответ об ошибке от службы.

Имя	Тип	Описание
error	CloudErrorBody	Текст ошибки облака.

CloudErrorBody

Ответ об ошибке от службы.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

Состояние объявленного общедоступного префикса ресурса пиринга.

Имя	Тип	Описание
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Задает конфигурацию пиринга.

Имя	Тип	Описание
advertisedCommunities	string[]	Сообщества пиринга bgp. Указывается для пиринга Майкрософт.
advertisedPublicPrefixes	string[]	Ссылка на ОбъявленныеPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	Состояние объявленного общедоступного префикса ресурса пиринга.
customerASN	integer	CustomerASN пиринга.
legacyMode	integer	Устаревший режим пиринга.
routingRegistryName	string	RoutingRegistryName конфигурации.

ExpressRouteCircuitPeeringState

Состояние пиринга.

Имя	Тип	Описание
Disabled	string
Enabled	string

ExpressRouteCircuitReference

Ссылка на канал express route.

Имя	Тип	Описание
id	string	Соответствующий идентификатор канала Express Route.

ExpressRouteCrossConnection

Ресурс ExpressRouteCrossConnection.

Имя	Тип	Описание
etag	string	Уникальная строка, доступная только для чтения, которая изменяется при каждом обновлении ресурса.
id	string	Идентификатор ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.bandwidthInMbps	integer	Пропускная способность канала в Мбит/с.
properties.expressRouteCircuit	ExpressRouteCircuitReference	The ExpressRouteCircuit.
properties.peeringLocation	string	Расположение пиринга канала ExpressRoute.
properties.peerings	ExpressRouteCrossConnectionPeering[]	Список пирингов.
properties.primaryAzurePort	string	Имя основного порта.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса express route cross connection.
properties.sTag	integer	Идентификатор трафика канала.
properties.secondaryAzurePort	string	Имя дополнительного порта.
properties.serviceProviderNotes	string	Дополнительные заметки только для чтения, заданные поставщиком услуг подключения.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	Состояние подготовки канала в системе поставщика услуг подключения.
tags	object	Теги ресурсов.
type	string	Тип ресурса.

ExpressRouteCrossConnectionPeering

Пиринг в ресурсе Перекрестного подключения ExpressRoute.

Имя	Тип	Описание
etag	string	Уникальная строка, доступная только для чтения, которая изменяется при каждом обновлении ресурса.
id	string	Идентификатор ресурса.
name	string	Имя ресурса, уникального в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.
properties.azureASN	integer	The Azure ASN.
properties.gatewayManagerEtag	string	Etag GatewayManager.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	Конфигурация пиринга IPv6.
properties.lastModifiedBy	string	Кто последним изменял пиринг.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Конфигурация пиринга Майкрософт.
properties.peerASN	integer	AsN однорангового узла.
properties.peeringType	ExpressRoutePeeringType	Тип пиринга.
properties.primaryAzurePort	string	Основной порт.
properties.primaryPeerAddressPrefix	string	Префикс основного адреса.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса пиринга expressroute cross connection.
properties.secondaryAzurePort	string	Дополнительный порт.
properties.secondaryPeerAddressPrefix	string	Префикс вторичного адреса.
properties.sharedKey	string	Общий ключ.
properties.state	ExpressRoutePeeringState	Состояние пиринга.
properties.vlanId	integer	Идентификатор виртуальной локальной сети.

ExpressRoutePeeringState

Состояние пиринга.

Имя	Тип	Описание
Disabled	string
Enabled	string

ExpressRoutePeeringType

Тип пиринга.

Имя	Тип	Описание
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6ExpressRouteCircuitPeeringConfig

Содержит конфигурацию пиринга IPv6.

Имя	Тип	Описание
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Конфигурация пиринга Майкрософт.
primaryPeerAddressPrefix	string	Префикс основного адреса.
routeFilter	SubResource	Ссылка на ресурс RouteFilter.
secondaryPeerAddressPrefix	string	Префикс вторичного адреса.
state	ExpressRouteCircuitPeeringState	Состояние пиринга.

ProvisioningState

Текущее состояние подготовки.

Имя	Тип	Описание
Deleting	string
Failed	string
Succeeded	string
Updating	string

ServiceProviderProvisioningState

Состояние Ресурса ServiceProviderProvisioningState.

Имя	Тип	Описание
Deprovisioning	string
NotProvisioned	string
Provisioned	string
Provisioning	string

SubResource

Ссылка на другой подресурс.

Имя	Тип	Описание
id	string	Идентификатор ресурса.