File: //snap/google-cloud-cli/396/help/man/man1/gcloud_alpha_apigee_environments_describe.1
.TH "GCLOUD_ALPHA_APIGEE_ENVIRONMENTS_DESCRIBE" 1
.SH "NAME"
.HP
gcloud alpha apigee environments describe \- describe an Apigee deployment environment
.SH "SYNOPSIS"
.HP
\f5gcloud alpha apigee environments describe\fR (\fIENVIRONMENT\fR\ :\ \fB\-\-organization\fR=\fIORGANIZATION\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR Describe an Apigee deployment environment.
\f5gcloud alpha apigee environments describe\fR shows metadata about an Apigee
environment.
.SH "EXAMPLES"
To describe an environment called \f5\fImy\-env\fR\fR for the active Cloud
Platform project, run:
.RS 2m
$ gcloud alpha apigee environments describe my\-env
.RE
To describe an environment called \f5\fImy\-env\fR\fR, in an organization called
\f5\fImy\-org\fR\fR, as a JSON object, run:
.RS 2m
$ gcloud alpha apigee environments describe my\-env \e
\-\-organization=my\-org \-\-format=json
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Environment resource \- Apigee environment to be described. To get a list of
available environments, run \f5gcloud alpha apigee environments list\fR. The
arguments in this group can be used to specify the attributes of this resource.
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\-\-organization\fR=\fIORGANIZATION\fR
Apigee organization containing the environment. If unspecified, the Cloud
Platform project's associated organization will be used.
To set the \f5organization\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\-\-organization\fR on the command line;
.IP "\(bu" 2m
set the property [project] or provide the argument [\-\-project] on the command
line, using a Cloud Platform project with an associated Apigee organization.
.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 "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 beta apigee environments describe
.RE