Express Route Circuit Connections - Create Or Update

Başvuru

Service:: ExpressRoute

API Version:: 2023-09-01

Belirtilen express route devrelerinde Express Route Bağlantı Hattı Bağlantısı oluşturur veya güncelleştirir.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}?api-version=2023-09-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
circuitName	path	True	string	Express route bağlantı hattının adı.
connectionName	path	True	string	Express route bağlantı hattı bağlantısının adı.
peeringName	path	True	string	Eşlemenin adı.
resourceGroupName	path	True	string	Kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci API sürümü.

İstek Gövdesi

Name	Tür	Description
id	string	Kaynak Kimliği.
name	string	Kaynak grubu içinde benzersiz olan kaynağın adı. Bu ad kaynağa erişmek için kullanılabilir.
properties.addressPrefix	string	Tüneller için Müşteri adreslerini oymak için IP adresi alanını /29.
properties.authorizationKey	string	Yetkilendirme anahtarı.
properties.expressRouteCircuitPeering	SubResource	Bağlantı başlatan bağlantı hattının Express Route Bağlantı Hattı Özel Eşleme Kaynağına başvuru.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	Hızlı yol bağlantı hattı bağlantısının IPv6 Adres Ön EkiÖzellikler.
properties.peerExpressRouteCircuitPeering	SubResource	Eşlenen bağlantı hattının Express Route Devresi Özel Eşleme Kaynağına başvuru.

Yanıtlar

Name	Tür	Description
200 OK	ExpressRouteCircuitConnection	Güncelleştirme başarılı oldu. İşlem, sonuçta elde edilen ExpressRouteCircuitPeering kaynağını döndürür.
201 Created	ExpressRouteCircuitConnection	Oluşturma başarılı. İşlem, sonuçta elde edilen ExpressRouteCircuitPeering kaynağını döndürür.
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ExpressRouteCircuitConnectionCreate

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS?api-version=2023-09-01

{
  "properties": {
    "expressRouteCircuitPeering": {
      "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"
    },
    "peerExpressRouteCircuitPeering": {
      "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"
    },
    "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a",
    "addressPrefix": "10.0.0.0/29",
    "ipv6CircuitConnectionConfig": {
      "addressPrefix": "aa:bb::/125"
    }
  }
}


import com.azure.core.management.SubResource;
import com.azure.resourcemanager.network.fluent.models.ExpressRouteCircuitConnectionInner;
import com.azure.resourcemanager.network.models.Ipv6CircuitConnectionConfig;

