PrivateZones interface

Package:

@azure/arm-privatedns

Interface representing a PrivateZones.

Methods

beginCreateOrUpdate(string, string, PrivateZone, PrivateZonesCreateOrUpdateOptionalParams)	Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.
beginCreateOrUpdateAndWait(string, string, PrivateZone, PrivateZonesCreateOrUpdateOptionalParams)	Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.
beginDelete(string, string, PrivateZonesDeleteOptionalParams)	Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.
beginDeleteAndWait(string, string, PrivateZonesDeleteOptionalParams)	Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.
beginUpdate(string, string, PrivateZone, PrivateZonesUpdateOptionalParams)	Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.
beginUpdateAndWait(string, string, PrivateZone, PrivateZonesUpdateOptionalParams)	Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.
get(string, string, PrivateZonesGetOptionalParams)	Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.
list(PrivateZonesListOptionalParams)	Lists the Private DNS zones in all resource groups in a subscription.
listByResourceGroup(string, PrivateZonesListByResourceGroupOptionalParams)	Lists the Private DNS zones within a resource group.

Method Details

beginCreateOrUpdate(string, string, PrivateZone, PrivateZonesCreateOrUpdateOptionalParams)

Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.

function beginCreateOrUpdate(resourceGroupName: string, privateZoneName: string, parameters: PrivateZone, options?: PrivateZonesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateZone>, PrivateZone>>

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

parameters

PrivateZone

Parameters supplied to the CreateOrUpdate operation.

options

PrivateZonesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PrivateZone>, PrivateZone>>

beginCreateOrUpdateAndWait(string, string, PrivateZone, PrivateZonesCreateOrUpdateOptionalParams)

Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.

function beginCreateOrUpdateAndWait(resourceGroupName: string, privateZoneName: string, parameters: PrivateZone, options?: PrivateZonesCreateOrUpdateOptionalParams): Promise<PrivateZone>

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

parameters

PrivateZone

Parameters supplied to the CreateOrUpdate operation.

options

PrivateZonesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateZone>

beginDelete(string, string, PrivateZonesDeleteOptionalParams)

Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.

function beginDelete(resourceGroupName: string, privateZoneName: string, options?: PrivateZonesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

options

PrivateZonesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, PrivateZonesDeleteOptionalParams)

Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.

function beginDeleteAndWait(resourceGroupName: string, privateZoneName: string, options?: PrivateZonesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

options

PrivateZonesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, PrivateZone, PrivateZonesUpdateOptionalParams)

Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.

function beginUpdate(resourceGroupName: string, privateZoneName: string, parameters: PrivateZone, options?: PrivateZonesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateZone>, PrivateZone>>

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

parameters

PrivateZone

Parameters supplied to the Update operation.

options

PrivateZonesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PrivateZone>, PrivateZone>>

beginUpdateAndWait(string, string, PrivateZone, PrivateZonesUpdateOptionalParams)

Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.

function beginUpdateAndWait(resourceGroupName: string, privateZoneName: string, parameters: PrivateZone, options?: PrivateZonesUpdateOptionalParams): Promise<PrivateZone>

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

parameters

PrivateZone

Parameters supplied to the Update operation.

options

PrivateZonesUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateZone>

get(string, string, PrivateZonesGetOptionalParams)

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

function get(resourceGroupName: string, privateZoneName: string, options?: PrivateZonesGetOptionalParams): Promise<PrivateZone>

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

options

PrivateZonesGetOptionalParams

The options parameters.

Returns

Promise<PrivateZone>

list(PrivateZonesListOptionalParams)

Lists the Private DNS zones in all resource groups in a subscription.

function list(options?: PrivateZonesListOptionalParams): PagedAsyncIterableIterator<PrivateZone, PrivateZone[], PageSettings>

Parameters

options

PrivateZonesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateZone, PrivateZone[], PageSettings>

listByResourceGroup(string, PrivateZonesListByResourceGroupOptionalParams)

Lists the Private DNS zones within a resource group.

function listByResourceGroup(resourceGroupName: string, options?: PrivateZonesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<PrivateZone, PrivateZone[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

PrivateZonesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateZone, PrivateZone[], PageSettings>