security_profile_groups

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

Overview

Name	security_profile_groups
Type	Resource
Id	google.networksecurity.security_profile_groups

Fields

The following fields are returned by SELECT queries:

projects_locations_security_profile_groups_get

Name	Datatype	Description
name	string	Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}.
createTime	string (google-datetime)	Output only. Resource creation timestamp.
customInterceptProfile	string	Optional. Reference to a SecurityProfile with the CustomIntercept configuration.
customMirroringProfile	string	Optional. Reference to a SecurityProfile with the CustomMirroring configuration.
dataPathId	string (uint64)	Output only. Identifier used by the data-path. Unique within {container, location}.
description	string	Optional. An optional description of the profile group. Max length 2048 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	string	Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.
updateTime	string (google-datetime)	Output only. Last resource update timestamp.
urlFilteringProfile	string	Optional. Reference to a SecurityProfile with the UrlFiltering configuration.

organizations_locations_security_profile_groups_get

Name	Datatype	Description
name	string	Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}.
createTime	string (google-datetime)	Output only. Resource creation timestamp.
customInterceptProfile	string	Optional. Reference to a SecurityProfile with the CustomIntercept configuration.
customMirroringProfile	string	Optional. Reference to a SecurityProfile with the CustomMirroring configuration.
dataPathId	string (uint64)	Output only. Identifier used by the data-path. Unique within {container, location}.
description	string	Optional. An optional description of the profile group. Max length 2048 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	string	Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.
updateTime	string (google-datetime)	Output only. Last resource update timestamp.
urlFilteringProfile	string	Optional. Reference to a SecurityProfile with the UrlFiltering configuration.

projects_locations_security_profile_groups_list

Name	Datatype	Description
name	string	Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}.
createTime	string (google-datetime)	Output only. Resource creation timestamp.
customInterceptProfile	string	Optional. Reference to a SecurityProfile with the CustomIntercept configuration.
customMirroringProfile	string	Optional. Reference to a SecurityProfile with the CustomMirroring configuration.
dataPathId	string (uint64)	Output only. Identifier used by the data-path. Unique within {container, location}.
description	string	Optional. An optional description of the profile group. Max length 2048 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	string	Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.
updateTime	string (google-datetime)	Output only. Last resource update timestamp.
urlFilteringProfile	string	Optional. Reference to a SecurityProfile with the UrlFiltering configuration.

organizations_locations_security_profile_groups_list

Name	Datatype	Description
name	string	Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}.
createTime	string (google-datetime)	Output only. Resource creation timestamp.
customInterceptProfile	string	Optional. Reference to a SecurityProfile with the CustomIntercept configuration.
customMirroringProfile	string	Optional. Reference to a SecurityProfile with the CustomMirroring configuration.
dataPathId	string (uint64)	Output only. Identifier used by the data-path. Unique within {container, location}.
description	string	Optional. An optional description of the profile group. Max length 2048 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	string	Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.
updateTime	string (google-datetime)	Output only. Last resource update timestamp.
urlFilteringProfile	string	Optional. Reference to a SecurityProfile with the UrlFiltering configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_security_profile_groups_get	select	projectsId, locationsId, securityProfileGroupsId		Gets details of a single SecurityProfileGroup.
organizations_locations_security_profile_groups_get	select	organizationsId, locationsId, securityProfileGroupsId		Gets details of a single SecurityProfileGroup.
projects_locations_security_profile_groups_list	select	projectsId, locationsId	pageSize, pageToken	Lists SecurityProfileGroups in a given project and location.
organizations_locations_security_profile_groups_list	select	organizationsId, locationsId	pageSize, pageToken	Lists SecurityProfileGroups in a given organization and location.
projects_locations_security_profile_groups_create	insert	projectsId, locationsId	securityProfileGroupId	Creates a new SecurityProfileGroup in a given project and location.
organizations_locations_security_profile_groups_create	insert	organizationsId, locationsId	securityProfileGroupId	Creates a new SecurityProfileGroup in a given organization and location.
projects_locations_security_profile_groups_patch	update	projectsId, locationsId, securityProfileGroupsId	updateMask	Updates the parameters of a single SecurityProfileGroup.
organizations_locations_security_profile_groups_patch	update	organizationsId, locationsId, securityProfileGroupsId	updateMask	Updates the parameters of a single SecurityProfileGroup.
projects_locations_security_profile_groups_delete	delete	projectsId, locationsId, securityProfileGroupsId	etag	Deletes a single SecurityProfileGroup.
organizations_locations_security_profile_groups_delete	delete	organizationsId, locationsId, securityProfileGroupsId	etag	Deletes a single SecurityProfileGroup.

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
projectsId	string
securityProfileGroupsId	string
etag	string
pageSize	integer (int32)
pageToken	string
securityProfileGroupId	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_security_profile_groups_get

