RecordSets interface

  • Reference
Package:
@azure/arm-privatedns

Interface representing a RecordSets.

Methods

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

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

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

Gets a record set.
list(string, string, RecordSetsListOptionalParams)

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

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

Updates a record set within a Private DNS zone.

Method Details

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

Creates or updates a record set within a Private DNS zone.

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

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

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 Private DNS zone is created).

relativeRecordSetName

string

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

parameters
RecordSet

Parameters supplied to the CreateOrUpdate operation.

options
RecordSetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RecordSet>

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

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

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

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

recordType
RecordType

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

relativeRecordSetName

string

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

options
RecordSetsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

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

Gets a record set.

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

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

recordType
RecordType

The type of DNS record in this record set.

relativeRecordSetName

string

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

options
RecordSetsGetOptionalParams

The options parameters.

Returns

Promise<RecordSet>

list(string, string, RecordSetsListOptionalParams)

Lists all record sets in a Private DNS zone.

function list(resourceGroupName: string, privateZoneName: string, options?: RecordSetsListOptionalParams): PagedAsyncIterableIterator<RecordSet, RecordSet[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

options
RecordSetsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RecordSet, RecordSet[], PageSettings>

listByType(string, string, RecordType, RecordSetsListByTypeOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

The name of the Private 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, RecordType, string, RecordSet, RecordSetsUpdateOptionalParams)

Updates a record set within a Private DNS zone.

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

Parameters

resourceGroupName

string

The name of the resource group.

privateZoneName

string

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

recordType
RecordType

The type of DNS record in this record set.

relativeRecordSetName

string

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

parameters
RecordSet

Parameters supplied to the Update operation.

options
RecordSetsUpdateOptionalParams

The options parameters.

Returns

Promise<RecordSet>