local_rules

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

Overview

Name	local_rules
Type	Resource
Id	azure_isv.paloaltonetworksngfw.local_rules

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.
actionType	string	rule action. Known values are: "Allow", "DenySilent", "DenyResetServer", and "DenyResetBoth".
applications	array	array of rule applications.
auditComment	string	rule comment.
category	object	rule category.
decryptionRuleType	string	enable or disable decryption. Known values are: "SSLOutboundInspection", "SSLInboundInspection", and "None".
description	string	rule description.
destination	object	destination address.
enableLogging	string	enable or disable logging. Known values are: "DISABLED" and "ENABLED".
etag	string	etag info.
inboundInspectionCertificate	string	inbound Inspection Certificate.
negateDestination	string	cidr should not be 'any'. Known values are: "TRUE" and "FALSE".
negateSource	string	cidr should not be 'any'. Known values are: "TRUE" and "FALSE".
priority	integer	:vartype priority: int
protocol	string	any, application-default, TCP:number, UDP:number.
protocolPortList	array	prot port list.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
ruleName	string	rule name. Required.
ruleState	string	state of this rule. Known values are: "DISABLED" and "ENABLED".
source	object	source address.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	array	tag for rule.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_local_rulestacks

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.
actionType	string	rule action. Known values are: "Allow", "DenySilent", "DenyResetServer", and "DenyResetBoth".
applications	array	array of rule applications.
auditComment	string	rule comment.
category	object	rule category.
decryptionRuleType	string	enable or disable decryption. Known values are: "SSLOutboundInspection", "SSLInboundInspection", and "None".
description	string	rule description.
destination	object	destination address.
enableLogging	string	enable or disable logging. Known values are: "DISABLED" and "ENABLED".
etag	string	etag info.
inboundInspectionCertificate	string	inbound Inspection Certificate.
negateDestination	string	cidr should not be 'any'. Known values are: "TRUE" and "FALSE".
negateSource	string	cidr should not be 'any'. Known values are: "TRUE" and "FALSE".
priority	integer	:vartype priority: int
protocol	string	any, application-default, TCP:number, UDP:number.
protocolPortList	array	prot port list.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
ruleName	string	rule name. Required.
ruleState	string	state of this rule. Known values are: "DISABLED" and "ENABLED".
source	object	source address.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	array	tag for rule.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, local_rulestack_name, priority, subscription_id		Get a LocalRulesResource.
list_by_local_rulestacks	select	resource_group_name, local_rulestack_name, subscription_id		List LocalRulesResource resources by LocalRulestacks.
create_or_update	insert	resource_group_name, local_rulestack_name, priority, subscription_id, properties		Create a LocalRulesResource.
create_or_update	replace	resource_group_name, local_rulestack_name, priority, subscription_id, properties		Create a LocalRulesResource.
delete	delete	resource_group_name, local_rulestack_name, priority, subscription_id		Delete a LocalRulesResource.
get_counters	exec	resource_group_name, local_rulestack_name, priority, subscription_id	firewallName	Get counters.
refresh_counters	exec	resource_group_name, local_rulestack_name, priority, subscription_id	firewallName	Refresh counters.
reset_counters	exec	resource_group_name, local_rulestack_name, priority, subscription_id	firewallName	Reset counters.

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
local_rulestack_name	string	LocalRulestack resource name. Required.
priority	string	Local Rule priority. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
firewallName	string	Default value is None.

SELECT examples

get

Get a LocalRulesResource.

SELECT
id,
name,
actionType,
applications,
auditComment,
category,
decryptionRuleType,
description,
destination,
enableLogging,
etag,
inboundInspectionCertificate,
negateDestination,
negateSource,
priority,
protocol,
protocolPortList,
provisioningState,
ruleName,
ruleState,
source,
systemData,
tags,
type
FROM azure_isv.paloaltonetworksngfw.local_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND local_rulestack_name = '{{ local_rulestack_name }}' -- required
AND priority = '{{ priority }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_local_rulestacks

List LocalRulesResource resources by LocalRulestacks.

SELECT
id,
name,
actionType,
applications,
auditComment,
category,
decryptionRuleType,
description,
destination,
enableLogging,
etag,
inboundInspectionCertificate,
negateDestination,
negateSource,
priority,
protocol,
protocolPortList,
provisioningState,
ruleName,
ruleState,
source,
systemData,
tags,
type
FROM azure_isv.paloaltonetworksngfw.local_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND local_rulestack_name = '{{ local_rulestack_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a LocalRulesResource.

INSERT INTO azure_isv.paloaltonetworksngfw.local_rules (
properties,
resource_group_name,
local_rulestack_name,
priority,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ local_rulestack_name }}',
'{{ priority }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: local_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the local_rules resource.
  - name: local_rulestack_name
    value: "{{ local_rulestack_name }}"
    description: Required parameter for the local_rules resource.
  - name: priority
    value: "{{ priority }}"
    description: Required parameter for the local_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the local_rules resource.
  - name: properties
    value:
      etag: "{{ etag }}"
      ruleName: "{{ ruleName }}"
      description: "{{ description }}"
      ruleState: "{{ ruleState }}"
      source:
        cidrs:
          - "{{ cidrs }}"
        countries:
          - "{{ countries }}"
        feeds:
          - "{{ feeds }}"
        prefixLists:
          - "{{ prefixLists }}"
      negateSource: "{{ negateSource }}"
      destination:
        cidrs:
          - "{{ cidrs }}"
        countries:
          - "{{ countries }}"
        feeds:
          - "{{ feeds }}"
        prefixLists:
          - "{{ prefixLists }}"
        fqdnLists:
          - "{{ fqdnLists }}"
      negateDestination: "{{ negateDestination }}"
      applications:
        - "{{ applications }}"
      category:
        urlCustom:
          - "{{ urlCustom }}"
        feeds:
          - "{{ feeds }}"
      protocol: "{{ protocol }}"
      protocolPortList:
        - "{{ protocolPortList }}"
      inboundInspectionCertificate: "{{ inboundInspectionCertificate }}"
      auditComment: "{{ auditComment }}"
      actionType: "{{ actionType }}"
      enableLogging: "{{ enableLogging }}"
      decryptionRuleType: "{{ decryptionRuleType }}"
      tags:
        - key: "{{ key }}"
          value: "{{ value }}"

REPLACE examples

create_or_update

Create a LocalRulesResource.

REPLACE azure_isv.paloaltonetworksngfw.local_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND local_rulestack_name = '{{ local_rulestack_name }}' --required
AND priority = '{{ priority }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a LocalRulesResource.

DELETE FROM azure_isv.paloaltonetworksngfw.local_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND local_rulestack_name = '{{ local_rulestack_name }}' --required
AND priority = '{{ priority }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_counters

Get counters.

EXEC azure_isv.paloaltonetworksngfw.local_rules.get_counters 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@priority='{{ priority }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@firewallName='{{ firewallName }}'
;

refresh_counters

Refresh counters.

EXEC azure_isv.paloaltonetworksngfw.local_rules.refresh_counters 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@priority='{{ priority }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@firewallName='{{ firewallName }}'
;

reset_counters

Reset counters.

EXEC azure_isv.paloaltonetworksngfw.local_rules.reset_counters 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@priority='{{ priority }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@firewallName='{{ firewallName }}'
;