Skip to main content

organization_security_policies

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

Overview

Nameorganization_security_policies
TypeResource
Idgoogle.compute.organization_security_policies

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (uint64)Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
adaptiveProtectionConfigobjectConfiguration options for Cloud Armor Adaptive Protection (CAAP). (id: SecurityPolicyAdaptiveProtectionConfig)
advancedOptionsConfigobject (id: SecurityPolicyAdvancedOptionsConfig)
associationsarrayA list of associations that belong to this policy.
creationTimestampstringOutput only. [Output Only] Creation timestamp inRFC3339 text format.
ddosProtectionConfigobject (id: SecurityPolicyDdosProtectionConfig)
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
fingerprintstring (byte)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 error412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.
kindstringOutput only. [Output only] Type of the resource. Alwayscompute#securityPolicyfor security policies (default: compute#securityPolicy)
labelFingerprintstring (byte)A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.
labelsobjectLabels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
parentstringOutput only. [Output Only] The parent of the security policy.
recaptchaOptionsConfigobject (id: SecurityPolicyRecaptchaOptionsConfig)
regionstringOutput only. [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
rulesarrayA list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "" for srcIpRanges and for the networkMatch condition every field must be either match "" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
selfLinkstringOutput only. [Output Only] Server-defined URL for the resource.
shortNamestringUser-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
typestringThe type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. (CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK)
userDefinedFieldsarrayDefinitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectsecurityPolicyList all of the ordered rules present in a single specified policy.

Use this API to read Cloud Armor policies. Previously, alpha and beta
versions of this API were used to read firewall policies. This usage is now
disabled for most organizations. Use firewallPolicies.get instead.
listselectreturnPartialSuccess, parentId, orderBy, filter, maxResults, pageTokenList all the policies that have been configured for the specified
organization.

Use this API to read Cloud Armor policies. Previously, alpha and beta
versions of this API were used to read firewall policies. This usage is now
disabled for most organizations. Use firewallPolicies.list instead.
insertinsertparentId, requestIdCreates a new policy in the specified organization using the data included
in the request.

Use this API to add Cloud Armor policies. Previously, alpha and beta
versions of this API were used to add firewall policies. This usage is now
disabled for most organizations. Use firewallPolicies.insert instead.
patchupdatesecurityPolicyrequestIdPatches the specified policy with the data included in the request.

Use this API to modify Cloud Armor policies. Previously, alpha and beta
versions of this API were used to modify firewall policies. This usage is
now disabled for most organizations. Use firewallPolicies.patch instead.
patch_ruleupdatesecurityPolicypriority, requestIdPatches a rule at the specified priority.

Use this API to modify Cloud Armor policies. Previously, alpha and beta
versions of this API were used to modify firewall policies. This usage is
now disabled for most organizations. Use firewallPolicies.patchRule
instead.
deletedeletesecurityPolicyrequestIdDeletes the specified policy.

Use this API to remove Cloud Armor policies. Previously, alpha and beta
versions of this API were used to remove firewall policies. This usage is
now disabled for most organizations. Use firewallPolicies.delete instead.
moveexecsecurityPolicyparentId, requestIdMoves the specified security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta
versions of this API were used to modify firewall policies. This usage is
now disabled for most organizations. Use firewallPolicies.move instead.
copy_rulesexecsecurityPolicysourceSecurityPolicy, requestIdCopies rules to the specified security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta
versions of this API were used to modify firewall policies. This usage is
now disabled for most organizations. Use firewallPolicies.cloneRules
instead.

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.

NameDatatypeDescription
securityPolicystring
filterstring
maxResultsinteger (uint32)
orderBystring
pageTokenstring
parentIdstring
priorityinteger (int32)
requestIdstring
returnPartialSuccessboolean
sourceSecurityPolicystring

SELECT examples

List all of the ordered rules present in a single specified policy.

Use this API to read Cloud Armor policies. Previously, alpha and beta
versions of this API were used to read firewall policies. This usage is now
disabled for most organizations. Use firewallPolicies.get instead.

SELECT
id,
name,
adaptiveProtectionConfig,
advancedOptionsConfig,
associations,
creationTimestamp,
ddosProtectionConfig,
description,
fingerprint,
kind,
labelFingerprint,
labels,
parent,
recaptchaOptionsConfig,
region,
rules,
selfLink,
shortName,
type,
userDefinedFields
FROM google.compute.organization_security_policies
WHERE securityPolicy = '{{ securityPolicy }}' -- required
;

INSERT examples

Creates a new policy in the specified organization using the data included
in the request.

Use this API to add Cloud Armor policies. Previously, alpha and beta
versions of this API were used to add firewall policies. This usage is now
disabled for most organizations. Use firewallPolicies.insert instead.

INSERT INTO google.compute.organization_security_policies (
data__recaptchaOptionsConfig,
data__type,
data__labelFingerprint,
data__name,
data__advancedOptionsConfig,
data__rules,
data__userDefinedFields,
data__labels,
data__description,
data__fingerprint,
data__ddosProtectionConfig,
data__associations,
data__adaptiveProtectionConfig,
data__shortName,
parentId,
requestId
)
SELECT
'{{ recaptchaOptionsConfig }}',
'{{ type }}',
'{{ labelFingerprint }}',
'{{ name }}',
'{{ advancedOptionsConfig }}',
'{{ rules }}',
'{{ userDefinedFields }}',
'{{ labels }}',
'{{ description }}',
'{{ fingerprint }}',
'{{ ddosProtectionConfig }}',
'{{ associations }}',
'{{ adaptiveProtectionConfig }}',
'{{ shortName }}',
'{{ parentId }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

UPDATE examples

Patches the specified policy with the data included in the request.

Use this API to modify Cloud Armor policies. Previously, alpha and beta
versions of this API were used to modify firewall policies. This usage is
now disabled for most organizations. Use firewallPolicies.patch instead.

UPDATE google.compute.organization_security_policies
SET
data__recaptchaOptionsConfig = '{{ recaptchaOptionsConfig }}',
data__type = '{{ type }}',
data__labelFingerprint = '{{ labelFingerprint }}',
data__name = '{{ name }}',
data__advancedOptionsConfig = '{{ advancedOptionsConfig }}',
data__rules = '{{ rules }}',
data__userDefinedFields = '{{ userDefinedFields }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__fingerprint = '{{ fingerprint }}',
data__ddosProtectionConfig = '{{ ddosProtectionConfig }}',
data__associations = '{{ associations }}',
data__adaptiveProtectionConfig = '{{ adaptiveProtectionConfig }}',
data__shortName = '{{ shortName }}'
WHERE
securityPolicy = '{{ securityPolicy }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples

Deletes the specified policy.

Use this API to remove Cloud Armor policies. Previously, alpha and beta
versions of this API were used to remove firewall policies. This usage is
now disabled for most organizations. Use firewallPolicies.delete instead.

DELETE FROM google.compute.organization_security_policies
WHERE securityPolicy = '{{ securityPolicy }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

Moves the specified security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta
versions of this API were used to modify firewall policies. This usage is
now disabled for most organizations. Use firewallPolicies.move instead.

EXEC google.compute.organization_security_policies.move
@securityPolicy='{{ securityPolicy }}' --required,
@parentId='{{ parentId }}',
@requestId='{{ requestId }}'
;