mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-08 10:35:03 +00:00
94 lines
3.5 KiB
Text
94 lines
3.5 KiB
Text
NAME
|
|
gcloud ai index-endpoints create - create a new Vertex AI index endpoint
|
|
|
|
SYNOPSIS
|
|
gcloud ai index-endpoints create --display-name=DISPLAY_NAME
|
|
[--description=DESCRIPTION] [--enable-private-service-connect]
|
|
[--encryption-kms-key-name=ENCRYPTION_KMS_KEY_NAME]
|
|
[--labels=[KEY=VALUE,...]] [--network=NETWORK]
|
|
[--project-allowlist=[PROJECTS,...]] [--public-endpoint-enabled]
|
|
[--region=REGION] [GCLOUD_WIDE_FLAG ...]
|
|
|
|
EXAMPLES
|
|
To create an index endpoint under project example with network
|
|
projects/123/global/networks/test-network in region us-central1, run:
|
|
|
|
$ gcloud ai index-endpoints create --display-name=index-endpoint \
|
|
--description=test \
|
|
--network=projects/123/global/networks/test-network \
|
|
--project=example --region=us-central1
|
|
|
|
REQUIRED FLAGS
|
|
--display-name=DISPLAY_NAME
|
|
Display name of the index endpoint.
|
|
|
|
OPTIONAL FLAGS
|
|
--description=DESCRIPTION
|
|
Description of the index endpoint.
|
|
|
|
--enable-private-service-connect
|
|
If true, expose the index endpoint via private service connect.
|
|
|
|
--encryption-kms-key-name=ENCRYPTION_KMS_KEY_NAME
|
|
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.
|
|
|
|
--labels=[KEY=VALUE,...]
|
|
List of label KEY=VALUE pairs to add.
|
|
|
|
Keys must start with a lowercase character and contain only hyphens
|
|
(-), underscores (_), lowercase characters, and numbers. Values must
|
|
contain only hyphens (-), underscores (_), lowercase characters, and
|
|
numbers.
|
|
|
|
--network=NETWORK
|
|
The Google Compute Engine network name to which the IndexEndpoint
|
|
should be peered.
|
|
|
|
--project-allowlist=[PROJECTS,...]
|
|
List of projects from which the forwarding rule will target the service
|
|
attachment.
|
|
|
|
--public-endpoint-enabled
|
|
If true, the deployed index will be accessible through public endpoint.
|
|
|
|
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 project attribute:
|
|
◆ provide the argument --region on the command line with a fully
|
|
specified name;
|
|
◆ set the property ai/region with a fully specified name;
|
|
◆ choose one from the prompted list of available regions with a fully
|
|
specified name;
|
|
◆ provide the argument --project on the command line;
|
|
◆ set the property core/project.
|
|
|
|
--region=REGION
|
|
ID of the region or fully qualified identifier for the region.
|
|
|
|
To set the region attribute:
|
|
▸ provide the argument --region on the command line;
|
|
▸ set the property ai/region;
|
|
▸ choose one from the prompted list of available regions.
|
|
|
|
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
|
|
These variants are also available:
|
|
|
|
$ gcloud alpha ai index-endpoints create
|
|
|
|
$ gcloud beta ai index-endpoints create
|
|
|