gcloud dataplex environments describe

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 Environmenttest-environment in projecttest-project under locationus-central1 within 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 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.
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 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.