PrivateDnsExtensions.GetPrivateDnsZoneAsync Method

Definition

Namespace:

Azure.ResourceManager.PrivateDns

Assembly:

Azure.ResourceManager.PrivateDns.dll

Package:

Azure.ResourceManager.PrivateDns v1.2.0

Source:

PrivateDnsExtensions.cs

Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}
• Operation Id: PrivateZones_Get
• Default Api Version: 2024-06-01
• Resource: PrivateDnsZoneResource

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.PrivateDns.PrivateDnsZoneResource>> GetPrivateDnsZoneAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string privateZoneName, System.Threading.CancellationToken cancellationToken = default);

static member GetPrivateDnsZoneAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.PrivateDns.PrivateDnsZoneResource>>

<Extension()>
Public Function GetPrivateDnsZoneAsync (resourceGroupResource As ResourceGroupResource, privateZoneName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PrivateDnsZoneResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

privateZoneName

String

The name of the Private DNS zone (without a terminating dot).

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<PrivateDnsZoneResource>>

Exceptions

ArgumentNullException

resourceGroupResource or privateZoneName is null.

ArgumentException

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