- NAME
-
- gcloud alpha ai index-endpoints undeploy-index - undeploy an index from a Vertex AI index endpoint
- SYNOPSIS
-
-
gcloud alpha ai index-endpoints undeploy-index
(INDEX_ENDPOINT
:--region
=REGION
)--deployed-index-id
=DEPLOYED_INDEX_ID
[GCLOUD_WIDE_FLAG …
]
-
- EXAMPLES
-
To undeploy the deployed-index
from an index endpointdeployed-index-345
under project456
in regionexample
, run:us-central1
gcloud alpha ai index-endpoints undeploy-index 456 --project=example --region=us-central1 --deployed-index-id=deployed-index-345
- POSITIONAL ARGUMENTS
-
-
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
project
attribute:-
provide the argument
index_endpoint
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
This must be specified.
INDEX_ENDPOINT
-
ID of the index_endpoint or fully qualified identifier for the index_endpoint.
To set the
name
attribute:-
provide the argument
index_endpoint
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--region
=REGION
-
Cloud region for the index_endpoint.
To set the
region
attribute:-
provide the argument
index_endpoint
on the command line with a fully specified name; -
provide the argument
--region
on the command line; -
set the property
ai/region
; - choose one from the prompted list of available regions.
-
provide the argument
-
provide the argument
-
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.
- REQUIRED FLAGS
-
--deployed-index-id
=DEPLOYED_INDEX_ID
- Id of the deployed index.
- 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
$ gcloud help
for details. - 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. These variants are also available:
gcloud ai index-endpoints undeploy-index
gcloud beta ai index-endpoints undeploy-index
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-06 UTC.