1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 18:45:13 +00:00
gcloud-help/gcloud/alpha/workstations/list
2023-05-04 10:43:54 +00:00

102 lines
4 KiB
Text

NAME
gcloud alpha workstations list - list workstations
SYNOPSIS
gcloud alpha workstations list
(--config=CONFIG : --cluster=CLUSTER --region=REGION)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List all workstations under the specified configuration.
EXAMPLES
To list workstations, run:
$ gcloud alpha workstations list
REQUIRED FLAGS
Config resource - The configuration of the workstations 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 --config 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.
--config=CONFIG
ID of the config or fully qualified identifier for the config.
To set the config attribute:
▸ provide the argument --config on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--cluster=CLUSTER
The name of the cluster containing the config.
To set the cluster attribute:
▸ provide the argument --config on the command line with a fully
specified name;
▸ provide the argument --cluster on the command line.
--region=REGION
The name of the region of the config.
To set the region attribute:
▸ provide the argument --config on the command line with a fully
specified name;
▸ provide the argument --region on the command line.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, 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 --filter
and --limit depending 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 help for details.
API REFERENCE
This command uses the workstations/v1beta API. The full documentation for
this API can be found at: https://cloud.google.com/workstations
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud beta workstations list