Package version:

Interface RecordSets

Interface representing a RecordSets.

interface RecordSets {
    createOrUpdate(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, parameters: RecordSet, options?: RecordSetsCreateOrUpdateOptionalParams): Promise<RecordSet>;
    delete(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, options?: RecordSetsDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, options?: RecordSetsGetOptionalParams): Promise<RecordSet>;
    listAllByDnsZone(resourceGroupName: string, zoneName: string, options?: RecordSetsListAllByDnsZoneOptionalParams): PagedAsyncIterableIterator<RecordSet>;
    listByDnsZone(resourceGroupName: string, zoneName: string, options?: RecordSetsListByDnsZoneOptionalParams): PagedAsyncIterableIterator<RecordSet>;
    listByType(resourceGroupName: string, zoneName: string, recordType: RecordType, options?: RecordSetsListByTypeOptionalParams): PagedAsyncIterableIterator<RecordSet>;
    update(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, parameters: RecordSet, options?: RecordSetsUpdateOptionalParams): Promise<RecordSet>;
}

Methods

createOrUpdate(resourceGroupName, zoneName, relativeRecordSetName, recordType, parameters, options?): Promise<RecordSet>
Creates or updates a record set within a DNS zone. Record sets of type SOA can be updated but not created (they are created when the DNS zone is created).
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).
- 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 CreateOrUpdate operation.
- Optionaloptions: RecordSetsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<RecordSet>
- Defined in operationsInterfaces/recordSets.ts:90

delete(resourceGroupName, zoneName, relativeRecordSetName, recordType, options?): Promise<void>
Deletes a record set from a DNS zone. This operation cannot be undone. Record sets of type SOA cannot be deleted (they are deleted when the DNS zone is deleted).
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).
- 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.
- Optionaloptions: RecordSetsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/recordSets.ts:107

get(resourceGroupName, zoneName, relativeRecordSetName, recordType, options?): Promise<RecordSet>
Gets a record set.
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).
- 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.
- Optionaloptions: RecordSetsGetOptionalParams
  The options parameters.
Returns Promise<RecordSet>
- Defined in operationsInterfaces/recordSets.ts:122

listAllByDnsZone(resourceGroupName, zoneName, options?): PagedAsyncIterableIterator<RecordSet>
Lists all record sets in a DNS 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).
- Optionaloptions: RecordSetsListAllByDnsZoneOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<RecordSet>
- Defined in operationsInterfaces/recordSets.ts:58

listByDnsZone(resourceGroupName, zoneName, options?): PagedAsyncIterableIterator<RecordSet>
Lists all record sets in a DNS 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).
- Optionaloptions: RecordSetsListByDnsZoneOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<RecordSet>
- Defined in operationsInterfaces/recordSets.ts:47

listByType(resourceGroupName, zoneName, recordType, options?): PagedAsyncIterableIterator<RecordSet>
Lists the record sets of a specified type in a DNS 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).
- recordType: RecordType
  The type of DNS record in this record set.
- Optionaloptions: RecordSetsListByTypeOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<RecordSet>
- Defined in operationsInterfaces/recordSets.ts:35

update(resourceGroupName, zoneName, relativeRecordSetName, recordType, parameters, options?): Promise<RecordSet>
Updates a record set within a DNS 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).
- 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.
- Optionaloptions: RecordSetsUpdateOptionalParams
  The options parameters.
Returns Promise<RecordSet>
- Defined in operationsInterfaces/recordSets.ts:72