firewalls

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

Overview

Name	firewalls
Type	Resource
Id	azure_isv.paloaltonetworksngfw.firewalls

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.
associatedRulestack	object	Associated Rulestack.
dnsSettings	object	DNS settings for Firewall. Required.
frontEndSettings	array	Frontend settings for Firewall.
identity	object	The managed service identities assigned to this resource.
isPanoramaManaged	string	Panorama Managed: Default is False. Default will be CloudSec managed. Known values are: "TRUE" and "FALSE".
isStrataCloudManaged	string	Strata Cloud Managed: Default is False. Default will be CloudSec managed. Known values are: "TRUE" and "FALSE".
location	string	The geo-location where the resource lives. Required.
marketplaceDetails	object	Marketplace details. Required.
networkProfile	object	Network settings. Required.
panEtag	string	panEtag info.
panoramaConfig	object	Panorama Configuration.
planData	object	Billing plan information. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
strataCloudManagerConfig	object	Strata Cloud Manager Configuration, only applicable if Strata Cloud Manager is selected.
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.
associatedRulestack	object	Associated Rulestack.
dnsSettings	object	DNS settings for Firewall. Required.
frontEndSettings	array	Frontend settings for Firewall.
identity	object	The managed service identities assigned to this resource.
isPanoramaManaged	string	Panorama Managed: Default is False. Default will be CloudSec managed. Known values are: "TRUE" and "FALSE".
isStrataCloudManaged	string	Strata Cloud Managed: Default is False. Default will be CloudSec managed. Known values are: "TRUE" and "FALSE".
location	string	The geo-location where the resource lives. Required.
marketplaceDetails	object	Marketplace details. Required.
networkProfile	object	Network settings. Required.
panEtag	string	panEtag info.
panoramaConfig	object	Panorama Configuration.
planData	object	Billing plan information. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
strataCloudManagerConfig	object	Strata Cloud Manager Configuration, only applicable if Strata Cloud Manager is selected.
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.
associatedRulestack	object	Associated Rulestack.
dnsSettings	object	DNS settings for Firewall. Required.
frontEndSettings	array	Frontend settings for Firewall.
identity	object	The managed service identities assigned to this resource.
isPanoramaManaged	string	Panorama Managed: Default is False. Default will be CloudSec managed. Known values are: "TRUE" and "FALSE".
isStrataCloudManaged	string	Strata Cloud Managed: Default is False. Default will be CloudSec managed. Known values are: "TRUE" and "FALSE".
location	string	The geo-location where the resource lives. Required.
marketplaceDetails	object	Marketplace details. Required.
networkProfile	object	Network settings. Required.
panEtag	string	panEtag info.
panoramaConfig	object	Panorama Configuration.
planData	object	Billing plan information. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
strataCloudManagerConfig	object	Strata Cloud Manager Configuration, only applicable if Strata Cloud Manager is selected.
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, firewall_name, subscription_id		Get a FirewallResource.
list_by_resource_group	select	resource_group_name, subscription_id		List FirewallResource resources by resource group.
list_by_subscription	select	subscription_id		List FirewallResource resources by subscription ID.
create_or_update	insert	resource_group_name, firewall_name, subscription_id, location, properties		Create a FirewallResource.
update	update	resource_group_name, firewall_name, subscription_id		Update a FirewallResource.
create_or_update	replace	resource_group_name, firewall_name, subscription_id, location, properties		Create a FirewallResource.
delete	delete	resource_group_name, firewall_name, subscription_id		Delete a FirewallResource.
get_global_rulestack	exec	resource_group_name, firewall_name, subscription_id		Get Global Rulestack associated with the Firewall.
get_log_profile	exec	resource_group_name, firewall_name, subscription_id		Log Profile for Firewall.
get_support_info	exec	resource_group_name, firewall_name, subscription_id	email	support info for firewall.
save_log_profile	exec	resource_group_name, firewall_name, subscription_id		Log Profile for Firewall.

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
firewall_name	string	Firewall resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
email	string	email address on behalf of which this API called. Default value is None.

SELECT examples

get

Get a FirewallResource.

SELECT
id,
name,
associatedRulestack,
dnsSettings,
frontEndSettings,
identity,
isPanoramaManaged,
isStrataCloudManaged,
location,
marketplaceDetails,
networkProfile,
panEtag,
panoramaConfig,
planData,
provisioningState,
strataCloudManagerConfig,
systemData,
tags,
type
FROM azure_isv.paloaltonetworksngfw.firewalls
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND firewall_name = '{{ firewall_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List FirewallResource resources by resource group.

SELECT
id,
name,
associatedRulestack,
dnsSettings,
frontEndSettings,
identity,
isPanoramaManaged,
isStrataCloudManaged,
location,
marketplaceDetails,
networkProfile,
panEtag,
panoramaConfig,
planData,
provisioningState,
strataCloudManagerConfig,
systemData,
tags,
type
FROM azure_isv.paloaltonetworksngfw.firewalls
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List FirewallResource resources by subscription ID.

SELECT
id,
name,
associatedRulestack,
dnsSettings,
frontEndSettings,
identity,
isPanoramaManaged,
isStrataCloudManaged,
location,
marketplaceDetails,
networkProfile,
panEtag,
panoramaConfig,
planData,
provisioningState,
strataCloudManagerConfig,
systemData,
tags,
type
FROM azure_isv.paloaltonetworksngfw.firewalls
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a FirewallResource.

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

