gcloud beta active-directory domains update

NAME
gcloud beta active-directory domains update - update a Managed Microsoft AD domain
SYNOPSIS
gcloud beta active-directory domains updateDOMAIN[--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
(BETA) Update the metadata and/or configuration parameters of amanaged 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 namemy-domain.com to add the two labels,env andservice and to add a provisioned regionus-west1:
gcloudbetaactive-directorydomainsupdatemy-domain.com--update-labels=env=test,service=foo--add-region=us-west1

This peers the domainmy-domain.com to the networkmy-network.

gcloudbetaactive-directorydomainsupdatemy-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 argumentsin this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentdomain on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

DOMAIN
ID of the domain or fully qualified identifier for the domain.

To set thedomain attribute:

  • provide the argumentdomain 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 ismodified. Otherwise, a new label is created.

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.

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 formprojects/{project}/global/networks/{network}. Networks must belong to theproject.
--remove-authorized-networks=[AUTH_NET1,AUTH_NET2, …,…]
A list of URLs of additional networks to unpeer this domain from in the formprojects/{project}/global/networks/{network}. Networks must belong to theproject.
At most one of these can be specified:
--add-region=ADD_REGION
An additional region to provision this domain in. If domain is alreadyprovisioned in region, nothing will be done in that region. Supported regionsare: 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 provisionedin a region, nothing will be done in that region. Domains must be leftprovisioned 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:

gcloudbetaactive-directorydomainsupdate--clear-labels

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

gcloudbetaactive-directorydomainsupdate--clear-labels--update-labelsfoo=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 themanagedidentities/v1beta1 API. The fulldocumentation for this API can be found at:https://cloud.google.com/managed-microsoft-ad/
NOTES
This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudactive-directorydomainsupdate
gcloudalphaactive-directorydomainsupdate

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.