Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecordSets

Package version

Class representing a RecordSets.

Hierarchy

  • RecordSets

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, parameters: RecordSet, options?: Models.RecordSetsCreateOrUpdateOptionalParams): Promise<Models.RecordSetsCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, parameters: RecordSet, callback: msRest.ServiceCallback<RecordSet>): void
  • createOrUpdate(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, parameters: RecordSet, options: RecordSetsCreateOrUpdateOptionalParams, callback: msRest.ServiceCallback<RecordSet>): void

  • Creates or 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: Models.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). Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • parameters: RecordSet

      Parameters supplied to the CreateOrUpdate operation.

    • Optional options: Models.RecordSetsCreateOrUpdateOptionalParams

    Returns Promise<Models.RecordSetsCreateOrUpdateResponse>

    Promise<Models.RecordSetsCreateOrUpdateResponse>

  • 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: Models.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). Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • parameters: RecordSet

      Parameters supplied to the CreateOrUpdate operation.

    • callback: msRest.ServiceCallback<RecordSet>

      The callback

    Returns void

  • 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: Models.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). Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • parameters: RecordSet

      Parameters supplied to the CreateOrUpdate operation.

    • options: RecordSetsCreateOrUpdateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<RecordSet>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, options?: Models.RecordSetsDeleteMethodOptionalParams): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, options: RecordSetsDeleteMethodOptionalParams, callback: msRest.ServiceCallback<void>): void

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

    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: Models.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). Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • Optional options: Models.RecordSetsDeleteMethodOptionalParams

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • 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: Models.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). Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • 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: Models.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). Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • options: RecordSetsDeleteMethodOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, options?: msRest.RequestOptionsBase): Promise<Models.RecordSetsGetResponse>
  • get(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, callback: msRest.ServiceCallback<RecordSet>): void
  • get(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecordSet>): void

  • 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: Models.RecordType

      The type of DNS record in this record set. Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RecordSetsGetResponse>

    Promise<Models.RecordSetsGetResponse>

  • 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: Models.RecordType

      The type of DNS record in this record set. Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • callback: msRest.ServiceCallback<RecordSet>

      The callback

    Returns void

  • 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: Models.RecordType

      The type of DNS record in this record set. Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RecordSet>

      The callback

    Returns void

listByDnsZone

  • listByDnsZone(resourceGroupName: string, zoneName: string, options?: Models.RecordSetsListByDnsZoneOptionalParams): Promise<Models.RecordSetsListByDnsZoneResponse>
  • listByDnsZone(resourceGroupName: string, zoneName: string, callback: msRest.ServiceCallback<RecordSetListResult>): void
  • listByDnsZone(resourceGroupName: string, zoneName: string, options: RecordSetsListByDnsZoneOptionalParams, callback: msRest.ServiceCallback<RecordSetListResult>): void

  • 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).

    • Optional options: Models.RecordSetsListByDnsZoneOptionalParams

    Returns Promise<Models.RecordSetsListByDnsZoneResponse>

    Promise<Models.RecordSetsListByDnsZoneResponse>

  • 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).

    • callback: msRest.ServiceCallback<RecordSetListResult>

      The callback

    Returns void

  • 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: RecordSetsListByDnsZoneOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<RecordSetListResult>

      The callback

    Returns void

listByDnsZoneNext

  • listByDnsZoneNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.RecordSetsListByDnsZoneNextResponse>
  • listByDnsZoneNext(nextPageLink: string, callback: msRest.ServiceCallback<RecordSetListResult>): void
  • listByDnsZoneNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecordSetListResult>): void

  • Lists all record sets in a DNS zone.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RecordSetsListByDnsZoneNextResponse>

    Promise<Models.RecordSetsListByDnsZoneNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<RecordSetListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RecordSetListResult>

      The callback

    Returns void

listByType

  • listByType(resourceGroupName: string, zoneName: string, recordType: Models.RecordType, options?: Models.RecordSetsListByTypeOptionalParams): Promise<Models.RecordSetsListByTypeResponse>
  • listByType(resourceGroupName: string, zoneName: string, recordType: Models.RecordType, callback: msRest.ServiceCallback<RecordSetListResult>): void
  • listByType(resourceGroupName: string, zoneName: string, recordType: Models.RecordType, options: RecordSetsListByTypeOptionalParams, callback: msRest.ServiceCallback<RecordSetListResult>): void

  • 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: Models.RecordType

      The type of record sets to enumerate. Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • Optional options: Models.RecordSetsListByTypeOptionalParams

    Returns Promise<Models.RecordSetsListByTypeResponse>

    Promise<Models.RecordSetsListByTypeResponse>

  • 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: Models.RecordType

      The type of record sets to enumerate. Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • callback: msRest.ServiceCallback<RecordSetListResult>

      The callback

    Returns void

  • 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: Models.RecordType

      The type of record sets to enumerate. Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • options: RecordSetsListByTypeOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<RecordSetListResult>

      The callback

    Returns void

listByTypeNext

  • listByTypeNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.RecordSetsListByTypeNextResponse>
  • listByTypeNext(nextPageLink: string, callback: msRest.ServiceCallback<RecordSetListResult>): void
  • listByTypeNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecordSetListResult>): void

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

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RecordSetsListByTypeNextResponse>

    Promise<Models.RecordSetsListByTypeNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<RecordSetListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RecordSetListResult>

      The callback

    Returns void

update

  • update(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, parameters: RecordSet, options?: Models.RecordSetsUpdateOptionalParams): Promise<Models.RecordSetsUpdateResponse>
  • update(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, parameters: RecordSet, callback: msRest.ServiceCallback<RecordSet>): void
  • update(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: Models.RecordType, parameters: RecordSet, options: RecordSetsUpdateOptionalParams, callback: msRest.ServiceCallback<RecordSet>): void

  • 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: Models.RecordType

      The type of DNS record in this record set. Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • parameters: RecordSet

      Parameters supplied to the Update operation.

    • Optional options: Models.RecordSetsUpdateOptionalParams

    Returns Promise<Models.RecordSetsUpdateResponse>

    Promise<Models.RecordSetsUpdateResponse>

  • 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: Models.RecordType

      The type of DNS record in this record set. Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • parameters: RecordSet

      Parameters supplied to the Update operation.

    • callback: msRest.ServiceCallback<RecordSet>

      The callback

    Returns void

  • 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: Models.RecordType

      The type of DNS record in this record set. Possible values include: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'

    • parameters: RecordSet

      Parameters supplied to the Update operation.

    • options: RecordSetsUpdateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<RecordSet>

      The callback

    Returns void

Generated using TypeDoc