.TH "GCLOUD_ALPHA_APIGEE_ARCHIVES_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha apigee archives update \- update an existing Apigee archive deployment



.SH "SYNOPSIS"
.HP
\f5gcloud alpha apigee archives update\fR (\fIARCHIVE_DEPLOYMENT\fR\ :\ \fB\-\-environment\fR=\fIENVIRONMENT\fR\ \fB\-\-organization\fR=\fIORGANIZATION\fR) [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Update an existing Apigee archive deployment.

\f5gcloud alpha apigee archives update\fR updates an Apigee archive deployment.



.SH "EXAMPLES"

To update the \f5\fItag\fR\fR and \f5\fIrev\fR\fR labels of an archive
deployment with the id \f5\fIabcdef01234\fR\fR in the Apigee environment called
\f5\fImy\-env\fR\fR using the active Cloud Platform project, run:

.RS 2m
$ gcloud alpha apigee archives update abcdef01234 \e
  \-\-environment=my\-env \-\-update\-labels=tag=my\-tag,rev=1234
.RE

To remove the \f5\fIdev\fR\fR label on an archive deployment with the id
\f5\fIuvwxyz56789\fR\fR, in the Apigee environment called \f5\fImy\-env\fR\fR,
in an organization called \f5\fImy\-org\fR\fR, run:

.RS 2m
$ gcloud alpha apigee archives update uvwxyz56789 \e
  \-\-environment=my\-env \-\-organization=my\-org \-\-remove\-labels=dev
.RE

To clear all labels on an archive deployment with the id \f5\fImnop4321\fR\fR,
in the Apigee environment called \f5\fImy\-env\fR\fR, in an organization called
\f5\fImy\-org\fR\fR, and return the updated archive deployment as a JSON object,
run:

.RS 2m
$ gcloud alpha apigee archives update mnop4321 \e
  \-\-environment=my\-env \-\-organization=my\-org \-\-clear\-labels \e
  \-\-format=json
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Archive deployment resource \- Archive deployment to update. To get a list of
existing archive deployments, run \f5gcloud alpha apigee archives list\fR. The
arguments in this group can be used to specify the attributes of this resource.

This must be specified.


.RS 2m
.TP 2m
\fIARCHIVE_DEPLOYMENT\fR

ID of the archive deployment or fully qualified identifier for the archive
deployment.

To set the \f5archive_deployment\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5archive_deployment\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-environment\fR=\fIENVIRONMENT\fR

Deployment environment of the archive deployment.

To set the \f5environment\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5archive_deployment\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-environment\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-organization\fR=\fIORGANIZATION\fR

Apigee organization containing the archive deployment. If unspecified, the Cloud
Platform project's associated organization will be used.

To set the \f5organization\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5archive_deployment\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-organization\fR on the command line;
.IP "\(bu" 2m
set the property [project] or provide the argument [\-\-project] on the command
line, using a Cloud Platform project with an associated Apigee organization.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

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 (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud alpha apigee archives update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud alpha apigee archives update \-\-clear\-labels \e
  \-\-update\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.


.RE
.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 "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:

.RS 2m
$ gcloud beta apigee archives update
.RE