- NAME
-
- gcloud alpha monitoring dashboards update - update a Cloud Monitoring dashboard
- SYNOPSIS
-
-
gcloud alpha monitoring dashboards update
DASHBOARD
(--config
=CONFIG
|--config-from-file
=PATH_TO_FILE
) [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Update a Monitoring dashboard. The updated dashboard can be specified as a JSON/YAML value passed in as a string through the--config
flag or as a file through the--config-from-file
flag.Note: Etags are used to prevent concurrent updates to the same dashboard. The latest etag can be found in a
describe
orlist
response.For information about the format of a dashboard: https://cloud.google.com/monitoring/api/ref_v3/rest/v1/projects.dashboards
- EXAMPLES
-
To update a dashboard with a YAML config, run:
gcloud alpha monitoring dashboards update MY-DASHBOARD --config='''
displayName: New Dashboard with New Display Name etag: 40d1040034db4e5a9dee931ec1b12c0d gridLayout: widgets: - text: content: Hello World '''To update a dashboard with a JSON config, run:
gcloud alpha monitoring dashboards update MY-DASHBOARD --config='''
{ "displayName": "New Dashboard with New Display Name", "etag": "40d1040034db4e5a9dee931ec1b12c0d", "gridLayout": { "widgets": [ { "text": { "content": "Hello World", } } ] }, } '''To update a dashboard within a specific project, run:
gcloud alpha monitoring dashboards update MY-DASHBOARD --project=MY-PROJECT --config='''
displayName: New Dashboard with New Display Name etag: 40d1040034db4e5a9dee931ec1b12c0d gridLayout: widgets: - text: content: Hello World '''To update a dashboard with a file, run:
gcloud alpha monitoring dashboards update MY-DASHBOARD --config-from-file=MY-FILE
Sample contents of MY-FILE:
displayName: New Dashboard with new Display Name etag: 40d1040034db4e5a9dee931ec1b12c0d gridLayout: widgets: - text: content: Hello World
- POSITIONAL ARGUMENTS
-
-
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
project
attribute:-
provide the argument
dashboard
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.
DASHBOARD
-
ID of the dashboard or fully qualified identifier for the dashboard.
To set the
dashboard
attribute:-
provide the argument
dashboard
on the command line.
-
provide the argument
-
provide the argument
-
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.
- REQUIRED FLAGS
-
-
Exactly one of these must be specified:
--config
=CONFIG
- Dashboard configuration, in either JSON or YAML format, as a string.
--config-from-file
=PATH_TO_FILE
- 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.
-
Exactly one of these must be specified:
- 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
monitoring/v1
API. The full documentation for this API can be found at: https://cloud.google.com/monitoring/api/ - 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:
gcloud monitoring dashboards update
gcloud beta monitoring dashboards 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 2024-07-30 UTC.