Share via

RecordSets interface

  • Reference
Package:
@azure/arm-dns

Interface representing a RecordSets.

Methods

createOrUpdate(string, string, string, RecordType, RecordSet, RecordSetsCreateOrUpdateOptionalParams)

Creates or updates a record set within a DNS zone.
delete(string, string, string, RecordType, RecordSetsDeleteOptionalParams)

Deletes a record set from a DNS zone. This operation cannot be undone.
get(string, string, string, RecordType, RecordSetsGetOptionalParams)

Gets a record set.
listAllByDnsZone(string, string, RecordSetsListAllByDnsZoneOptionalParams)

Lists all record sets in a DNS zone.
listByDnsZone(string, string, RecordSetsListByDnsZoneOptionalParams)

Lists all record sets in a DNS zone.
listByType(string, string, RecordType, RecordSetsListByTypeOptionalParams)

Lists the record sets of a specified type in a DNS zone.
update(string, string, string, RecordType, RecordSet, RecordSetsUpdateOptionalParams)

Updates a record set within a DNS zone.

Method Details

createOrUpdate(string, string, string, RecordType, RecordSet, RecordSetsCreateOrUpdateOptionalParams)

Creates or updates a record set within a DNS zone.

function createOrUpdate(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, parameters: RecordSet, options?: RecordSetsCreateOrUpdateOptionalParams): Promise<RecordSet>

Parameters

resourceGroupName

string

The name of the resource group.

zoneName

string

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

relativeRecordSetName

string

The name of the record set, relative to the name of the zone.

recordType
RecordType

The type of DNS record in this record set. Record sets of type SOA can be updated but not created (they are created when the DNS zone is created).

parameters
RecordSet

Parameters supplied to the CreateOrUpdate operation.

options
RecordSetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RecordSet>

delete(string, string, string, RecordType, RecordSetsDeleteOptionalParams)

Deletes a record set from a DNS zone. This operation cannot be undone.

function delete(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, options?: RecordSetsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

zoneName

string

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

relativeRecordSetName

string

The name of the record set, relative to the name of the zone.

recordType
RecordType

The type of DNS record in this record set. Record sets of type SOA cannot be deleted (they are deleted when the DNS zone is deleted).

options
RecordSetsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, RecordType, RecordSetsGetOptionalParams)

Gets a record set.

function get(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, options?: RecordSetsGetOptionalParams): Promise<RecordSet>

Parameters

resourceGroupName

string

The name of the resource group.

zoneName

string

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

relativeRecordSetName

string

The name of the record set, relative to the name of the zone.

recordType
RecordType

The type of DNS record in this record set.

options
RecordSetsGetOptionalParams

The options parameters.

Returns

Promise<RecordSet>

listAllByDnsZone(string, string, RecordSetsListAllByDnsZoneOptionalParams)

Lists all record sets in a DNS zone.

function listAllByDnsZone(resourceGroupName: string, zoneName: string, options?: RecordSetsListAllByDnsZoneOptionalParams): PagedAsyncIterableIterator<RecordSet, RecordSet[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

zoneName

string

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

options
RecordSetsListAllByDnsZoneOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RecordSet, RecordSet[], PageSettings>

listByDnsZone(string, string, RecordSetsListByDnsZoneOptionalParams)

Lists all record sets in a DNS zone.

function listByDnsZone(resourceGroupName: string, zoneName: string, options?: RecordSetsListByDnsZoneOptionalParams): PagedAsyncIterableIterator<RecordSet, RecordSet[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

zoneName

string

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

options
RecordSetsListByDnsZoneOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RecordSet, RecordSet[], PageSettings>

listByType(string, string, RecordType, RecordSetsListByTypeOptionalParams)

Lists the record sets of a specified type in a DNS zone.

function listByType(resourceGroupName: string, zoneName: string, recordType: RecordType, options?: RecordSetsListByTypeOptionalParams): PagedAsyncIterableIterator<RecordSet, RecordSet[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

zoneName

string

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

recordType
RecordType

The type of record sets to enumerate.

options
RecordSetsListByTypeOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RecordSet, RecordSet[], PageSettings>

update(string, string, string, RecordType, RecordSet, RecordSetsUpdateOptionalParams)

Updates a record set within a DNS zone.

function update(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, parameters: RecordSet, options?: RecordSetsUpdateOptionalParams): Promise<RecordSet>

Parameters

resourceGroupName

string

The name of the resource group.

zoneName

string

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

relativeRecordSetName

string

The name of the record set, relative to the name of the zone.

recordType
RecordType

The type of DNS record in this record set.

parameters
RecordSet

Parameters supplied to the Update operation.

options
RecordSetsUpdateOptionalParams

The options parameters.

Returns

Promise<RecordSet>