local_rulestacks

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

Overview

Name	local_rulestacks
Type	Resource
Id	azure_isv.paloaltonetworksngfw.local_rulestacks

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.
associatedSubscriptions	array	subscription scope of global rulestack.
defaultMode	string	Mode for default rules creation. Known values are: "IPS", "FIREWALL", and "NONE".
description	string	rulestack description.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
minAppIdVersion	string	minimum version.
panEtag	string	PanEtag info.
panLocation	string	Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
scope	string	Rulestack Type. Known values are: "LOCAL", "GLOBAL", and "GLOBAL".
securityServices	object	Security Profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
associatedSubscriptions	array	subscription scope of global rulestack.
defaultMode	string	Mode for default rules creation. Known values are: "IPS", "FIREWALL", and "NONE".
description	string	rulestack description.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
minAppIdVersion	string	minimum version.
panEtag	string	PanEtag info.
panLocation	string	Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
scope	string	Rulestack Type. Known values are: "LOCAL", "GLOBAL", and "GLOBAL".
securityServices	object	Security Profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
associatedSubscriptions	array	subscription scope of global rulestack.
defaultMode	string	Mode for default rules creation. Known values are: "IPS", "FIREWALL", and "NONE".
description	string	rulestack description.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
minAppIdVersion	string	minimum version.
panEtag	string	PanEtag info.
panLocation	string	Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
scope	string	Rulestack Type. Known values are: "LOCAL", "GLOBAL", and "GLOBAL".
securityServices	object	Security Profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, subscription_id		Get a LocalRulestackResource.
list_by_resource_group	select	resource_group_name, subscription_id		List LocalRulestackResource resources by resource group.
list_by_subscription	select	subscription_id		List LocalRulestackResource resources by subscription ID.
create_or_update	insert	resource_group_name, local_rulestack_name, subscription_id, location		Create a LocalRulestackResource.
update	update	resource_group_name, local_rulestack_name, subscription_id		Update a LocalRulestackResource.
create_or_update	replace	resource_group_name, local_rulestack_name, subscription_id, location		Create a LocalRulestackResource.
delete	delete	resource_group_name, local_rulestack_name, subscription_id		Delete a LocalRulestackResource.
list_advanced_security_objects	exec	resource_group_name, local_rulestack_name, subscription_id, type	skip, top	Get the list of advanced security objects.
list_app_ids	exec	resource_group_name, local_rulestack_name, subscription_id	appIdVersion, appPrefix, skip, top	List of AppIds for LocalRulestack ApiVersion.
list_countries	exec	resource_group_name, local_rulestack_name, subscription_id	skip, top	List of countries for Rulestack.
list_firewalls	exec	resource_group_name, local_rulestack_name, subscription_id		List of Firewalls associated with Rulestack.
list_predefined_url_categories	exec	resource_group_name, local_rulestack_name, subscription_id	skip, top	List predefined URL categories for rulestack.
list_security_services	exec	resource_group_name, local_rulestack_name, subscription_id, type	skip, top	List the security services for rulestack.
get_change_log	exec	resource_group_name, local_rulestack_name, subscription_id		Get changelog.
get_support_info	exec	resource_group_name, local_rulestack_name, subscription_id	email	support info for rulestack.
commit	exec	resource_group_name, local_rulestack_name, subscription_id		Commit rulestack configuration.
revert	exec	resource_group_name, local_rulestack_name, subscription_id		Revert rulestack configuration.

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.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
type	string	Known values are: "antiSpyware", "antiVirus", "ipsVulnerability", "urlFiltering", "fileBlocking", and "dnsSubscription". Required.
appIdVersion	string	Default value is None.
appPrefix	string	Default value is None.
email	string	email address on behalf of which this API called. Default value is None.
skip	string	Default value is None.
top	integer	Default value is None.

SELECT examples

get

Get a LocalRulestackResource.

SELECT
id,
name,
associatedSubscriptions,
defaultMode,
description,
identity,
location,
minAppIdVersion,
panEtag,
panLocation,
provisioningState,
scope,
securityServices,
systemData,
tags,
type
FROM azure_isv.paloaltonetworksngfw.local_rulestacks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND local_rulestack_name = '{{ local_rulestack_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List LocalRulestackResource resources by resource group.

