
.TH "GCLOUD_AI_INDEX\-ENDPOINTS_CREATE" 1



.SH "NAME"
.HP
gcloud ai index\-endpoints create \- create a new Vertex AI index endpoint



.SH "SYNOPSIS"
.HP
\f5gcloud ai index\-endpoints create\fR \fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-enable\-private\-service\-connect\fR] [\fB\-\-encryption\-kms\-key\-name\fR=\fIENCRYPTION_KMS_KEY_NAME\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-network\fR=\fINETWORK\fR] [\fB\-\-project\-allowlist\fR=[\fIPROJECTS\fR,...]] [\fB\-\-public\-endpoint\-enabled\fR] [\fB\-\-region\fR=\fIREGION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "EXAMPLES"

To create an index endpoint under project \f5example\fR with network
\f5projects/123/global/networks/test\-network\fR in region \f5us\-central1\fR,
run:

.RS 2m
$ gcloud ai index\-endpoints create \-\-display\-name=index\-endpoint \e
    \-\-description=test \e
    \-\-network=projects/123/global/networks/test\-network \e
    \-\-project=example \-\-region=us\-central1
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

Display name of the index endpoint.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Description of the index endpoint.

.TP 2m
\fB\-\-enable\-private\-service\-connect\fR

If true, expose the index endpoint via private service connect.

.TP 2m
\fB\-\-encryption\-kms\-key\-name\fR=\fIENCRYPTION_KMS_KEY_NAME\fR

The Cloud KMS resource identifier of the customer managed encryption key used to
protect a resource. Has the form:
projects/my\-project/locations/my\-region/keyRings/my\-kr/cryptoKeys/my\-key.

The key needs to be in the same region as where the compute resource is created.

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m
\fB\-\-network\fR=\fINETWORK\fR

The Google Compute Engine network name to which the IndexEndpoint should be
peered.

.TP 2m
\fB\-\-project\-allowlist\fR=[\fIPROJECTS\fR,...]

List of projects from which the forwarding rule will target the service
attachment.

.TP 2m
\fB\-\-public\-endpoint\-enabled\fR

If true, the deployed index will be accessible through public endpoint.

.TP 2m

Region resource \- Cloud region to create index endpoint. This represents a
Cloud 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 \f5\-\-region\fR on the command line with a fully specified
name;
.IP "\(em" 2m
set the property \f5ai/region\fR with a fully specified name;
.IP "\(em" 2m
choose one from the prompted list of available regions 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


.TP 2m
\fB\-\-region\fR=\fIREGION\fR

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

To set the \f5region\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(em" 2m
set the property \f5ai/region\fR;
.IP "\(em" 2m
choose one from the prompted list of available regions.
.RE
.sp


.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"

These variants are also available:

.RS 2m
$ gcloud alpha ai index\-endpoints create
.RE

.RS 2m
$ gcloud beta ai index\-endpoints create
.RE


