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

Success.

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

list

Success.

Name	Datatype	Description
etag	string	The ETag of the virtual network link.
location	string	The Azure Region where the resource lives
properties	object	Properties of the virtual network link to 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, virtualNetworkLinkName, subscriptionId		Gets a virtual network link to the specified Private DNS zone.
list	select	resourceGroupName, privateZoneName, subscriptionId	$top	Lists the virtual network links to the specified Private DNS zone.
create_or_update	insert	resourceGroupName, privateZoneName, virtualNetworkLinkName, subscriptionId	If-Match, If-None-Match	Creates or updates a virtual network link to the specified Private DNS zone.
update	update	resourceGroupName, privateZoneName, virtualNetworkLinkName, subscriptionId	If-Match	Updates a virtual network link to the specified Private DNS zone.
delete	delete	resourceGroupName, privateZoneName, virtualNetworkLinkName, subscriptionId	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
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.
virtualNetworkLinkName	string	The name of the virtual network link.
$top	integer (int32)	The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links.
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.
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.

SELECT examples

get

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

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

list

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

SELECT
etag,
location,
properties,
tags
FROM azure.private_dns.virtual_network_links
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND privateZoneName = '{{ privateZoneName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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 (
data__etag,
data__properties,
data__tags,
data__location,
resourceGroupName,
privateZoneName,
virtualNetworkLinkName,
subscriptionId,
If-Match,
If-None-Match
)
SELECT 
'{{ etag }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ privateZoneName }}',
'{{ virtualNetworkLinkName }}',
'{{ subscriptionId }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
etag,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_links
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_network_links resource.
    - name: privateZoneName
      value: string
      description: Required parameter for the virtual_network_links resource.
    - name: virtualNetworkLinkName
      value: string
      description: Required parameter for the virtual_network_links resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the virtual_network_links resource.
    - name: etag
      value: string
      description: |
        The ETag of the virtual network link.
    - name: properties
      value: object
      description: |
        Properties of the virtual network link to 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 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.
    - name: If-None-Match
      value: string
      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.

UPDATE examples

update

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

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

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 resourceGroupName = '{{ resourceGroupName }}' --required
AND privateZoneName = '{{ privateZoneName }}' --required
AND virtualNetworkLinkName = '{{ virtualNetworkLinkName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND If-Match = '{{ If-Match }}'
;