gcloud dataplex environments describe Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud dataplex environments describe - retrieve a Dataplex Environment
- SYNOPSIS
gcloud dataplex environments describe(ENVIRONMENT:--lake=LAKE--location=LOCATION)[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Get a Dataplex Environment resource based on project, location, lake, andenvironment.
- EXAMPLES
- To describe a Dataplex Environment
test-environmentin projecttest-projectunder locationus-central1within laketest-lake, run:gclouddataplexenvironmentsdescribetest-environment--project=test-project--location=us-central1--lake=test-lake - POSITIONAL ARGUMENTS
- Environment resource - Arguments and flags that define the Dataplex Environmentyou want to retrieve. The arguments in this group can be used to specify theattributes of this resource. (NOTE) Some attributes are not given arguments inthis 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 Environmentyou want to retrieve. The arguments in this group can be used to specify theattributes of this resource. (NOTE) Some attributes are not given arguments inthis 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
dataplex/v1API. The full documentation forthis API can be found at:https://cloud.google.com/dataplex/docs - NOTES
- This variant is also available:
gcloudalphadataplexenvironmentsdescribe
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.