2023-02-15
▼ ▲ networksecurity.organizations.locations.addressGroups.delete
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
Path: v1beta1/{+name}
Parameter Order: name
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
requestId
Type: string
Location: query
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
name
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Type: string
Description: Required. A name of the AddressGroup to delete. Must be in the format `projects/*/locations/{location}/addressGroups/*`.
Location: path
Description: Deletes an address group.
▼ ▲ networksecurity.organizations.locations.addressGroups.patch
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
Path: v1beta1/{+name}
Description: Updates parameters of an address group.
Parameters:
updateMask
Format: google-fieldmask
Type: string
Description: Optional. Field mask is used to specify the fields to be overwritten in the AddressGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Location: query
name
Description: Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`.
Location: path
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Required: Yes
requestId
Location: query
Type: string
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
▼ ▲ networksecurity.organizations.locations.addressGroups.get
Path: v1beta1/{+name}
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
Parameter Order: name
Description: Gets details of a single address group.
Parameters:
name
Description: Required. A name of the AddressGroup to get. Must be in the format `projects/*/locations/{location}/addressGroups/*`.
Location: path
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ networksecurity.organizations.locations.addressGroups.listReferences
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:listReferences
Parameter Order: addressGroup
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists references of an address group.
Path: v1beta1/{+addressGroup}:listReferences
HTTP Method: GET
Parameters:
pageSize
Location: query
Description: The maximum number of references to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more AddressGroupUsers left to be queried.
Format: int32
Type: integer
pageToken
Type: string
Description: The next_page_token value returned from a previous List request, if any.
Location: query
addressGroup
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Type: string
Location: path
Description: Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Required: Yes
▼ ▲ networksecurity.organizations.locations.addressGroups.addItems
HTTP Method: POST
Path: v1beta1/{+addressGroup}:addItems
Parameters:
addressGroup
Description: Required. A name of the AddressGroup to add items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Type: string
Location: path
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:addItems
Description: Adds items to an address group.
Parameter Order: addressGroup
▼ ▲ networksecurity.organizations.locations.addressGroups.list
HTTP Method: GET
Path: v1beta1/{+parent}/addressGroups
Parameters:
pageToken
Type: string
Description: The value returned by the last `ListAddressGroupsResponse` Indicates that this is a continuation of a prior `ListAddressGroups` call, and that the system should return the next page of data.
Location: query
pageSize
Description: Maximum number of AddressGroups to return per call.
Location: query
Format: int32
Type: integer
parent
Description: Required. The project and location from which the AddressGroups should be listed, specified in the format `projects/*/locations/{location}`.
Location: path
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+$
Required: Yes
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists address groups in a given project and location.
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/addressGroups
▼ ▲ networksecurity.organizations.locations.addressGroups.cloneItems
Parameters:
addressGroup
Required: Yes
Description: Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Type: string
Location: path
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Parameter Order: addressGroup
Path: v1beta1/{+addressGroup}:cloneItems
Description: Clones items from one address group to another.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:cloneItems
▼ ▲ networksecurity.organizations.locations.addressGroups.removeItems
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:removeItems
Description: Removes items from an address group.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+addressGroup}:removeItems
Parameter Order: addressGroup
HTTP Method: POST
Parameters:
addressGroup
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Description: Required. A name of the AddressGroup to remove items from. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Type: string
Location: path
▼ ▲ networksecurity.organizations.locations.addressGroups.create
HTTP Method: POST
Path: v1beta1/{+parent}/addressGroups
Parameter Order: parent
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type: string
Location: query
parent
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+$
Description: Required. The parent resource of the AddressGroup. Must be in the format `projects/*/locations/{location}`.
Required: Yes
Location: path
addressGroupId
Type: string
Description: Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".
Location: query
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/addressGroups
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new address group in a given project and location.
▼ ▲ networksecurity.projects.locations.addressGroups.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Required: Yes
Location: path
Description: Required. A name of the AddressGroup to get. Must be in the format `projects/*/locations/{location}/addressGroups/*`.
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
Path: v1beta1/{+name}
Description: Gets details of a single address group.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: GET
▼ ▲ networksecurity.projects.locations.addressGroups.listReferences
Path: v1beta1/{+addressGroup}:listReferences
Parameter Order: addressGroup
Parameters:
pageSize
Format: int32
Description: The maximum number of references to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more AddressGroupUsers left to be queried.
Type: integer
Location: query
addressGroup
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Description: Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Required: Yes
Type: string
Location: path
pageToken
Location: query
Type: string
Description: The next_page_token value returned from a previous List request, if any.
Description: Lists references of an address group.
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:listReferences
▼ ▲ networksecurity.projects.locations.addressGroups.removeItems
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:removeItems
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
addressGroup
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Type: string
Location: path
Description: Required. A name of the AddressGroup to remove items from. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Required: Yes
HTTP Method: POST
Parameter Order: addressGroup
Description: Removes items from an address group.
Path: v1beta1/{+addressGroup}:removeItems
▼ ▲ networksecurity.projects.locations.addressGroups.cloneItems
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Clones items from one address group to another.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:cloneItems
HTTP Method: POST
Path: v1beta1/{+addressGroup}:cloneItems
Parameters:
addressGroup
Description: Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Type: string
Parameter Order: addressGroup
▼ ▲ networksecurity.projects.locations.addressGroups.addItems
Path: v1beta1/{+addressGroup}:addItems
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
addressGroup
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Description: Required. A name of the AddressGroup to add items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:addItems
Parameter Order: addressGroup
Description: Adds items to an address group.
▼ ▲ networksecurity.projects.locations.addressGroups.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/addressGroups
Description: Lists address groups in a given project and location.
HTTP Method: GET
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/addressGroups
Parameters:
pageToken
Location: query
Type: string
Description: The value returned by the last `ListAddressGroupsResponse` Indicates that this is a continuation of a prior `ListAddressGroups` call, and that the system should return the next page of data.
parent
Type: string
Location: path
Description: Required. The project and location from which the AddressGroups should be listed, specified in the format `projects/*/locations/{location}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
pageSize
Format: int32
Type: integer
Location: query
Description: Maximum number of AddressGroups to return per call.
▼ ▲ networksecurity.projects.locations.addressGroups.patch
Parameters:
name
Type: string
Required: Yes
Description: Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`.
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Location: path
updateMask
Type: string
Description: Optional. Field mask is used to specify the fields to be overwritten in the AddressGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Location: query
Format: google-fieldmask
requestId
Type: string
Location: query
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Description: Updates the parameters of a single address group.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
Parameter Order: name
Path: v1beta1/{+name}
HTTP Method: PATCH
▼ ▲ networksecurity.projects.locations.addressGroups.delete
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Description: Required. A name of the AddressGroup to delete. Must be in the format `projects/*/locations/{location}/addressGroups/*`.
Location: path
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single address group.
Path: v1beta1/{+name}
▼ ▲ networksecurity.projects.locations.addressGroups.create
Path: v1beta1/{+parent}/addressGroups
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/addressGroups
Parameters:
requestId
Type: string
Location: query
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
parent
Description: Required. The parent resource of the AddressGroup. Must be in the format `projects/*/locations/{location}`.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
addressGroupId
Type: string
Description: Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".
Location: query
HTTP Method: POST
Parameter Order: parent
Description: Creates a new address group in a given project and location.