firewall_policy_drafts

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

Overview

Name	firewall_policy_drafts
Type	Resource
Id	azure.network.firewall_policy_drafts

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.
dnsSettings	object	DNS Proxy Settings definition.
explicitProxy	object	Explicit Proxy Settings definition.
insights	object	Insights on Firewall Policy.
intrusionDetection	object	The configuration for Intrusion detection.
location	string	Resource location.
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.
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		Get a draft Firewall Policy.
create_or_update	insert	resource_group_name, firewall_policy_name, subscription_id		Create or update a draft Firewall Policy.
create_or_update	replace	resource_group_name, firewall_policy_name, subscription_id		Create or update a draft Firewall Policy.
delete	delete	resource_group_name, firewall_policy_name, subscription_id		Delete a draft 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

SELECT examples

get

Get a draft Firewall Policy.

SELECT
id,
name,
basePolicy,
dnsSettings,
explicitProxy,
insights,
intrusionDetection,
location,
snat,
sql,
tags,
threatIntelMode,
threatIntelWhitelist,
type
FROM azure.network.firewall_policy_drafts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND firewall_policy_name = '{{ firewall_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a draft Firewall Policy.

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

Manifest

# Description fields are for documentation purposes
- name: firewall_policy_drafts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the firewall_policy_drafts resource.
  - name: firewall_policy_name
    value: "{{ firewall_policy_name }}"
    description: Required parameter for the firewall_policy_drafts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the firewall_policy_drafts 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:
      basePolicy:
        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 }}"

REPLACE examples

create_or_update

Create or update a draft Firewall Policy.

REPLACE azure.network.firewall_policy_drafts
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
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,
location,
properties,
tags,
type;

DELETE examples

delete

Delete a draft policy.

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