SELECT
id,
name,
associatedSubscriptions,
defaultMode,
description,
identity,
location,
minAppIdVersion,
panEtag,
panLocation,
provisioningState,
scope,
securityServices,
systemData,
tags,
type
FROM azure_isv.paloaltonetworksngfw.local_rulestacks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List LocalRulestackResource resources by subscription ID.

SELECT
id,
name,
associatedSubscriptions,
defaultMode,
description,
identity,
location,
minAppIdVersion,
panEtag,
panLocation,
provisioningState,
scope,
securityServices,
systemData,
tags,
type
FROM azure_isv.paloaltonetworksngfw.local_rulestacks
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a LocalRulestackResource.

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

Manifest

# Description fields are for documentation purposes
- name: local_rulestacks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the local_rulestacks resource.
  - name: local_rulestack_name
    value: "{{ local_rulestack_name }}"
    description: Required parameter for the local_rulestacks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the local_rulestacks resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      tenantId: "{{ tenantId }}"
      principalId: "{{ principalId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      panEtag: "{{ panEtag }}"
      panLocation: "{{ panLocation }}"
      scope: "{{ scope }}"
      associatedSubscriptions:
        - "{{ associatedSubscriptions }}"
      description: "{{ description }}"
      defaultMode: "{{ defaultMode }}"
      minAppIdVersion: "{{ minAppIdVersion }}"
      securityServices:
        vulnerabilityProfile: "{{ vulnerabilityProfile }}"
        antiSpywareProfile: "{{ antiSpywareProfile }}"
        antiVirusProfile: "{{ antiVirusProfile }}"
        urlFilteringProfile: "{{ urlFilteringProfile }}"
        fileBlockingProfile: "{{ fileBlockingProfile }}"
        dnsSubscription: "{{ dnsSubscription }}"
        outboundUnTrustCertificate: "{{ outboundUnTrustCertificate }}"
        outboundTrustCertificate: "{{ outboundTrustCertificate }}"

UPDATE examples

update

Update a LocalRulestackResource.

UPDATE azure_isv.paloaltonetworksngfw.local_rulestacks
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND local_rulestack_name = '{{ local_rulestack_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a LocalRulestackResource.

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

DELETE examples

delete

Delete a LocalRulestackResource.

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

Lifecycle Methods

list_advanced_security_objects

Get the list of advanced security objects.

EXEC azure_isv.paloaltonetworksngfw.local_rulestacks.list_advanced_security_objects 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@type='{{ type }}' --required, 
@skip='{{ skip }}', 
@top='{{ top }}'
;

list_app_ids

List of AppIds for LocalRulestack ApiVersion.

EXEC azure_isv.paloaltonetworksngfw.local_rulestacks.list_app_ids 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@appIdVersion='{{ appIdVersion }}', 
@appPrefix='{{ appPrefix }}', 
@skip='{{ skip }}', 
@top='{{ top }}'
;

list_countries

List of countries for Rulestack.

EXEC azure_isv.paloaltonetworksngfw.local_rulestacks.list_countries 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@skip='{{ skip }}', 
@top='{{ top }}'
;

list_firewalls

List of Firewalls associated with Rulestack.

EXEC azure_isv.paloaltonetworksngfw.local_rulestacks.list_firewalls 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_predefined_url_categories

List predefined URL categories for rulestack.

EXEC azure_isv.paloaltonetworksngfw.local_rulestacks.list_predefined_url_categories 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@skip='{{ skip }}', 
@top='{{ top }}'
;

list_security_services

List the security services for rulestack.

EXEC azure_isv.paloaltonetworksngfw.local_rulestacks.list_security_services 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@type='{{ type }}' --required, 
@skip='{{ skip }}', 
@top='{{ top }}'
;

get_change_log

Get changelog.

EXEC azure_isv.paloaltonetworksngfw.local_rulestacks.get_change_log 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_support_info

support info for rulestack.

EXEC azure_isv.paloaltonetworksngfw.local_rulestacks.get_support_info 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@email='{{ email }}'
;

commit

Commit rulestack configuration.

EXEC azure_isv.paloaltonetworksngfw.local_rulestacks.commit 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

revert

Revert rulestack configuration.

EXEC azure_isv.paloaltonetworksngfw.local_rulestacks.revert 
@resource_group_name='{{ resource_group_name }}' --required, 
@local_rulestack_name='{{ local_rulestack_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;