global_rulestack

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

Overview

Name	global_rulestack
Type	Resource
Id	azure_isv.paloaltonetworksngfw.global_rulestack

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	Global Location. 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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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	Global Location. 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.
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	global_rulestack_name		Get a GlobalRulestackResource.
list	select			List GlobalRulestackResource resources by Tenant.
create_or_update	insert	global_rulestack_name, location		Create a GlobalRulestackResource.
update	update	global_rulestack_name		Update a GlobalRulestackResource.
create_or_update	replace	global_rulestack_name, location		Create a GlobalRulestackResource.
delete	delete	global_rulestack_name		Delete a GlobalRulestackResource.
list_advanced_security_objects	exec	global_rulestack_name, type	skip, top	Get the list of advanced security objects.
list_app_ids	exec	global_rulestack_name	appIdVersion, appPrefix, skip, top	List of AppIds for GlobalRulestack ApiVersion.
list_countries	exec	global_rulestack_name	skip, top	List of countries for Rulestack.
list_firewalls	exec	global_rulestack_name		List of Firewalls associated with Rulestack.
list_predefined_url_categories	exec	global_rulestack_name	skip, top	List predefined URL categories for rulestack.
list_security_services	exec	global_rulestack_name, type	skip, top	List the security services for rulestack.
get_change_log	exec	global_rulestack_name		Get changelog.
commit	exec	global_rulestack_name		Commit rulestack configuration.
revert	exec	global_rulestack_name		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
global_rulestack_name	string	GlobalRulestack resource name. Required.
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.
skip	string	Default value is None.
top	integer	Default value is None.

SELECT examples

get

Get a GlobalRulestackResource.

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

list

List GlobalRulestackResource resources by Tenant.

SELECT
id,
name,
associatedSubscriptions,
defaultMode,
description,
identity,
location,
minAppIdVersion,
panEtag,
panLocation,
provisioningState,
scope,
securityServices,
systemData,
type
FROM azure_isv.paloaltonetworksngfw.global_rulestack
;

INSERT examples

create_or_update

Create a GlobalRulestackResource.

INSERT INTO azure_isv.paloaltonetworksngfw.global_rulestack (
location,
identity,
properties,
global_rulestack_name
)
SELECT 
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ global_rulestack_name }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: global_rulestack
props:
  - name: global_rulestack_name
    value: "{{ global_rulestack_name }}"
    description: Required parameter for the global_rulestack resource.
  - name: location
    value: "{{ location }}"
    description: |
      Global Location. 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 GlobalRulestackResource.

UPDATE azure_isv.paloaltonetworksngfw.global_rulestack
SET 
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
global_rulestack_name = '{{ global_rulestack_name }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a GlobalRulestackResource.

REPLACE azure_isv.paloaltonetworksngfw.global_rulestack
SET 
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
global_rulestack_name = '{{ global_rulestack_name }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
type;

DELETE examples

delete

Delete a GlobalRulestackResource.

DELETE FROM azure_isv.paloaltonetworksngfw.global_rulestack
WHERE global_rulestack_name = '{{ global_rulestack_name }}' --required
;

Lifecycle Methods

list_advanced_security_objects

Get the list of advanced security objects.

EXEC azure_isv.paloaltonetworksngfw.global_rulestack.list_advanced_security_objects 
@global_rulestack_name='{{ global_rulestack_name }}' --required, 
@type='{{ type }}' --required, 
@skip='{{ skip }}', 
@top='{{ top }}'
;

list_app_ids

List of AppIds for GlobalRulestack ApiVersion.

EXEC azure_isv.paloaltonetworksngfw.global_rulestack.list_app_ids 
@global_rulestack_name='{{ global_rulestack_name }}' --required, 
@appIdVersion='{{ appIdVersion }}', 
@appPrefix='{{ appPrefix }}', 
@skip='{{ skip }}', 
@top='{{ top }}'
;

list_countries

List of countries for Rulestack.

EXEC azure_isv.paloaltonetworksngfw.global_rulestack.list_countries 
@global_rulestack_name='{{ global_rulestack_name }}' --required, 
@skip='{{ skip }}', 
@top='{{ top }}'
;

list_firewalls

List of Firewalls associated with Rulestack.

EXEC azure_isv.paloaltonetworksngfw.global_rulestack.list_firewalls 
@global_rulestack_name='{{ global_rulestack_name }}' --required
;

list_predefined_url_categories

List predefined URL categories for rulestack.

EXEC azure_isv.paloaltonetworksngfw.global_rulestack.list_predefined_url_categories 
@global_rulestack_name='{{ global_rulestack_name }}' --required, 
@skip='{{ skip }}', 
@top='{{ top }}'
;

list_security_services

List the security services for rulestack.

EXEC azure_isv.paloaltonetworksngfw.global_rulestack.list_security_services 
@global_rulestack_name='{{ global_rulestack_name }}' --required, 
@type='{{ type }}' --required, 
@skip='{{ skip }}', 
@top='{{ top }}'
;

get_change_log

Get changelog.

EXEC azure_isv.paloaltonetworksngfw.global_rulestack.get_change_log 
@global_rulestack_name='{{ global_rulestack_name }}' --required
;

commit

Commit rulestack configuration.

EXEC azure_isv.paloaltonetworksngfw.global_rulestack.commit 
@global_rulestack_name='{{ global_rulestack_name }}' --required
;

revert

Revert rulestack configuration.

EXEC azure_isv.paloaltonetworksngfw.global_rulestack.revert 
@global_rulestack_name='{{ global_rulestack_name }}' --required
;