dest_groups

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

Overview

Name	dest_groups
Type	Resource
Id	google.iap.dest_groups

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Identifier for the TunnelDestGroup. Must be unique within the project and contain only lower case letters (a-z) and dashes (-).
cidrs	array	Optional. Unordered list. List of CIDRs that this group applies to.
fqdns	array	Optional. Unordered list. List of FQDNs that this group applies to.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Identifier for the TunnelDestGroup. Must be unique within the project and contain only lower case letters (a-z) and dashes (-).
cidrs	array	Optional. Unordered list. List of CIDRs that this group applies to.
fqdns	array	Optional. Unordered list. List of FQDNs that this group applies to.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, destGroupsId		Retrieves an existing TunnelDestGroup.
list	select	projectsId, locationsId	pageSize, pageToken	Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups
create	insert	projectsId, locationsId	tunnelDestGroupId	Creates a new TunnelDestGroup.
patch	update	projectsId, locationsId, destGroupsId	updateMask	Updates a TunnelDestGroup.
delete	delete	projectsId, locationsId, destGroupsId		Deletes a TunnelDestGroup.

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

SELECT examples

get

Retrieves an existing TunnelDestGroup.

SELECT
name,
cidrs,
fqdns
FROM google.iap.dest_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND destGroupsId = '{{ destGroupsId }}' -- required;

list

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

SELECT
name,
cidrs,
fqdns
FROM google.iap.dest_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a new TunnelDestGroup.

INSERT INTO google.iap.dest_groups (
data__name,
data__cidrs,
data__fqdns,
projectsId,
locationsId,
tunnelDestGroupId
)
SELECT 
'{{ name }}',
'{{ cidrs }}',
'{{ fqdns }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ tunnelDestGroupId }}'
RETURNING
name,
cidrs,
fqdns
;

Manifest

# Description fields are for documentation purposes
- name: dest_groups
  props:
    - name: projectsId
      value: string
      description: Required parameter for the dest_groups resource.
    - name: locationsId
      value: string
      description: Required parameter for the dest_groups resource.
    - name: name
      value: string
      description: >
        Identifier. Identifier for the TunnelDestGroup. Must be unique within the project and contain only lower case letters (a-z) and dashes (-).
        
    - name: cidrs
      value: array
      description: >
        Optional. Unordered list. List of CIDRs that this group applies to.
        
    - name: fqdns
      value: array
      description: >
        Optional. Unordered list. List of FQDNs that this group applies to.
        
    - name: tunnelDestGroupId
      value: string

UPDATE examples

patch

Updates a TunnelDestGroup.

UPDATE google.iap.dest_groups
SET 
data__name = '{{ name }}',
data__cidrs = '{{ cidrs }}',
data__fqdns = '{{ fqdns }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND destGroupsId = '{{ destGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
cidrs,
fqdns;

DELETE examples

delete

Deletes a TunnelDestGroup.

DELETE FROM google.iap.dest_groups
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND destGroupsId = '{{ destGroupsId }}' --required;