- NAME
-
- gcloud workstations describe - describe a workstation
- SYNOPSIS
-
-
gcloud workstations describe(WORKSTATION:--cluster=CLUSTER--config=CONFIG--region=REGION) [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Describe a workstation.
- EXAMPLES
-
To describe a workstation, run:
gcloud workstations describe WORKSTATION - POSITIONAL ARGUMENTS
-
-
Workstation resource - The name of the workstation to display. The arguments in
this group can be used to specify the attributes of this resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
WORKSTATION-
ID of the workstation or fully qualified identifier for the workstation.
To set the
workstationattribute:-
provide the argument
workstationon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--cluster=CLUSTER-
The name of the cluster containing the workstation.
To set the
clusterattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--clusteron the command line; -
set the property
workstations/cluster.
-
provide the argument
--config=CONFIG-
The name of the config containing the workstation.
To set the
configattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--configon the command line; -
set the property
workstations/config.
-
provide the argument
--region=REGION-
The name of the region of the workstation.
To set the
regionattribute:-
provide the argument
workstationon the command line with a fully specified name; -
provide the argument
--regionon the command line; -
set the property
workstations/region.
-
provide the argument
-
provide the argument
-
Workstation resource - The name of the workstation to display. The arguments in
this group can be used to specify the attributes of this resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - API REFERENCE
-
This command uses the
workstations/v1API. The full documentation for this API can be found at: https://cloud.google.com/workstations - NOTES
-
These variants are also available:
gcloud alpha workstations describegcloud beta workstations describe
gcloud workstations describe
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.