HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/394/help/man/man1/gcloud_ai_index-endpoints_undeploy-index.1
.TH "GCLOUD_AI_INDEX\-ENDPOINTS_UNDEPLOY\-INDEX" 1



.SH "NAME"
.HP
gcloud ai index\-endpoints undeploy\-index \- undeploy an index from a Vertex AI index endpoint



.SH "SYNOPSIS"
.HP
\f5gcloud ai index\-endpoints undeploy\-index\fR (\fIINDEX_ENDPOINT\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) \fB\-\-deployed\-index\-id\fR=\fIDEPLOYED_INDEX_ID\fR [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "EXAMPLES"

To undeploy the deployed\-index \f5\fIdeployed\-index\-345\fR\fR from an index
endpoint \f5\fI456\fR\fR under project \f5\fIexample\fR\fR in region
\f5\fIus\-central1\fR\fR, run:

.RS 2m
$ gcloud ai index\-endpoints undeploy\-index 456 \-\-project=example \e
    \-\-region=us\-central1 \-\-deployed\-index\-id=deployed\-index\-345
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Index endpoint resource \- The index endpoint to undeploy an index. 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 \f5index_endpoint\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
\fIINDEX_ENDPOINT\fR

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

To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5index_endpoint\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\-\-region\fR=\fIREGION\fR

Cloud region for the index_endpoint.

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


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-deployed\-index\-id\fR=\fIDEPLOYED_INDEX_ID\fR

Id of the deployed index.


.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 undeploy\-index
.RE

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