1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00

gcloud: Thu Dec 18 10:57:44 UTC 2025

This commit is contained in:
Automated 2025-12-18 10:57:44 +00:00
parent 6d07e70b12
commit bdd724fcf3
219 changed files with 8033 additions and 381 deletions

View file

@ -0,0 +1,138 @@
NAME
gcloud beta run worker-pools add-iam-policy-binding - add IAM policy
binding to a Cloud Run worker pool
SYNOPSIS
gcloud beta run worker-pools add-iam-policy-binding
(WORKERPOOL : --region=REGION) --member=PRINCIPAL --role=ROLE
[--condition=[KEY=VALUE,...] | --condition-from-file=PATH_TO_FILE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Add an IAM policy binding to the IAM policy of a Cloud Run worker
pool. One binding consists of a member, and a role.
EXAMPLES
To add an IAM policy binding for the role of 'roles/run.developer' for the
user 'test-user@gmail.com' with worker pool 'my-worker-pool' and region
'us-central1', run:
$ gcloud beta run worker-pools add-iam-policy-binding \
my-worker-pool --region='us-central1' \
--member='user:test-user@gmail.com' --role='roles/run.developer'
See https://cloud.google.com/iam/docs/managing-policies for details of
policy role and member types.
POSITIONAL ARGUMENTS
Workerpool resource - The worker pool for which to add IAM policy binding
to. 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 workerpool 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.
WORKERPOOL
ID of the workerpool or fully qualified identifier for the
workerpool.
To set the workerpool attribute:
▸ provide the argument workerpool on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
The Cloud Run region.
To set the region attribute:
▸ provide the argument workerpool on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property run/region;
▸ specify from a list of available regions in a prompt.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to add the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
Role name to assign to the principal. The role name is the complete
path of a predefined role, such as roles/logging.viewer, or the role ID
for a custom role, such as
organizations/{ORGANIZATION_ID}/roles/logging.viewer.
OPTIONAL FLAGS
At most one of these can be specified:
--condition=[KEY=VALUE,...]
A condition to include in the binding. When the condition is
explicitly specified as None (--condition=None), a binding without a
condition is added. When the condition is specified and is not None,
--role cannot be a basic role. Basic roles are roles/editor,
roles/owner, and roles/viewer. For more on conditions, refer to the
conditions overview guide:
https://cloud.google.com/iam/docs/conditions-overview
When using the --condition flag, include the following key-value
pairs:
expression
(Required) Condition expression that evaluates to True or False.
This uses a subset of Common Expression Language syntax.
If the condition expression includes a comma, use a different
delimiter to separate the key-value pairs. Specify the delimiter
before listing the key-value pairs. For example, to specify a
colon (:) as the delimiter, do the following:
--condition=^:^title=TITLE:expression=EXPRESSION. For more
information, see
https://cloud.google.com/sdk/gcloud/reference/topic/escaping.
title
(Required) A short string describing the purpose of the
expression.
description
(Optional) Additional description for the expression.
--condition-from-file=PATH_TO_FILE
Path to a local JSON or YAML file that defines the condition. To see
available fields, see the help for --condition. Use a full or
relative path to a local file containing the value of condition.
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 run/v1 API. The full documentation for this API can
be found at: https://cloud.google.com/run/
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha run worker-pools add-iam-policy-binding

View file

@ -0,0 +1,100 @@
NAME
gcloud beta run worker-pools get-iam-policy - get the IAM policy for a
Cloud Run worker pool
SYNOPSIS
gcloud beta run worker-pools get-iam-policy (WORKERPOOL : --region=REGION)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) This command gets the IAM policy for a worker pool. If formatted as
JSON, the output can be edited and used as a policy file for
set-iam-policy. The output includes an "etag" field identifying the version
emitted and allowing detection of concurrent policy updates; see $ gcloud
alpha run registries set-iam-policy for additional details.
EXAMPLES
To print the IAM policy for a given worker pool, run:
$ gcloud beta run worker-pools get-iam-policy --region=us-central1 \
my-worker-pool
POSITIONAL ARGUMENTS
Workerpool resource - The worker pool for which to display the IAM policy.
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 workerpool 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.
WORKERPOOL
ID of the workerpool or fully qualified identifier for the
workerpool.
To set the workerpool attribute:
▸ provide the argument workerpool on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
The Cloud Run region.
To set the region attribute:
▸ provide the argument workerpool on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property run/region;
▸ specify from a list of available regions in a prompt.
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 run/v1 API. The full documentation for this API can
be found at: https://cloud.google.com/run/
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha run worker-pools get-iam-policy

View file

@ -27,6 +27,9 @@ GROUPS
COMMANDS
COMMAND is one of the following:
add-iam-policy-binding
(BETA) Add IAM policy binding to a Cloud Run worker pool.
delete
(BETA) Delete a worker-pool.
@ -36,13 +39,22 @@ COMMANDS
describe
(BETA) Obtain details about a given worker-pool.
get-iam-policy
(BETA) Get the IAM policy for a Cloud Run worker pool.
list
(BETA) List available worker-pools.
remove-iam-policy-binding
(BETA) Remove IAM policy binding of a Cloud Run worker pool.
replace
(BETA) Create or replace a worker-pool from a YAML worker-pool
specification.
set-iam-policy
(BETA) Set the IAM policy for a worker pool.
update
(BETA) Update Cloud Run environment variables and other configuration
settings.

