private_zones

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

Overview

Name	private_zones
Type	Resource
Id	azure.private_dns.private_zones

Fields

The following fields are returned by SELECT queries:

get

Success.

Name	Datatype	Description
etag	string	The ETag of the zone.
location	string	The Azure Region where the resource lives
properties	object	Properties of the Private DNS zone.
tags	object	Resource tags.

list_by_resource_group

Success.

Name	Datatype	Description
etag	string	The ETag of the zone.
location	string	The Azure Region where the resource lives
properties	object	Properties of the Private DNS zone.
tags	object	Resource tags.

list

Success.

Name	Datatype	Description
etag	string	The ETag of the zone.
location	string	The Azure Region where the resource lives
properties	object	Properties of the Private DNS zone.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, privateZoneName, subscriptionId		Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.
list_by_resource_group	select	resourceGroupName, subscriptionId	$top	Lists the Private DNS zones within a resource group.
list	select	subscriptionId	$top	Lists the Private DNS zones in all resource groups in a subscription.
create_or_update	insert	resourceGroupName, privateZoneName, subscriptionId	If-Match, If-None-Match	Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.
update	update	resourceGroupName, privateZoneName, subscriptionId	If-Match	Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.
delete	delete	resourceGroupName, privateZoneName, subscriptionId	If-Match	Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.

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).
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.
$top	integer (int32)	The maximum number of Private DNS zones to return. If not specified, returns up to 100 zones.
If-Match	string	The ETag of the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes.
If-None-Match	string	Set to '*' to allow a new Private DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored.

SELECT examples

get

Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.

SELECT
etag,
location,
properties,
tags
FROM azure.private_dns.private_zones
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND privateZoneName = '{{ privateZoneName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists the Private DNS zones within a resource group.

SELECT
etag,
location,
properties,
tags
FROM azure.private_dns.private_zones
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
;

list

Lists the Private DNS zones in all resource groups in a subscription.

SELECT
etag,
location,
properties,
tags
FROM azure.private_dns.private_zones
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.

INSERT INTO azure.private_dns.private_zones (
data__etag,
data__properties,
data__tags,
data__location,
resourceGroupName,
privateZoneName,
subscriptionId,
If-Match,
If-None-Match
)
SELECT 
'{{ etag }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ privateZoneName }}',
'{{ subscriptionId }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
etag,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: private_zones
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_zones resource.
    - name: privateZoneName
      value: string
      description: Required parameter for the private_zones resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the private_zones resource.
    - name: etag
      value: string
      description: |
        The ETag of the zone.
    - name: properties
      value: object
      description: |
        Properties of the Private DNS zone.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The Azure Region where the resource lives
    - name: If-Match
      value: string
      description: The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. 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 Private DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored.

UPDATE examples

update

Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.

UPDATE azure.private_dns.private_zones
SET 
data__etag = '{{ etag }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}',
data__location = '{{ location }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND privateZoneName = '{{ privateZoneName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
etag,
location,
properties,
tags;

DELETE examples

delete

Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.

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