Share via

SearchService interface

  • Referensi
Paket:
@azure/arm-search

Menjelaskan layanan Azure Cognitive Search dan statusnya saat ini.

Extends
TrackedResource

Properti

authOptions

Menentukan opsi tentang cara API sarana data dari layanan pencarian mengautentikasi permintaan. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true.
disableLocalAuth

Ketika diatur ke true, panggilan ke layanan pencarian tidak akan diizinkan untuk menggunakan kunci API untuk autentikasi. Ini tidak dapat diatur ke true jika 'dataPlaneAuthOptions' ditentukan.
encryptionWithCmk

Menentukan kebijakan apa pun mengenai enkripsi sumber daya (seperti indeks) menggunakan kunci manajer pelanggan dalam layanan pencarian.
hostingMode

Hanya berlaku untuk SKU standar3. Anda dapat mengatur properti ini untuk mengaktifkan hingga 3 partisi kepadatan tinggi yang memungkinkan hingga 1000 indeks, yang jauh lebih tinggi dari indeks maksimum yang diizinkan untuk SKU lainnya. Untuk SKU standar3, nilainya adalah 'default' atau 'highDensity'. Untuk semua SKU lainnya, nilai ini harus 'default'.
identity

Identitas sumber daya.
networkRuleSet

Aturan khusus jaringan yang menentukan bagaimana layanan Azure Cognitive Search dapat dicapai.
partitionCount

Jumlah partisi dalam layanan pencarian; jika ditentukan, bisa 1, 2, 3, 4, 6, atau 12. Nilai yang lebih besar dari 1 hanya valid untuk SKU standar. Untuk layanan 'standar3' dengan hostingMode yang diatur ke 'highDensity', nilai yang diizinkan adalah antara 1 dan 3.
privateEndpointConnections

Daftar koneksi titik akhir privat ke layanan Azure Cognitive Search. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
provisioningState

Status operasi provisi terakhir yang dilakukan pada layanan pencarian. Provisi adalah status perantara yang terjadi saat kapasitas layanan sedang ditetapkan. Setelah kapasitas disiapkan, provisioningState berubah menjadi 'berhasil' atau 'gagal'. Aplikasi klien dapat melakukan polling status penyediaan (interval polling yang direkomendasikan adalah dari 30 detik hingga satu menit) dengan menggunakan operasi Dapatkan Layanan Pencarian untuk melihat kapan operasi selesai. Jika Anda menggunakan layanan gratis, nilai ini cenderung kembali sebagai 'berhasil' langsung dalam panggilan untuk Membuat layanan pencarian. Ini karena layanan gratis menggunakan kapasitas yang sudah disiapkan. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
publicNetworkAccess

Nilai ini dapat diatur ke 'diaktifkan' untuk menghindari perubahan yang melanggar pada sumber daya dan templat pelanggan yang ada. Jika diatur ke 'dinonaktifkan', lalu lintas melalui antarmuka publik tidak diizinkan, dan koneksi titik akhir privat akan menjadi metode akses eksklusif.
replicaCount

Jumlah replika dalam layanan pencarian. Jika ditentukan, nilainya harus antara 1 dan 12 inklusif untuk SKU standar atau antara 1 dan 3 inklusif untuk SKU dasar.
semanticSearch

Mengatur opsi yang mengontrol ketersediaan pencarian semantik. Konfigurasi ini hanya dimungkinkan untuk SKU Azure Cognitive Search tertentu di lokasi tertentu.
sharedPrivateLinkResources

Daftar sumber daya tautan privat bersama yang dikelola oleh layanan Azure Cognitive Search. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
sku

SKU Layanan Pencarian, yang menentukan tingkat harga dan batas kapasitas. Properti ini diperlukan saat membuat Layanan Pencarian baru.
status

