1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 10:35:03 +00:00

gcloud: Thu Apr 6 10:23:36 UTC 2023

This commit is contained in:
Automated 2023-04-06 10:23:36 +00:00
parent 5fabf24be7
commit 32e56b8b99
209 changed files with 5396 additions and 561 deletions

View file

@ -17,6 +17,9 @@ GCLOUD WIDE FLAGS
GROUPS
GROUP is one of the following:
keys
Create and manage IAM workforce pool provider keys.
operations
Manage IAM workforce pool provider long-running operations.

View file

@ -0,0 +1,100 @@
NAME
gcloud iam workforce-pools providers keys create - create a new workforce
pool provider key
SYNOPSIS
gcloud iam workforce-pools providers keys create
(KEY : --location=LOCATION
--provider=PROVIDER --workforce-pool=WORKFORCE_POOL) --spec=SPEC
--use=USE [--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a new workforce pool provider key.
EXAMPLES
The following command creates a workforce pool provider key with the ID
my-key. Explicit values for all required and optional parameters are
provided.
$ gcloud iam workforce-pools providers keys create my-key \
--location="global" --workforce-pool="my-workforce-pool" \
--provider="my-provider" --use="ENCRYPTION" --spec="RSA_4096"
POSITIONAL ARGUMENTS
Workforce pool provider key resource - The workforce pool provider key to
create. The arguments in this group can be used to specify the attributes
of this resource.
This must be specified.
KEY
ID of the workforce pool provider key or fully qualified identifier
for the workforce pool provider key. To set the key attribute:
▸ provide the argument key 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 for the workforce pool. To set the location attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--provider=PROVIDER
The ID to use for the workforce pool provider, which becomes the
final component of the resource name. This value must be unique
within the workforce pool, 4-32 characters in length, and may contain
the characters [a-z0-9-]. The prefix gcp- is reserved for use by
Google, and may not be specified.
To set the provider attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --provider on the command line.
--workforce-pool=WORKFORCE_POOL
The ID to use for the workforce pool, which becomes the final
component of the resource name. This value must be a globally unique
string of 6 to 63 lowercase letters, digits, or hyphens. It must
start with a letter, and cannot have a trailing hyphen. The prefix
gcp- is reserved for use by Google, and may not be specified.
To set the workforce-pool attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --workforce-pool on the command line.
REQUIRED FLAGS
--spec=SPEC
The specifications for the key. SPEC must be one of:
key-spec-unspecified, rsa-2048, rsa-3072, rsa-4096.
--use=USE
The purpose of the key. USE must be one of: encryption,
key-use-unspecified.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 workforce-pools providers keys create
$ gcloud beta iam workforce-pools providers keys create

View file

@ -0,0 +1,90 @@
NAME
gcloud iam workforce-pools providers keys delete - delete a workforce pool
provider key
SYNOPSIS
gcloud iam workforce-pools providers keys delete
(KEY : --location=LOCATION
--provider=PROVIDER --workforce-pool=WORKFORCE_POOL) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete a workforce pool provider key.
EXAMPLES
The following command deletes a workforce pool provider key with the ID
my-key.
$ gcloud iam workforce-pools providers keys delete my-key \
--location="global" --workforce-pool="my-workforce-pool" \
--provider="my-provider"
POSITIONAL ARGUMENTS
Workforce pool provider key resource - The workforce pool provider key to
delete. The arguments in this group can be used to specify the attributes
of this resource.
This must be specified.
KEY
ID of the workforce pool provider key or fully qualified identifier
for the workforce pool provider key. To set the key attribute:
▸ provide the argument key 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 for the workforce pool. To set the location attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--provider=PROVIDER
The ID to use for the workforce pool provider, which becomes the
final component of the resource name. This value must be unique
within the workforce pool, 4-32 characters in length, and may contain
the characters [a-z0-9-]. The prefix gcp- is reserved for use by
Google, and may not be specified.
To set the provider attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --provider on the command line.
--workforce-pool=WORKFORCE_POOL
The ID to use for the workforce pool, which becomes the final
component of the resource name. This value must be a globally unique
string of 6 to 63 lowercase letters, digits, or hyphens. It must
start with a letter, and cannot have a trailing hyphen. The prefix
gcp- is reserved for use by Google, and may not be specified.
To set the workforce-pool attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --workforce-pool on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 workforce-pools providers keys delete
$ gcloud beta iam workforce-pools providers keys delete

View file

@ -0,0 +1,85 @@
NAME
gcloud iam workforce-pools providers keys describe - describe a workforce
pool provider key
SYNOPSIS
gcloud iam workforce-pools providers keys describe
(KEY : --location=LOCATION
--provider=PROVIDER --workforce-pool=WORKFORCE_POOL)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe a workforce pool provider key.
EXAMPLES
The following command describes a workforce pool provider key with the ID
my-key.
$ gcloud iam workforce-pools providers keys describe my-key \
--location="global" --workforce-pool="my-workforce-pool" \
--provider="my-provider"
POSITIONAL ARGUMENTS
Workforce pool provider key resource - The workforce pool provider key to
describe. The arguments in this group can be used to specify the
attributes of this resource.
This must be specified.
KEY
ID of the workforce pool provider key or fully qualified identifier
for the workforce pool provider key. To set the key attribute:
▸ provide the argument key 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 for the workforce pool. To set the location attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--provider=PROVIDER
The ID to use for the workforce pool provider, which becomes the
final component of the resource name. This value must be unique
within the workforce pool, 4-32 characters in length, and may contain
the characters [a-z0-9-]. The prefix gcp- is reserved for use by
Google, and may not be specified.
To set the provider attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --provider on the command line.
--workforce-pool=WORKFORCE_POOL
The ID to use for the workforce pool, which becomes the final
component of the resource name. This value must be a globally unique
string of 6 to 63 lowercase letters, digits, or hyphens. It must
start with a letter, and cannot have a trailing hyphen. The prefix
gcp- is reserved for use by Google, and may not be specified.
To set the workforce-pool attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --workforce-pool on the command line.
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 workforce-pools providers keys describe
$ gcloud beta iam workforce-pools providers keys describe

View file

@ -0,0 +1,48 @@
NAME
gcloud iam workforce-pools providers keys - create and manage IAM workforce
pool provider keys
SYNOPSIS
gcloud iam workforce-pools providers keys GROUP | COMMAND
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
The gcloud iam workforce-pools providers keys group lets you create and
manage IAM workforce pool provider keys.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
operations
Manage IAM workforce pool provider key long-running operations.
COMMANDS
COMMAND is one of the following:
create
Create a new workforce pool provider key.
delete
Delete a workforce pool provider key.
describe
Describe a workforce pool provider key.
list
List workforce pool provider keys.
undelete
Undelete a workforce pool provider key.
NOTES
These variants are also available:
$ gcloud alpha iam workforce-pools providers keys
$ gcloud beta iam workforce-pools providers keys

View file

@ -0,0 +1,104 @@
NAME
gcloud iam workforce-pools providers keys list - list workforce pool
provider keys
SYNOPSIS
gcloud iam workforce-pools providers keys list
(--provider=PROVIDER
: --location=LOCATION --workforce-pool=WORKFORCE_POOL)
[--show-deleted] [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List workforce pool provider keys.
EXAMPLES
The following command lists the keys in the workforce pool provider with ID
my-provider, including soft-deleted keys:
$ gcloud iam workforce-pools providers keys list \
--workforce-pool="my-workforce-pool" --provider="my-provider" \
--location="global" --show-deleted
REQUIRED FLAGS
Workforce pool provider resource - The parent workforce pool provider of
the keys to list. The arguments in this group can be used to specify the
attributes of this resource.
This must be specified.
--provider=PROVIDER
ID of the workforce pool provider or fully qualified identifier for
the workforce pool provider. To set the provider attribute:
▸ provide the argument --provider on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location for the workforce pool. To set the location attribute:
▸ provide the argument --provider on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--workforce-pool=WORKFORCE_POOL
The ID to use for the workforce pool, which becomes the final
component of the resource name. This value must be a globally unique
string of 6 to 63 lowercase letters, digits, or hyphens. It must
start with a letter, and cannot have a trailing hyphen. The prefix
gcp- is reserved for use by Google, and may not be specified.
To set the workforce-pool attribute:
▸ provide the argument --provider on the command line with a fully
specified name;
▸ provide the argument --workforce-pool on the command line.
FLAGS
--show-deleted
Show soft-deleted keys by specifying this flag.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
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 workforce-pools providers keys list
$ gcloud beta iam workforce-pools providers keys list

View file

@ -0,0 +1,97 @@
NAME
gcloud iam workforce-pools providers keys operations describe - describe a
workforce pool provider key operation
SYNOPSIS
gcloud iam workforce-pools providers keys operations describe
(OPERATION : --key=KEY --location=LOCATION
--provider=PROVIDER --workforce-pool=WORKFORCE_POOL)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe a workforce pool provider key operation.
EXAMPLES
To describe the long-running workforce pool provider key operation with the
ID my-operation, run:
$ gcloud iam workforce-pools providers keys operations describe \
my-operation --workforce-pool="my-workforce-pool" \
--provider="my-provider" --key="my-key" --location="global"
POSITIONAL ARGUMENTS
Workforce pool provider key operation resource - The workforce pool
provider key long-running operation to describe. The arguments in this
group can be used to specify the attributes of this resource.
This must be specified.
OPERATION
ID of the workforce pool provider key operation or fully qualified
identifier for the workforce pool provider key operation. To set the
operation attribute:
▸ provide the argument operation on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--key=KEY
The ID for the key, which becomes the final component of the resource
name. This value must be 4-32 characters, and may contain the
characters [a-z0-9-]. The prefix gcp- is reserved for use by Google,
and may not be specified.
To set the key attribute:
▸ provide the argument operation on the command line with a fully
specified name;
▸ provide the argument --key on the command line.
--location=LOCATION
The location for the workforce pool. To set the location attribute:
▸ provide the argument operation on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--provider=PROVIDER
The ID to use for the workforce pool provider, which becomes the
final component of the resource name. This value must be unique
within the workforce pool, 4-32 characters in length, and may contain
the characters [a-z0-9-]. The prefix gcp- is reserved for use by
Google, and may not be specified.
To set the provider attribute:
▸ provide the argument operation on the command line with a fully
specified name;
▸ provide the argument --provider on the command line.
--workforce-pool=WORKFORCE_POOL
The ID to use for the workforce pool, which becomes the final
component of the resource name. This value must be a globally unique
string of 6 to 63 lowercase letters, digits, or hyphens. It must
start with a letter, and cannot have a trailing hyphen. The prefix
gcp- is reserved for use by Google, and may not be specified.
To set the workforce-pool attribute:
▸ provide the argument operation on the command line with a fully
specified name;
▸ provide the argument --workforce-pool on the command line.
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 workforce-pools providers keys operations describe
$ gcloud beta iam workforce-pools providers keys operations describe

View file

@ -0,0 +1,30 @@
NAME
gcloud iam workforce-pools providers keys operations - manage IAM workforce
pool provider key long-running operations
SYNOPSIS
gcloud iam workforce-pools providers keys operations COMMAND
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Commands for managing IAM workforce pool provider key long-running
operations.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
Describe a workforce pool provider key operation.
NOTES
These variants are also available:
$ gcloud alpha iam workforce-pools providers keys operations
$ gcloud beta iam workforce-pools providers keys operations

View file

@ -0,0 +1,90 @@
NAME
gcloud iam workforce-pools providers keys undelete - undelete a workforce
pool provider key
SYNOPSIS
gcloud iam workforce-pools providers keys undelete
(KEY : --location=LOCATION
--provider=PROVIDER --workforce-pool=WORKFORCE_POOL) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Undelete a workforce pool provider key.
EXAMPLES
The following command undeletes a workforce pool provider key with the ID
my-key.
$ gcloud iam workforce-pools providers keys undelete my-key \
--location="global" --workforce-pool="my-workforce-pool" \
--provider="my-provider"
POSITIONAL ARGUMENTS
Workforce pool provider key resource - The workforce pool provider key to
undelete. The arguments in this group can be used to specify the
attributes of this resource.
This must be specified.
KEY
ID of the workforce pool provider key or fully qualified identifier
for the workforce pool provider key. To set the key attribute:
▸ provide the argument key 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 for the workforce pool. To set the location attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--provider=PROVIDER
The ID to use for the workforce pool provider, which becomes the
final component of the resource name. This value must be unique
within the workforce pool, 4-32 characters in length, and may contain
the characters [a-z0-9-]. The prefix gcp- is reserved for use by
Google, and may not be specified.
To set the provider attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --provider on the command line.
--workforce-pool=WORKFORCE_POOL
The ID to use for the workforce pool, which becomes the final
component of the resource name. This value must be a globally unique
string of 6 to 63 lowercase letters, digits, or hyphens. It must
start with a letter, and cannot have a trailing hyphen. The prefix
gcp- is reserved for use by Google, and may not be specified.
To set the workforce-pool attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --workforce-pool on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 workforce-pools providers keys undelete
$ gcloud beta iam workforce-pools providers keys undelete