network_firewall_policies

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

Overview

Name	network_firewall_policies
Type	Resource
Id	google.compute.network_firewall_policies

Fields

Name	Datatype	Description
id	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.
description	string	An optional description of this resource. Provide this property when you create the resource.
associations	array	A list of associations that belong to this firewall policy.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
displayName	string	Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
fingerprint	string	Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.
kind	string	[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
parent	string	[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
region	string	[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
ruleTupleCount	integer	[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
rules	array	A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
selfLink	string	[Output Only] Server-defined URL for the resource.
selfLinkWithId	string	[Output Only] Server-defined URL for this resource with the resource id.
shortName	string	User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	firewallPolicy, project	Returns the specified network firewall policy.
list	SELECT	project	Lists all the policies that have been configured for the specified project.
insert	INSERT	project	Creates a new policy in the specified project using the data included in the request.
delete	DELETE	firewallPolicy, project	Deletes the specified policy.
patch	UPDATE	firewallPolicy, project	Patches the specified policy with the data included in the request.
patch_rule	UPDATE	firewallPolicy, project	Patches a rule of the specified priority.
clone_rules	EXEC	firewallPolicy, project	Copies rules to the specified firewall policy.

SELECT examples

Lists all the policies that have been configured for the specified project.

SELECT
id,
name,
description,
associations,
creationTimestamp,
displayName,
fingerprint,
kind,
parent,
region,
ruleTupleCount,
rules,
selfLink,
selfLinkWithId,
shortName
FROM google.compute.network_firewall_policies
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new network_firewall_policies resource.

All Properties

/*+ create */
INSERT INTO google.compute.network_firewall_policies (
project,
name,
description,
rules,
fingerprint,
associations,
ruleTupleCount,
shortName,
displayName,
parent,
region
)
SELECT 
'{{ project }}',
'{{ name }}',
'{{ description }}',
'{{ rules }}',
'{{ fingerprint }}',
'{{ associations }}',
'{{ ruleTupleCount }}',
'{{ shortName }}',
'{{ displayName }}',
'{{ parent }}',
'{{ region }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: rules
      value:
        - - name: kind
            value: string
          - name: ruleName
            value: string
          - name: description
            value: string
          - name: priority
            value: integer
          - name: match
            value:
              - name: srcIpRanges
                value:
                  - string
              - name: destIpRanges
                value:
                  - string
              - name: layer4Configs
                value:
                  - - name: ipProtocol
                      value: string
                    - name: ports
                      value:
                        - string
              - name: srcSecureTags
                value:
                  - - name: name
                      value: string
                    - name: state
                      value: string
              - name: destAddressGroups
                value:
                  - string
              - name: srcAddressGroups
                value:
                  - string
              - name: srcFqdns
                value:
                  - string
              - name: destFqdns
                value:
                  - string
              - name: srcRegionCodes
                value:
                  - string
              - name: destRegionCodes
                value:
                  - string
              - name: destThreatIntelligences
                value:
                  - string
              - name: srcThreatIntelligences
                value:
                  - string
          - name: action
            value: string
          - name: securityProfileGroup
            value: string
          - name: tlsInspect
            value: boolean
          - name: direction
            value: string
          - name: targetResources
            value:
              - string
          - name: enableLogging
            value: boolean
          - name: ruleTupleCount
            value: integer
          - name: targetServiceAccounts
            value:
              - string
          - name: targetSecureTags
            value:
              - - name: name
                  value: string
                - name: state
                  value: string
          - name: disabled
            value: boolean
    - name: fingerprint
      value: string
    - name: selfLink
      value: string
    - name: selfLinkWithId
      value: string
    - name: associations
      value:
        - - name: name
            value: string
          - name: attachmentTarget
            value: string
          - name: firewallPolicyId
            value: string
          - name: shortName
            value: string
          - name: displayName
            value: string
    - name: ruleTupleCount
      value: integer
    - name: shortName
      value: string
    - name: displayName
      value: string
    - name: parent
      value: string
    - name: region
      value: string

UPDATE example

Updates a network_firewall_policies resource.

/*+ update */
UPDATE google.compute.network_firewall_policies
SET 
name = '{{ name }}',
description = '{{ description }}',
rules = '{{ rules }}',
fingerprint = '{{ fingerprint }}',
associations = '{{ associations }}',
ruleTupleCount = '{{ ruleTupleCount }}',
shortName = '{{ shortName }}',
displayName = '{{ displayName }}',
parent = '{{ parent }}',
region = '{{ region }}'
WHERE 
firewallPolicy = '{{ firewallPolicy }}'
AND project = '{{ project }}';

DELETE example

Deletes the specified network_firewall_policies resource.

/*+ delete */
DELETE FROM google.compute.network_firewall_policies
WHERE firewallPolicy = '{{ firewallPolicy }}'
AND project = '{{ project }}';