virtual_network_rules

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

Overview

Name	virtual_network_rules
Type	Resource
Id	azure.data_lake_store.virtual_network_rules

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the virtual network rule.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The virtual network rule properties.
type	string	The resource type.

list_by_account

Successfully retrieved the list of virtual network rules.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The virtual network rule properties.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, virtualNetworkRuleName		Gets the specified Data Lake Store virtual network rule.
list_by_account	select	subscriptionId, resourceGroupName, accountName		Lists the Data Lake Store virtual network rules within the specified Data Lake Store account.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, virtualNetworkRuleName, data__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	subscriptionId, resourceGroupName, accountName, virtualNetworkRuleName		Updates the specified virtual network rule.
delete	delete	subscriptionId, resourceGroupName, accountName, virtualNetworkRuleName		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
accountName	string	The name of the Data Lake Store account.
resourceGroupName	string	The name of the Azure 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.
virtualNetworkRuleName	string	The name of the virtual network rule to delete.

SELECT examples

get

Gets the specified Data Lake Store virtual network rule.

SELECT
id,
name,
properties,
type
FROM azure.data_lake_store.virtual_network_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND virtualNetworkRuleName = '{{ virtualNetworkRuleName }}' -- required
;

list_by_account

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

SELECT
id,
name,
properties,
type
FROM azure.data_lake_store.virtual_network_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- 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.data_lake_store.virtual_network_rules (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
virtualNetworkRuleName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ virtualNetworkRuleName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_rules
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the virtual_network_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_network_rules resource.
    - name: accountName
      value: string
      description: Required parameter for the virtual_network_rules resource.
    - name: virtualNetworkRuleName
      value: string
      description: Required parameter for the virtual_network_rules resource.
    - name: properties
      value: object
      description: |
        The virtual network rule properties to use when creating a new virtual network rule.

UPDATE examples

update

Updates the specified virtual network rule.

UPDATE azure.data_lake_store.virtual_network_rules
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND virtualNetworkRuleName = '{{ virtualNetworkRuleName }}' --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.data_lake_store.virtual_network_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND virtualNetworkRuleName = '{{ virtualNetworkRuleName }}' --required
;