firewall_policies

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

Overview

Name	firewall_policies
Type	Resource
Id	azure.network.firewall_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
basePolicy	object	Reference to another subresource.
childPolicies	array	List of references to Child Firewall Policies.
dnsSettings	object	DNS Proxy Settings definition.
etag	string	A unique read-only string that changes whenever the resource is updated.
explicitProxy	object	Explicit Proxy Settings definition.
firewalls	array	List of references to Azure Firewalls that this Firewall Policy is associated with.
identity	object	The identity of the firewall policy.
insights	object	Insights on Firewall Policy.
intrusionDetection	object	The configuration for Intrusion detection.
location	string	Resource location.
provisioningState	string	The provisioning state of the firewall policy resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
ruleCollectionGroups	array	List of references to FirewallPolicyRuleCollectionGroups.
size	string	A read-only string that represents the size of the FirewallPolicyPropertiesFormat in MB. (ex 0.5MB).
sku	object	The Firewall Policy SKU.
snat	object	The private IP addresses/IP ranges to which traffic will not be SNAT.
sql	object	SQL Settings definition.
tags	object	Resource tags.
threatIntelMode	string	The operation mode for Threat Intelligence. Known values are: "Alert", "Deny", and "Off". (Alert, Deny, Off)
threatIntelWhitelist	object	ThreatIntel Whitelist for Firewall Policy.
transportSecurity	object	TLS Configuration definition.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
basePolicy	object	Reference to another subresource.
childPolicies	array	List of references to Child Firewall Policies.
dnsSettings	object	DNS Proxy Settings definition.
etag	string	A unique read-only string that changes whenever the resource is updated.
explicitProxy	object	Explicit Proxy Settings definition.
firewalls	array	List of references to Azure Firewalls that this Firewall Policy is associated with.
identity	object	The identity of the firewall policy.
insights	object	Insights on Firewall Policy.
intrusionDetection	object	The configuration for Intrusion detection.
location	string	Resource location.
provisioningState	string	The provisioning state of the firewall policy resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
ruleCollectionGroups	array	List of references to FirewallPolicyRuleCollectionGroups.
size	string	A read-only string that represents the size of the FirewallPolicyPropertiesFormat in MB. (ex 0.5MB).
sku	object	The Firewall Policy SKU.
snat	object	The private IP addresses/IP ranges to which traffic will not be SNAT.
sql	object	SQL Settings definition.
tags	object	Resource tags.
threatIntelMode	string	The operation mode for Threat Intelligence. Known values are: "Alert", "Deny", and "Off". (Alert, Deny, Off)
threatIntelWhitelist	object	ThreatIntel Whitelist for Firewall Policy.
transportSecurity	object	TLS Configuration definition.
type	string	Resource type.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
basePolicy	object	Reference to another subresource.
childPolicies	array	List of references to Child Firewall Policies.
dnsSettings	object	DNS Proxy Settings definition.
etag	string	A unique read-only string that changes whenever the resource is updated.
explicitProxy	object	Explicit Proxy Settings definition.
firewalls	array	List of references to Azure Firewalls that this Firewall Policy is associated with.
identity	object	The identity of the firewall policy.
insights	object	Insights on Firewall Policy.
intrusionDetection	object	The configuration for Intrusion detection.
location	string	Resource location.
provisioningState	string	The provisioning state of the firewall policy resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
ruleCollectionGroups	array	List of references to FirewallPolicyRuleCollectionGroups.
size	string	A read-only string that represents the size of the FirewallPolicyPropertiesFormat in MB. (ex 0.5MB).
sku	object	The Firewall Policy SKU.
snat	object	The private IP addresses/IP ranges to which traffic will not be SNAT.
sql	object	SQL Settings definition.
tags	object	Resource tags.
threatIntelMode	string	The operation mode for Threat Intelligence. Known values are: "Alert", "Deny", and "Off". (Alert, Deny, Off)
threatIntelWhitelist	object	ThreatIntel Whitelist for Firewall Policy.
transportSecurity	object	TLS Configuration definition.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, firewall_policy_name, subscription_id	$expand	Gets the specified Firewall Policy.
list	select	resource_group_name, subscription_id		Lists all Firewall Policies in a resource group.
list_all	select	subscription_id		Gets all the Firewall Policies in a subscription.
create_or_update	insert	resource_group_name, firewall_policy_name, subscription_id		Creates or updates the specified Firewall Policy.
update_tags	update	resource_group_name, firewall_policy_name, subscription_id		Updates tags of a Azure Firewall Policy resource.
create_or_update	replace	resource_group_name, firewall_policy_name, subscription_id		Creates or updates the specified Firewall Policy.
delete	delete	resource_group_name, firewall_policy_name, subscription_id		Deletes the specified Firewall Policy.

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_policy_name	string	The name of the Firewall Policy. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	Expands referenced resources. Default value is None.

