security_profiles

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

Overview

Name	security_profiles
Type	Resource
Id	google.networksecurity.security_profiles

Fields

The following fields are returned by SELECT queries:

organizations_locations_security_profiles_get

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern projects|organizations/*/locations/{location}/securityProfiles/{security_profile}.
createTime	string (google-datetime)	Output only. Resource creation timestamp.
customInterceptProfile	object	The custom TPPI configuration for the SecurityProfile. (id: CustomInterceptProfile)
customMirroringProfile	object	The custom Packet Mirroring v2 configuration for the SecurityProfile. (id: CustomMirroringProfile)
description	string	Optional. An optional description of the profile. Max length 512 characters.
etag	string	Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels	object	Optional. Labels as key value pairs.
threatPreventionProfile	object	The threat prevention configuration for the SecurityProfile. (id: ThreatPreventionProfile)
type	string	Immutable. The single ProfileType that the SecurityProfile resource configures.
updateTime	string (google-datetime)	Output only. Last resource update timestamp.

organizations_locations_security_profiles_list

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern projects|organizations/*/locations/{location}/securityProfiles/{security_profile}.
createTime	string (google-datetime)	Output only. Resource creation timestamp.
customInterceptProfile	object	The custom TPPI configuration for the SecurityProfile. (id: CustomInterceptProfile)
customMirroringProfile	object	The custom Packet Mirroring v2 configuration for the SecurityProfile. (id: CustomMirroringProfile)
description	string	Optional. An optional description of the profile. Max length 512 characters.
etag	string	Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels	object	Optional. Labels as key value pairs.
threatPreventionProfile	object	The threat prevention configuration for the SecurityProfile. (id: ThreatPreventionProfile)
type	string	Immutable. The single ProfileType that the SecurityProfile resource configures.
updateTime	string (google-datetime)	Output only. Last resource update timestamp.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_locations_security_profiles_get	select	organizationsId, locationsId, securityProfilesId		Gets details of a single SecurityProfile.
organizations_locations_security_profiles_list	select	organizationsId, locationsId	pageSize, pageToken	Lists SecurityProfiles in a given organization and location.
organizations_locations_security_profiles_create	insert	organizationsId, locationsId	securityProfileId	Creates a new SecurityProfile in a given organization and location.
organizations_locations_security_profiles_patch	update	organizationsId, locationsId, securityProfilesId	updateMask	Updates the parameters of a single SecurityProfile.
organizations_locations_security_profiles_delete	delete	organizationsId, locationsId, securityProfilesId	etag	Deletes a single SecurityProfile.

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
locationsId	string
organizationsId	string
securityProfilesId	string
etag	string
pageSize	integer (int32)
pageToken	string
securityProfileId	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_locations_security_profiles_get

Gets details of a single SecurityProfile.

SELECT
name,
createTime,
customInterceptProfile,
customMirroringProfile,
description,
etag,
labels,
threatPreventionProfile,
type,
updateTime
FROM google.networksecurity.security_profiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND securityProfilesId = '{{ securityProfilesId }}' -- required;

organizations_locations_security_profiles_list

Lists SecurityProfiles in a given organization and location.

SELECT
name,
createTime,
customInterceptProfile,
customMirroringProfile,
description,
etag,
labels,
threatPreventionProfile,
type,
updateTime
FROM google.networksecurity.security_profiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_locations_security_profiles_create

Creates a new SecurityProfile in a given organization and location.

INSERT INTO google.networksecurity.security_profiles (
data__threatPreventionProfile,
data__customMirroringProfile,
data__customInterceptProfile,
data__name,
data__description,
data__labels,
data__type,
organizationsId,
locationsId,
securityProfileId
)
SELECT 
'{{ threatPreventionProfile }}',
'{{ customMirroringProfile }}',
'{{ customInterceptProfile }}',
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ type }}',
'{{ organizationsId }}',
'{{ locationsId }}',
'{{ securityProfileId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: security_profiles
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the security_profiles resource.
    - name: locationsId
      value: string
      description: Required parameter for the security_profiles resource.
    - name: threatPreventionProfile
      value: object
      description: >
        The threat prevention configuration for the SecurityProfile.
        
    - name: customMirroringProfile
      value: object
      description: >
        The custom Packet Mirroring v2 configuration for the SecurityProfile.
        
    - name: customInterceptProfile
      value: object
      description: >
        The custom TPPI configuration for the SecurityProfile.
        
    - name: name
      value: string
      description: >
        Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.
        
    - name: description
      value: string
      description: >
        Optional. An optional description of the profile. Max length 512 characters.
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs.
        
    - name: type
      value: string
      description: >
        Immutable. The single ProfileType that the SecurityProfile resource configures.
        
      valid_values: ['PROFILE_TYPE_UNSPECIFIED', 'THREAT_PREVENTION', 'CUSTOM_MIRRORING', 'CUSTOM_INTERCEPT']
    - name: securityProfileId
      value: string

UPDATE examples

organizations_locations_security_profiles_patch

Updates the parameters of a single SecurityProfile.

UPDATE google.networksecurity.security_profiles
SET 
data__threatPreventionProfile = '{{ threatPreventionProfile }}',
data__customMirroringProfile = '{{ customMirroringProfile }}',
data__customInterceptProfile = '{{ customInterceptProfile }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__type = '{{ type }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND securityProfilesId = '{{ securityProfilesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

organizations_locations_security_profiles_delete

Deletes a single SecurityProfile.

DELETE FROM google.networksecurity.security_profiles
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND securityProfilesId = '{{ securityProfilesId }}' --required
AND etag = '{{ etag }}';