private_dns_zone_groups

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

Overview

Name	private_dns_zone_groups
Type	Resource
Id	azure.network.private_dns_zone_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
privateDnsZoneConfigs	array	A collection of private dns zone configurations of the private dns zone group.
provisioningState	string	The provisioning state of the private dns zone group resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
privateDnsZoneConfigs	array	A collection of private dns zone configurations of the private dns zone group.
provisioningState	string	The provisioning state of the private dns zone group resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_endpoint_name, private_dns_zone_group_name, subscription_id		Gets the private dns zone group resource by specified private dns zone group name.
list	select	private_endpoint_name, resource_group_name, subscription_id		Gets all private dns zone groups in a private endpoint.
create_or_update	insert	resource_group_name, private_endpoint_name, private_dns_zone_group_name, subscription_id		Creates or updates a private dns zone group in the specified private endpoint.
create_or_update	replace	resource_group_name, private_endpoint_name, private_dns_zone_group_name, subscription_id		Creates or updates a private dns zone group in the specified private endpoint.
delete	delete	resource_group_name, private_endpoint_name, private_dns_zone_group_name, subscription_id		Deletes the specified private dns zone group.

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
private_dns_zone_group_name	string	The name of the private endpoint. Required.
private_endpoint_name	string	The name of the private endpoint. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the private dns zone group resource by specified private dns zone group name.

SELECT
id,
name,
etag,
privateDnsZoneConfigs,
provisioningState
FROM azure.network.private_dns_zone_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_endpoint_name = '{{ private_endpoint_name }}' -- required
AND private_dns_zone_group_name = '{{ private_dns_zone_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all private dns zone groups in a private endpoint.

SELECT
id,
name,
etag,
privateDnsZoneConfigs,
provisioningState
FROM azure.network.private_dns_zone_groups
WHERE private_endpoint_name = '{{ private_endpoint_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a private dns zone group in the specified private endpoint.

INSERT INTO azure.network.private_dns_zone_groups (
id,
name,
properties,
resource_group_name,
private_endpoint_name,
private_dns_zone_group_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_endpoint_name }}',
'{{ private_dns_zone_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: private_dns_zone_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_dns_zone_groups resource.
  - name: private_endpoint_name
    value: "{{ private_endpoint_name }}"
    description: Required parameter for the private_dns_zone_groups resource.
  - name: private_dns_zone_group_name
    value: "{{ private_dns_zone_group_name }}"
    description: Required parameter for the private_dns_zone_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_dns_zone_groups resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource that is unique within a resource group. This name can be used to access the resource.
  - name: properties
    description: |
      Properties of the private dns zone group.
    value:
      provisioningState: "{{ provisioningState }}"
      privateDnsZoneConfigs:
        - name: "{{ name }}"
          properties:
            privateDnsZoneId: "{{ privateDnsZoneId }}"
            recordSets:
              - recordType: "{{ recordType }}"
                recordSetName: "{{ recordSetName }}"
                fqdn: "{{ fqdn }}"
                provisioningState: "{{ provisioningState }}"
                ttl: {{ ttl }}
                ipAddresses: "{{ ipAddresses }}"

REPLACE examples

create_or_update

Creates or updates a private dns zone group in the specified private endpoint.

REPLACE azure.network.private_dns_zone_groups
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_endpoint_name = '{{ private_endpoint_name }}' --required
AND private_dns_zone_group_name = '{{ private_dns_zone_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties;

DELETE examples

delete

Deletes the specified private dns zone group.

DELETE FROM azure.network.private_dns_zone_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_endpoint_name = '{{ private_endpoint_name }}' --required
AND private_dns_zone_group_name = '{{ private_dns_zone_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;