gcloud alpha apigee archives deploy Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha apigee archives deploy - deploy an Apigee archive deployment to an environment
- SYNOPSIS
gcloud alpha apigee archives deploy(--environment=ENVIRONMENT:--organization=ORGANIZATION)[--async][--labels=[KEY=VALUE,…]][--bundle-file=BUNDLE_FILE|--source=SOURCE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Deploy an Apigee archive deployment to an environment.gcloud alpha apigee archives deployinstalls an archive deploymentin an Apigee environment.By default, the archive deployment will be deployed on the remote managementplane for the specified Apigee organization. To deploy on a locally runningApigee emulator, use the
--localflag.- EXAMPLES
- To deploy the contents of the current working directory as an archive deploymentto an environment named
, given thatthe Cloud Platform project has been set in gcloud settings, run:my-testgcloudalphaapigeearchivesdeploy--environment=my-testTo deploy an archive deployment from a local directory other than the currentworking directory, to an environment named
in an organization belonging to aCloud Platform project other than the one set in gcloud settings, namedmy-demo, run:my-orggcloudalphaapigeearchivesdeploy--organization=my-org--environment=my-demo--source=/apigee/devTo deploy the contents of the current working directory as an archivedeployment, with the user-defined labels
andmy-label1=foo, to an environment namedmy-label2=bar, given that the Cloud Platformproject has been set in gcloud settings, run:my-testgcloudalphaapigeearchivesdeploy--environment=my-test--labels=my-label1=foo,my-label2=bar - REQUIRED FLAGS
- Environment resource - Apigee environment in which to deploy the archivedeployment. The arguments in this group can be used to specify the attributes ofthis resource.
This must be specified.
--environment=ENVIRONMENT- ID of the environment or fully qualified identifier for the environment.
To set the
environmentattribute:- provide the argument
--environmenton the command line.
This flag argument must be specified if any of the other arguments in this groupare specified.
- provide the argument
--organization=ORGANIZATION- Apigee organization containing the environment. If unspecified, the CloudPlatform project's associated organization will be used.
To set the
organizationattribute:- provide the argument
--environmenton the command line with a fullyspecified name; - provide the argument
--organizationon the command line; - set the property [project] or provide the argument [--project] on the commandline, using a Cloud Platform project with an associated Apigee organization.
- provide the argument
- Environment resource - Apigee environment in which to deploy the archivedeployment. The arguments in this group can be used to specify the attributes ofthis resource.
- OPTIONAL FLAGS
--async- If set, returns immediately and outputs a description of the long runningoperation that was launched. Else,
gcloud alpha apigee archivesdeploywill block until the archive deployment has been successfullydeployed to the specified environment.To monitor the operation once it's been launched, run
gcloud alpha apigeeoperations describe OPERATION_NAME. --labels=[KEY=VALUE,…]- List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens(
-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers. - Source input.
At most one of these can be specified:
--bundle-file=BUNDLE_FILE- The zip file containing an archive to upload.
--source=SOURCE- The source directory of the archive to upload.
- 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. - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gcloudbetaapigeearchivesdeploy
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.