File: //snap/google-cloud-cli/current/help/man/man1/gcloud_monitoring_dashboards_create.1
.TH "GCLOUD_MONITORING_DASHBOARDS_CREATE" 1
.SH "NAME"
.HP
gcloud monitoring dashboards create \- create a new Cloud Monitoring dashboard
.SH "SYNOPSIS"
.HP
\f5gcloud monitoring dashboards create\fR (\fB\-\-config\fR=\fICONFIG\fR\ |\ \fB\-\-config\-from\-file\fR=\fIPATH_TO_FILE\fR) [\fB\-\-validate\-only\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
Create a new Monitoring dashboard. A 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. Validate a dashboard config
without saving by setting the \f5\-\-validate\-only\fR flag.
For information about the format of a dashboard:
https://cloud.google.com/monitoring/api/ref_v3/rest/v1/projects.dashboards
.SH "EXAMPLES"
To create a dashboard with a YAML config, run:
.RS 2m
$ gcloud monitoring dashboards create \-\-config='''
displayName: New Dashboard
gridLayout:
widgets:
\- text:
content: Hello World
'''
.RE
To validate a dashboard and not save it, run:
.RS 2m
$ gcloud monitoring dashboards create \-\-validate\-only \-\-config='''
displayName: New Dashboard
gridLayout:
widgets:
\- text:
content: Hello World
'''
.RE
To create a dashboard with a JSON config, run:
.RS 2m
$ gcloud monitoring dashboards create \-\-config='''
{
"displayName": "New Dashboard",
"gridLayout": {
"widgets": [
{
"text": {
"content": "Hello World",
}
}
]
},
}
'''
.RE
To create a dashboard with a specific dashboard ID, run:
.RS 2m
$ gcloud monitoring dashboards create \-\-config='''
name: projects/MY\-PROJECT/dashboards/MY\-DASHBOARD
displayName: New Dashboard
gridLayout:
widgets:
\- text:
content: Hello World
'''
.RE
To create a dashboard within a specific project, run:
.RS 2m
$ gcloud monitoring dashboards create \-\-project=MY\-PROJECT \e
\-\-config='''
displayName: New Dashboard
gridLayout:
widgets:
\- text:
content: Hello World
'''
.RE
To create a dashboard with a file, run:
.RS 2m
$ gcloud monitoring dashboards create \-\-config\-from\-file=MY\-FILE
.RE
Sample contents of MY\-FILE:
.RS 2m
displayName: New Dashboard
gridLayout:
widgets:
\- text:
content: Hello World
.RE
.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 "OPTIONAL FLAGS"
.RS 2m
.TP 2m
\fB\-\-validate\-only\fR
When set, validate the dashboard but do not save it.
.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"
These variants are also available:
.RS 2m
$ gcloud alpha monitoring dashboards create
.RE
.RS 2m
$ gcloud beta monitoring dashboards create
.RE