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

Request successful. The operation returns the resulting privateDnsZoneGroup resource.

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.
properties	object	Properties of the private dns zone group.

list

Request successful. The operation returns a list of private dns zone group resources.

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.
properties	object	Properties of the private dns zone group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, privateEndpointName, privateDnsZoneGroupName, subscriptionId		Gets the private dns zone group resource by specified private dns zone group name.
list	select	privateEndpointName, resourceGroupName, subscriptionId		Gets all private dns zone groups in a private endpoint.
create_or_update	insert	resourceGroupName, privateEndpointName, privateDnsZoneGroupName, subscriptionId		Creates or updates a private dns zone group in the specified private endpoint.
delete	delete	resourceGroupName, privateEndpointName, privateDnsZoneGroupName, subscriptionId		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
privateDnsZoneGroupName	string	The name of the private dns zone group.
privateEndpointName	string	The name of the private endpoint.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

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

SELECT
id,
name,
etag,
properties
FROM azure.network.private_dns_zone_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND privateEndpointName = '{{ privateEndpointName }}' -- required
AND privateDnsZoneGroupName = '{{ privateDnsZoneGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all private dns zone groups in a private endpoint.

SELECT
id,
name,
etag,
properties
FROM azure.network.private_dns_zone_groups
WHERE privateEndpointName = '{{ privateEndpointName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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 (
data__name,
data__properties,
data__id,
resourceGroupName,
privateEndpointName,
privateDnsZoneGroupName,
subscriptionId
)
SELECT 
'{{ name }}',
'{{ properties }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ privateEndpointName }}',
'{{ privateDnsZoneGroupName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: private_dns_zone_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_dns_zone_groups resource.
    - name: privateEndpointName
      value: string
      description: Required parameter for the private_dns_zone_groups resource.
    - name: privateDnsZoneGroupName
      value: string
      description: Required parameter for the private_dns_zone_groups resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the private_dns_zone_groups resource.
    - name: name
      value: string
      description: |
        Name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: properties
      value: object
      description: |
        Properties of the private dns zone group.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified private dns zone group.

DELETE FROM azure.network.private_dns_zone_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND privateEndpointName = '{{ privateEndpointName }}' --required
AND privateDnsZoneGroupName = '{{ privateDnsZoneGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;