Share via

Zones interface

  • Reference
Package:
@azure/arm-dns

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.
update(string, string, ZoneUpdate, ZonesUpdateOptionalParams)

Updates a DNS zone. Does not modify DNS records within the zone.

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<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

zoneName

string

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

options
ZonesDeleteOptionalParams

The options parameters.

Returns

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

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<void>

Parameters

resourceGroupName

string

The name of the resource group.

zoneName

string

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

options
ZonesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

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.

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.

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

PagedAsyncIterableIterator<Zone, Zone[], PageSettings>

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.

options
ZonesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Zone, Zone[], PageSettings>

update(string, string, ZoneUpdate, ZonesUpdateOptionalParams)

Updates a DNS zone. Does not modify DNS records within the zone.

function update(resourceGroupName: string, zoneName: string, parameters: ZoneUpdate, options?: ZonesUpdateOptionalParams): Promise<Zone>

Parameters

resourceGroupName

string

The name of the resource group.

zoneName

string

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

parameters
ZoneUpdate

Parameters supplied to the Update operation.

options
ZonesUpdateOptionalParams

The options parameters.

Returns

Promise<Zone>