.TH "GCLOUD_ALPHA_DATAPLEX_ENVIRONMENTS_DESCRIBE" 1



.SH "NAME"
.HP
gcloud alpha dataplex environments describe \- retrieve a Dataplex Environment



.SH "SYNOPSIS"
.HP
\f5gcloud alpha dataplex environments describe\fR (\fIENVIRONMENT\fR\ :\ \fB\-\-lake\fR=\fILAKE\fR\ \fB\-\-location\fR=\fILOCATION\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Get a Dataplex Environment resource based on project, location,
lake, and environment.



.SH "EXAMPLES"

To describe a Dataplex Environment \f5test\-environment\fR in project
\f5test\-project\fR under location \f5us\-central1\fR within lake
\f5test\-lake\fR, run:

.RS 2m
$ gcloud alpha dataplex environments describe test\-environment \e
    \-\-project=test\-project \-\-location=us\-central1 \-\-lake=test\-lake
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Environment resource \- Arguments and flags that define the Dataplex Environment
you want to retrieve. The arguments in this group can be used to specify the
attributes of this resource. (NOTE) Some attributes are not given arguments in
this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5environment\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIENVIRONMENT\fR

ID of the environment or fully qualified identifier for the environment.

To set the \f5environment\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5environment\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-lake\fR=\fILAKE\fR

Identifier of the Dataplex lake resource.


To set the \f5lake\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5environment\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-lake\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

Location of the Dataplex resource.


To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5environment\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5dataplex/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBdataplex/v1\fR API. The full documentation for this API
can be found at: https://cloud.google.com/dataplex/docs



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. This variant is also available:

.RS 2m
$ gcloud dataplex environments describe
.RE