azure_firewalls

Creates, updates, deletes, gets or lists an azure_firewalls resource.

Overview

Name	azure_firewalls
Type	Resource
Id	azure.network.azure_firewalls

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
additionalProperties	object	The additional properties used to further config this azure firewall.
afcConfiguration	object	AFC configuration for the Azure Firewall.
applicationRuleCollections	array	Collection of application rule collections used by Azure Firewall.
autoscaleConfiguration	object	Properties to provide a custom autoscale configuration to this azure firewall.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of type local virtual network gateway.
firewallPolicy	object	Reference to another subresource.
hubIPAddresses	object	IP addresses associated with AzureFirewall.
ipConfigurations	array	IP configuration of the Azure Firewall resource.
ipGroups	array	IpGroups associated with AzureFirewall.
location	string	Resource location.
managementIpConfiguration	object	IP configuration of an Azure Firewall.
natRuleCollections	array	Collection of NAT rule collections used by Azure Firewall.
networkRuleCollections	array	Collection of network rule collections used by Azure Firewall.
provisioningState	string	The provisioning state of the Azure firewall resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sku	object	The Azure Firewall Resource SKU.
tags	object	Resource tags.
threatIntelMode	string	The operation mode for Threat Intelligence. Known values are: "Alert", "Deny", and "Off". (Alert, Deny, Off)
type	string	Resource type.
virtualHub	object	Reference to another subresource.
zones	array	A list of availability zones denoting where the resource needs to come from.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
additionalProperties	object	The additional properties used to further config this azure firewall.
afcConfiguration	object	AFC configuration for the Azure Firewall.
applicationRuleCollections	array	Collection of application rule collections used by Azure Firewall.
autoscaleConfiguration	object	Properties to provide a custom autoscale configuration to this azure firewall.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of type local virtual network gateway.
firewallPolicy	object	Reference to another subresource.
hubIPAddresses	object	IP addresses associated with AzureFirewall.
ipConfigurations	array	IP configuration of the Azure Firewall resource.
ipGroups	array	IpGroups associated with AzureFirewall.
location	string	Resource location.
managementIpConfiguration	object	IP configuration of an Azure Firewall.
natRuleCollections	array	Collection of NAT rule collections used by Azure Firewall.
networkRuleCollections	array	Collection of network rule collections used by Azure Firewall.
provisioningState	string	The provisioning state of the Azure firewall resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sku	object	The Azure Firewall Resource SKU.
tags	object	Resource tags.
threatIntelMode	string	The operation mode for Threat Intelligence. Known values are: "Alert", "Deny", and "Off". (Alert, Deny, Off)
type	string	Resource type.
virtualHub	object	Reference to another subresource.
zones	array	A list of availability zones denoting where the resource needs to come from.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
additionalProperties	object	The additional properties used to further config this azure firewall.
afcConfiguration	object	AFC configuration for the Azure Firewall.
applicationRuleCollections	array	Collection of application rule collections used by Azure Firewall.
autoscaleConfiguration	object	Properties to provide a custom autoscale configuration to this azure firewall.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of type local virtual network gateway.
firewallPolicy	object	Reference to another subresource.
hubIPAddresses	object	IP addresses associated with AzureFirewall.
ipConfigurations	array	IP configuration of the Azure Firewall resource.
ipGroups	array	IpGroups associated with AzureFirewall.
location	string	Resource location.
managementIpConfiguration	object	IP configuration of an Azure Firewall.
natRuleCollections	array	Collection of NAT rule collections used by Azure Firewall.
networkRuleCollections	array	Collection of network rule collections used by Azure Firewall.
provisioningState	string	The provisioning state of the Azure firewall resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sku	object	The Azure Firewall Resource SKU.
tags	object	Resource tags.
threatIntelMode	string	The operation mode for Threat Intelligence. Known values are: "Alert", "Deny", and "Off". (Alert, Deny, Off)
type	string	Resource type.
virtualHub	object	Reference to another subresource.
zones	array	A list of availability zones denoting where the resource needs to come from.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, azure_firewall_name, subscription_id		Gets the specified Azure Firewall.
list	select	resource_group_name, subscription_id		Lists all Azure Firewalls in a resource group.
list_all	select	subscription_id		Gets all the Azure Firewalls in a subscription.
create_or_update	insert	resource_group_name, azure_firewall_name, subscription_id	createAfcControlPlane	Creates or updates the specified Azure Firewall.
update_tags	update	resource_group_name, azure_firewall_name, subscription_id		Updates tags of an Azure Firewall resource.
create_or_update	replace	resource_group_name, azure_firewall_name, subscription_id	createAfcControlPlane	Creates or updates the specified Azure Firewall.
delete	delete	resource_group_name, azure_firewall_name, subscription_id		Deletes the specified Azure Firewall.
list_learned_prefixes	exec	resource_group_name, azure_firewall_name, subscription_id		Retrieves a list of all IP prefixes that azure firewall has learned to not SNAT.
packet_capture	exec	resource_group_name, azure_firewall_name, subscription_id		Runs a packet capture on AzureFirewall.
packet_capture_operation	exec	resource_group_name, azure_firewall_name, subscription_id		Runs a packet capture operation on AzureFirewall.

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
azure_firewall_name	string	The name of the Azure Firewall. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
createAfcControlPlane	boolean	When set to true, creates an AFC control plane for the Azure Firewall. Default value is None.

