gcloud workstations describe

NAME
gcloud workstations describe - describe a workstation
SYNOPSIS
gcloud workstations describe (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) [--endpoint-mode=ENDPOINT_MODE] [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 project attribute:

  • provide the argument workstation on the command line with a fully specified name;
  • provide the argument --project on 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 workstation attribute:

  • provide the argument workstation on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--cluster=CLUSTER
The name of the cluster containing the workstation. To set the cluster attribute:
  • provide the argument workstation on the command line with a fully specified name;
  • provide the argument --cluster on the command line;
  • set the property workstations/cluster.
--config=CONFIG
The name of the config containing the workstation. To set the config attribute:
  • provide the argument workstation on the command line with a fully specified name;
  • provide the argument --config on the command line;
  • set the property workstations/config.
--region=REGION
The name of the region of the workstation. To set the region attribute:
  • provide the argument workstation on the command line with a fully specified name;
  • provide the argument --region on the command line;
  • set the property workstations/region.
FLAGS
--endpoint-mode=ENDPOINT_MODE
Specifies endpoint mode for a given command. Regional endpoints provide enhanced data residency and reliability by ensuring your request is handled entirely within the specified Google Cloud region. This differs from global endpoints, which may process parts of the request outside the target region. Overrides the default regional/endpoint_mode property value for this command invocation. ENDPOINT_MODE must be one of:
global
(Default) Use global rather than regional endpoints.
regional
Only use regional endpoints. An error will be raised if a regional endpoint is not available for a given command.
regional-preferred
Use regional endpoints when available, otherwise use global endpoints. Recommended for most users.
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 help for details.

API REFERENCE
This command uses the workstations/v1 API. The full documentation for this API can be found at: https://cloud.google.com/workstations
REGIONAL ENDPOINTS
This command supports regional endpoints. To use regional endpoints for this command, use the --endpoint-mode=regional-preferred flag. To use regional endpoints by default, run $ gcloud config set regional/endpoint_mode regional-preferred.
NOTES
These variants are also available: 
gcloud alpha workstations describe
 
gcloud beta workstations describe