- NAME
-
- gcloud alpha notebooks instances set-iam-policy - set the IAM policy for an Instance
- SYNOPSIS
-
-
gcloud alpha notebooks instances set-iam-policy(INSTANCE:--location=LOCATION)POLICY_FILE[GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)(DEPRECATED)This command is deprecated. Please usegcloud notebooksinstead.gcloud alpha notebooks instances set-iam-policysets the IAM policy for a Notebook instance given an instance ID and a JSON or YAML file that describes the IAM policy.Note: Setting the IAM policy for an Instance replaces existing IAM bindings for that account.
- EXAMPLES
-
The following command reads an IAM policy defined in the JSON file
policy.jsonand sets it for Instance IDmy_instanceat the specified locaiton:gcloud alpha notebooks instances set-iam-policy my_instance --location=us-central1-a policy.jsonSee https://cloud.google.com/iam/docs/managing-policies for policy file format and content details.
- POSITIONAL ARGUMENTS
-
-
Instance resource - The ID of the instance 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
projectattribute:-
provide the argument
instanceon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
INSTANCE-
ID of the instance or fully qualified identifier for the instance.
To set the
instanceattribute:-
provide the argument
instanceon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
The location of the notebook instance.
To set the
locationattribute:-
provide the argument
instanceon the command line with a fully specified name; -
provide the argument
--locationon the command line; -
set the property
notebooks/location.
-
provide the argument
-
provide the argument
POLICY_FILE-
Path to a local JSON or YAML formatted file containing a valid policy.
The output of the
get-iam-policycommand is a valid file, as is any JSON or YAML file conforming to the structure of a Policy.
-
Instance resource - The ID of the instance 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.
- 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 helpfor details. - API REFERENCE
-
This command uses the
notebooks/v1API. The full documentation for this API can be found at: https://cloud.google.com/notebooks/docs/ - NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. These variants are also available:
gcloud notebooks instances set-iam-policygcloud beta notebooks instances set-iam-policy
gcloud alpha notebooks instances set-iam-policy
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 2025-05-07 UTC.