virtual_network_links

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

Overview

Name	virtual_network_links
Type	Resource
Id	azure.dns_resolver.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.").
metadata	object	Metadata attached to the virtual network link.
provisioningState	string	The current provisioning state of the 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.
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.").
metadata	object	Metadata attached to the virtual network link.
provisioningState	string	The current provisioning state of the 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.
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_forwarding_ruleset_name, virtual_network_link_name, subscription_id		Gets properties of a virtual network link to a DNS forwarding ruleset.
list	select	resource_group_name, dns_forwarding_ruleset_name, subscription_id	$top	Lists virtual network links to a DNS forwarding ruleset.
create_or_update	insert	resource_group_name, dns_forwarding_ruleset_name, virtual_network_link_name, subscription_id, properties		Creates or updates a virtual network link to a DNS forwarding ruleset.
update	update	resource_group_name, dns_forwarding_ruleset_name, virtual_network_link_name, subscription_id		Updates a virtual network link to a DNS forwarding ruleset.
create_or_update	replace	resource_group_name, dns_forwarding_ruleset_name, virtual_network_link_name, subscription_id, properties		Creates or updates a virtual network link to a DNS forwarding ruleset.
delete	delete	resource_group_name, dns_forwarding_ruleset_name, virtual_network_link_name, subscription_id		Deletes a virtual network link to a DNS forwarding ruleset. 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_forwarding_ruleset_name	string	The name of the DNS forwarding ruleset. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_network_link_name	string	The name of the virtual network link. Required.
$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 virtual network link to a DNS forwarding ruleset.

SELECT
id,
name,
etag,
metadata,
provisioningState,
systemData,
type,
virtualNetwork
FROM azure.dns_resolver.virtual_network_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_name }}' -- required
AND virtual_network_link_name = '{{ virtual_network_link_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists virtual network links to a DNS forwarding ruleset.

SELECT
id,
name,
etag,
metadata,
provisioningState,
systemData,
type,
virtualNetwork
FROM azure.dns_resolver.virtual_network_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a virtual network link to a DNS forwarding ruleset.

INSERT INTO azure.dns_resolver.virtual_network_links (
properties,
resource_group_name,
dns_forwarding_ruleset_name,
virtual_network_link_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ dns_forwarding_ruleset_name }}',
'{{ virtual_network_link_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
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: dns_forwarding_ruleset_name
    value: "{{ dns_forwarding_ruleset_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: properties
    description: |
      Properties of the virtual network link. Required.
    value:
      virtualNetwork:
        id: "{{ id }}"
      metadata: "{{ metadata }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates a virtual network link to a DNS forwarding ruleset.

UPDATE azure.dns_resolver.virtual_network_links
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_name }}' --required
AND virtual_network_link_name = '{{ virtual_network_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a virtual network link to a DNS forwarding ruleset.

REPLACE azure.dns_resolver.virtual_network_links
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_name }}' --required
AND virtual_network_link_name = '{{ virtual_network_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a virtual network link to a DNS forwarding ruleset. WARNING: This operation cannot be undone.

DELETE FROM azure.dns_resolver.virtual_network_links
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_name }}' --required
AND virtual_network_link_name = '{{ virtual_network_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;