ExpressRouteCircuitResource.GetExpressRouteCircuitPeeringAsync Method

Definition

Gets the specified peering for the express route circuit.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}
  • Operation Id: ExpressRouteCircuitPeerings_Get
  • Default Api Version: 2024-03-01
  • Resource: ExpressRouteCircuitPeeringResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.ExpressRouteCircuitPeeringResource>> GetExpressRouteCircuitPeeringAsync (string peeringName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetExpressRouteCircuitPeeringAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.ExpressRouteCircuitPeeringResource>>
override this.GetExpressRouteCircuitPeeringAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.ExpressRouteCircuitPeeringResource>>
Public Overridable Function GetExpressRouteCircuitPeeringAsync (peeringName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ExpressRouteCircuitPeeringResource))

Parameters

peeringName
String

The name of the peering.

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