VirtualRouterPeeringCollection.GetIfExistsAsync Method

Definition

Namespace:
Azure.ResourceManager.Network
Assembly:
Azure.ResourceManager.Network.dll
Package:
Azure.ResourceManager.Network v1.16.1
Package:
Azure.ResourceManager.Network v1.11.0-beta.2
Source:
VirtualRouterPeeringCollection.cs
Source:
VirtualRouterPeeringCollection.cs

Tries to get details for this resource from the service.

  • 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 System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Network.VirtualRouterPeeringResource>> GetIfExistsAsync(string peeringName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Network.VirtualRouterPeeringResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Network.VirtualRouterPeeringResource>>
Public Overridable Function GetIfExistsAsync (peeringName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(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

Task<NullableResponse<VirtualRouterPeeringResource>>

Exceptions

ArgumentNullException

peeringName is null.

ArgumentException

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

Applies to