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

Request successful. The operation returns a Firewall Policy 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.
identity	object	The identity of the firewall policy.
properties	object	Properties of the firewall policy.
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

Success. The operation returns a list of FirewallPolicy 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.
identity	object	The identity of the firewall policy.
properties	object	Properties of the firewall policy.
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_all

Success. The operation returns a list of FirewallPolicy 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.
identity	object	The identity of the firewall policy.
properties	object	Properties of the firewall policy.
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	resourceGroupName, firewallPolicyName, subscriptionId	$expand	Gets the specified Firewall Policy.
list	select	resourceGroupName, subscriptionId		Lists all Firewall Policies in a resource group.
list_all	select	subscriptionId		Gets all the Firewall Policies in a subscription.
create_or_update	insert	resourceGroupName, firewallPolicyName, subscriptionId		Creates or updates the specified Firewall Policy.
delete	delete	resourceGroupName, firewallPolicyName, subscriptionId		Deletes the specified Firewall Policy.
update_tags	exec	resourceGroupName, firewallPolicyName, subscriptionId		Updates tags of a Azure Firewall Policy resource.

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
firewallPolicyName	string	The name of the Firewall Policy.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets the specified Firewall Policy.

SELECT
id,
name,
etag,
identity,
properties,
systemData,
type
FROM azure.network.firewall_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND firewallPolicyName = '{{ firewallPolicyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Lists all Firewall Policies in a resource group.

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

list_all

Gets all the Firewall Policies in a subscription.

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

INSERT examples

create_or_update

Creates or updates the specified Firewall Policy.

INSERT INTO azure.network.firewall_policies (
data__properties,
data__identity,
resourceGroupName,
firewallPolicyName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ resourceGroupName }}',
'{{ firewallPolicyName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
identity,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: firewall_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the firewall_policies resource.
    - name: firewallPolicyName
      value: string
      description: Required parameter for the firewall_policies resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the firewall_policies resource.
    - name: properties
      value: object
      description: |
        Properties of the firewall policy.
    - name: identity
      value: object
      description: |
        The identity of the firewall policy.

DELETE examples

delete

Deletes the specified Firewall Policy.

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

Lifecycle Methods

update_tags

Updates tags of a Azure Firewall Policy resource.

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