address_groups

Creates, updates, deletes, gets or lists an address_groups resource.

Overview

Name	address_groups
Type	Resource
Id	google.networksecurity.address_groups

Fields

The following fields are returned by SELECT queries:

projects_locations_address_groups_get

Successful response

Name	Datatype	Description
name	string	Required. Name of the AddressGroup resource. It matches pattern projects/*/locations/{location}/addressGroups/.
capacity	integer (int32)	Required. Capacity of the Address Group
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. Free-text description of the resource.
items	array	Optional. List of items.
labels	object	Optional. Set of label tags associated with the AddressGroup resource.
purpose	array	Optional. List of supported purposes of the Address Group.
selfLink	string	Output only. Server-defined fully-qualified URL for this resource.
type	string	Required. The type of the Address Group. Possible values are "IPv4" or "IPV6".
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

organizations_locations_address_groups_get

Successful response

Name	Datatype	Description
name	string	Required. Name of the AddressGroup resource. It matches pattern projects/*/locations/{location}/addressGroups/.
capacity	integer (int32)	Required. Capacity of the Address Group
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. Free-text description of the resource.
items	array	Optional. List of items.
labels	object	Optional. Set of label tags associated with the AddressGroup resource.
purpose	array	Optional. List of supported purposes of the Address Group.
selfLink	string	Output only. Server-defined fully-qualified URL for this resource.
type	string	Required. The type of the Address Group. Possible values are "IPv4" or "IPV6".
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

projects_locations_address_groups_list

Successful response

Name	Datatype	Description
name	string	Required. Name of the AddressGroup resource. It matches pattern projects/*/locations/{location}/addressGroups/.
capacity	integer (int32)	Required. Capacity of the Address Group
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. Free-text description of the resource.
items	array	Optional. List of items.
labels	object	Optional. Set of label tags associated with the AddressGroup resource.
purpose	array	Optional. List of supported purposes of the Address Group.
selfLink	string	Output only. Server-defined fully-qualified URL for this resource.
type	string	Required. The type of the Address Group. Possible values are "IPv4" or "IPV6".
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

organizations_locations_address_groups_list

Successful response

Name	Datatype	Description
name	string	Required. Name of the AddressGroup resource. It matches pattern projects/*/locations/{location}/addressGroups/.
capacity	integer (int32)	Required. Capacity of the Address Group
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. Free-text description of the resource.
items	array	Optional. List of items.
labels	object	Optional. Set of label tags associated with the AddressGroup resource.
purpose	array	Optional. List of supported purposes of the Address Group.
selfLink	string	Output only. Server-defined fully-qualified URL for this resource.
type	string	Required. The type of the Address Group. Possible values are "IPv4" or "IPV6".
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_address_groups_get	select	projectsId, locationsId, addressGroupsId		Gets details of a single address group.
organizations_locations_address_groups_get	select	organizationsId, locationsId, addressGroupsId		Gets details of a single address group.
projects_locations_address_groups_list	select	projectsId, locationsId	pageSize, pageToken, returnPartialSuccess	Lists address groups in a given project and location.
organizations_locations_address_groups_list	select	organizationsId, locationsId	pageSize, pageToken, returnPartialSuccess	Lists address groups in a given project and location.
projects_locations_address_groups_create	insert	projectsId, locationsId	addressGroupId, requestId	Creates a new address group in a given project and location.
organizations_locations_address_groups_create	insert	organizationsId, locationsId	addressGroupId, requestId	Creates a new address group in a given project and location.
projects_locations_address_groups_patch	update	projectsId, locationsId, addressGroupsId	updateMask, requestId	Updates the parameters of a single address group.
organizations_locations_address_groups_patch	update	organizationsId, locationsId, addressGroupsId	updateMask, requestId	Updates parameters of an address group.
projects_locations_address_groups_delete	delete	projectsId, locationsId, addressGroupsId	requestId	Deletes a single address group.
organizations_locations_address_groups_delete	delete	organizationsId, locationsId, addressGroupsId	requestId	Deletes an address group.
projects_locations_address_groups_clone_items	exec	projectsId, locationsId, addressGroupsId		Clones items from one address group to another.
organizations_locations_address_groups_clone_items	exec	organizationsId, locationsId, addressGroupsId		Clones items from one address group to another.

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
addressGroupsId	string
locationsId	string
organizationsId	string
projectsId	string
addressGroupId	string
pageSize	integer (int32)
pageToken	string
requestId	string
returnPartialSuccess	boolean
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_address_groups_get

Gets details of a single address group.

