- NAME
-
- gcloud alpha container backup-restore backup-plans describe - describe a backup plan
- SYNOPSIS
-
-
gcloud alpha container backup-restore backup-plans describe
(BACKUP_PLAN
:--location
=LOCATION
) [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Describe a Backup for GKE backup plan. - EXAMPLES
-
To describe a backup plan
in projectmy-backup-plan
in locationmy-project
, run:us-central1
gcloud alpha container backup-restore backup-plans describe my-backup-plan --project=my-project --location=us-central1
- POSITIONAL ARGUMENTS
-
-
Backup plan resource - Name of the backup plan to describe. The name may be
provided either as a relative name, e.g.
projects/<project>/locations/<location>/backupPlans/<backupPlan>
or as a single ID name (with the parent resources provided via options or through properties), e.g.BACKUP_PLAN --project=<project> --location=<location>
The arguments in this group can be used to specify the attributes of this 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
backup_plan
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.
BACKUP_PLAN
-
ID of the backup plan or fully qualified identifier for the backup plan.
To set the
backup_plan
attribute:-
provide the argument
backup_plan
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location
=LOCATION
-
Google Cloud location.
To set the
location
attribute:-
provide the argument
backup_plan
on the command line with a fully specified name; -
provide the argument
--location
on the command line; -
set the property
gkebackup/location
.
-
provide the argument
-
provide the argument
-
Backup plan resource - Name of the backup plan to describe. The name may be
provided either as a relative name, e.g.
- 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
gkebackup/v1
API. The full documentation for this API can be found at: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke - 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. This variant is also available:
gcloud beta container backup-restore backup-plans describe
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.