gcloud beta ai tensorboard-runs update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta ai tensorboard-runs update - update an existing Vertex AI Tensorboard run
- SYNOPSIS
gcloud beta ai tensorboard-runs update(TENSORBOARD_RUN:--region=REGION--tensorboard-experiment-id=TENSORBOARD_EXPERIMENT_ID--tensorboard-id=TENSORBOARD_ID)[--description=DESCRIPTION][--display-name=DISPLAY_NAME][--update-labels=[KEY=VALUE,…]][--clear-labels|--remove-labels=[KEY,…]][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(BETA)Update an existing Vertex AI Tensorboard run.- EXAMPLES
- To update Tensorboard Time Run
my-tensorboard-runin Tensorboard12345, Tensorboard Experimentmy-tensorboard-experiment, with the display nameupdateddisplay name:gcloudbetaaitensorboard-runsupdateprojects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment/runs/my-tensorboard-run--display-name="updated display name"Or with flags:
gcloudbetaaitensorboard-runsupdatemy-tensorboard-run--tensorboard-id=12345--tensorboard-experiment-id=my-tensorboard-experiment--display-name="updated display name" - POSITIONAL ARGUMENTS
- Tensorboard run resource - The Tensorboard run to update. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
tensorboard_runon the command line with afully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
TENSORBOARD_RUN- ID of the tensorboard_run or fully qualified identifier for the tensorboard_run.
To set the
nameattribute:- provide the argument
tensorboard_runon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--region=REGION- Cloud region for the tensorboard_run.
To set the
regionattribute:- provide the argument
tensorboard_runon the command line with afully 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
--tensorboard-experiment-id=TENSORBOARD_EXPERIMENT_ID- ID of the tensorboard experiment for the tensorboard_run.
To set the
tensorboard-experiment-idattribute:- provide the argument
tensorboard_runon the command line with afully specified name; - provide the argument
--tensorboard-experiment-idon the commandline.
- provide the argument
--tensorboard-id=TENSORBOARD_ID- ID of the tensorboard for the tensorboard_run.
To set the
tensorboard-idattribute:- provide the argument
tensorboard_runon the command line with afully specified name; - provide the argument
--tensorboard-idon the command line.
- provide the argument
- provide the argument
- Tensorboard run resource - The Tensorboard run to update. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
- FLAGS
--description=DESCRIPTION- Description of the tensorboard run.
--display-name=DISPLAY_NAME- Display name of the tensorboard run.
--update-labels=[KEY=VALUE,…]- List of label KEY=VALUE pairs to update. If a label exists, its value ismodified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens(
-), underscores (_), lowercase characters, andnumbers. 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:
gcloudbetaaitensorboard-runsupdate--clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloudbetaaitensorboard-runsupdate--clear-labels--update-labelsfoo=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
- This command is currently in beta and might change without notice. This variantis also available:
gcloudalphaaitensorboard-runsupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-16 UTC.