SELECT
name,
capacity,
createTime,
description,
items,
labels,
purpose,
selfLink,
type,
updateTime
FROM google.networksecurity.address_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND addressGroupsId = '{{ addressGroupsId }}' -- required;

organizations_locations_address_groups_get

Gets details of a single address group.

SELECT
name,
capacity,
createTime,
description,
items,
labels,
purpose,
selfLink,
type,
updateTime
FROM google.networksecurity.address_groups
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND addressGroupsId = '{{ addressGroupsId }}' -- required;

projects_locations_address_groups_list

Lists address groups in a given project and location.

SELECT
name,
capacity,
createTime,
description,
items,
labels,
purpose,
selfLink,
type,
updateTime
FROM google.networksecurity.address_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

organizations_locations_address_groups_list

Lists address groups in a given project and location.

SELECT
name,
capacity,
createTime,
description,
items,
labels,
purpose,
selfLink,
type,
updateTime
FROM google.networksecurity.address_groups
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

projects_locations_address_groups_create

Creates a new address group in a given project and location.

INSERT INTO google.networksecurity.address_groups (
data__name,
data__description,
data__labels,
data__type,
data__items,
data__capacity,
data__purpose,
projectsId,
locationsId,
addressGroupId,
requestId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ type }}',
'{{ items }}',
{{ capacity }},
'{{ purpose }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ addressGroupId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

organizations_locations_address_groups_create

Creates a new address group in a given project and location.

INSERT INTO google.networksecurity.address_groups (
data__name,
data__description,
data__labels,
data__type,
data__items,
data__capacity,
data__purpose,
organizationsId,
locationsId,
addressGroupId,
requestId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ type }}',
'{{ items }}',
{{ capacity }},
'{{ purpose }}',
'{{ organizationsId }}',
'{{ locationsId }}',
'{{ addressGroupId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: address_groups
  props:
    - name: projectsId
      value: string
      description: Required parameter for the address_groups resource.
    - name: locationsId
      value: string
      description: Required parameter for the address_groups resource.
    - name: organizationsId
      value: string
      description: Required parameter for the address_groups resource.
    - name: name
      value: string
      description: >
        Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`.
        
    - name: description
      value: string
      description: >
        Optional. Free-text description of the resource.
        
    - name: labels
      value: object
      description: >
        Optional. Set of label tags associated with the AddressGroup resource.
        
    - name: type
      value: string
      description: >
        Required. The type of the Address Group. Possible values are "IPv4" or "IPV6".
        
      valid_values: ['TYPE_UNSPECIFIED', 'IPV4', 'IPV6']
    - name: items
      value: array
      description: >
        Optional. List of items.
        
    - name: capacity
      value: integer
      description: >
        Required. Capacity of the Address Group
        
    - name: purpose
      value: array
      description: >
        Optional. List of supported purposes of the Address Group.
        
    - name: addressGroupId
      value: string
    - name: requestId
      value: string

UPDATE examples

projects_locations_address_groups_patch

Updates the parameters of a single address group.

UPDATE google.networksecurity.address_groups
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__type = '{{ type }}',
data__items = '{{ items }}',
data__capacity = {{ capacity }},
data__purpose = '{{ purpose }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND addressGroupsId = '{{ addressGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

organizations_locations_address_groups_patch

Updates parameters of an address group.

UPDATE google.networksecurity.address_groups
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__type = '{{ type }}',
data__items = '{{ items }}',
data__capacity = {{ capacity }},
data__purpose = '{{ purpose }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND addressGroupsId = '{{ addressGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_address_groups_delete

Deletes a single address group.

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

organizations_locations_address_groups_delete

Deletes an address group.

DELETE FROM google.networksecurity.address_groups
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND addressGroupsId = '{{ addressGroupsId }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods

projects_locations_address_groups_clone_items

Clones items from one address group to another.

EXEC google.networksecurity.address_groups.projects_locations_address_groups_clone_items 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@addressGroupsId='{{ addressGroupsId }}' --required 
@@json=
'{
"sourceAddressGroup": "{{ sourceAddressGroup }}", 
"requestId": "{{ requestId }}"
}';

organizations_locations_address_groups_clone_items

Clones items from one address group to another.

EXEC google.networksecurity.address_groups.organizations_locations_address_groups_clone_items 
@organizationsId='{{ organizationsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@addressGroupsId='{{ addressGroupsId }}' --required 
@@json=
'{
"sourceAddressGroup": "{{ sourceAddressGroup }}", 
"requestId": "{{ requestId }}"
}';