Manifest

# Description fields are for documentation purposes
- name: firewalls
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the firewalls resource.
  - name: firewall_name
    value: "{{ firewall_name }}"
    description: Required parameter for the firewalls resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the firewalls 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 }}"
      networkProfile:
        vnetConfiguration:
          vnet:
            resourceId: "{{ resourceId }}"
            addressSpace: "{{ addressSpace }}"
          trustSubnet:
            resourceId: "{{ resourceId }}"
            addressSpace: "{{ addressSpace }}"
          unTrustSubnet:
            resourceId: "{{ resourceId }}"
            addressSpace: "{{ addressSpace }}"
          ipOfTrustSubnetForUdr:
            resourceId: "{{ resourceId }}"
            address: "{{ address }}"
        vwanConfiguration:
          networkVirtualApplianceId: "{{ networkVirtualApplianceId }}"
          vHub:
            resourceId: "{{ resourceId }}"
            addressSpace: "{{ addressSpace }}"
          trustSubnet:
            resourceId: "{{ resourceId }}"
            addressSpace: "{{ addressSpace }}"
          unTrustSubnet:
            resourceId: "{{ resourceId }}"
            addressSpace: "{{ addressSpace }}"
          ipOfTrustSubnetForUdr:
            resourceId: "{{ resourceId }}"
            address: "{{ address }}"
        networkType: "{{ networkType }}"
        publicIps:
          - resourceId: "{{ resourceId }}"
            address: "{{ address }}"
        enableEgressNat: "{{ enableEgressNat }}"
        egressNatIp:
          - resourceId: "{{ resourceId }}"
            address: "{{ address }}"
        trustedRanges:
          - "{{ trustedRanges }}"
        privateSourceNatRulesDestination:
          - "{{ privateSourceNatRulesDestination }}"
      isPanoramaManaged: "{{ isPanoramaManaged }}"
      isStrataCloudManaged: "{{ isStrataCloudManaged }}"
      panoramaConfig:
        configString: "{{ configString }}"
        vmAuthKey: "{{ vmAuthKey }}"
        panoramaServer: "{{ panoramaServer }}"
        panoramaServer2: "{{ panoramaServer2 }}"
        dgName: "{{ dgName }}"
        tplName: "{{ tplName }}"
        cgName: "{{ cgName }}"
        hostName: "{{ hostName }}"
      strataCloudManagerConfig:
        cloudManagerName: "{{ cloudManagerName }}"
      associatedRulestack:
        resourceId: "{{ resourceId }}"
        rulestackId: "{{ rulestackId }}"
        location: "{{ location }}"
      dnsSettings:
        enableDnsProxy: "{{ enableDnsProxy }}"
        enabledDnsType: "{{ enabledDnsType }}"
        dnsServers:
          - resourceId: "{{ resourceId }}"
            address: "{{ address }}"
      frontEndSettings:
        - name: "{{ name }}"
          protocol: "{{ protocol }}"
          frontendConfiguration:
            port: "{{ port }}"
            address:
              resourceId: "{{ resourceId }}"
              address: "{{ address }}"
          backendConfiguration:
            port: "{{ port }}"
            address:
              resourceId: "{{ resourceId }}"
              address: "{{ address }}"
      planData:
        usageType: "{{ usageType }}"
        billingCycle: "{{ billingCycle }}"
        planId: "{{ planId }}"
        effectiveDate: "{{ effectiveDate }}"
      marketplaceDetails:
        marketplaceSubscriptionId: "{{ marketplaceSubscriptionId }}"
        offerId: "{{ offerId }}"
        publisherId: "{{ publisherId }}"
        marketplaceSubscriptionStatus: "{{ marketplaceSubscriptionStatus }}"

UPDATE examples

update

Update a FirewallResource.

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

REPLACE examples

create_or_update

Create a FirewallResource.

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

DELETE examples

delete

Delete a FirewallResource.

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

Lifecycle Methods

get_global_rulestack

Get Global Rulestack associated with the Firewall.

EXEC azure_isv.paloaltonetworksngfw.firewalls.get_global_rulestack 
@resource_group_name='{{ resource_group_name }}' --required, 
@firewall_name='{{ firewall_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_log_profile

Log Profile for Firewall.

EXEC azure_isv.paloaltonetworksngfw.firewalls.get_log_profile 
@resource_group_name='{{ resource_group_name }}' --required, 
@firewall_name='{{ firewall_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_support_info

support info for firewall.

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

save_log_profile

Log Profile for Firewall.

EXEC azure_isv.paloaltonetworksngfw.firewalls.save_log_profile 
@resource_group_name='{{ resource_group_name }}' --required, 
@firewall_name='{{ firewall_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"logType": "{{ logType }}", 
"logOption": "{{ logOption }}", 
"applicationInsights": "{{ applicationInsights }}", 
"commonDestination": "{{ commonDestination }}", 
"trafficLogDestination": "{{ trafficLogDestination }}", 
"threatLogDestination": "{{ threatLogDestination }}", 
"decryptLogDestination": "{{ decryptLogDestination }}"
}'
;