VirtualRouterPeeringCollection.Get(String, CancellationToken) Method

Definition

Gets the specified Virtual Router Peering.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}.
  • Operation Id. : VirtualRouterPeerings_Get.
  • Default Api Version. : 2025-07-01.
public virtual Azure.Response<Azure.ResourceManager.Network.VirtualRouterPeeringResource> Get(string peeringName, System.Threading.CancellationToken cancellationToken = default);
abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Network.VirtualRouterPeeringResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Network.VirtualRouterPeeringResource>
Public Overridable Function Get (peeringName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of VirtualRouterPeeringResource)

Parameters

peeringName
String

The name of the resource that is unique within a resource group. This name can be used to access the resource.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

peeringName is null.

peeringName is an empty string, and was expected to be non-empty.

Applies to