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

vw_virtual_network_links

Name	Datatype	Description
etag	text	The ETag of the virtual network link.
location	text	The Azure Region where the resource lives
privateZoneName	text	field from the properties object
provisioning_state	text	field from the properties object
registration_enabled	text	field from the properties object
resolution_policy	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
virtualNetworkLinkName	text	field from the properties object
virtual_network	text	field from the properties object
virtual_network_link_state	text	field from the properties object

virtual_network_links

Name	Datatype	Description
etag	string	The ETag of the virtual network link.
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, virtualNetworkLinkName	Gets a virtual network link to the specified Private DNS zone.
list	SELECT	privateZoneName, resourceGroupName, subscriptionId	Lists the virtual network links to the specified Private DNS zone.
create_or_update	INSERT	privateZoneName, resourceGroupName, subscriptionId, virtualNetworkLinkName	Creates or updates a virtual network link to the specified Private DNS zone.
delete	DELETE	privateZoneName, resourceGroupName, subscriptionId, virtualNetworkLinkName	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.
update	UPDATE	privateZoneName, resourceGroupName, subscriptionId, virtualNetworkLinkName	Updates a virtual network link to the specified Private DNS zone.

SELECT examples

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

vw_virtual_network_links

SELECT
etag,
location,
privateZoneName,
provisioning_state,
registration_enabled,
resolution_policy,
resourceGroupName,
subscriptionId,
tags,
virtualNetworkLinkName,
virtual_network,
virtual_network_link_state
FROM azure.private_dns.vw_virtual_network_links
WHERE privateZoneName = '{{ privateZoneName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

virtual_network_links

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: etag
      value: string
    - name: properties
      value:
        - name: virtualNetwork
          value:
            - name: id
              value: string
        - name: registrationEnabled
          value: boolean
        - name: resolutionPolicy
          value: string
        - name: virtualNetworkLinkState
          value: string
        - name: provisioningState
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a virtual_network_links resource.

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

DELETE example

Deletes the specified virtual_network_links resource.

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