- NAME
-
- gcloud iam policy-bindings update - update PolicyBinding instance
- SYNOPSIS
-
-
gcloud iam policy-bindings update
(POLICY_BINDING
:--folder
=FOLDER
--location
=LOCATION
--organization
=ORGANIZATION
) [--async
] [--display-name
=DISPLAY_NAME
] [--etag
=ETAG
] [--annotations
=[ANNOTATIONS
,…] |--update-annotations
=[UPDATE_ANNOTATIONS
,…]--clear-annotations
|--remove-annotations
=[__REMOVE_ANNOTATIONS,…]] [--condition-description
=CONDITION_DESCRIPTION
--condition-expression
=CONDITION_EXPRESSION
--condition-location
=CONDITION_LOCATION
--condition-title
=CONDITION_TITLE
] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
- Update PolicyBinding instance.
- EXAMPLES
-
To update display name of
my-binding
in organization123
run:gcloud iam policy-bindings update my-binding --organization=123 --location=global --display-name=new-display-name
- POSITIONAL ARGUMENTS
-
-
PolicyBinding resource - Identifier. The name of the policy binding, in the
format
{binding_parent/locations/{location}/policyBindings/{policy_binding_id}
. The binding parent is the closest Resource Manager resource (i.e., Project, Folder or Organization) to the binding target.Format:
-
projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}
-
projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}
-
folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}
-
organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}
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
policy_binding
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
. This resource can be one of the following types: [iam.folders.locations.policyBindings, iam.organizations.locations.policyBindings, iam.projects.locations.policyBindings].
This must be specified.
POLICY_BINDING
-
ID of the policyBinding or fully qualified identifier for the policyBinding.
To set the
policy_binding
attribute:-
provide the argument
policy_binding
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--folder
=FOLDER
-
The folder id of the policyBinding resource.
To set the
folder
attribute:-
provide the argument
policy_binding
on the command line with a fully specified name; -
provide the argument
--folder
on the command line. Must be specified for resource of type [iam.folders.locations.policyBindings].
-
provide the argument
--location
=LOCATION
-
The location id of the policyBinding resource.
To set the
location
attribute:-
provide the argument
policy_binding
on the command line with a fully specified name; -
provide the argument
--location
on the command line.
-
provide the argument
--organization
=ORGANIZATION
-
The organization id of the policyBinding resource.
To set the
organization
attribute:-
provide the argument
policy_binding
on the command line with a fully specified name; -
provide the argument
--organization
on the command line. Must be specified for resource of type [iam.organizations.locations.policyBindings].
-
provide the argument
-
-
PolicyBinding resource - Identifier. The name of the policy binding, in the
format
- FLAGS
-
--async
- Return immediately, without waiting for the operation in progress to complete.
--display-name
=DISPLAY_NAME
- The description of the policy binding. Must be less than or equal to 63 characters.
--etag
=ETAG
- The etag for the policy binding. If this is provided on update, it must match the server's etag.
-
Update annotations.
At most one of these can be specified:
--annotations
=[ANNOTATIONS
,…]-
Set annotations to new value. User defined annotations. See https://google.aip.dev/148#annotations
for more details such as format and size limitations.
KEY
-
Sets
KEY
value. VALUE
-
Sets
VALUE
value.
Shorthand Example:
--annotations=string=string
JSON Example:
--annotations='{"string": "string"}'
File Example:
--annotations=path_to_file.(yaml|json)
--update-annotations
=[UPDATE_ANNOTATIONS
,…]-
Update annotations value or add key value pair. User defined annotations. See https://google.aip.dev/148#annotations
for more details such as format and size limitations.
KEY
-
Sets
KEY
value. VALUE
-
Sets
VALUE
value.
Shorthand Example:
--update-annotations=string=string
JSON Example:
--update-annotations='{"string": "string"}'
File Example:
--update-annotations=path_to_file.(yaml|json)
-
At most one of these can be specified:
--clear-annotations
- Clear annotations value and set to empty map.
--remove-annotations
=[__REMOVE_ANNOTATIONS,…]- Remove existing value from map annotations.
-
Represents a textual expression in the Common Expression Language (CEL) syntax.
CEL is a C-like expression language. The syntax and semantics of CEL are
documented at https://github.com/google/cel-spec.
Example (Comparison):
title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"
Example (Equality):
title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
Example (Logic):
title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"
Example (Data Manipulation):
title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"
The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
--condition-description
=CONDITION_DESCRIPTION
- Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
--condition-expression
=CONDITION_EXPRESSION
- Textual representation of an expression in Common Expression Language syntax.
--condition-location
=CONDITION_LOCATION
- String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
--condition-title
=CONDITION_TITLE
- Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
- 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/v3
API. The full documentation for this API can be found at: https://cloud.google.com/iam/ - NOTES
-
This variant is also available:
gcloud beta iam policy-bindings update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-10 UTC.