mirroring_deployments

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

Overview

Name	`mirroring_deployments`
Type	Resource
Id	`google.networksecurity.mirroring_deployments`

Fields

The following fields are returned by SELECT queries:

projects_locations_mirroring_deployments_get
projects_locations_mirroring_deployments_list

Successful response

Name	Datatype	Description
`name`	`string`	Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. See https://google.aip.dev/122 for more details.
`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. Used as additional context for the deployment.
`forwardingRule`	`string`	Required. Immutable. The regional forwarding rule that fronts the mirroring collectors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124.
`labels`	`object`	Optional. Labels are key/value pairs that help to organize and filter resources.
`mirroringDeploymentGroup`	`string`	Required. Immutable. The deployment group that this deployment is a part of, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. 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 part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
`state`	`string`	Output only. The current state of the deployment. 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.

Successful response

Name	Datatype	Description
`name`	`string`	Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. See https://google.aip.dev/122 for more details.
`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. Used as additional context for the deployment.
`forwardingRule`	`string`	Required. Immutable. The regional forwarding rule that fronts the mirroring collectors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124.
`labels`	`object`	Optional. Labels are key/value pairs that help to organize and filter resources.
`mirroringDeploymentGroup`	`string`	Required. Immutable. The deployment group that this deployment is a part of, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. 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 part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
`state`	`string`	Output only. The current state of the deployment. 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_deployments_get`	`select`	`projectsId`, `locationsId`, `mirroringDeploymentsId`		Gets a specific deployment. See https://google.aip.dev/131.
`projects_locations_mirroring_deployments_list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Lists deployments in a given project and location. See https://google.aip.dev/132.
`projects_locations_mirroring_deployments_create`	`insert`	`projectsId`, `locationsId`	`mirroringDeploymentId`, `requestId`	Creates a deployment in a given project and location. See https://google.aip.dev/133.
`projects_locations_mirroring_deployments_patch`	`update`	`projectsId`, `locationsId`, `mirroringDeploymentsId`	`updateMask`, `requestId`	Updates a deployment. See https://google.aip.dev/134.
`projects_locations_mirroring_deployments_delete`	`delete`	`projectsId`, `locationsId`, `mirroringDeploymentsId`	`requestId`	Deletes a deployment. 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`
`mirroringDeploymentsId`	`string`
`projectsId`	`string`
`filter`	`string`
`mirroringDeploymentId`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`requestId`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

projects_locations_mirroring_deployments_get
projects_locations_mirroring_deployments_list

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

SELECT
name,
createTime,
description,
forwardingRule,
labels,
mirroringDeploymentGroup,
reconciling,
state,
updateTime
FROM google.networksecurity.mirroring_deployments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND mirroringDeploymentsId = '{{ mirroringDeploymentsId }}' -- required;

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

SELECT
name,
createTime,
description,
forwardingRule,
labels,
mirroringDeploymentGroup,
reconciling,
state,
updateTime
FROM google.networksecurity.mirroring_deployments
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_deployments_create
Manifest

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

INSERT INTO google.networksecurity.mirroring_deployments (
data__name,
data__labels,
data__forwardingRule,
data__mirroringDeploymentGroup,
data__description,
projectsId,
locationsId,
mirroringDeploymentId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ forwardingRule }}',
'{{ mirroringDeploymentGroup }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ mirroringDeploymentId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: mirroring_deployments
  props:
    - name: projectsId
      value: string
      description: Required parameter for the mirroring_deployments resource.
    - name: locationsId
      value: string
      description: Required parameter for the mirroring_deployments resource.
    - name: name
      value: string
      description: >
        Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. 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: forwardingRule
      value: string
      description: >
        Required. Immutable. The regional forwarding rule that fronts the mirroring collectors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124.
        
    - name: mirroringDeploymentGroup
      value: string
      description: >
        Required. Immutable. The deployment group that this deployment is a part of, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124.
        
    - name: description
      value: string
      description: >
        Optional. User-provided description of the deployment. Used as additional context for the deployment.
        
    - name: mirroringDeploymentId
      value: string
    - name: requestId
      value: string

`UPDATE` examples

projects_locations_mirroring_deployments_patch

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

UPDATE google.networksecurity.mirroring_deployments
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__forwardingRule = '{{ forwardingRule }}',
data__mirroringDeploymentGroup = '{{ mirroringDeploymentGroup }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND mirroringDeploymentsId = '{{ mirroringDeploymentsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

projects_locations_mirroring_deployments_delete

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

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​