firewall_rules

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

Overview

Name	firewall_rules
Type	Resource
Id	azure.data_lake_store.firewall_rules

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the firewall rule.

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

list_by_account

Successfully retrieved the list of firewall rules.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The firewall 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, firewallRuleName		Gets the specified Data Lake Store firewall rule.
list_by_account	select	subscriptionId, resourceGroupName, accountName		Lists the Data Lake Store firewall rules within the specified Data Lake Store account.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, firewallRuleName, data__properties		Creates or updates the specified firewall rule. During update, the firewall rule with the specified name will be replaced with this new firewall rule.
update	update	subscriptionId, resourceGroupName, accountName, firewallRuleName		Updates the specified firewall rule.
delete	delete	subscriptionId, resourceGroupName, accountName, firewallRuleName		Deletes the specified firewall 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.
firewallRuleName	string	The name of the firewall rule to delete.
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.

SELECT examples

get

Gets the specified Data Lake Store firewall rule.

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

list_by_account

Lists the Data Lake Store firewall rules within the specified Data Lake Store account.

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

INSERT examples

create_or_update

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

INSERT INTO azure.data_lake_store.firewall_rules (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
firewallRuleName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ firewallRuleName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

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

UPDATE examples

update

Updates the specified firewall rule.

UPDATE azure.data_lake_store.firewall_rules
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND firewallRuleName = '{{ firewallRuleName }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes the specified firewall rule from the specified Data Lake Store account.

DELETE FROM azure.data_lake_store.firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND firewallRuleName = '{{ firewallRuleName }}' --required
;