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

vw_private_zones

Name	Datatype	Description
etag	text	The ETag of the zone.
internal_id	text	field from the properties object
location	text	The Azure Region where the resource lives
max_number_of_record_sets	text	field from the properties object
max_number_of_virtual_network_links	text	field from the properties object
max_number_of_virtual_network_links_with_registration	text	field from the properties object
number_of_record_sets	text	field from the properties object
number_of_virtual_network_links	text	field from the properties object
number_of_virtual_network_links_with_registration	text	field from the properties object
privateZoneName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

private_zones

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	privateZoneName, resourceGroupName, subscriptionId	Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.
list	SELECT	subscriptionId	Lists the Private DNS zones in all resource groups in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists the Private DNS zones within a resource group.
create_or_update	INSERT	privateZoneName, resourceGroupName, subscriptionId	Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.
delete	DELETE	privateZoneName, resourceGroupName, subscriptionId	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.
update	UPDATE	privateZoneName, resourceGroupName, subscriptionId	Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.

SELECT examples

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

vw_private_zones

SELECT
etag,
internal_id,
location,
max_number_of_record_sets,
max_number_of_virtual_network_links,
max_number_of_virtual_network_links_with_registration,
number_of_record_sets,
number_of_virtual_network_links,
number_of_virtual_network_links_with_registration,
privateZoneName,
provisioning_state,
resourceGroupName,
subscriptionId,
tags
FROM azure.private_dns.vw_private_zones
WHERE subscriptionId = '{{ subscriptionId }}';

private_zones

SELECT
etag,
location,
properties,
tags
FROM azure.private_dns.private_zones
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new private_zones resource.

All Properties

/*+ create */
INSERT INTO azure.private_dns.private_zones (
privateZoneName,
resourceGroupName,
subscriptionId,
etag,
properties,
tags,
location
)
SELECT 
'{{ privateZoneName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ etag }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: etag
      value: string
    - name: properties
      value:
        - name: maxNumberOfRecordSets
          value: integer
        - name: numberOfRecordSets
          value: integer
        - name: maxNumberOfVirtualNetworkLinks
          value: integer
        - name: numberOfVirtualNetworkLinks
          value: integer
        - name: maxNumberOfVirtualNetworkLinksWithRegistration
          value: integer
        - name: numberOfVirtualNetworkLinksWithRegistration
          value: integer
        - name: provisioningState
          value: string
        - name: internalId
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a private_zones resource.

/*+ update */
UPDATE azure.private_dns.private_zones
SET 
etag = '{{ etag }}',
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}'
WHERE 
privateZoneName = '{{ privateZoneName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified private_zones resource.

/*+ delete */
DELETE FROM azure.private_dns.private_zones
WHERE privateZoneName = '{{ privateZoneName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';