Zones interface

Interface representing a Zones.

Methods

beginDelete(string, string, ZonesDeleteOptionalParams)

Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

beginDeleteAndWait(string, string, ZonesDeleteOptionalParams)

Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

createOrUpdate(string, string, Zone, ZonesCreateOrUpdateOptionalParams)

Creates or updates a DNS zone. Does not modify DNS records within the zone.

get(string, string, ZonesGetOptionalParams)

Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.

list(ZonesListOptionalParams)

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

listByResourceGroup(string, ZonesListByResourceGroupOptionalParams)

Lists the DNS zones within a resource group.

Method Details

beginDelete(string, string, ZonesDeleteOptionalParams)

Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

function beginDelete(resourceGroupName: string, zoneName: string, options?: ZonesDeleteOptionalParams): Promise<PollerLike<PollOperationState<ZoneDeleteResult>, ZoneDeleteResult>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

zoneName

string

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

options
ZonesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<ZoneDeleteResult>, ZoneDeleteResult>>

beginDeleteAndWait(string, string, ZonesDeleteOptionalParams)

Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

function beginDeleteAndWait(resourceGroupName: string, zoneName: string, options?: ZonesDeleteOptionalParams): Promise<ZoneDeleteResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

zoneName

string

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

options
ZonesDeleteOptionalParams

The options parameters.

Returns

Promise<ZoneDeleteResult>

createOrUpdate(string, string, Zone, ZonesCreateOrUpdateOptionalParams)

Creates or updates a DNS zone. Does not modify DNS records within the zone.

function createOrUpdate(resourceGroupName: string, zoneName: string, parameters: Zone, options?: ZonesCreateOrUpdateOptionalParams): Promise<Zone>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

zoneName

string

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

parameters
Zone

Parameters supplied to the CreateOrUpdate operation.

options
ZonesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Zone>

get(string, string, ZonesGetOptionalParams)

Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.

function get(resourceGroupName: string, zoneName: string, options?: ZonesGetOptionalParams): Promise<Zone>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

zoneName

string

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

options
ZonesGetOptionalParams

The options parameters.

Returns

Promise<Zone>

list(ZonesListOptionalParams)

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

function list(options?: ZonesListOptionalParams): PagedAsyncIterableIterator<Zone, Zone[], PageSettings>

Parameters

options
ZonesListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, ZonesListByResourceGroupOptionalParams)

Lists the DNS zones within a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
ZonesListByResourceGroupOptionalParams

The options parameters.

Returns