1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 18:45:13 +00:00
gcloud-help/gcloud/active-directory/peerings/update
2022-03-01 04:29:52 +00:00

93 lines
3.3 KiB
Text

NAME
gcloud active-directory peerings update - update a Managed Microsoft Active
Directory domain peering
SYNOPSIS
gcloud active-directory peerings update PEERING [--async]
[--update-labels=[KEY=VALUE,...]]
[--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update a Managed Microsoft Active Directory (AD) domain peering.
This command can fail for the following reasons:
▪ The active account does not have permission to access the given AD
domain.
EXAMPLES
The following command updates an AD domain peering my-peering with the
label l1 and l2
$ gcloud active-directory peerings update my-peering \
--update-labels=l1=1,l2=2
POSITIONAL ARGUMENTS
Peering resource - Name of the managed Managed Microsoft AD domain you
want to delete. 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 peering 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.
PEERING
ID of the peering or fully qualified identifier for the peering. To
set the peering attribute:
▸ provide the argument peering on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--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 active-directory peerings update --clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud active-directory peerings 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/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/managed-microsoft-ad/
NOTES
These variants are also available:
$ gcloud alpha active-directory peerings update
$ gcloud beta active-directory peerings update