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

Request successful. The operation returns an AzureFirewall resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the azure firewall.
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"
zones	array	A list of availability zones denoting where the resource needs to come from.

list

Success. The operation returns a list of AzureFirewall resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the azure firewall.
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"
zones	array	A list of availability zones denoting where the resource needs to come from.

list_all

Success. The operation returns a list of AzureFirewall resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the azure firewall.
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"
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	resourceGroupName, azureFirewallName, subscriptionId		Gets the specified Azure Firewall.
list	select	resourceGroupName, subscriptionId		Lists all Azure Firewalls in a resource group.
list_all	select	subscriptionId		Gets all the Azure Firewalls in a subscription.
create_or_update	insert	resourceGroupName, azureFirewallName, subscriptionId		Creates or updates the specified Azure Firewall.
delete	delete	resourceGroupName, azureFirewallName, subscriptionId		Deletes the specified Azure Firewall.
update_tags	exec	resourceGroupName, azureFirewallName, subscriptionId		Updates tags of an Azure Firewall resource.
packet_capture	exec	resourceGroupName, azureFirewallName, subscriptionId		Runs a packet capture 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
azureFirewallName	string	The name of the Azure Firewall.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the specified Azure Firewall.

SELECT
id,
name,
etag,
properties,
systemData,
type,
zones
FROM azure.network.azure_firewalls
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND azureFirewallName = '{{ azureFirewallName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all Azure Firewalls in a resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type,
zones
FROM azure.network.azure_firewalls
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_all

Gets all the Azure Firewalls in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type,
zones
FROM azure.network.azure_firewalls
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified Azure Firewall.

INSERT INTO azure.network.azure_firewalls (
data__properties,
data__zones,
resourceGroupName,
azureFirewallName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ zones }}',
'{{ resourceGroupName }}',
'{{ azureFirewallName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: azure_firewalls
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the azure_firewalls resource.
    - name: azureFirewallName
      value: string
      description: Required parameter for the azure_firewalls resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the azure_firewalls resource.
    - name: properties
      value: object
      description: |
        Properties of the azure firewall.
    - name: zones
      value: array
      description: |
        A list of availability zones denoting where the resource needs to come from.

DELETE examples

delete

Deletes the specified Azure Firewall.

DELETE FROM azure.network.azure_firewalls
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND azureFirewallName = '{{ azureFirewallName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates tags of an Azure Firewall resource.

EXEC azure.network.azure_firewalls.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@azureFirewallName='{{ azureFirewallName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

packet_capture

Runs a packet capture on AzureFirewall.

EXEC azure.network.azure_firewalls.packet_capture 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@azureFirewallName='{{ azureFirewallName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"durationInSeconds": {{ durationInSeconds }}, 
"numberOfPacketsToCapture": {{ numberOfPacketsToCapture }}, 
"sasUrl": "{{ sasUrl }}", 
"fileName": "{{ fileName }}", 
"protocol": "{{ protocol }}", 
"flags": "{{ flags }}", 
"filters": "{{ filters }}"
}'
;