1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-10 11:21:48 +00:00
gcloud-help/gcloud/alpha/active-directory/peerings/update
2024-07-31 09:35:16 +00:00

99 lines
3.6 KiB
Text

NAME
gcloud alpha active-directory peerings update - update a Managed Microsoft
Active Directory domain peering
SYNOPSIS
gcloud alpha active-directory peerings update PEERING [--async]
[--update-labels=[KEY=VALUE,...]]
[--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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 alpha 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;
◆ provide the argument --project on the command line;
◆ set the property core/project.
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 alpha active-directory peerings update --clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud alpha 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/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 peerings update
$ gcloud beta active-directory peerings update