mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-16 12:22:03 +00:00
gcloud: Wed Mar 30 09:07:09 UTC 2022
This commit is contained in:
parent
cd34e797ae
commit
9bf28f1efe
90 changed files with 1554 additions and 258 deletions
|
|
@ -32,6 +32,9 @@ GROUPS
|
|||
dashboards
|
||||
(ALPHA) Manage Cloud Monitoring dashboards.
|
||||
|
||||
metrics-scopes
|
||||
(ALPHA) Manage Cloud Monitoring Metrics Scopes.
|
||||
|
||||
policies
|
||||
(ALPHA) Manage Cloud Monitoring alerting policies.
|
||||
|
||||
|
|
|
|||
52
gcloud/alpha/monitoring/metrics-scopes/create
Normal file
52
gcloud/alpha/monitoring/metrics-scopes/create
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
NAME
|
||||
gcloud alpha monitoring metrics-scopes create - create a monitored project
|
||||
in a metrics scope
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha monitoring metrics-scopes create
|
||||
MONITORED_PROJECT_ID_OR_NUMBER [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) This command can fail for the following reasons:
|
||||
▪ The projects specified do not exist.
|
||||
▪ The active account does not have permission to access one of the
|
||||
given project.
|
||||
▪ The monitored project already exists in the metrics scope.
|
||||
|
||||
More details can be found at
|
||||
https://cloud.google.com/monitoring/api/ref_v3/rest/v1/locations.global.metricsScopes.projects/create
|
||||
|
||||
EXAMPLES
|
||||
The following command adds a monitored project with the ID
|
||||
monitored-project-1 to a metrics scope with project id metrics-scope-1
|
||||
assuming the metrics-scope-1 is the default project:
|
||||
|
||||
$ gcloud alpha monitoring metrics-scopes create monitored-project-1
|
||||
|
||||
The following command adds a monitored project with the ID
|
||||
monitored-project-1 to a metrics scope with project id metrics-scope-1:
|
||||
|
||||
$ gcloud alpha monitoring metrics-scopes create \
|
||||
monitored-project-1 --project=metrics-scope-1
|
||||
$ gcloud alpha monitoring metrics-scopes create \
|
||||
locations/global/metricsScopes/metrics-scope-1/projects/\
|
||||
monitored-project-1
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
MONITORED_PROJECT_ID_OR_NUMBER
|
||||
Monitored project ID or number for the project you want to create.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
51
gcloud/alpha/monitoring/metrics-scopes/delete
Normal file
51
gcloud/alpha/monitoring/metrics-scopes/delete
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
NAME
|
||||
gcloud alpha monitoring metrics-scopes delete - delete a monitored project
|
||||
in a metrics scope
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha monitoring metrics-scopes delete
|
||||
MONITORED_PROJECT_ID_OR_NUMBER [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) This command can fail for the following reasons:
|
||||
▪ The projects specified do not exist.
|
||||
▪ The active account does not have permission to access one of the
|
||||
given project.
|
||||
|
||||
More details can be found at
|
||||
https://cloud.google.com/monitoring/api/ref_v3/rest/v1/locations.global.metricsScopes.projects/delete
|
||||
|
||||
EXAMPLES
|
||||
The following command adds a monitored project with the ID
|
||||
monitored-project-1 to a metrics scope with project id metrics-scope-1
|
||||
assuming the metrics-scope-1 is the default project:
|
||||
|
||||
$ gcloud alpha monitoring metrics-scopes delete monitored-project-1
|
||||
|
||||
The following command adds a monitored project with the ID
|
||||
monitored-project-1 to a metrics scope with project id metrics-scope-1:
|
||||
|
||||
$ gcloud alpha monitoring metrics-scopes delete \
|
||||
monitored-project-1 --project=metrics-scope-1
|
||||
$ gcloud alpha monitoring metrics-scopes delete \
|
||||
locations/global/metricsScopes/metrics-scope-1/projects/\
|
||||
monitored-project-1
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
MONITORED_PROJECT_ID_OR_NUMBER
|
||||
Monitored project ID or number for the project you want to delete.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
60
gcloud/alpha/monitoring/metrics-scopes/describe
Normal file
60
gcloud/alpha/monitoring/metrics-scopes/describe
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
NAME
|
||||
gcloud alpha monitoring metrics-scopes describe - describe a Cloud
|
||||
Monitoring metrics scope
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha monitoring metrics-scopes describe METRICS_SCOPE
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Describe a Cloud Monitoring metrics scope along with the list of
|
||||
projects it is monitoring.
|
||||
|
||||
More details can be found at
|
||||
https://cloud.google.com/monitoring/api/ref_v3/rest/v1/locations.global.metricsScopes/get
|
||||
|
||||
EXAMPLES
|
||||
To describe a metrics scope contained within a specific project, run:
|
||||
|
||||
$ gcloud alpha monitoring metrics-scopes describe \
|
||||
MY-METRICS-SCOPE-PROJECT-ID
|
||||
|
||||
To describe a metrics scope in JSON, run:
|
||||
|
||||
$ gcloud alpha monitoring metrics-scopes describe \
|
||||
MY-METRICS-SCOPE-PROJECT-ID --format=json
|
||||
|
||||
To describe a metrics scope with a fully qualified metrics scope ID, run:
|
||||
|
||||
$ gcloud alpha monitoring metrics-scopes describe \
|
||||
locations/global/metricsScopes/MY-METRICS-SCOPE-PROJECT-ID
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Metrics scope resource - The metrics scope to describe. This represents a
|
||||
Cloud resource.
|
||||
|
||||
This must be specified.
|
||||
|
||||
METRICS_SCOPE
|
||||
ID of the metrics_scope or fully qualified identifier for the
|
||||
metrics_scope. To set the metrics_scope attribute:
|
||||
▸ provide the argument metrics_scope on the command line.
|
||||
|
||||
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.
|
||||
|
||||
40
gcloud/alpha/monitoring/metrics-scopes/help
Normal file
40
gcloud/alpha/monitoring/metrics-scopes/help
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
NAME
|
||||
gcloud alpha monitoring metrics-scopes - manage Cloud Monitoring Metrics
|
||||
Scopes
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha monitoring metrics-scopes COMMAND [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) The gcloud alpha monitoring metrics-scopes group lets you manage
|
||||
Monitoring metrics scopes.
|
||||
|
||||
More information on managing metrics scopes can be found here:
|
||||
https://cloud.google.com/monitoring/settings/manage-api
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --help.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
create
|
||||
(ALPHA) Create a monitored project in a metrics scope.
|
||||
|
||||
delete
|
||||
(ALPHA) Delete a monitored project in a metrics scope.
|
||||
|
||||
describe
|
||||
(ALPHA) Describe a Cloud Monitoring metrics scope.
|
||||
|
||||
list
|
||||
(ALPHA) List the metrics scopes monitoring the specified project.
|
||||
|
||||
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.
|
||||
|
||||
73
gcloud/alpha/monitoring/metrics-scopes/list
Normal file
73
gcloud/alpha/monitoring/metrics-scopes/list
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
NAME
|
||||
gcloud alpha monitoring metrics-scopes list - list the metrics scopes
|
||||
monitoring the specified project
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha monitoring metrics-scopes list PROJECT_ID_OR_NUMBER
|
||||
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
|
||||
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) This command can fail for the following reasons:
|
||||
▪ The projects specified do not exist.
|
||||
▪ The active account does not have permission to access one of the
|
||||
given project.
|
||||
|
||||
More details can be found at
|
||||
https://cloud.google.com/monitoring/api/ref_v3/rest/v1/locations.global.metricsScopes/listMetricsScopesByMonitoredProject
|
||||
|
||||
EXAMPLES
|
||||
To list the metrics scopes monitoring MY-PROJECT-ID
|
||||
|
||||
$ gcloud alpha monitoring metrics-scopes list MY-PROJECT-ID
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
PROJECT_ID_OR_NUMBER
|
||||
ID or number for the project you want to list.
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
Apply a Boolean filter EXPRESSION to each resource item to be listed.
|
||||
If the expression evaluates True, then that item is listed. For more
|
||||
details and examples of filter expressions, run $ gcloud topic filters.
|
||||
This flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--limit=LIMIT
|
||||
Maximum number of resources to list. The default is unlimited. This
|
||||
flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--page-size=PAGE_SIZE
|
||||
Some services group resource list output into pages. This flag
|
||||
specifies the maximum number of resources per page. The default is
|
||||
determined by the service if it supports paging, otherwise it is
|
||||
unlimited (no paging). Paging may be applied before or after --filter
|
||||
and --limit depending on the service.
|
||||
|
||||
--sort-by=[FIELD,...]
|
||||
Comma-separated list of resource field key names to sort by. The
|
||||
default order is ascending. Prefix a field with ``~'' for descending
|
||||
order on that field. This flag interacts with other flags that are
|
||||
applied in this order: --flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--uri
|
||||
Print a list of resource URIs instead of the default output, and change
|
||||
the command output to a list of URIs. If this flag is used with
|
||||
--format, the formatting is applied on this URI list. To display URIs
|
||||
alongside other keys instead, use the uri() transform.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue