Method: projects.locations.workstationClusters.workstationConfigs.workstations.patch

Updates an existing workstation.

HTTP request

PATCH https://workstations.googleapis.com/v1/{workstation.name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
workstation.name

string

Identifier. Full name of this workstation.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Mask specifying which fields in the workstation configuration should be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

validateOnly

boolean

Optional. If set, validate the request and preview the review, but do not actually apply it.

allowMissing

boolean

Optional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, updateMask is ignored.

Request body

The request body contains an instance of Workstation.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.