gcloud-help/gcloud/alpha/active-directory/domains/update

NAME
    gcloud alpha active-directory domains update - update a Managed Microsoft
        AD domain

SYNOPSIS
    gcloud alpha active-directory domains update DOMAIN [--async]
        [--enable-audit-logs] [--update-labels=[KEY=VALUE,...]]
        [--add-authorized-networks=[AUTH_NET1, AUTH_NET2, ...,...]
          | --remove-authorized-networks=[AUTH_NET1, AUTH_NET2, ...,...]]
        [--add-region=ADD_REGION | --remove-region=REMOVE_REGION]
        [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    (ALPHA) Update the metadata and/or configuration parameters of a managed
    Microsoft AD domain.

    This command can fail for the following reasons:
      ▪ The AD domain specified does not exist.
      ▪ The active account does not have permission to update the given AD
        domain.

EXAMPLES
    The following command updates an AD domain with the name my-domain.com to
    add the two labels, env and service and to add a provisioned region
    us-west1:

        $ gcloud alpha active-directory domains update my-domain.com \
            --update-labels=env=test,service=foo --add-region=us-west1

    This peers the domain my-domain.com to the network my-network.

        $ gcloud alpha active-directory domains update my-domain.com \
            --add-authorized-networks=projects/my-project/global/networks/\
        my-network

POSITIONAL ARGUMENTS
     Domain resource - Name of the Managed Microsoft AD domain you want to
     update. This represents a Cloud resource. (NOTE) Some attributes are not
     given arguments in this group but can be set in other ways. To set the
     project attribute:
      ◆ provide the argument domain on the command line with a fully
        specified name;
      ◆ set the property core/project;
      ◆ provide the argument --project on the command line.

     This must be specified.

       DOMAIN
          ID of the domain or fully qualified identifier for the domain. To set
          the domain attribute:
          ▸ provide the argument domain on the command line.

FLAGS
     --async
        Return immediately, without waiting for the operation in progress to
        complete.

     --enable-audit-logs
        If specified, Active Directory data audit logs are enabled for the
        domain.

     --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:

       --add-authorized-networks=[AUTH_NET1, AUTH_NET2, ...,...]
          A list of URLs of additional networks to peer this domain to in the
          form projects/{project}/global/networks/{network}. Networks must
          belong to the project.

       --remove-authorized-networks=[AUTH_NET1, AUTH_NET2, ...,...]
          A list of URLs of additional networks to unpeer this domain from in
          the form projects/{project}/global/networks/{network}. Networks must
          belong to the project.

     At most one of these can be specified:

       --add-region=ADD_REGION
          An additional region to provision this domain in. If domain is
          already provisioned in region, nothing will be done in that region.
          Supported regions are: asia-east1, asia-northeast1, asia-south1,
          asia-southeast1, australia-southeast1, europe-north1, europe-west1,
          europe-west2, europe-west3, europe-west4, northamerica-northeast1,
          southamerica-east1, us-central1, us-east1, us-east4, us-west1,
          us-west2.

       --remove-region=REMOVE_REGION
          A region to de-provision this domain from. If domain is already not
          provisioned in a region, nothing will be done in that region. Domains
          must be left provisioned in at least one region. Supported regions
          are: asia-east1, asia-northeast1, asia-south1, asia-southeast1,
          australia-southeast1, europe-north1, europe-west1, europe-west2,
          europe-west3, europe-west4, northamerica-northeast1,
          southamerica-east1, us-central1, us-east1, us-east4, us-west1,
          us-west2.

     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 active-directory domains update --clear-labels

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

              $ gcloud alpha active-directory domains 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.

API REFERENCE
    This command uses the managedidentities/v1alpha1 API. The full
    documentation for this API can be found at:
    https://cloud.google.com/managed-microsoft-ad/

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 active-directory domains update

        $ gcloud beta active-directory domains update