/**
 * Samples for ExpressRouteCircuitConnections CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * ExpressRouteCircuitConnectionCreate.json
     */
    /**
     * Sample code: ExpressRouteCircuitConnectionCreate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void expressRouteCircuitConnectionCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCircuitConnections().createOrUpdate("rg1",
            "ExpressRouteARMCircuitA", "AzurePrivatePeering", "circuitConnectionUSAUS",
            new ExpressRouteCircuitConnectionInner().withExpressRouteCircuitPeering(new SubResource().withId(
                "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"))
                .withPeerExpressRouteCircuitPeering(new SubResource().withId(
                    "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"))
                .withAddressPrefix("10.0.0.0/29").withAuthorizationKey("fakeTokenPlaceholder")
                .withIpv6CircuitConnectionConfig(new Ipv6CircuitConnectionConfig().withAddressPrefix("aa:bb::/125")),
            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

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_circuit_connection_create.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="subid1",
    )

    response = client.express_route_circuit_connections.begin_create_or_update(
        resource_group_name="rg1",
        circuit_name="ExpressRouteARMCircuitA",
        peering_name="AzurePrivatePeering",
        connection_name="circuitConnectionUSAUS",
        express_route_circuit_connection_parameters={
            "properties": {
                "addressPrefix": "10.0.0.0/29",
                "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a",
                "expressRouteCircuitPeering": {
                    "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"
                },
                "ipv6CircuitConnectionConfig": {"addressPrefix": "aa:bb::/125"},
                "peerExpressRouteCircuitPeering": {
                    "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"
                },
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitConnectionCreate.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

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/ExpressRouteCircuitConnectionCreate.json
func ExampleExpressRouteCircuitConnectionsClient_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.NewExpressRouteCircuitConnectionsClient().BeginCreateOrUpdate(ctx, "rg1", "ExpressRouteARMCircuitA", "AzurePrivatePeering", "circuitConnectionUSAUS", armnetwork.ExpressRouteCircuitConnection{
		Properties: &armnetwork.ExpressRouteCircuitConnectionPropertiesFormat{
			AddressPrefix:    to.Ptr("10.0.0.0/29"),
			AuthorizationKey: to.Ptr("946a1918-b7a2-4917-b43c-8c4cdaee006a"),
			ExpressRouteCircuitPeering: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"),
			},
			IPv6CircuitConnectionConfig: &armnetwork.IPv6CircuitConnectionConfig{
				AddressPrefix: to.Ptr("aa:bb::/125"),
			},
			PeerExpressRouteCircuitPeering: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"),
			},
		},
	}, 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.ExpressRouteCircuitConnection = armnetwork.ExpressRouteCircuitConnection{
	// 	ID: to.Ptr("/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS"),
	// 	Name: to.Ptr("circuitConnectionUSAUS"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.ExpressRouteCircuitConnectionPropertiesFormat{
	// 		AddressPrefix: to.Ptr("10.0.0.0/24"),
	// 		AuthorizationKey: to.Ptr("946a1918-b7a2-4917-b43c-8c4cdaee006a"),
	// 		CircuitConnectionStatus: to.Ptr(armnetwork.CircuitConnectionStatusConnected),
	// 		ExpressRouteCircuitPeering: &armnetwork.SubResource{
	// 			ID: to.Ptr("/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"),
	// 		},
	// 		IPv6CircuitConnectionConfig: &armnetwork.IPv6CircuitConnectionConfig{
	// 			AddressPrefix: to.Ptr("aa:bb::1/125"),
	// 			CircuitConnectionStatus: to.Ptr(armnetwork.CircuitConnectionStatusConnected),
	// 		},
	// 		PeerExpressRouteCircuitPeering: &armnetwork.SubResource{
	// 			ID: to.Ptr("/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"),
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a Express Route Circuit Connection in the specified express route circuits.
 *
 * @summary Creates or updates a Express Route Circuit Connection in the specified express route circuits.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitConnectionCreate.json
 */
async function expressRouteCircuitConnectionCreate() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid1";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const circuitName = "ExpressRouteARMCircuitA";
  const peeringName = "AzurePrivatePeering";
  const connectionName = "circuitConnectionUSAUS";
  const expressRouteCircuitConnectionParameters = {
    addressPrefix: "10.0.0.0/29",
    authorizationKey: "946a1918-b7a2-4917-b43c-8c4cdaee006a",
    expressRouteCircuitPeering: {
      id: "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering",
    },
    ipv6CircuitConnectionConfig: { addressPrefix: "aa:bb::/125" },
    peerExpressRouteCircuitPeering: {
      id: "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteCircuitConnections.beginCreateOrUpdateAndWait(
    resourceGroupName,
    circuitName,
    peeringName,
    connectionName,
    expressRouteCircuitConnectionParameters,
  );
  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

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;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitConnectionCreate.json
// this example is just showing the usage of "ExpressRouteCircuitConnections_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 ExpressRouteCircuitConnectionResource created on azure
// for more information of creating ExpressRouteCircuitConnectionResource, please refer to the document of ExpressRouteCircuitConnectionResource
string subscriptionId = "subid1";
string resourceGroupName = "rg1";
string circuitName = "ExpressRouteARMCircuitA";
string peeringName = "AzurePrivatePeering";
string connectionName = "circuitConnectionUSAUS";
ResourceIdentifier expressRouteCircuitConnectionResourceId = ExpressRouteCircuitConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, circuitName, peeringName, connectionName);
ExpressRouteCircuitConnectionResource expressRouteCircuitConnection = client.GetExpressRouteCircuitConnectionResource(expressRouteCircuitConnectionResourceId);

// invoke the operation
ExpressRouteCircuitConnectionData data = new ExpressRouteCircuitConnectionData()
{
    ExpressRouteCircuitPeeringId = new ResourceIdentifier("/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"),
    PeerExpressRouteCircuitPeeringId = new ResourceIdentifier("/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"),
    AddressPrefix = "10.0.0.0/29",
    AuthorizationKey = "946a1918-b7a2-4917-b43c-8c4cdaee006a",
    IPv6CircuitConnectionConfig = new IPv6CircuitConnectionConfig()
    {
        AddressPrefix = "aa:bb::/125",
    },
};
ArmOperation<ExpressRouteCircuitConnectionResource> lro = await expressRouteCircuitConnection.UpdateAsync(WaitUntil.Completed, data);
ExpressRouteCircuitConnectionResource 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
ExpressRouteCircuitConnectionData 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:: 201

