.TH "GCLOUD_BETA_ARTIFACTS_DOCKER_IMAGES_DESCRIBE" 1



.SH "NAME"
.HP
gcloud beta artifacts docker images describe \- describe an Artifact Registry container image



.SH "SYNOPSIS"
.HP
\f5gcloud beta artifacts docker images describe\fR \fIIMAGE\fR [\fB\-\-metadata\-filter\fR=\fIMETADATA_FILTER\fR] [\fB\-\-show\-all\-metadata\fR] [\fB\-\-show\-build\-details\fR] [\fB\-\-show\-deployment\fR] [\fB\-\-show\-image\-basis\fR] [\fB\-\-show\-package\-vulnerability\fR] [\fB\-\-show\-provenance\fR] [\fB\-\-show\-sbom\-references\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Reference an image by tag or digest using the format:

.RS 2m
LOCATION\-docker.pkg.dev/PROJECT\-ID/REPOSITORY\-ID/IMAGE:tag
LOCATION\-docker.pkg.dev/PROJECT\-ID/REPOSITORY\-ID/IMAGE@sha256:digest
.RE

This command can fail for the following reasons:
.RS 2m
.IP "\(bu" 2m
The repository format is invalid.
.IP "\(bu" 2m
The specified image does not exist.
.IP "\(bu" 2m
The active account does not have permission to run the command
(\f5roles/artifactregistry.reader\fR, \f5roles/containeranalysis.admin\fR and
\f5roles/serviceusage.serviceUsageViewer\fR).
.RE
.sp



.SH "EXAMPLES"

To describe an image digest \f5abcxyz\fR under image \f5busy\-box\fR:

.RS 2m
$ gcloud beta artifacts docker images describe \e
  us\-west1\-docker.pkg.dev/my\-project/my\-repository/\e
busy\-box@sha256:abcxyz
.RE

To describe an image \f5busy\-box\fR with tag \f5my\-tag\fR:

.RS 2m
$ gcloud beta artifacts docker images describe \e
  us\-west1\-docker.pkg.dev/my\-project/my\-repository/busy\-box:my\-tag
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIIMAGE\fR

A container image.

A valid container image has the format of
LOCATION\-docker.pkg.dev/PROJECT\-ID/REPOSITORY\-ID/IMAGE

A valid container image that can be referenced by tag or digest, has the format
of LOCATION\-docker.pkg.dev/PROJECT\-ID/REPOSITORY\-ID/IMAGE:tag
LOCATION\-docker.pkg.dev/PROJECT\-ID/REPOSITORY\-ID/IMAGE@sha256:digest


.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-metadata\-filter\fR=\fIMETADATA_FILTER\fR

Additional filter to fetch metadata for a given qualified image reference.

.TP 2m
\fB\-\-show\-all\-metadata\fR

Include all metadata in the output. Metadata will be grouped by Grafeas kind,
with an additional section for intoto provenance metadata.

.TP 2m
\fB\-\-show\-build\-details\fR

Include build metadata in the output.

.TP 2m
\fB\-\-show\-deployment\fR

Include deployment metadata in the output.

.TP 2m
\fB\-\-show\-image\-basis\fR

Include base image metadata in the output.

.TP 2m
\fB\-\-show\-package\-vulnerability\fR

Include vulnerability metadata in the output.

.TP 2m
\fB\-\-show\-provenance\fR

Include intoto provenance metadata in the output, in the provenance_summary
section. To see all build metadata in the output, use \-\-show\-all\-metadata or
\-\-show\-build\-details.

.TP 2m
\fB\-\-show\-sbom\-references\fR

Include SBOM metadata in the output.


.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 beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud artifacts docker images describe
.RE

.RS 2m
$ gcloud alpha artifacts docker images describe
.RE