Status layanan pencarian. Nilai yang mungkin termasuk: 'berjalan': Layanan pencarian sedang berjalan dan tidak ada operasi provisi yang sedang berlangsung. 'provisi': Layanan pencarian sedang disediakan atau ditingkatkan atau diturunkan skalanya. 'menghapus': Layanan pencarian sedang dihapus. 'terdegradasi': Layanan pencarian terdegradasi. Ini dapat terjadi ketika unit pencarian yang mendasar tidak sehat. Layanan pencarian kemungkinan besar beroperasi, tetapi performa mungkin lambat dan beberapa permintaan mungkin dihilangkan. 'dinonaktifkan': Layanan pencarian dinonaktifkan. Dalam status ini, layanan akan menolak semua permintaan API. 'error': Layanan pencarian dalam status kesalahan. Jika layanan Anda berada dalam status terdegradasi, dinonaktifkan, atau kesalahan, itu berarti tim Azure Cognitive Search secara aktif menyelidiki masalah yang mendasar. Layanan khusus di status ini masih dikenakan biaya berdasarkan jumlah unit pencarian yang disediakan. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
statusDetails

Detail status layanan pencarian. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

Properti yang Diwariskan

id

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
location

Lokasi geografis tempat sumber daya berada
name

Nama CATATAN sumber daya: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
tags

Tag sumber daya.
type

Jenis sumber daya. Misalnya CATATAN "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts": Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

Detail Properti

authOptions

Menentukan opsi tentang cara API sarana data dari layanan pencarian mengautentikasi permintaan. Ini tidak dapat diatur jika 'disableLocalAuth' diatur ke true.

authOptions?: DataPlaneAuthOptions

Nilai Properti

DataPlaneAuthOptions

disableLocalAuth

Ketika diatur ke true, panggilan ke layanan pencarian tidak akan diizinkan untuk menggunakan kunci API untuk autentikasi. Ini tidak dapat diatur ke true jika 'dataPlaneAuthOptions' ditentukan.

disableLocalAuth?: boolean

Nilai Properti

boolean

encryptionWithCmk

Menentukan kebijakan apa pun mengenai enkripsi sumber daya (seperti indeks) menggunakan kunci manajer pelanggan dalam layanan pencarian.

encryptionWithCmk?: EncryptionWithCmk

Nilai Properti

EncryptionWithCmk

hostingMode

Hanya berlaku untuk SKU standar3. Anda dapat mengatur properti ini untuk mengaktifkan hingga 3 partisi kepadatan tinggi yang memungkinkan hingga 1000 indeks, yang jauh lebih tinggi dari indeks maksimum yang diizinkan untuk SKU lainnya. Untuk SKU standar3, nilainya adalah 'default' atau 'highDensity'. Untuk semua SKU lainnya, nilai ini harus 'default'.

hostingMode?: HostingMode

Nilai Properti

HostingMode

identity

Identitas sumber daya.

identity?: Identity

Nilai Properti

Identity

networkRuleSet

Aturan khusus jaringan yang menentukan bagaimana layanan Azure Cognitive Search dapat dicapai.

networkRuleSet?: NetworkRuleSet

Nilai Properti

NetworkRuleSet

partitionCount

Jumlah partisi dalam layanan pencarian; jika ditentukan, bisa 1, 2, 3, 4, 6, atau 12. Nilai yang lebih besar dari 1 hanya valid untuk SKU standar. Untuk layanan 'standar3' dengan hostingMode yang diatur ke 'highDensity', nilai yang diizinkan adalah antara 1 dan 3.

partitionCount?: number

Nilai Properti

number

privateEndpointConnections

Daftar koneksi titik akhir privat ke layanan Azure Cognitive Search. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

privateEndpointConnections?: PrivateEndpointConnection[]

Nilai Properti

PrivateEndpointConnection[]

provisioningState

