gcloud alpha dataplex environments get-iam-policy

NAME
gcloud alpha dataplex environments get-iam-policy - retrieve a Dataplex Environment IAM policy
SYNOPSIS
gcloud alpha dataplex environments get-iam-policy(ENVIRONMENT :--lake=LAKE--location=LOCATION)[--filter=EXPRESSION][--limit=LIMIT][--page-size=PAGE_SIZE][--sort-by=[FIELD,…]][GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Get a Dataplex Environment Iam Policy based on project_id,location, lake_id, and environment_id.
EXAMPLES
To get the IAM policy of a Dataplex Environmenttest-environment inprojecttest-project under locationus-central1 withinlaketest-lake, run:
gcloudalphadataplexenvironmentsget-iam-policytest-environment--project=test-project--location=us-central1--lake=test-lake
POSITIONAL ARGUMENTS
Environment resource - Arguments and flags that define the Dataplex EnvironmentIAM policy you want to retrieve. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments 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 environment or fully qualified identifier for the environment.

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
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
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.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filterEXPRESSION to each resource itemto be listed. If the expression evaluatesTrue, then that item islisted. For more details and examples of filter expressions, run $gcloud topic filters. This flaginteracts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit.
--limit=LIMIT
Maximum number of resources to list. The default isunlimited. Thisflag 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 themaximum number of resources per page. The default is determined by the serviceif it supports paging, otherwise it isunlimited (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 orderis ascending. Prefix a field with ``~´´ for descending order on thatfield. 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 thedataplex/v1 API. The full documentation forthis API can be found at:https://cloud.google.com/dataplex/docs
NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gclouddataplexenvironmentsget-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-05-07 UTC.