{
  "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "name": "circuitConnectionUSAUS",
  "properties": {
    "expressRouteCircuitPeering": {
      "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"
    },
    "peerExpressRouteCircuitPeering": {
      "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"
    },
    "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a",
    "addressPrefix": "10.0.0.0/24",
    "circuitConnectionStatus": "Connected",
    "provisioningState": "Succeeded",
    "ipv6CircuitConnectionConfig": {
      "addressPrefix": "aa:bb::1/125",
      "circuitConnectionStatus": "Connected"
    }
  }
}

Status code:: 200

{
  "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "name": "circuitConnectionUSAUS",
  "properties": {
    "expressRouteCircuitPeering": {
      "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"
    },
    "peerExpressRouteCircuitPeering": {
      "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"
    },
    "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a",
    "addressPrefix": "10.0.0.0/24",
    "circuitConnectionStatus": "Connected",
    "provisioningState": "Succeeded",
    "ipv6CircuitConnectionConfig": {
      "addressPrefix": "aa:bb::1/125",
      "circuitConnectionStatus": "Connected"
    }
  }
}

Tanımlar

Name	Description
CircuitConnectionStatus	Express Route Bağlantı Hattı bağlantı durumu.
CloudError	Hizmetten bir hata yanıtı.
CloudErrorBody	Hizmetten bir hata yanıtı.
ExpressRouteCircuitConnection	ExpressRouteCircuitPeering kaynağında Express Route Bağlantı Hattı.
Ipv6CircuitConnectionConfig	Genel erişim için IPv6 Bağlantı Hattı Özellikleri.
ProvisioningState	Geçerli sağlama durumu.
SubResource	Başka bir alt kaynak başvurusu.

CircuitConnectionStatus

Express Route Bağlantı Hattı bağlantı durumu.

Name	Tür	Description
Connected	string
Connecting	string
Disconnected	string

CloudError

Hizmetten bir hata yanıtı.

Name	Tür	Description
error	CloudErrorBody	Bulut hata gövdesi.

CloudErrorBody

Hizmetten bir hata yanıtı.

Name	Tür	Description
code	string	Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
details	CloudErrorBody[]	Hatayla ilgili ek ayrıntıların listesi.
message	string	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
target	string	Belirli bir hatanın hedefi. Örneğin, özelliğin adı hatalı.

ExpressRouteCircuitConnection

ExpressRouteCircuitPeering kaynağında Express Route Bağlantı Hattı.

Name	Tür	Description
etag	string	Kaynak her güncelleştirildiğinde değişen benzersiz bir salt okunur dize.
id	string	Kaynak Kimliği.
name	string	Kaynak grubu içinde benzersiz olan kaynağın adı. Bu ad kaynağa erişmek için kullanılabilir.
properties.addressPrefix	string	Tüneller için Müşteri adreslerini oymak için IP adresi alanını /29.
properties.authorizationKey	string	Yetkilendirme anahtarı.
properties.circuitConnectionStatus	CircuitConnectionStatus	Express Route Bağlantı Hattı bağlantı durumu.
properties.expressRouteCircuitPeering	SubResource	Bağlantı başlatan bağlantı hattının Express Route Bağlantı Hattı Özel Eşleme Kaynağına başvuru.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	Hızlı yol bağlantı hattı bağlantısının IPv6 Adres Ön EkiÖzellikler.
properties.peerExpressRouteCircuitPeering	SubResource	Eşlenen bağlantı hattının Express Route Devresi Özel Eşleme Kaynağına başvuru.
properties.provisioningState	ProvisioningState	Express route bağlantı hattı bağlantısının sağlama durumu.
type	string	Kaynağın türü.

Ipv6CircuitConnectionConfig

Genel erişim için IPv6 Bağlantı Hattı Özellikleri.

Name	Tür	Description
addressPrefix	string	Genel erişim için müşteri adreslerini oymak için IP adresi alanını /125.
circuitConnectionStatus	CircuitConnectionStatus	Express Route Bağlantı Hattı bağlantı durumu.

ProvisioningState

Geçerli sağlama durumu.

Name	Tür	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Başka bir alt kaynak başvurusu.

Name	Tür	Description
id	string	Kaynak Kimliği.