record_sets

Creates, updates, deletes, gets or lists a record_sets resource.

Overview

Name	record_sets
Type	Resource
Id	azure.private_dns.record_sets

Fields

The following fields are returned by SELECT queries:

get

Success.

Name	Datatype	Description
id	string	The ID of the record set.
name	string	The name of the record set.
etag	string	The ETag of the record set.
properties	object	The properties of the record set.
type	string	The type of the record set.

list_by_type

Success.

Name	Datatype	Description
id	string	The ID of the record set.
name	string	The name of the record set.
etag	string	The ETag of the record set.
properties	object	The properties of the record set.
type	string	The type of the record set.

list

Success.

Name	Datatype	Description
id	string	The ID of the record set.
name	string	The name of the record set.
etag	string	The ETag of the record set.
properties	object	The properties of the record set.
type	string	The type of the record set.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, privateZoneName, recordType, relativeRecordSetName, subscriptionId		Gets a record set.
list_by_type	select	resourceGroupName, privateZoneName, recordType, subscriptionId	$top, $recordsetnamesuffix	Lists the record sets of a specified type in a Private DNS zone.
list	select	resourceGroupName, privateZoneName, subscriptionId	$top, $recordsetnamesuffix	Lists all record sets in a Private DNS zone.
create_or_update	insert	resourceGroupName, privateZoneName, recordType, relativeRecordSetName, subscriptionId	If-Match, If-None-Match	Creates or updates a record set within a Private DNS zone.
update	update	resourceGroupName, privateZoneName, recordType, relativeRecordSetName, subscriptionId	If-Match	Updates a record set within a Private DNS zone.
delete	delete	resourceGroupName, privateZoneName, recordType, relativeRecordSetName, subscriptionId	If-Match	Deletes a record set from a Private DNS zone. This operation cannot be undone.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
privateZoneName	string	The name of the Private DNS zone (without a terminating dot).
recordType	string	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.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$recordsetnamesuffix	string	The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with ".<recordsetnamesuffix>".
$top	integer (int32)	The maximum number of record sets to return. If not specified, returns up to 100 record sets.
If-Match	string	The ETag of the record set. Omit this value to always delete the current record set. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes.
If-None-Match	string	Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored.

SELECT examples

get

Gets a record set.

SELECT
id,
name,
etag,
properties,
type
FROM azure.private_dns.record_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND privateZoneName = '{{ privateZoneName }}' -- required
AND recordType = '{{ recordType }}' -- required
AND relativeRecordSetName = '{{ relativeRecordSetName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_type

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

SELECT
id,
name,
etag,
properties,
type
FROM azure.private_dns.record_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND privateZoneName = '{{ privateZoneName }}' -- required
AND recordType = '{{ recordType }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
AND $recordsetnamesuffix = '{{ $recordsetnamesuffix }}'
;

list

Lists all record sets in a Private DNS zone.

SELECT
id,
name,
etag,
properties,
type
FROM azure.private_dns.record_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND privateZoneName = '{{ privateZoneName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
AND $recordsetnamesuffix = '{{ $recordsetnamesuffix }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.private_dns.record_sets (
data__etag,
data__properties,
resourceGroupName,
privateZoneName,
recordType,
relativeRecordSetName,
subscriptionId,
If-Match,
If-None-Match
)
SELECT 
'{{ etag }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ privateZoneName }}',
'{{ recordType }}',
'{{ relativeRecordSetName }}',
'{{ subscriptionId }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: record_sets
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the record_sets resource.
    - name: privateZoneName
      value: string
      description: Required parameter for the record_sets resource.
    - name: recordType
      value: string
      description: Required parameter for the record_sets resource.
    - name: relativeRecordSetName
      value: string
      description: Required parameter for the record_sets resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the record_sets resource.
    - name: etag
      value: string
      description: |
        The ETag of the record set.
    - name: properties
      value: object
      description: |
        The properties of the record set.
    - name: If-Match
      value: string
      description: The ETag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored.

UPDATE examples

update

Updates a record set within a Private DNS zone.

UPDATE azure.private_dns.record_sets
SET 
data__etag = '{{ etag }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND privateZoneName = '{{ privateZoneName }}' --required
AND recordType = '{{ recordType }}' --required
AND relativeRecordSetName = '{{ relativeRecordSetName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

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

DELETE FROM azure.private_dns.record_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND privateZoneName = '{{ privateZoneName }}' --required
AND recordType = '{{ recordType }}' --required
AND relativeRecordSetName = '{{ relativeRecordSetName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND If-Match = '{{ If-Match }}'
;