mirroring_deployment_groups

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

Overview

Name	mirroring_deployment_groups
Type	Resource
Id	google.networksecurity.mirroring_deployment_groups

Fields

The following fields are returned by SELECT queries:

projects_locations_mirroring_deployment_groups_get

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. The resource name of this deployment group, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg. See https://google.aip.dev/122 for more details.
connectedEndpointGroups	array	Output only. The list of endpoint groups that are connected to this resource.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
description	string	Optional. User-provided description of the deployment group. Used as additional context for the deployment group.
labels	object	Optional. Labels are key/value pairs that help to organize and filter resources.
locations	array	Output only. The list of locations where the deployment group is present.
nestedDeployments	array	Output only. The list of Mirroring Deployments that belong to this group.
network	string	Required. Immutable. The network that will be used for all child deployments, for example: projects/{project}/global/networks/{network}. See https://google.aip.dev/124.
reconciling	boolean	Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128.
state	string	Output only. The current state of the deployment group. See https://google.aip.dev/216.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

projects_locations_mirroring_deployment_groups_list

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. The resource name of this deployment group, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg. See https://google.aip.dev/122 for more details.
connectedEndpointGroups	array	Output only. The list of endpoint groups that are connected to this resource.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
description	string	Optional. User-provided description of the deployment group. Used as additional context for the deployment group.
labels	object	Optional. Labels are key/value pairs that help to organize and filter resources.
locations	array	Output only. The list of locations where the deployment group is present.
nestedDeployments	array	Output only. The list of Mirroring Deployments that belong to this group.
network	string	Required. Immutable. The network that will be used for all child deployments, for example: projects/{project}/global/networks/{network}. See https://google.aip.dev/124.
reconciling	boolean	Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128.
state	string	Output only. The current state of the deployment group. See https://google.aip.dev/216.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_mirroring_deployment_groups_get	select	projectsId, locationsId, mirroringDeploymentGroupsId		Gets a specific deployment group. See https://google.aip.dev/131.
projects_locations_mirroring_deployment_groups_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists deployment groups in a given project and location. See https://google.aip.dev/132.
projects_locations_mirroring_deployment_groups_create	insert	projectsId, locationsId	mirroringDeploymentGroupId, requestId	Creates a deployment group in a given project and location. See https://google.aip.dev/133.
projects_locations_mirroring_deployment_groups_patch	update	projectsId, locationsId, mirroringDeploymentGroupsId	updateMask, requestId	Updates a deployment group. See https://google.aip.dev/134.
projects_locations_mirroring_deployment_groups_delete	delete	projectsId, locationsId, mirroringDeploymentGroupsId	requestId	Deletes a deployment group. See https://google.aip.dev/135.

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
locationsId	string
mirroringDeploymentGroupsId	string
projectsId	string
filter	string
mirroringDeploymentGroupId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_mirroring_deployment_groups_get

Gets a specific deployment group. See https://google.aip.dev/131.

SELECT
name,
connectedEndpointGroups,
createTime,
description,
labels,
locations,
nestedDeployments,
network,
reconciling,
state,
updateTime
FROM google.networksecurity.mirroring_deployment_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND mirroringDeploymentGroupsId = '{{ mirroringDeploymentGroupsId }}' -- required;

projects_locations_mirroring_deployment_groups_list

Lists deployment groups in a given project and location. See https://google.aip.dev/132.

SELECT
name,
connectedEndpointGroups,
createTime,
description,
labels,
locations,
nestedDeployments,
network,
reconciling,
state,
updateTime
FROM google.networksecurity.mirroring_deployment_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

projects_locations_mirroring_deployment_groups_create

Creates a deployment group in a given project and location. See https://google.aip.dev/133.

INSERT INTO google.networksecurity.mirroring_deployment_groups (
data__name,
data__labels,
data__network,
data__description,
projectsId,
locationsId,
mirroringDeploymentGroupId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ network }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ mirroringDeploymentGroupId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: mirroring_deployment_groups
  props:
    - name: projectsId
      value: string
      description: Required parameter for the mirroring_deployment_groups resource.
    - name: locationsId
      value: string
      description: Required parameter for the mirroring_deployment_groups resource.
    - name: name
      value: string
      description: >
        Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.
        
    - name: labels
      value: object
      description: >
        Optional. Labels are key/value pairs that help to organize and filter resources.
        
    - name: network
      value: string
      description: >
        Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project}/global/networks/{network}`. See https://google.aip.dev/124.
        
    - name: description
      value: string
      description: >
        Optional. User-provided description of the deployment group. Used as additional context for the deployment group.
        
    - name: mirroringDeploymentGroupId
      value: string
    - name: requestId
      value: string

UPDATE examples

projects_locations_mirroring_deployment_groups_patch

Updates a deployment group. See https://google.aip.dev/134.

UPDATE google.networksecurity.mirroring_deployment_groups
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__network = '{{ network }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND mirroringDeploymentGroupsId = '{{ mirroringDeploymentGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_mirroring_deployment_groups_delete

Deletes a deployment group. See https://google.aip.dev/135.

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