SELECT examples

get

Gets the specified Firewall Policy.

SELECT
id,
name,
basePolicy,
childPolicies,
dnsSettings,
etag,
explicitProxy,
firewalls,
identity,
insights,
intrusionDetection,
location,
provisioningState,
ruleCollectionGroups,
size,
sku,
snat,
sql,
tags,
threatIntelMode,
threatIntelWhitelist,
transportSecurity,
type
FROM azure.network.firewall_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND firewall_policy_name = '{{ firewall_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

Lists all Firewall Policies in a resource group.

SELECT
id,
name,
basePolicy,
childPolicies,
dnsSettings,
etag,
explicitProxy,
firewalls,
identity,
insights,
intrusionDetection,
location,
provisioningState,
ruleCollectionGroups,
size,
sku,
snat,
sql,
tags,
threatIntelMode,
threatIntelWhitelist,
transportSecurity,
type
FROM azure.network.firewall_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all the Firewall Policies in a subscription.

SELECT
id,
name,
basePolicy,
childPolicies,
dnsSettings,
etag,
explicitProxy,
firewalls,
identity,
insights,
intrusionDetection,
location,
provisioningState,
ruleCollectionGroups,
size,
sku,
snat,
sql,
tags,
threatIntelMode,
threatIntelWhitelist,
transportSecurity,
type
FROM azure.network.firewall_policies
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified Firewall Policy.

INSERT INTO azure.network.firewall_policies (
id,
location,
tags,
properties,
identity,
resource_group_name,
firewall_policy_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ firewall_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: firewall_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the firewall_policies resource.
  - name: firewall_policy_name
    value: "{{ firewall_policy_name }}"
    description: Required parameter for the firewall_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the firewall_policies resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the firewall policy.
    value:
      size: "{{ size }}"
      ruleCollectionGroups:
        - id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      basePolicy:
        id: "{{ id }}"
      firewalls:
        - id: "{{ id }}"
      childPolicies:
        - id: "{{ id }}"
      threatIntelMode: "{{ threatIntelMode }}"
      threatIntelWhitelist:
        ipAddresses:
          - "{{ ipAddresses }}"
        fqdns:
          - "{{ fqdns }}"
      insights:
        isEnabled: {{ isEnabled }}
        retentionDays: {{ retentionDays }}
        logAnalyticsResources:
          workspaces:
            - region: "{{ region }}"
              workspaceId:
                id: "{{ id }}"
          defaultWorkspaceId:
            id: "{{ id }}"
      snat:
        privateRanges:
          - "{{ privateRanges }}"
        autoLearnPrivateRanges: "{{ autoLearnPrivateRanges }}"
      sql:
        allowSqlRedirect: {{ allowSqlRedirect }}
      dnsSettings:
        servers:
          - "{{ servers }}"
        enableProxy: {{ enableProxy }}
        requireProxyForNetworkRules: {{ requireProxyForNetworkRules }}
      explicitProxy:
        enableExplicitProxy: {{ enableExplicitProxy }}
        httpPort: {{ httpPort }}
        httpsPort: {{ httpsPort }}
        enablePacFile: {{ enablePacFile }}
        pacFilePort: {{ pacFilePort }}
        pacFile: "{{ pacFile }}"
      intrusionDetection:
        mode: "{{ mode }}"
        profile: "{{ profile }}"
        configuration:
          signatureOverrides:
            - id: "{{ id }}"
              mode: "{{ mode }}"
          bypassTrafficSettings:
            - name: "{{ name }}"
              description: "{{ description }}"
              protocol: "{{ protocol }}"
              sourceAddresses: "{{ sourceAddresses }}"
              destinationAddresses: "{{ destinationAddresses }}"
              destinationPorts: "{{ destinationPorts }}"
              sourceIpGroups: "{{ sourceIpGroups }}"
              destinationIpGroups: "{{ destinationIpGroups }}"
          privateRanges:
            - "{{ privateRanges }}"
      transportSecurity:
        certificateAuthority:
          keyVaultSecretId: "{{ keyVaultSecretId }}"
          name: "{{ name }}"
      sku:
        tier: "{{ tier }}"
  - name: identity
    description: |
      The identity of the firewall policy.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update_tags

Updates tags of a Azure Firewall Policy resource.

UPDATE azure.network.firewall_policies
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND firewall_policy_name = '{{ firewall_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates the specified Firewall Policy.

REPLACE azure.network.firewall_policies
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND firewall_policy_name = '{{ firewall_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified Firewall Policy.

DELETE FROM azure.network.firewall_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND firewall_policy_name = '{{ firewall_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;