virtual_network_rules

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

Overview

Name	virtual_network_rules
Type	Resource
Id	azure.datalake_store.virtual_network_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
subnetId	string	The resource identifier for the subnet.
type	string	The resource type.

list_by_account

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
subnetId	string	The resource identifier for the subnet.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, virtual_network_rule_name, subscription_id		Gets the specified Data Lake Store virtual network rule.
list_by_account	select	resource_group_name, account_name, subscription_id		Lists the Data Lake Store virtual network rules within the specified Data Lake Store account.
create_or_update	insert	resource_group_name, account_name, virtual_network_rule_name, subscription_id, properties		Creates or updates the specified virtual network rule. During update, the virtual network rule with the specified name will be replaced with this new virtual network rule.
update	update	resource_group_name, account_name, virtual_network_rule_name, subscription_id		Updates the specified virtual network rule.
create_or_update	replace	resource_group_name, account_name, virtual_network_rule_name, subscription_id, properties		Creates or updates the specified virtual network rule. During update, the virtual network rule with the specified name will be replaced with this new virtual network rule.
delete	delete	resource_group_name, account_name, virtual_network_rule_name, subscription_id		Deletes the specified virtual network rule from the specified Data Lake Store account.

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
account_name	string	The name of the Data Lake Store account. Required.
resource_group_name	string	The name of the Azure resource group. Required.
subscription_id	string
virtual_network_rule_name	string	The name of the virtual network rule to delete. Required.

SELECT examples

get

Gets the specified Data Lake Store virtual network rule.

SELECT
id,
name,
subnetId,
type
FROM azure.datalake_store.virtual_network_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND virtual_network_rule_name = '{{ virtual_network_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_account

Lists the Data Lake Store virtual network rules within the specified Data Lake Store account.

SELECT
id,
name,
subnetId,
type
FROM azure.datalake_store.virtual_network_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified virtual network rule. During update, the virtual network rule with the specified name will be replaced with this new virtual network rule.

INSERT INTO azure.datalake_store.virtual_network_rules (
properties,
resource_group_name,
account_name,
virtual_network_rule_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ virtual_network_rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_network_rules resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the virtual_network_rules resource.
  - name: virtual_network_rule_name
    value: "{{ virtual_network_rule_name }}"
    description: Required parameter for the virtual_network_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_network_rules resource.
  - name: properties
    value:
      subnetId: "{{ subnetId }}"

UPDATE examples

update

Updates the specified virtual network rule.

UPDATE azure.datalake_store.virtual_network_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND virtual_network_rule_name = '{{ virtual_network_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

REPLACE examples

create_or_update

Creates or updates the specified virtual network rule. During update, the virtual network rule with the specified name will be replaced with this new virtual network rule.

REPLACE azure.datalake_store.virtual_network_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND virtual_network_rule_name = '{{ virtual_network_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes the specified virtual network rule from the specified Data Lake Store account.

DELETE FROM azure.datalake_store.virtual_network_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND virtual_network_rule_name = '{{ virtual_network_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;