dns_resolver_policy_virtual_network_links

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

Overview

Name	dns_resolver_policy_virtual_network_links
Type	Resource
Id	azure.dns_resolver.dns_resolver_policy_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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current provisioning state of the DNS resolver policy virtual network link. 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". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetwork	object	Reference to another ARM resource.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current provisioning state of the DNS resolver policy virtual network link. 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". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetwork	object	Reference to another ARM resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, dns_resolver_policy_name, dns_resolver_policy_virtual_network_link_name, subscription_id		Gets properties of a DNS resolver policy virtual network link.
list	select	resource_group_name, dns_resolver_policy_name, subscription_id	$top	Lists DNS resolver policy virtual network links.
create_or_update	insert	resource_group_name, dns_resolver_policy_name, dns_resolver_policy_virtual_network_link_name, subscription_id, location, properties		Creates or updates a DNS resolver policy virtual network link.
update	update	resource_group_name, dns_resolver_policy_name, dns_resolver_policy_virtual_network_link_name, subscription_id		Updates a DNS resolver policy virtual network link.
create_or_update	replace	resource_group_name, dns_resolver_policy_name, dns_resolver_policy_virtual_network_link_name, subscription_id, location, properties		Creates or updates a DNS resolver policy virtual network link.
delete	delete	resource_group_name, dns_resolver_policy_name, dns_resolver_policy_virtual_network_link_name, subscription_id		Deletes a DNS resolver policy virtual network link. WARNING: 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
dns_resolver_policy_name	string	The name of the DNS resolver policy. Required.
dns_resolver_policy_virtual_network_link_name	string	The name of the DNS resolver policy virtual network link for the DNS resolver policy. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of results to return. If not specified, returns up to 100 results. Default value is None.

SELECT examples

get

Gets properties of a DNS resolver policy virtual network link.

SELECT
id,
name,
etag,
location,
provisioningState,
systemData,
tags,
type,
virtualNetwork
FROM azure.dns_resolver.dns_resolver_policy_virtual_network_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dns_resolver_policy_name = '{{ dns_resolver_policy_name }}' -- required
AND dns_resolver_policy_virtual_network_link_name = '{{ dns_resolver_policy_virtual_network_link_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists DNS resolver policy virtual network links.

SELECT
id,
name,
etag,
location,
provisioningState,
systemData,
tags,
type,
virtualNetwork
FROM azure.dns_resolver.dns_resolver_policy_virtual_network_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dns_resolver_policy_name = '{{ dns_resolver_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a DNS resolver policy virtual network link.

INSERT INTO azure.dns_resolver.dns_resolver_policy_virtual_network_links (
tags,
location,
properties,
resource_group_name,
dns_resolver_policy_name,
dns_resolver_policy_virtual_network_link_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ dns_resolver_policy_name }}',
'{{ dns_resolver_policy_virtual_network_link_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: dns_resolver_policy_virtual_network_links
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dns_resolver_policy_virtual_network_links resource.
  - name: dns_resolver_policy_name
    value: "{{ dns_resolver_policy_name }}"
    description: Required parameter for the dns_resolver_policy_virtual_network_links resource.
  - name: dns_resolver_policy_virtual_network_link_name
    value: "{{ dns_resolver_policy_virtual_network_link_name }}"
    description: Required parameter for the dns_resolver_policy_virtual_network_links resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dns_resolver_policy_virtual_network_links resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of the DNS resolver policy virtual network link. Required.
    value:
      virtualNetwork:
        id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates a DNS resolver policy virtual network link.

UPDATE azure.dns_resolver.dns_resolver_policy_virtual_network_links
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dns_resolver_policy_name = '{{ dns_resolver_policy_name }}' --required
AND dns_resolver_policy_virtual_network_link_name = '{{ dns_resolver_policy_virtual_network_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a DNS resolver policy virtual network link.

REPLACE azure.dns_resolver.dns_resolver_policy_virtual_network_links
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dns_resolver_policy_name = '{{ dns_resolver_policy_name }}' --required
AND dns_resolver_policy_virtual_network_link_name = '{{ dns_resolver_policy_virtual_network_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a DNS resolver policy virtual network link. WARNING: This operation cannot be undone.

DELETE FROM azure.dns_resolver.dns_resolver_policy_virtual_network_links
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dns_resolver_policy_name = '{{ dns_resolver_policy_name }}' --required
AND dns_resolver_policy_virtual_network_link_name = '{{ dns_resolver_policy_virtual_network_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;