Status operasi provisi terakhir yang dilakukan pada layanan pencarian. Provisi adalah status perantara yang terjadi saat kapasitas layanan sedang ditetapkan. Setelah kapasitas disiapkan, provisioningState berubah menjadi 'berhasil' atau 'gagal'. Aplikasi klien dapat melakukan polling status penyediaan (interval polling yang direkomendasikan adalah dari 30 detik hingga satu menit) dengan menggunakan operasi Dapatkan Layanan Pencarian untuk melihat kapan operasi selesai. Jika Anda menggunakan layanan gratis, nilai ini cenderung kembali sebagai 'berhasil' langsung dalam panggilan untuk Membuat layanan pencarian. Ini karena layanan gratis menggunakan kapasitas yang sudah disiapkan. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

provisioningState?: ProvisioningState

Nilai Properti

ProvisioningState

publicNetworkAccess

Nilai ini dapat diatur ke 'diaktifkan' untuk menghindari perubahan yang melanggar pada sumber daya dan templat pelanggan yang ada. Jika diatur ke 'dinonaktifkan', lalu lintas melalui antarmuka publik tidak diizinkan, dan koneksi titik akhir privat akan menjadi metode akses eksklusif.

publicNetworkAccess?: PublicNetworkAccess

Nilai Properti

PublicNetworkAccess

replicaCount

Jumlah replika dalam layanan pencarian. Jika ditentukan, nilainya harus antara 1 dan 12 inklusif untuk SKU standar atau antara 1 dan 3 inklusif untuk SKU dasar.

replicaCount?: number

Nilai Properti

number

semanticSearch

Mengatur opsi yang mengontrol ketersediaan pencarian semantik. Konfigurasi ini hanya dimungkinkan untuk SKU Azure Cognitive Search tertentu di lokasi tertentu.

semanticSearch?: string

Nilai Properti

string

sharedPrivateLinkResources

Daftar sumber daya tautan privat bersama yang dikelola oleh layanan Azure Cognitive Search. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Nilai Properti

SharedPrivateLinkResource[]

sku

SKU Layanan Pencarian, yang menentukan tingkat harga dan batas kapasitas. Properti ini diperlukan saat membuat Layanan Pencarian baru.

sku?: Sku

Nilai Properti

Sku

status

Status layanan pencarian. Nilai yang mungkin termasuk: 'berjalan': Layanan pencarian sedang berjalan dan tidak ada operasi provisi yang sedang berlangsung. 'provisi': Layanan pencarian sedang disediakan atau ditingkatkan atau diturunkan skalanya. 'menghapus': Layanan pencarian sedang dihapus. 'terdegradasi': Layanan pencarian terdegradasi. Ini dapat terjadi ketika unit pencarian yang mendasar tidak sehat. Layanan pencarian kemungkinan besar beroperasi, tetapi performa mungkin lambat dan beberapa permintaan mungkin dihilangkan. 'dinonaktifkan': Layanan pencarian dinonaktifkan. Dalam status ini, layanan akan menolak semua permintaan API. 'error': Layanan pencarian dalam status kesalahan. Jika layanan Anda berada dalam status terdegradasi, dinonaktifkan, atau kesalahan, itu berarti tim Azure Cognitive Search secara aktif menyelidiki masalah yang mendasar. Layanan khusus di status ini masih dikenakan biaya berdasarkan jumlah unit pencarian yang disediakan. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

status?: SearchServiceStatus

Nilai Properti

SearchServiceStatus

statusDetails

Detail status layanan pencarian. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

statusDetails?: string

Nilai Properti

string

Detail Properti yang Diwariskan

id

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

id?: string

Nilai Properti

string

Diwarisi DariTrackedResource.id

location

Lokasi geografis tempat sumber daya berada

location: string

Nilai Properti

string

Diwarisi DariTrackedResource.location

name

Nama CATATAN sumber daya: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

name?: string

Nilai Properti

string

Diwarisi DariTrackedResource.name

tags

Tag sumber daya.

tags?: {[propertyName: string]: string}

Nilai Properti

{[propertyName: string]: string}

Diwarisi DariTrackedResource.tags

type

Jenis sumber daya. Misalnya CATATAN "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts": Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

type?: string

Nilai Properti

string

Diwarisi DariTrackedResource.type