- NAME
-
- gcloud ai tensorboards update - update an existing Vertex AI Tensorboard
- SYNOPSIS
-
-
gcloud ai tensorboards update(TENSORBOARD:--region=REGION) [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] [--update-labels=[KEY=VALUE,…]] [--clear-labels|--remove-labels=[KEY,…]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Update an existing Vertex AI Tensorboard.
- EXAMPLES
-
To update a Tensorboard
12345, in regionus-central1and projectmy-project, with the display nameupdated display name:gcloud ai tensorboards update projects/my-project/locations/us-central1/tensorboards/12345 --display-name="updated display name" - POSITIONAL ARGUMENTS
-
-
Tensorboard resource - The tensorboard to update. 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
tensorboardon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
TENSORBOARD-
ID of the tensorboard or fully qualified identifier for the tensorboard.
To set the
nameattribute:-
provide the argument
tensorboardon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--region=REGION-
Cloud region for the tensorboard.
To set the
regionattribute:-
provide the argument
tensorboardon the command line with a fully specified name; -
provide the argument
--regionon the command line; -
set the property
ai/region; - choose one from the prompted list of available regions.
-
provide the argument
-
provide the argument
-
Tensorboard resource - The tensorboard to update. 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.
- FLAGS
-
--description=DESCRIPTION- Description of the tensorboard.
--display-name=DISPLAY_NAME- Display name of the tensorboard.
--update-labels=[KEY=VALUE,…]-
List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens (
-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers. -
At most one of these can be specified:
--clear-labels-
Remove all labels. If
--update-labelsis also specified then--clear-labelsis applied first.For example, to remove all labels:
gcloud ai tensorboards update --clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloud ai tensorboards update --clear-labels --update-labels foo=bar,baz=qux --remove-labels=[KEY,…]-
List of label keys to remove. If a label does not exist it is silently ignored.
If
--update-labelsis also specified then--update-labelsis applied first.
- 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. - NOTES
-
These variants are also available:
gcloud alpha ai tensorboards updategcloud beta ai tensorboards update
gcloud ai tensorboards update
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-09-16 UTC.