# REST Resource: organizations.locations.addressGroups

- [Resource: AddressGroup](https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups#AddressGroup)
  - [JSON representation](https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups#AddressGroup.SCHEMA_REPRESENTATION)
  - [Type](https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups#AddressGroup.Type)
  - [Purpose](https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups#AddressGroup.Purpose)
- [Methods](https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups#METHODS_SUMMARY)

## Resource: AddressGroup

AddressGroup is a resource that specifies how a collection of IP/DNS used in Firewall Policy.

| JSON representation |
|---|
| ``` { "name": string, "description": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "type": enum (`https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups#AddressGroup.Type`), "items": [ string ], "capacity": integer, "selfLink": string, "purpose": [ enum (`https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups#AddressGroup.Purpose`) ] } ``` |

| Fields ||
|---|---|
| `name` | `string` Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/<addressGroup>`. |
| `description` | `string` Optional. Free-text description of the resource. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `labels` | `map (key: string, value: string)` Optional. Set of label tags associated with the AddressGroup resource. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |
| `type` | ``enum (`https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups#AddressGroup.Type`)`` Required. The type of the Address Group. Possible values are "IPv4" or "IPV6". |
| `items[]` | `string` Optional. List of items. |
| `capacity` | `integer` Required. Capacity of the Address Group |
| `selfLink` | `string` Output only. Server-defined fully-qualified URL for this resource. |
| `purpose[]` | ``enum (`https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups#AddressGroup.Purpose`)`` Optional. List of supported purposes of the Address Group. |

### Type

Possible type of the Address Group.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Default value. |
| `IPV4` | IP v4 ranges. |
| `IPV6` | IP v6 ranges. |

### Purpose

Purpose of the Address Group.

| Enums ||
|---|---|
| `PURPOSE_UNSPECIFIED` | Default value. Should never happen. |
| `DEFAULT` | Address Group is distributed to VMC, and is usable in Firewall Policies and other systems that rely on VMC. |
| `CLOUD_ARMOR` | Address Group is usable in Cloud Armor. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups/addItems` | Adds items to an address group. |
| ### `https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups/cloneItems` | Clones items from one address group to another. |
| ### `https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups/create` | Creates a new address group in a given project and location. |
| ### `https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups/delete` | Deletes an address group. |
| ### `https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups/get` | Gets details of a single address group. |
| ### `https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups/list` | Lists address groups in a given project and location. |
| ### `https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups/listReferences` | Lists references of an address group. |
| ### `https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups/patch` | Updates parameters of an address group. |
| ### `https://docs.cloud.google.com/service-mesh/v1.21/docs/reference/network-security/rest/v1beta1/organizations.locations.addressGroups/removeItems` | Removes items from an address group. |