- NAME
-
- gcloud workstations configs list - list workstation configurations
- SYNOPSIS
-
-
gcloud workstations configs list[--endpoint-mode=ENDPOINT_MODE] [--cluster=CLUSTER--region=REGION] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,…]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- List all workstation configurations under the specified cluster.
- EXAMPLES
-
To list workstation configurations, run:
gcloud workstations configs list - 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_modeproperty value for this command invocation.ENDPOINT_MODEmust 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.
-
Cluster resource - The cluster of the configurations 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
--clusteron the command line with a fully specified name; -
set the property
workstations/clusterwith a fully specified name; - default is all clusters with a fully specified name;
-
provide the argument
--projecton the command line; -
set the property
core/project.
-
provide the argument
--cluster=CLUSTER-
ID of the cluster or fully qualified identifier for the cluster.
To set the
clusterattribute:-
provide the argument
--clusteron the command line; -
set the property
workstations/cluster; - default is all clusters .
-
provide the argument
--region=REGION-
The name of the region of the cluster.
To set the
regionattribute:-
provide the argument
--clusteron the command line with a fully specified name; -
set the property
workstations/clusterwith a fully specified name; - default is all clusters with a fully specified name;
-
provide the argument
--regionon the command line; -
set the property
workstations/region; - default is all regions .
-
provide the argument
- LIST COMMAND FLAGS
-
--filter=EXPRESSION-
Apply a Boolean filter
EXPRESSIONto each resource item to be listed. If the expression evaluatesTrue, then that item is listed. For more details and examples of filter expressions, run $ gcloud topic filters. This flag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. --limit=LIMIT-
Maximum number of resources to list. The default is
unlimited. This flag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. --page-size=PAGE_SIZE-
Some services group resource list output into pages. This flag specifies the
maximum number of resources per page. The default is determined by the service
if it supports paging, otherwise it is
unlimited(no paging). Paging may be applied before or after--filterand--limitdepending on the service. --sort-by=[FIELD,…]-
Comma-separated list of resource field key names to sort by. The default order
is ascending. Prefix a field with ``~´´ for descending order on that
field. This flag interacts with other flags that are applied in this order:
--flatten,--sort-by,--filter,--limit.
- 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 - REGIONAL ENDPOINTS
-
This command supports regional endpoints. To use regional endpoints for this
command, use the
--endpoint-mode=regional-preferredflag. To use regional endpoints by default, run$ gcloud config set regional/endpoint_mode regional-preferred. - NOTES
-
These variants are also available:
gcloud alpha workstations configs listgcloud beta workstations configs list
gcloud workstations configs list
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 2026-09-29 UTC.