SELECT examples

get

Gets the specified Azure Firewall.

SELECT
id,
name,
additionalProperties,
afcConfiguration,
applicationRuleCollections,
autoscaleConfiguration,
etag,
extendedLocation,
firewallPolicy,
hubIPAddresses,
ipConfigurations,
ipGroups,
location,
managementIpConfiguration,
natRuleCollections,
networkRuleCollections,
provisioningState,
sku,
tags,
threatIntelMode,
type,
virtualHub,
zones
FROM azure.network.azure_firewalls
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND azure_firewall_name = '{{ azure_firewall_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all Azure Firewalls in a resource group.

SELECT
id,
name,
additionalProperties,
afcConfiguration,
applicationRuleCollections,
autoscaleConfiguration,
etag,
extendedLocation,
firewallPolicy,
hubIPAddresses,
ipConfigurations,
ipGroups,
location,
managementIpConfiguration,
natRuleCollections,
networkRuleCollections,
provisioningState,
sku,
tags,
threatIntelMode,
type,
virtualHub,
zones
FROM azure.network.azure_firewalls
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all the Azure Firewalls in a subscription.

SELECT
id,
name,
additionalProperties,
afcConfiguration,
applicationRuleCollections,
autoscaleConfiguration,
etag,
extendedLocation,
firewallPolicy,
hubIPAddresses,
ipConfigurations,
ipGroups,
location,
managementIpConfiguration,
natRuleCollections,
networkRuleCollections,
provisioningState,
sku,
tags,
threatIntelMode,
type,
virtualHub,
zones
FROM azure.network.azure_firewalls
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified Azure Firewall.

