Skip to main content

groups

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

Overview

Namegroups
TypeResource
Idgoogle.networkconnectivity.groups

Fields

NameDatatypeDescription
namestringImmutable. The name of the group. Group names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub}/groups/{group_id}
descriptionstringOptional. The description of the group.
autoAcceptobjectThe auto-accept setting for a group controls whether proposed spokes are automatically attached to the hub. If auto-accept is enabled, the spoke immediately is attached to the hub and becomes part of the group. In this case, the new spoke is in the ACTIVE state. If auto-accept is disabled, the spoke goes to the INACTIVE state, and it must be reviewed and accepted by a hub administrator.
createTimestringOutput only. The time the group was created.
labelsobjectOptional. Labels in key-value pair format. For more information about labels, see Requirements for labels.
routeTablestringOutput only. The name of the route table that corresponds to this group. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}
statestringOutput only. The current lifecycle state of this group.
uidstringOutput only. The Google-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different unique_id.
updateTimestringOutput only. The time the group was last updated.

Methods

NameAccessible byRequired ParamsDescription
getSELECTgroupsId, hubsId, projectsIdGets details about a Network Connectivity Center group.
listSELECThubsId, projectsIdLists groups in a given hub.
patchUPDATEgroupsId, hubsId, projectsIdUpdates the parameters of a Network Connectivity Center group.

SELECT examples

Lists groups in a given hub.

SELECT
name,
description,
autoAccept,
createTime,
labels,
routeTable,
state,
uid,
updateTime
FROM google.networkconnectivity.groups
WHERE hubsId = '{{ hubsId }}'
AND projectsId = '{{ projectsId }}';

UPDATE example

Updates a groups resource.

/*+ update */
UPDATE google.networkconnectivity.groups
SET
name = '{{ name }}',
labels = '{{ labels }}',
description = '{{ description }}',
autoAccept = '{{ autoAccept }}'
WHERE
groupsId = '{{ groupsId }}'
AND hubsId = '{{ hubsId }}'
AND projectsId = '{{ projectsId }}';