gcloud-help/gcloud/alpha/apigee/archives/update

NAME
    gcloud alpha apigee archives update - update an existing Apigee archive
        deployment

SYNOPSIS
    gcloud alpha apigee archives update
        (ARCHIVE_DEPLOYMENT
          : --environment=ENVIRONMENT --organization=ORGANIZATION)
        [--update-labels=[KEY=VALUE,...]]
        [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    (ALPHA) Update an existing Apigee archive deployment.

    gcloud alpha apigee archives update updates an Apigee archive deployment.

EXAMPLES
    To update the tag and rev labels of an archive deployment with the id
    abcdef01234 in the Apigee environment called my-env using the active Cloud
    Platform project, run:

        $ gcloud alpha apigee archives update abcdef01234 \
          --environment=my-env --update-labels=tag=my-tag,rev=1234

    To remove the dev label on an archive deployment with the id uvwxyz56789,
    in the Apigee environment called my-env, in an organization called my-org,
    run:

        $ gcloud alpha apigee archives update uvwxyz56789 \
          --environment=my-env --organization=my-org --remove-labels=dev

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

        $ gcloud alpha apigee archives update mnop4321 \
          --environment=my-env --organization=my-org --clear-labels \
          --format=json

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

     This must be specified.

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

          To set the archive_deployment attribute:
          ▸ provide the argument archive_deployment on the command line.

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

       --environment=ENVIRONMENT
          Deployment environment of the archive deployment.

          To set the environment attribute:
          ▸ provide the argument archive_deployment on the command line with
            a fully specified name;
          ▸ provide the argument --environment on the command line.

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

          To set the organization attribute:
          ▸ provide the argument archive_deployment on the command line with
            a fully specified name;
          ▸ provide the argument --organization on the command line;
          ▸ set the property [project] or provide the argument [--project] on
            the command line, using a Cloud Platform project with an associated
            Apigee organization.

FLAGS
     --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-labels is also specified then
          --clear-labels is applied first.

          For example, to remove all labels:

              $ gcloud alpha apigee archives update --clear-labels

          To remove all existing labels and create two new labels, foo and baz:

              $ gcloud alpha apigee archives 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-labels is also specified then
          --update-labels is applied first.

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.

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 apigee archives update