sac_realms

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

Overview

Name	sac_realms
Type	Resource
Id	google.networksecurity.sac_realms

Fields

The following fields are returned by SELECT queries:

projects_locations_sac_realms_get

Name	Datatype	Description
name	string	Identifier. Resource name, in the form projects/{project}/locations/global/sacRealms/{sacRealm}.
createTime	string (google-datetime)	Output only. Timestamp when the realm was created.
labels	object	Optional. Optional list of labels applied to the resource.
pairingKey	object	Output only. Key to be shared with SSE service provider during pairing. (id: SACRealmPairingKey)
securityService	string	Immutable. SSE service provider associated with the realm. (SECURITY_SERVICE_UNSPECIFIED, PALO_ALTO_PRISMA_ACCESS)
state	string	Output only. State of the realm. (STATE_UNSPECIFIED, PENDING_PARTNER_ATTACHMENT, PARTNER_ATTACHED, PARTNER_DETACHED, KEY_EXPIRED)
updateTime	string (google-datetime)	Output only. Timestamp when the realm was last updated.

projects_locations_sac_realms_list

Name	Datatype	Description
name	string	Identifier. Resource name, in the form projects/{project}/locations/global/sacRealms/{sacRealm}.
createTime	string (google-datetime)	Output only. Timestamp when the realm was created.
labels	object	Optional. Optional list of labels applied to the resource.
pairingKey	object	Output only. Key to be shared with SSE service provider during pairing. (id: SACRealmPairingKey)
securityService	string	Immutable. SSE service provider associated with the realm. (SECURITY_SERVICE_UNSPECIFIED, PALO_ALTO_PRISMA_ACCESS)
state	string	Output only. State of the realm. (STATE_UNSPECIFIED, PENDING_PARTNER_ATTACHMENT, PARTNER_ATTACHED, PARTNER_DETACHED, KEY_EXPIRED)
updateTime	string (google-datetime)	Output only. Timestamp when the realm was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_sac_realms_get	select	projectsId, locationsId, sacRealmsId		Returns the specified realm.
projects_locations_sac_realms_list	select	projectsId, locationsId	pageToken, orderBy, filter, pageSize	Lists SACRealms in a given project.
projects_locations_sac_realms_create	insert	projectsId, locationsId	sacRealmId, requestId	Creates a new SACRealm in a given project.
projects_locations_sac_realms_delete	delete	projectsId, locationsId, sacRealmsId	requestId	Deletes the specified realm.

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
projectsId	string
sacRealmsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
sacRealmId	string

SELECT examples

projects_locations_sac_realms_get

Returns the specified realm.

SELECT
name,
createTime,
labels,
pairingKey,
securityService,
state,
updateTime
FROM google.networksecurity.sac_realms
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sacRealmsId = '{{ sacRealmsId }}' -- required
;

projects_locations_sac_realms_list

Lists SACRealms in a given project.

SELECT
name,
createTime,
labels,
pairingKey,
securityService,
state,
updateTime
FROM google.networksecurity.sac_realms
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

projects_locations_sac_realms_create

Creates a new SACRealm in a given project.

INSERT INTO google.networksecurity.sac_realms (
data__labels,
data__securityService,
data__name,
projectsId,
locationsId,
sacRealmId,
requestId
)
SELECT 
'{{ labels }}',
'{{ securityService }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ sacRealmId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: sac_realms
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the sac_realms resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the sac_realms resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Optional list of labels applied to the resource.
  - name: securityService
    value: "{{ securityService }}"
    description: |
      Immutable. SSE service provider associated with the realm.
    valid_values: ['SECURITY_SERVICE_UNSPECIFIED', 'PALO_ALTO_PRISMA_ACCESS']
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Resource name, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.
  - name: sacRealmId
    value: "{{ sacRealmId }}"
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

projects_locations_sac_realms_delete

Deletes the specified realm.

DELETE FROM google.networksecurity.sac_realms
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND sacRealmsId = '{{ sacRealmsId }}' --required
AND requestId = '{{ requestId }}'
;