View file

@ -0,0 +1,143 @@
NAME
gcloud beta run worker-pools remove-iam-policy-binding - remove IAM policy
binding of a Cloud Run worker pool
SYNOPSIS
gcloud beta run worker-pools remove-iam-policy-binding
(WORKERPOOL : --region=REGION) --member=PRINCIPAL --role=ROLE
[--all | --condition=[KEY=VALUE,...]
| --condition-from-file=PATH_TO_FILE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Remove an IAM policy binding from the IAM policy of a worker pool.
One binding consists of a member, and a role.
EXAMPLES
To remove an IAM policy binding for the role of 'roles/run.developer' for
the user 'test-user@gmail.com' with worker pool 'my-worker-pool' and region
'us-central1', run:
$ gcloud beta run worker-pools remove-iam-policy-binding \
my-worker-pool --region='us-central1' \
--member='user:test-user@gmail.com' --role='roles/run.developer'
See https://cloud.google.com/iam/docs/managing-policies for details of
policy role and member types.
POSITIONAL ARGUMENTS
Workerpool resource - The service for which to remove the IAM policy
binding. 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 workerpool 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.
WORKERPOOL
ID of the workerpool or fully qualified identifier for the
workerpool.
To set the workerpool attribute:
▸ provide the argument workerpool on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
The Cloud Run region.
To set the region attribute:
▸ provide the argument workerpool on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property run/region;
▸ specify from a list of available regions in a prompt.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to remove the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Deleted principals have an additional deleted: prefix and a ?uid=UID
suffix, where UID is a unique identifier for the principal. Example:
deleted:user:test-user@gmail.com?uid=123456789012345678901.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
The role to remove the principal from.
OPTIONAL FLAGS
At most one of these can be specified:
--all
Remove all bindings with this role and principal, irrespective of any
conditions.
--condition=[KEY=VALUE,...]
The condition of the binding that you want to remove. When the
condition is explicitly specified as None (--condition=None), a
binding without a condition is removed. Otherwise, only a binding
with a condition that exactly matches the specified condition
(including the optional description) is removed. For more on
conditions, refer to the conditions overview guide:
https://cloud.google.com/iam/docs/conditions-overview
When using the --condition flag, include the following key-value
pairs:
expression
(Required) Condition expression that evaluates to True or False.
This uses a subset of Common Expression Language syntax.
If the condition expression includes a comma, use a different
delimiter to separate the key-value pairs. Specify the delimiter
before listing the key-value pairs. For example, to specify a
colon (:) as the delimiter, do the following:
--condition=^:^title=TITLE:expression=EXPRESSION. For more
information, see
https://cloud.google.com/sdk/gcloud/reference/topic/escaping.
title
(Required) A short string describing the purpose of the
expression.
description
(Optional) Additional description for the expression.
--condition-from-file=PATH_TO_FILE
Path to a local JSON or YAML file that defines the condition. To see
available fields, see the help for --condition. Use a full or
relative path to a local file containing the value of condition.
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 run/v1 API. The full documentation for this API can
be found at: https://cloud.google.com/run/
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha run worker-pools remove-iam-policy-binding

View file

@ -0,0 +1,87 @@
NAME
gcloud beta run worker-pools set-iam-policy - set the IAM policy for a
worker pool
SYNOPSIS
gcloud beta run worker-pools set-iam-policy (WORKERPOOL : --region=REGION)
POLICY_FILE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) This command replaces the existing IAM policy for a worker pool,
given a worker pool and a file encoded in JSON or YAML that contains the
IAM policy. If the given policy file specifies an "etag" value, then the
replacement will succeed only if the policy already in place matches that
etag. (An etag obtain via get-iam-policy will prevent the replacement if
the policy for the worker pool has been subsequently updated.) A policy
file that does not contain an etag value will replace any existing policy
for the worker pool.
EXAMPLES
The following command will read an IAM policy defined in a JSON file
'policy.json' and set it for a worker pool with identifier 'my-worker-pool'
$ gcloud beta run worker-pools set-iam-policy --region=us-central1 \
my-worker-pool policy.json
See https://cloud.google.com/iam/docs/managing-policies for details of the
policy file format and contents.
POSITIONAL ARGUMENTS
Workerpool resource - The service for which to set the IAM policy. 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 workerpool 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.
WORKERPOOL
ID of the workerpool or fully qualified identifier for the
workerpool.
To set the workerpool attribute:
▸ provide the argument workerpool on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
The Cloud Run region.
To set the region attribute:
▸ provide the argument workerpool on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property run/region;
▸ specify from a list of available regions in a prompt.
POLICY_FILE
Path to a local JSON or YAML formatted file containing a valid policy.
The output of the get-iam-policy command is a valid file, as is any
JSON or YAML file conforming to the structure of a Policy
(https://cloud.google.com/iam/reference/rest/v1/Policy).
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 run/v1 API. The full documentation for this API can
be found at: https://cloud.google.com/run/
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha run worker-pools set-iam-policy