INSERT INTO azure.network.azure_firewalls (
id,
location,
tags,
properties,
extendedLocation,
zones,
resource_group_name,
azure_firewall_name,
subscription_id,
createAfcControlPlane
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ azure_firewall_name }}',
'{{ subscription_id }}',
'{{ createAfcControlPlane }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: azure_firewalls
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the azure_firewalls resource.
  - name: azure_firewall_name
    value: "{{ azure_firewall_name }}"
    description: Required parameter for the azure_firewalls resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the azure_firewalls 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 azure firewall.
    value:
      applicationRuleCollections:
        - id: "{{ id }}"
          properties:
            priority: {{ priority }}
            action:
              type: "{{ type }}"
            rules:
              - name: "{{ name }}"
                description: "{{ description }}"
                sourceAddresses: "{{ sourceAddresses }}"
                protocols: "{{ protocols }}"
                targetFqdns: "{{ targetFqdns }}"
                fqdnTags: "{{ fqdnTags }}"
                sourceIpGroups: "{{ sourceIpGroups }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
      natRuleCollections:
        - id: "{{ id }}"
          properties:
            priority: {{ priority }}
            action:
              type: "{{ type }}"
            rules:
              - name: "{{ name }}"
                description: "{{ description }}"
                sourceAddresses: "{{ sourceAddresses }}"
                destinationAddresses: "{{ destinationAddresses }}"
                destinationPorts: "{{ destinationPorts }}"
                protocols: "{{ protocols }}"
                translatedAddress: "{{ translatedAddress }}"
                translatedPort: "{{ translatedPort }}"
                translatedFqdn: "{{ translatedFqdn }}"
                sourceIpGroups: "{{ sourceIpGroups }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
      networkRuleCollections:
        - id: "{{ id }}"
          properties:
            priority: {{ priority }}
            action:
              type: "{{ type }}"
            rules:
              - name: "{{ name }}"
                description: "{{ description }}"
                protocols: "{{ protocols }}"
                sourceAddresses: "{{ sourceAddresses }}"
                destinationAddresses: "{{ destinationAddresses }}"
                destinationPorts: "{{ destinationPorts }}"
                destinationFqdns: "{{ destinationFqdns }}"
                sourceIpGroups: "{{ sourceIpGroups }}"
                destinationIpGroups: "{{ destinationIpGroups }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
      ipConfigurations:
        - id: "{{ id }}"
          properties:
            privateIPAddress: "{{ privateIPAddress }}"
            subnet:
              id: "{{ id }}"
            publicIPAddress:
              id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      managementIpConfiguration:
        id: "{{ id }}"
        properties:
          privateIPAddress: "{{ privateIPAddress }}"
          subnet:
            id: "{{ id }}"
          publicIPAddress:
            id: "{{ id }}"
          provisioningState: "{{ provisioningState }}"
        name: "{{ name }}"
        etag: "{{ etag }}"
        type: "{{ type }}"
      provisioningState: "{{ provisioningState }}"
      threatIntelMode: "{{ threatIntelMode }}"
      virtualHub:
        id: "{{ id }}"
      firewallPolicy:
        id: "{{ id }}"
      hubIPAddresses:
        publicIPs:
          addresses:
            - address: "{{ address }}"
          count: {{ count }}
        privateIPAddress: "{{ privateIPAddress }}"
      ipGroups:
        - id: "{{ id }}"
          changeNumber: "{{ changeNumber }}"
      sku:
        name: "{{ name }}"
        tier: "{{ tier }}"
      additionalProperties: "{{ additionalProperties }}"
      autoscaleConfiguration:
        minCapacity: {{ minCapacity }}
        maxCapacity: {{ maxCapacity }}
      afcConfiguration:
        serviceEndpoint: "{{ serviceEndpoint }}"
  - name: extendedLocation
    description: |
      The extended location of type local virtual network gateway.
    value:
      name: "{{ name }}"
      type: "{{ type }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      A list of availability zones denoting where the resource needs to come from.
  - name: createAfcControlPlane
    value: {{ createAfcControlPlane }}
    description: When set to true, creates an AFC control plane for the Azure Firewall. Default value is None.
    description: When set to true, creates an AFC control plane for the Azure Firewall. Default value is None.

UPDATE examples

update_tags

Updates tags of an Azure Firewall resource.

UPDATE azure.network.azure_firewalls
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_firewall_name = '{{ azure_firewall_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type,
zones;

REPLACE examples

create_or_update

Creates or updates the specified Azure Firewall.

REPLACE azure.network.azure_firewalls
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_firewall_name = '{{ azure_firewall_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND createAfcControlPlane = {{ createAfcControlPlane}}
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type,
zones;

DELETE examples

delete

Deletes the specified Azure Firewall.

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

Lifecycle Methods

list_learned_prefixes

Retrieves a list of all IP prefixes that azure firewall has learned to not SNAT.

EXEC azure.network.azure_firewalls.list_learned_prefixes 
@resource_group_name='{{ resource_group_name }}' --required, 
@azure_firewall_name='{{ azure_firewall_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

packet_capture

Runs a packet capture on AzureFirewall.

EXEC azure.network.azure_firewalls.packet_capture 
@resource_group_name='{{ resource_group_name }}' --required, 
@azure_firewall_name='{{ azure_firewall_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"durationInSeconds": {{ durationInSeconds }}, 
"numberOfPacketsToCapture": {{ numberOfPacketsToCapture }}, 
"sasUrl": "{{ sasUrl }}", 
"fileName": "{{ fileName }}", 
"protocol": "{{ protocol }}", 
"flags": "{{ flags }}", 
"filters": "{{ filters }}", 
"operation": "{{ operation }}"
}'
;

packet_capture_operation

Runs a packet capture operation on AzureFirewall.

EXEC azure.network.azure_firewalls.packet_capture_operation 
@resource_group_name='{{ resource_group_name }}' --required, 
@azure_firewall_name='{{ azure_firewall_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"durationInSeconds": {{ durationInSeconds }}, 
"numberOfPacketsToCapture": {{ numberOfPacketsToCapture }}, 
"sasUrl": "{{ sasUrl }}", 
"fileName": "{{ fileName }}", 
"protocol": "{{ protocol }}", 
"flags": "{{ flags }}", 
"filters": "{{ filters }}", 
"operation": "{{ operation }}"
}'
;