.TH "GCLOUD_ALPHA_APIGEE_ARCHIVES_DEPLOY" 1



.SH "NAME"
.HP
gcloud alpha apigee archives deploy \- deploy an Apigee archive deployment to an environment



.SH "SYNOPSIS"
.HP
\f5gcloud alpha apigee archives deploy\fR (\fB\-\-environment\fR=\fIENVIRONMENT\fR\ :\ \fB\-\-organization\fR=\fIORGANIZATION\fR) [\fB\-\-async\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-bundle\-file\fR=\fIBUNDLE_FILE\fR\ |\ \fB\-\-source\fR=\fISOURCE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Deploy an Apigee archive deployment to an environment.

\f5gcloud alpha apigee archives deploy\fR installs an archive deployment in an
Apigee environment.

By default, the archive deployment will be deployed on the remote management
plane for the specified Apigee organization. To deploy on a locally running
Apigee emulator, use the \f5\-\-local\fR flag.



.SH "EXAMPLES"

To deploy the contents of the current working directory as an archive deployment
to an environment named \f5\fImy\-test\fR\fR, given that the Cloud Platform
project has been set in gcloud settings, run:

.RS 2m
$ gcloud alpha apigee archives deploy \-\-environment=my\-test
.RE

To deploy an archive deployment from a local directory other than the current
working directory, to an environment named \f5\fImy\-demo\fR\fR in an
organization belonging to a Cloud Platform project other than the one set in
gcloud settings, named \f5\fImy\-org\fR\fR, run:

.RS 2m
$ gcloud alpha apigee archives deploy \-\-organization=my\-org \e
    \-\-environment=my\-demo \-\-source=/apigee/dev
.RE

To deploy the contents of the current working directory as an archive
deployment, with the user\-defined labels \f5\fImy\-label1=foo\fR\fR and
\f5\fImy\-label2=bar\fR\fR, to an environment named \f5\fImy\-test\fR\fR, given
that the Cloud Platform project has been set in gcloud settings, run:

.RS 2m
$ gcloud alpha apigee archives deploy \-\-environment=my\-test \e
    \-\-labels=my\-label1=foo,my\-label2=bar
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

Environment resource \- Apigee environment in which to deploy the archive
deployment. The arguments in this group can be used to specify the attributes of
this resource.

This must be specified.


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

ID of the environment or fully qualified identifier for the environment.

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

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

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

Apigee organization containing the environment. 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 \f5\-\-environment\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 "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

If set, returns immediately and outputs a description of the long running
operation that was launched. Else, \f5gcloud alpha apigee archives deploy\fR
will block until the archive deployment has been successfully deployed to the
specified environment.

To monitor the operation once it's been launched, run \f5gcloud alpha apigee
operations describe OPERATION_NAME\fR.

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

List of label KEY=VALUE pairs to add.

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

Source input.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-bundle\-file\fR=\fIBUNDLE_FILE\fR

The zip file containing an archive to upload.

.TP 2m
\fB\-\-source\fR=\fISOURCE\fR

The source directory of the archive to upload.


.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 deploy
.RE