Skip to main content

workstations_usable

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

Overview

Nameworkstations_usable
TypeResource
Idgoogle.workstations.workstations_usable

Fields

NameDatatypeDescription
namestringIdentifier. Full name of this workstation.
annotationsobjectOptional. Client-specified annotations.
createTimestringOutput only. Time when this workstation was created.
deleteTimestringOutput only. Time when this workstation was soft-deleted.
displayNamestringOptional. Human-readable name for this workstation.
envobjectOptional. Environment variables passed to the workstation container's entrypoint.
etagstringOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
hoststringOutput only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.
kmsKeystringOutput only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
labelsobjectOptional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.
reconcilingbooleanOutput only. Indicates whether this workstation is currently being updated to match its intended state.
startTimestringOutput only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
statestringOutput only. Current state of the workstation.
uidstringOutput only. A system-assigned unique identifier for this workstation.
updateTimestringOutput only. Time when this workstation was most recently updated.

Methods

NameAccessible byRequired ParamsDescription
list_usableSELECTlocationsId, projectsId, workstationClustersId, workstationConfigsIdReturns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.

SELECT examples

Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.

SELECT
name,
annotations,
createTime,
deleteTime,
displayName,
env,
etag,
host,
kmsKey,
labels,
reconciling,
startTime,
state,
uid,
updateTime
FROM google.workstations.workstations_usable
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND workstationClustersId = '{{ workstationClustersId }}'
AND workstationConfigsId = '{{ workstationConfigsId }}';