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

gcloud: Wed Feb 12 10:41:39 UTC 2025

Browse source
This commit is contained in:
Automated 2025-02-12 10:41:39 +00:00
parent c854ee0644
commit 44f319c56c
119 changed files with 5956 additions and 337 deletions
Download patch file Download diff file Expand all files Collapse all files

139
gcloud/deploy/deploy-policies/add-iam-policy-binding Normal file
View file

@ -0,0 +1,139 @@
NAME
gcloud deploy deploy-policies add-iam-policy-binding - add IAM policy
binding for a Cloud Deploy Policy
SYNOPSIS
gcloud deploy deploy-policies add-iam-policy-binding
(DEPLOY_POLICY : --region=REGION) --member=PRINCIPAL --role=ROLE
[--condition=[KEY=VALUE,...] | --condition-from-file=PATH_TO_FILE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Adds a policy binding to the IAM policy of a Cloud Deploy Policy. One
binding consists of a member and a role.
See https://cloud.google.com/iam/docs/managing-policies for details of the
policy file format and contents.
EXAMPLES
To add an IAM policy binding for the role of roles/clouddeploy.policyAdmin
for the user test-user@gmail.com on holiday-policy with the region
us-central1, run:
$ gcloud deploy deploy-policies add-iam-policy-binding \
holiday-policy --region='us-central1' \
--member='user:test-user@gmail.com' \
--role='roles/clouddeploy.policyAdmin'
POSITIONAL ARGUMENTS
Deploy policy resource - The deploy policy for which to add 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 deploy_policy 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.
DEPLOY_POLICY
ID of the deploy policy or fully qualified identifier for the deploy
policy.
To set the deploy_policy attribute:
▸ provide the argument deploy_policy on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Location of the deploy policy.
To set the region attribute:
▸ provide the argument deploy_policy on the command line with a
fully specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/region.
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 clouddeploy/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/deploy/
NOTES
These variants are also available:
$ gcloud alpha deploy deploy-policies add-iam-policy-binding
$ gcloud beta deploy deploy-policies add-iam-policy-binding

102
gcloud/deploy/deploy-policies/get-iam-policy Normal file
View file

@ -0,0 +1,102 @@
NAME
gcloud deploy deploy-policies get-iam-policy - get the IAM policy for a
Cloud Deploy Policy
SYNOPSIS
gcloud deploy deploy-policies get-iam-policy
(DEPLOY_POLICY : --region=REGION) [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud deploy deploy-policies get-iam-policy displays the IAM policy
associated with a Cloud Deploy Policy. 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 deploy deploy-policies
set-iam-policy for additional details.
EXAMPLES
To print the IAM policy for a deploy policy my-holiday-policy in region
us-central1, run:
$ gcloud deploy deploy-policies get-iam-policy my-holiday-policy \
--region=us-central1
POSITIONAL ARGUMENTS
Deploy policy resource - The deploy policy 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 deploy_policy 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.
DEPLOY_POLICY
ID of the deploy policy or fully qualified identifier for the deploy
policy.
To set the deploy_policy attribute:
▸ provide the argument deploy_policy on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Location of the deploy policy.
To set the region attribute:
▸ provide the argument deploy_policy on the command line with a
fully specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/region.
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 clouddeploy/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/deploy/
NOTES
These variants are also available:
$ gcloud alpha deploy deploy-policies get-iam-policy
$ gcloud beta deploy deploy-policies get-iam-policy

12
gcloud/deploy/deploy-policies/help
View file

@ -16,6 +16,9 @@ GCLOUD WIDE FLAGS
COMMANDS
COMMAND is one of the following:
add-iam-policy-binding
Add IAM policy binding for a Cloud Deploy Policy.
delete
Delete a deploy policy.
@ -25,6 +28,15 @@ COMMANDS
export
Returns the .yaml definition of the specified deploy policy.
get-iam-policy
Get the IAM policy for a Cloud Deploy Policy.
remove-iam-policy-binding
Remove an IAM policy binding for a Cloud Deploy Policy.
set-iam-policy
Set the IAM policy for a Cloud Deploy Policy.
NOTES
These variants are also available:

144
gcloud/deploy/deploy-policies/remove-iam-policy-binding Normal file
View file

@ -0,0 +1,144 @@
NAME
gcloud deploy deploy-policies remove-iam-policy-binding - remove an IAM
policy binding for a Cloud Deploy Policy
SYNOPSIS
gcloud deploy deploy-policies remove-iam-policy-binding
(DEPLOY_POLICY : --region=REGION) --member=PRINCIPAL --role=ROLE
[--all | --condition=[KEY=VALUE,...]
| --condition-from-file=PATH_TO_FILE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Removes a policy binding to the IAM policy of a Cloud Deploy Policy. One
binding consists of a member and a role.
See https://cloud.google.com/iam/docs/managing-policies for details of the
policy file format and contents.
EXAMPLES
To remove an IAM policy binding for the role of
roles/roles/clouddeploy.policyAdmin for the user test-user@gmail.com on
holiday-policy with the region us-central1, run:
$ gcloud deploy deploy-policies remove-iam-policy-binding \
holiday-policy --region='us-central1' \
--member='user:test-user@gmail.com' \
--role='roles/roles/clouddeploy.policyAdmin'
POSITIONAL ARGUMENTS
Deploy policy resource - The deploy policy 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 deploy_policy 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.
DEPLOY_POLICY
ID of the deploy policy or fully qualified identifier for the deploy
policy.
To set the deploy_policy attribute:
▸ provide the argument deploy_policy on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Location of the deploy policy.
To set the region attribute:
▸ provide the argument deploy_policy on the command line with a
fully specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/region.
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 clouddeploy/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/deploy/
NOTES
These variants are also available:
$ gcloud alpha deploy deploy-policies remove-iam-policy-binding
$ gcloud beta deploy deploy-policies remove-iam-policy-binding

84
gcloud/deploy/deploy-policies/set-iam-policy Normal file
View file

@ -0,0 +1,84 @@
NAME
gcloud deploy deploy-policies set-iam-policy - set the IAM policy for a
Cloud Deploy Policy
SYNOPSIS
gcloud deploy deploy-policies set-iam-policy
(DEPLOY_POLICY : --region=REGION) POLICY_FILE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Set the IAM policy associated with a Cloud Deploy Policy.
See https://cloud.google.com/iam/docs/managing-policies for details of the
policy file format and contents.
EXAMPLES
The following command will read an IAM policy defined in a JSON file
policy.json and set it for a deploy policy with identifier
my-holiday-policy in region us-central1:
$ gcloud deploy deploy-policies set-iam-policy my-holiday-policy \
policy.json --region=us-central1
See https://cloud.google.com/iam/docs/managing-policies for details of the
policy file format and contents.
POSITIONAL ARGUMENTS
Deploy policy resource - The deploy policy 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 deploy_policy 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.
DEPLOY_POLICY
ID of the deploy policy or fully qualified identifier for the deploy
policy.
To set the deploy_policy attribute:
▸ provide the argument deploy_policy on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Location of the deploy policy.
To set the region attribute:
▸ provide the argument deploy_policy on the command line with a
fully specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/region.
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 clouddeploy/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/deploy/
NOTES
These variants are also available:
$ gcloud alpha deploy deploy-policies set-iam-policy
$ gcloud beta deploy deploy-policies set-iam-policy