gateway_security_policies

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

Overview

Name	gateway_security_policies
Type	Resource
Id	google.networksecurity.gateway_security_policies

Fields

The following fields are returned by SELECT queries:

projects_locations_gateway_security_policies_get

Successful response

Name	Datatype	Description
name	string	Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy} gateway_security_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. Free-text description of the resource.
tlsInspectionPolicy	string	Optional. Name of a TLS Inspection Policy resource that defines how TLS inspection will be performed for any rule(s) which enables it.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

projects_locations_gateway_security_policies_list

Successful response

Name	Datatype	Description
name	string	Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy} gateway_security_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. Free-text description of the resource.
tlsInspectionPolicy	string	Optional. Name of a TLS Inspection Policy resource that defines how TLS inspection will be performed for any rule(s) which enables it.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_gateway_security_policies_get	select	projectsId, locationsId, gatewaySecurityPoliciesId		Gets details of a single GatewaySecurityPolicy.
projects_locations_gateway_security_policies_list	select	projectsId, locationsId	pageSize, pageToken	Lists GatewaySecurityPolicies in a given project and location.
projects_locations_gateway_security_policies_create	insert	projectsId, locationsId	gatewaySecurityPolicyId	Creates a new GatewaySecurityPolicy in a given project and location.
projects_locations_gateway_security_policies_patch	update	projectsId, locationsId, gatewaySecurityPoliciesId	updateMask	Updates the parameters of a single GatewaySecurityPolicy.
projects_locations_gateway_security_policies_delete	delete	projectsId, locationsId, gatewaySecurityPoliciesId		Deletes a single GatewaySecurityPolicy.

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
gatewaySecurityPoliciesId	string
locationsId	string
projectsId	string
gatewaySecurityPolicyId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_gateway_security_policies_get

Gets details of a single GatewaySecurityPolicy.

SELECT
name,
createTime,
description,
tlsInspectionPolicy,
updateTime
FROM google.networksecurity.gateway_security_policies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND gatewaySecurityPoliciesId = '{{ gatewaySecurityPoliciesId }}' -- required;

projects_locations_gateway_security_policies_list

Lists GatewaySecurityPolicies in a given project and location.

SELECT
name,
createTime,
description,
tlsInspectionPolicy,
updateTime
FROM google.networksecurity.gateway_security_policies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_gateway_security_policies_create

Creates a new GatewaySecurityPolicy in a given project and location.

INSERT INTO google.networksecurity.gateway_security_policies (
data__name,
data__description,
data__tlsInspectionPolicy,
projectsId,
locationsId,
gatewaySecurityPolicyId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ tlsInspectionPolicy }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ gatewaySecurityPolicyId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: gateway_security_policies
  props:
    - name: projectsId
      value: string
      description: Required parameter for the gateway_security_policies resource.
    - name: locationsId
      value: string
      description: Required parameter for the gateway_security_policies resource.
    - name: name
      value: string
      description: >
        Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy} gateway_security_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
        
    - name: description
      value: string
      description: >
        Optional. Free-text description of the resource.
        
    - name: tlsInspectionPolicy
      value: string
      description: >
        Optional. Name of a TLS Inspection Policy resource that defines how TLS inspection will be performed for any rule(s) which enables it.
        
    - name: gatewaySecurityPolicyId
      value: string

UPDATE examples

projects_locations_gateway_security_policies_patch

Updates the parameters of a single GatewaySecurityPolicy.

UPDATE google.networksecurity.gateway_security_policies
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__tlsInspectionPolicy = '{{ tlsInspectionPolicy }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND gatewaySecurityPoliciesId = '{{ gatewaySecurityPoliciesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_gateway_security_policies_delete

Deletes a single GatewaySecurityPolicy.

DELETE FROM google.networksecurity.gateway_security_policies
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND gatewaySecurityPoliciesId = '{{ gatewaySecurityPoliciesId }}' --required;