.TH "GCLOUD_ALPHA_MONITORING_DASHBOARDS_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha monitoring dashboards update \- update a Cloud Monitoring dashboard



.SH "SYNOPSIS"
.HP
\f5gcloud alpha monitoring dashboards update\fR \fIDASHBOARD\fR (\fB\-\-config\fR=\fICONFIG\fR\ |\ \fB\-\-config\-from\-file\fR=\fIPATH_TO_FILE\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Update a Monitoring dashboard. The updated dashboard can be
specified as a JSON/YAML value passed in as a string through the
\f5\-\-config\fR flag or as a file through the \f5\-\-config\-from\-file\fR
flag.

Note: Etags are used to prevent concurrent updates to the same dashboard. The
latest etag can be found in a \f5describe\fR or \f5list\fR response.

For information about the format of a dashboard:
https://cloud.google.com/monitoring/api/ref_v3/rest/v1/projects.dashboards



.SH "EXAMPLES"

To update a dashboard with a YAML config, run:

.RS 2m
$ gcloud alpha monitoring dashboards update MY\-DASHBOARD \-\-config='''
  displayName: New Dashboard with New Display Name
  etag: 40d1040034db4e5a9dee931ec1b12c0d
  gridLayout:
    widgets:
    \- text:
        content: Hello World
  '''
.RE

To update a dashboard with a JSON config, run:

.RS 2m
$ gcloud alpha monitoring dashboards update MY\-DASHBOARD \-\-config='''
  {
    "displayName": "New Dashboard with New Display Name",
    "etag": "40d1040034db4e5a9dee931ec1b12c0d",
    "gridLayout": {
      "widgets": [
        {
          "text": {
            "content": "Hello World",
          }
        }
      ]
    },
  }
  '''
.RE

To update a dashboard within a specific project, run:

.RS 2m
$ gcloud alpha monitoring dashboards update MY\-DASHBOARD \e
    \-\-project=MY\-PROJECT \-\-config='''
  displayName: New Dashboard with New Display Name
  etag: 40d1040034db4e5a9dee931ec1b12c0d
  gridLayout:
    widgets:
    \- text:
        content: Hello World
  '''
.RE

To update a dashboard with a file, run:

.RS 2m
$ gcloud alpha monitoring dashboards update MY\-DASHBOARD \e
    \-\-config\-from\-file=MY\-FILE
.RE

Sample contents of MY\-FILE:

.RS 2m
displayName: New Dashboard with new Display Name
etag: 40d1040034db4e5a9dee931ec1b12c0d
gridLayout:
  widgets:
  \- text:
      content: Hello World
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Dashboard resource \- The dashboard to update. This represents a Cloud resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5dashboard\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIDASHBOARD\fR

ID of the dashboard or fully qualified identifier for the dashboard.

To set the \f5dashboard\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5dashboard\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-config\fR=\fICONFIG\fR

Dashboard configuration, in either JSON or YAML format, as a string.

.TP 2m
\fB\-\-config\-from\-file\fR=\fIPATH_TO_FILE\fR

Path to a JSON or YAML file containing the dashboard configuration. Use a full
or relative path to a local file containing the value of config.


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBmonitoring/v1\fR API. The full documentation for this
API can be found at: https://cloud.google.com/monitoring/api/



.SH "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. These variants are also available:

.RS 2m
$ gcloud monitoring dashboards update
.RE

.RS 2m
$ gcloud beta monitoring dashboards update
.RE