gcloud alpha dataplex environments get-iam-policy Stay organized with collections Save and categorize content based on your preferences.
- 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 Environment
test-environmentinprojecttest-projectunder locationus-central1withinlaketest-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 the
projectattribute:- provide the argument
environmenton the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
ENVIRONMENT- ID of the environment or fully qualified identifier for the environment.
To set the
environmentattribute:- provide the argument
environmenton the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--lake=LAKE- Identifier of the Dataplex lake resource.To set the
lakeattribute:- provide the argument
environmenton the command line with a fullyspecified name; - provide the argument
--lakeon the command line.
- provide the argument
--location=LOCATION- Location of the Dataplex resource.To set the
locationattribute:- provide the argument
environmenton the command line with a fullyspecified name; - provide the argument
--locationon the command line; - set the property
dataplex/location.
- provide the argument
- provide the argument
- 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.
- LIST COMMAND FLAGS
--filter=EXPRESSION- Apply a Boolean filter
EXPRESSIONto 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 is
unlimited. 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 is
unlimited(no paging).Paging may be applied before or after--filterand--limitdepending 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 helpfor details. - API REFERENCE
- This command uses the
dataplex/v1API. 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.