- NAME
-
- gcloud alpha backup-dr restore-templates update - update a Restore Template
- SYNOPSIS
-
-
gcloud alpha backup-dr restore-templates update(RESTORE_TEMPLATE:--location=LOCATION) [--async] [--description=DESCRIPTION] [--restore-properties=RESTORE_PROPERTIES] [--update-labels=[KEY=VALUE,…]] [--clear-labels|--remove-labels=[KEY,…]] [--post-restore-cloud-run-job=POST_RESTORE_CLOUD_RUN_JOB--post-restore-timeout=POST_RESTORE_TIMEOUT] [--pre-restore-cloud-run-job=PRE_RESTORE_CLOUD_RUN_JOB--pre-restore-timeout=PRE_RESTORE_TIMEOUT] [--verification-cloud-run-job=VERIFICATION_CLOUD_RUN_JOB--verification-timeout=VERIFICATION_TIMEOUT] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Update a Restore Template. - EXAMPLES
-
To update a restore template
my-templatewith a new description, run:gcloud alpha backup-dr restore-templates update my-template --location=us-central1 --description="Updated template"To update the restore properties of a restore template
my-templatefrom a file, run:gcloud alpha backup-dr restore-templates update my-template --location=us-central1 --restore-properties=path/to/restore_properties.json - POSITIONAL ARGUMENTS
-
-
Restore Template resource - to update 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
projectattribute:-
provide the argument
restore_templateon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
RESTORE_TEMPLATE-
ID of the Restore Template or fully qualified identifier for the Restore
Template.
To set the
nameattribute:-
provide the argument
restore_templateon 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-
The location of the Restore Template.
To set the
locationattribute:-
provide the argument
restore_templateon the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
Restore Template resource - to update 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.
- FLAGS
-
--async-
Return immediately, without waiting for the operation in progress to complete.
The default is
True. Enabled by default, use--no-asyncto disable. --description=DESCRIPTION- Description of the restore template.
--restore-properties=RESTORE_PROPERTIES- Defines the target environment and configuration for restoring the resource. Accepts either an inline JSON or YAML string or a path to a JSON or YAML file containing the properties.
--update-labels=[KEY=VALUE,…]-
List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens (
-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers. -
At most one of these can be specified:
--clear-labels-
Remove all labels. If
--update-labelsis also specified then--clear-labelsis applied first.For example, to remove all labels:
gcloud alpha backup-dr restore-templates update --clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloud alpha backup-dr restore-templates update --clear-labels --update-labels foo=bar,baz=qux --remove-labels=[KEY,…]-
List of label keys to remove. If a label does not exist it is silently ignored.
If
--update-labelsis also specified then--update-labelsis applied first.
- Post-restore hook configuration.
--post-restore-cloud-run-job=POST_RESTORE_CLOUD_RUN_JOB- The Cloud Run job to execute after the restore operation. Format: projects/{project}/locations/{location}/jobs/{job}
--post-restore-timeout=POST_RESTORE_TIMEOUT- Timeout for the post-restore hook (e.g., 600s). Must be specified with --post-restore-cloud-run-job.
- Pre-restore hook configuration.
--pre-restore-cloud-run-job=PRE_RESTORE_CLOUD_RUN_JOB- The Cloud Run job to execute before the restore operation. Format: projects/{project}/locations/{location}/jobs/{job}
--pre-restore-timeout=PRE_RESTORE_TIMEOUT- Timeout for the pre-restore hook (e.g., 300s). Must be specified with --pre-restore-cloud-run-job.
- Verification hook configuration.
--verification-cloud-run-job=VERIFICATION_CLOUD_RUN_JOB- The Cloud Run job to execute to verify the restored workload. Format: projects/{project}/locations/{location}/jobs/{job}
--verification-timeout=VERIFICATION_TIMEOUT- Timeout for the verification hook (e.g., 300s). Must be specified with --verification-cloud-run-job.
- 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 helpfor details. - BRIEF
- Update a restore template.
- 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 backup-dr restore-templates updategcloud beta backup-dr restore-templates update
gcloud alpha backup-dr restore-templates 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 2026-11-10 UTC.