gcloud dataplex environments set-iam-policy

NAME
gcloud dataplex environments set-iam-policy - set an IAM policy binding for a Dataplex Environment as defined in a JSON or YAML file
SYNOPSIS
gcloud dataplex environments set-iam-policy(ENVIRONMENT :--lake=LAKE--location=LOCATION)POLICY_FILE[GCLOUD_WIDE_FLAG]
DESCRIPTION
Seehttps://cloud.google.com/iam/docs/managing-policiesfor details of the policy file format and contents.
EXAMPLES
The following command will read an IAM policy defined in a JSON filepolicy.json and set it for the Dataplex environmenttest-environment within laketest-lake in locationus-central1:
gclouddataplexenvironmentsset-iam-policytest-environment--project=test-project--location=us-central1--lake=test-lakepolicy.json
wherepolicy.jsonistherelativepathtothejsonfile.
POSITIONAL ARGUMENTS
Environments resource - The Environment to set IAM policy to. The arguments inthis group can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentenvironment on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

ENVIRONMENT
ID of the environments or fully qualified identifier for the environments.

To set theenvironment attribute:

  • provide the argumentenvironment on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--lake=LAKE
The identifier of the Dataplex lake resource.

To set thelake attribute:

  • provide the argumentenvironment on the command line with a fullyspecified name;
  • provide the argument--lake on the command line.
--location=LOCATION
The location of the Dataplex resource.

To set thelocation attribute:

  • provide the argumentenvironment on the command line with a fullyspecified name;
  • provide the argument--location on the command line;
  • set the propertydataplex/location.
POLICY_FILE
Path to a local JSON or YAML formatted file containing a valid policy.

The output of theget-iam-policy command is a valid file, as is anyJSON or YAML file conforming to the structure of aPolicy.

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.

NOTES
This variant is also available:
gcloudalphadataplexenvironmentsset-iam-policy

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-22 UTC.