virtual_network_links

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

Overview

Name	virtual_network_links
Type	Resource
Id	azure.private_dns.virtual_network_links

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'. # pylint: disable=line-too-long
name	string	The name of the resource.
etag	string	The ETag of the virtual network link.
location	string	The Azure Region where the resource lives.
provisioningState	string	The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled".
registrationEnabled	boolean	Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?.
resolutionPolicy	string	The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response. Known values are: "Default" and "NxDomainRedirect".
tags	object	Resource tags.
type	string	The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
virtualNetwork	object	The reference of the virtual network.
virtualNetworkLinkState	string	The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored. Known values are: "InProgress" and "Completed".

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'. # pylint: disable=line-too-long
name	string	The name of the resource.
etag	string	The ETag of the virtual network link.
location	string	The Azure Region where the resource lives.
provisioningState	string	The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled".
registrationEnabled	boolean	Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?.
resolutionPolicy	string	The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response. Known values are: "Default" and "NxDomainRedirect".
tags	object	Resource tags.
type	string	The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
virtualNetwork	object	The reference of the virtual network.
virtualNetworkLinkState	string	The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored. Known values are: "InProgress" and "Completed".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_zone_name, virtual_network_link_name, subscription_id		Gets a virtual network link to the specified Private DNS zone.
list	select	resource_group_name, private_zone_name, subscription_id	$top	Lists the virtual network links to the specified Private DNS zone.
create_or_update	insert	resource_group_name, private_zone_name, virtual_network_link_name, subscription_id	If-Match, If-None-Match	Creates or updates a virtual network link to the specified Private DNS zone.
update	update	resource_group_name, private_zone_name, virtual_network_link_name, subscription_id	If-Match	Updates a virtual network link to the specified Private DNS zone.
create_or_update	replace	resource_group_name, private_zone_name, virtual_network_link_name, subscription_id	If-Match, If-None-Match	Creates or updates a virtual network link to the specified Private DNS zone.
delete	delete	resource_group_name, private_zone_name, virtual_network_link_name, subscription_id	If-Match	Deletes a virtual network link to the specified Private DNS zone. WARNING: In case of a registration virtual network, all auto-registered DNS records in the zone for the virtual network will also be deleted. 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
private_zone_name	string	The name of the Private DNS zone (without a terminating dot). Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
virtual_network_link_name	string	The name of the virtual network link. Required.
$top	integer	The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links. Default value is None.
If-Match	string	The ETag of the virtual network link to 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. Default value is None.
If-None-Match	string	Set to '*' to allow a new virtual network link to the Private DNS zone to be created, but to prevent updating an existing link. Other values will be ignored. Default value is None.

SELECT examples

get

Gets a virtual network link to the specified Private DNS zone.

SELECT
id,
name,
etag,
location,
provisioningState,
registrationEnabled,
resolutionPolicy,
tags,
type,
virtualNetwork,
virtualNetworkLinkState
FROM azure.private_dns.virtual_network_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_zone_name = '{{ private_zone_name }}' -- required
AND virtual_network_link_name = '{{ virtual_network_link_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the virtual network links to the specified Private DNS zone.

SELECT
id,
name,
etag,
location,
provisioningState,
registrationEnabled,
resolutionPolicy,
tags,
type,
virtualNetwork,
virtualNetworkLinkState
FROM azure.private_dns.virtual_network_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_zone_name = '{{ private_zone_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a virtual network link to the specified Private DNS zone.

INSERT INTO azure.private_dns.virtual_network_links (
tags,
location,
etag,
properties,
resource_group_name,
private_zone_name,
virtual_network_link_name,
subscription_id,
If-Match,
If-None-Match
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ etag }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_zone_name }}',
'{{ virtual_network_link_name }}',
'{{ subscription_id }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_links
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_network_links resource.
  - name: private_zone_name
    value: "{{ private_zone_name }}"
    description: Required parameter for the virtual_network_links resource.
  - name: virtual_network_link_name
    value: "{{ virtual_network_link_name }}"
    description: Required parameter for the virtual_network_links resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_network_links resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The Azure Region where the resource lives.
  - name: etag
    value: "{{ etag }}"
    description: |
      The ETag of the virtual network link.
  - name: properties
    value:
      virtualNetwork:
        id: "{{ id }}"
      registrationEnabled: {{ registrationEnabled }}
      resolutionPolicy: "{{ resolutionPolicy }}"
  - name: If-Match
    value: "{{ If-Match }}"
    description: The ETag of the virtual network link to the Private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. Default value is None.
    description: The ETag of the virtual network link to the Private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. Default value is None.
  - name: If-None-Match
    value: "{{ If-None-Match }}"
    description: Set to '*' to allow a new virtual network link to the Private DNS zone to be created, but to prevent updating an existing link. Other values will be ignored. Default value is None.
    description: Set to '*' to allow a new virtual network link to the Private DNS zone to be created, but to prevent updating an existing link. Other values will be ignored. Default value is None.

UPDATE examples

update

Updates a virtual network link to the specified Private DNS zone.

UPDATE azure.private_dns.virtual_network_links
SET 
tags = '{{ tags }}',
location = '{{ location }}',
etag = '{{ etag }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_zone_name = '{{ private_zone_name }}' --required
AND virtual_network_link_name = '{{ virtual_network_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a virtual network link to the specified Private DNS zone.

REPLACE azure.private_dns.virtual_network_links
SET 
tags = '{{ tags }}',
location = '{{ location }}',
etag = '{{ etag }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_zone_name = '{{ private_zone_name }}' --required
AND virtual_network_link_name = '{{ virtual_network_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match}}'
AND If-None-Match = '{{ If-None-Match}}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a virtual network link to the specified Private DNS zone. WARNING: In case of a registration virtual network, all auto-registered DNS records in the zone for the virtual network will also be deleted. This operation cannot be undone.

DELETE FROM azure.private_dns.virtual_network_links
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_zone_name = '{{ private_zone_name }}' --required
AND virtual_network_link_name = '{{ virtual_network_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match }}'
;