Virtual Router Peerings - Create Or Update

Service:

Virtual Networks

Version d'API:

2024-05-01

Crée ou met à jour le peering de routeur virtuel spécifié.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}?api-version=2024-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
peeringName	path	True	string	Nom du peering de routeur virtuel.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification de l’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
virtualRouterName	path	True	string	Nom du routeur virtuel.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom du peering de routeur virtuel unique au sein d’un routeur virtuel.
properties.peerAsn	integer (int64) minimum: 0 maximum: 4294967295	ASN d’homologue.
properties.peerIp	string	Adresse IP d’homologue.

Réponses

Nom	Type	Description
200 OK	VirtualRouterPeering	Demande réussie. L’opération retourne la ressource de peering de routeur virtuel résultante.
201 Created	VirtualRouterPeering	Demande reçue avec succès. L’opération retourne la ressource de peering de routeur virtuel résultante.
Other Status Codes	Error	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Create Virtual Router Peering

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1?api-version=2024-05-01

{
  "properties": {
    "peerIp": "192.168.1.5",
    "peerAsn": 20000
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.VirtualRouterPeeringInner;

/**
 * Samples for VirtualRouterPeerings CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualRouterPeeringPut.json
     */
    /**
     * Sample code: Create Virtual Router Peering.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createVirtualRouterPeering(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualRouterPeerings().createOrUpdate("rg1", "virtualRouter",
            "peering1", new VirtualRouterPeeringInner().withPeerAsn(20000L).withPeerIp("192.168.1.5"),
            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 virtual_router_peering_put.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.virtual_router_peerings.begin_create_or_update(
        resource_group_name="rg1",
        virtual_router_name="virtualRouter",
        peering_name="peering1",
        parameters={"properties": {"peerAsn": 20000, "peerIp": "192.168.1.5"}},
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualRouterPeeringPut.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/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualRouterPeeringPut.json
func ExampleVirtualRouterPeeringsClient_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.NewVirtualRouterPeeringsClient().BeginCreateOrUpdate(ctx, "rg1", "virtualRouter", "peering1", armnetwork.VirtualRouterPeering{
		Properties: &armnetwork.VirtualRouterPeeringProperties{
			PeerAsn: to.Ptr[int64](20000),
			PeerIP:  to.Ptr("192.168.1.5"),
		},
	}, 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.VirtualRouterPeering = armnetwork.VirtualRouterPeering{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1"),
	// 	Name: to.Ptr("peering1"),
	// 	Etag: to.Ptr("W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\""),
	// 	Properties: &armnetwork.VirtualRouterPeeringProperties{
	// 		PeerAsn: to.Ptr[int64](20000),
	// 		PeerIP: to.Ptr("192.168.1.5"),
	// 		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

JavaScript

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

/**
 * This sample demonstrates how to Creates or updates the specified Virtual Router Peering.
 *
 * @summary Creates or updates the specified Virtual Router Peering.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualRouterPeeringPut.json
 */
async function createVirtualRouterPeering() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualRouterName = "virtualRouter";
  const peeringName = "peering1";
  const parameters = {
    peerAsn: 20000,
    peerIp: "192.168.1.5",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualRouterPeerings.beginCreateOrUpdateAndWait(
    resourceGroupName,
    virtualRouterName,
    peeringName,
    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;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualRouterPeeringPut.json
// this example is just showing the usage of "VirtualRouterPeerings_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 VirtualRouterResource created on azure
// for more information of creating VirtualRouterResource, please refer to the document of VirtualRouterResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualRouterName = "virtualRouter";
ResourceIdentifier virtualRouterResourceId = VirtualRouterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualRouterName);
VirtualRouterResource virtualRouter = client.GetVirtualRouterResource(virtualRouterResourceId);

// get the collection of this VirtualRouterPeeringResource
VirtualRouterPeeringCollection collection = virtualRouter.GetVirtualRouterPeerings();

// invoke the operation
string peeringName = "peering1";
VirtualRouterPeeringData data = new VirtualRouterPeeringData
{
    PeerAsn = 20000L,
    PeerIP = "192.168.1.5",
};
ArmOperation<VirtualRouterPeeringResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, peeringName, data);
VirtualRouterPeeringResource 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
VirtualRouterPeeringData 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

Exemple de réponse

Code d’état:

200

{
  "name": "peering1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1",
  "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
  "properties": {
    "provisioningState": "Succeeded",
    "peerIp": "192.168.1.5",
    "peerAsn": 20000
  }
}

Code d’état:

201

{
  "name": "peering1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1",
  "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
  "properties": {
    "provisioningState": "Succeeded",
    "peerIp": "192.168.1.5",
    "peerAsn": 20000
  }
}

Définitions

Nom	Description
Error	Représentation d’erreur courante.
ErrorDetails	Représentation des détails d’erreur courants.
ProvisioningState	État d’approvisionnement actuel.
VirtualRouterPeering	Ressource de peering de routeur virtuel.

Error

Object

Représentation d’erreur courante.

Nom	Type	Description
code	string	Code d’erreur.
details	ErrorDetails[]	Détails de l’erreur.
innerError	string	Message d’erreur interne.
message	string	Message d'erreur.
target	string	Cible d’erreur.

ErrorDetails

Object

Représentation des détails d’erreur courants.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d'erreur.
target	string	Cible d’erreur.

ProvisioningState

Énumération

État d’approvisionnement actuel.

Valeur	Description
Deleting
Failed
Succeeded
Updating

VirtualRouterPeering

Object

Ressource de peering de routeur virtuel.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom du peering de routeur virtuel unique au sein d’un routeur virtuel.
properties.peerAsn	integer (int64) minimum: 0 maximum: 4294967295	ASN d’homologue.
properties.peerIp	string	Adresse IP d’homologue.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource.
type	string	Type de peering.