1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 10:35:03 +00:00
gcloud-help/gcloud/iam/workload-identity-pools/update
2024-07-31 09:35:16 +00:00

84 lines
3 KiB
Text

NAME
gcloud iam workload-identity-pools update - update a workload identity pool
SYNOPSIS
gcloud iam workload-identity-pools update
(WORKLOAD_IDENTITY_POOL : --location=LOCATION)
[--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update a workload identity pool.
EXAMPLES
The following command updates the workload identity pool with the ID
my-workload-identity-pool:
$ gcloud iam workload-identity-pools update \
my-workload-identity-pool --location="global" \
--display-name="My workload pool" \
--description="My workload pool description" --disabled
POSITIONAL ARGUMENTS
Workload identity pool resource - The workload identity pool to update.
The arguments in this group can be used to specify the attributes of this
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 workload_identity_pool 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.
WORKLOAD_IDENTITY_POOL
ID of the workload identity pool or fully qualified identifier for
the workload identity pool.
To set the workload_identity_pool attribute:
▸ provide the argument workload_identity_pool on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location name.
To set the location attribute:
▸ provide the argument workload_identity_pool on the command line
with a fully specified name;
▸ provide the argument --location on the command line.
FLAGS
--description=DESCRIPTION
A description of the pool. Cannot exceed 256 characters.
--disabled
Whether the pool is disabled. You cannot use a disabled pool to
exchange tokens, or use existing tokens to access resources. If the
pool is re-enabled, existing tokens grant access again.
--display-name=DISPLAY_NAME
A display name for the pool. Cannot exceed 32 characters.
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 iam/v1 API. The full documentation for this API can
be found at: https://cloud.google.com/iam/
NOTES
These variants are also available:
$ gcloud alpha iam workload-identity-pools update
$ gcloud beta iam workload-identity-pools update