Gets details of a single SecurityProfileGroup.

SELECT
name,
createTime,
customInterceptProfile,
customMirroringProfile,
dataPathId,
description,
etag,
labels,
threatPreventionProfile,
updateTime,
urlFilteringProfile
FROM google.networksecurity.security_profile_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND securityProfileGroupsId = '{{ securityProfileGroupsId }}' -- required
;

organizations_locations_security_profile_groups_get

Gets details of a single SecurityProfileGroup.

SELECT
name,
createTime,
customInterceptProfile,
customMirroringProfile,
dataPathId,
description,
etag,
labels,
threatPreventionProfile,
updateTime,
urlFilteringProfile
FROM google.networksecurity.security_profile_groups
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND securityProfileGroupsId = '{{ securityProfileGroupsId }}' -- required
;

projects_locations_security_profile_groups_list

Lists SecurityProfileGroups in a given project and location.

SELECT
name,
createTime,
customInterceptProfile,
customMirroringProfile,
dataPathId,
description,
etag,
labels,
threatPreventionProfile,
updateTime,
urlFilteringProfile
FROM google.networksecurity.security_profile_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

organizations_locations_security_profile_groups_list

Lists SecurityProfileGroups in a given organization and location.

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

INSERT examples

projects_locations_security_profile_groups_create

Creates a new SecurityProfileGroup in a given project and location.

INSERT INTO google.networksecurity.security_profile_groups (
data__threatPreventionProfile,
data__urlFilteringProfile,
data__customInterceptProfile,
data__labels,
data__description,
data__customMirroringProfile,
data__name,
projectsId,
locationsId,
securityProfileGroupId
)
SELECT 
'{{ threatPreventionProfile }}',
'{{ urlFilteringProfile }}',
'{{ customInterceptProfile }}',
'{{ labels }}',
'{{ description }}',
'{{ customMirroringProfile }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ securityProfileGroupId }}'
RETURNING
name,
done,
error,
metadata,
response
;

organizations_locations_security_profile_groups_create

Creates a new SecurityProfileGroup in a given organization and location.

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

Manifest

# Description fields are for documentation purposes
- name: security_profile_groups
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the security_profile_groups resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the security_profile_groups resource.
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the security_profile_groups resource.
  - name: threatPreventionProfile
    value: "{{ threatPreventionProfile }}"
    description: |
      Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.
  - name: urlFilteringProfile
    value: "{{ urlFilteringProfile }}"
    description: |
      Optional. Reference to a SecurityProfile with the UrlFiltering configuration.
  - name: customInterceptProfile
    value: "{{ customInterceptProfile }}"
    description: |
      Optional. Reference to a SecurityProfile with the CustomIntercept configuration.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels as key value pairs.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. An optional description of the profile group. Max length 2048 characters.
  - name: customMirroringProfile
    value: "{{ customMirroringProfile }}"
    description: |
      Optional. Reference to a SecurityProfile with the CustomMirroring configuration.
  - name: name
    value: "{{ name }}"
    description: |
      Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.
  - name: securityProfileGroupId
    value: "{{ securityProfileGroupId }}"

UPDATE examples

projects_locations_security_profile_groups_patch

Updates the parameters of a single SecurityProfileGroup.

UPDATE google.networksecurity.security_profile_groups
SET 
data__threatPreventionProfile = '{{ threatPreventionProfile }}',
data__urlFilteringProfile = '{{ urlFilteringProfile }}',
data__customInterceptProfile = '{{ customInterceptProfile }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__customMirroringProfile = '{{ customMirroringProfile }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND securityProfileGroupsId = '{{ securityProfileGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

organizations_locations_security_profile_groups_patch

Updates the parameters of a single SecurityProfileGroup.

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

DELETE examples

projects_locations_security_profile_groups_delete

Deletes a single SecurityProfileGroup.

DELETE FROM google.networksecurity.security_profile_groups
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND securityProfileGroupsId = '{{ securityProfileGroupsId }}' --required
AND etag = '{{ etag }}'
;

organizations_locations_security_profile_groups_delete

Deletes a single SecurityProfileGroup.

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