SearchService interface

Paket:

@azure/arm-search

Azure AI Search hizmetini ve geçerli durumunu açıklar.

Extends

TrackedResource

Özellikler

authOptions	Arama hizmetinin veri düzlemi API'sinin isteklerin kimliğini doğrulama seçeneklerini tanımlar. 'disableLocalAuth' true olarak ayarlandıysa bu ayarlanamaz.
computeType	Bu özelliği, Varsayılan İşlem veya Azure Gizli İşlem'i kullanarak arama hizmetini destekleyecek şekilde yapılandırın.
dataExfiltrationProtections	Arama hizmeti için açıkça izin verilmeyen veri sızdırma senaryolarının listesi. Şu anda desteklenen tek değer ,gelecekte daha ayrıntılı denetimlerle tüm olası veri dışarı aktarma senaryolarını devre dışı bırakmak için 'Tümü'dür.
disableLocalAuth	True olarak ayarlandığında, arama hizmetine yapılan çağrıların kimlik doğrulaması için API anahtarlarını kullanmasına izin verilmez. 'dataPlaneAuthOptions' tanımlanmışsa bu true olarak ayarlanamaz.
encryptionWithCmk	Arama hizmetindeki müşteri yöneticisi anahtarlarını kullanarak kaynakların (dizinler gibi) şifrelenmesiyle ilgili tüm ilkeleri belirtir.
endpoint	Azure AI Search hizmetinin uç noktası.
eTag	Güncelleştirmeler sırasında iyimser eşzamanlılık denetimi için olabilecek hizmetin etiketini temsil eden sistem tarafından oluşturulan özellik. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
hostingMode	Yalnızca standart3 SKU için geçerlidir. Bu özelliği, diğer tüm SKU'lar için izin verilen en fazla dizinden çok daha yüksek olan 1000'e kadar dizine izin veren en fazla 3 yüksek yoğunluklu bölümü etkinleştirecek şekilde ayarlayabilirsiniz. Standart3 SKU'su için değer 'default' veya 'highDensity' şeklindedir. Diğer tüm SKU'lar için bu değer 'varsayılan' olmalıdır.
identity	Kaynağın kimliği.
networkRuleSet	Azure AI Search hizmetine nasıl ulaşılabileceğini belirleyen ağa özgü kurallar.
partitionCount	Arama hizmetindeki bölüm sayısı; belirtilirse, 1, 2, 3, 4, 6 veya 12 olabilir. 1'den büyük değerler yalnızca standart SKU'lar için geçerlidir. hostingMode 'highDensity' olarak ayarlanmış 'standard3' hizmetleri için izin verilen değerler 1 ile 3 arasındadır.
privateEndpointConnections	Azure AI Search hizmetine özel uç nokta bağlantılarının listesi. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
provisioningState	Arama hizmetinde gerçekleştirilen son sağlama işleminin durumu. Sağlama, hizmet kapasitesi oluşturulurken oluşan bir ara durumdur. Kapasite ayarlandıktan sonra provisioningState değeri 'Başarılı' veya 'Başarısız' olarak değişir. İstemci uygulamaları, bir işlemin ne zaman tamamlandığını görmek için Arama Hizmeti Al işlemini kullanarak sağlama durumunu yoklayabilir (önerilen yoklama aralığı 30 saniyeden bir dakikaya kadardır). Ücretsiz hizmeti kullanıyorsanız, bu değer doğrudan Arama hizmeti oluşturma çağrısında 'Başarılı' olarak geri dönme eğilimindedir. Bunun nedeni, ücretsiz hizmetin zaten ayarlanmış kapasiteyi kullanmasıdır. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
publicNetworkAccess	Mevcut müşteri kaynaklarında ve şablonlarında hataya neden olan değişiklikleri önlemek için bu değer 'etkin' olarak ayarlanabilir. 'Devre dışı' olarak ayarlanırsa, genel arabirim üzerinden trafiğe izin verilmez ve özel uç nokta bağlantıları özel erişim yöntemi olacaktır.
replicaCount	Arama hizmetindeki çoğaltma sayısı. Belirtilirse, standart SKU'lar için 1 ile 12 arasında veya temel SKU'lar için 1 ile 3 arasında bir değer olmalıdır.
semanticSearch	Anlamsal aramanın kullanılabilirliğini denetleye seçenekleri ayarlar. Bu yapılandırma yalnızca belirli konumlardaki belirli Azure AI Arama SKU'ları için mümkündür.
serviceUpgradedAt	Arama hizmetinin en son yükseltildiği tarih ve saat. Hizmet ilk kez yükseltilene kadar bu alan null olur. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
sharedPrivateLinkResources	Azure AI Search hizmeti tarafından yönetilen paylaşılan özel bağlantı kaynaklarının listesi. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
sku	Fiyat katmanını ve kapasite sınırlarını belirleyen arama hizmetinin SKU'su. Yeni bir arama hizmeti oluşturulurken bu özellik gereklidir.
status	Arama hizmetinin durumu. Olası değerler şunlardır: 'running': Arama hizmeti çalışıyor ve hiçbir sağlama işlemi devam ediyor. 'sağlama': Arama hizmeti sağlanıyor veya ölçeği artırılıyor veya azaltılıyor. 'silme': Arama hizmeti siliniyor. 'düzeyi düşürüldü': Arama hizmetinin düzeyi düşürüldü. Temel alınan arama birimleri iyi durumda olmadığında bu durum oluşabilir. Arama hizmeti büyük olasılıkla çalışır durumdadır, ancak performans yavaş olabilir ve bazı istekler bırakılabilir. 'devre dışı': Arama hizmeti devre dışı bırakıldı. Bu durumda, hizmet tüm API isteklerini reddeder. 'error': Arama hizmeti bir hata durumunda. 'durduruldu': Arama hizmeti devre dışı bırakılmış bir abonelikte. Hizmetiniz düzeyi düşürülmüş, devre dışı bırakılmış veya hata durumlarındaysa, Azure AI Search ekibi temel alınan sorunu etkin bir şekilde araştırıyor demektir. Bu durumlardaki ayrılmış hizmetler, sağlanan arama birimi sayısına göre ücretlendirilebilir. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
statusDetails	Arama hizmeti durumunun ayrıntıları. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
upgradeAvailable	Arama hizmetinin kullanılabilir bir yükseltmesi olup olmadığını gösterir.

Devralınan Özellikler

id	Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
location	Kaynağın bulunduğu coğrafi konum
name	Kaynağın adı NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
tags	Kaynak etiketleri.
type	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" NOT: Bu özellik seri hale getirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

Özellik Ayrıntıları

authOptions

Arama hizmetinin veri düzlemi API'sinin isteklerin kimliğini doğrulama seçeneklerini tanımlar. 'disableLocalAuth' true olarak ayarlandıysa bu ayarlanamaz.

authOptions?: DataPlaneAuthOptions

Özellik Değeri

DataPlaneAuthOptions

computeType

Bu özelliği, Varsayılan İşlem veya Azure Gizli İşlem'i kullanarak arama hizmetini destekleyecek şekilde yapılandırın.

computeType?: string

Özellik Değeri

string

dataExfiltrationProtections

Arama hizmeti için açıkça izin verilmeyen veri sızdırma senaryolarının listesi. Şu anda desteklenen tek değer ,gelecekte daha ayrıntılı denetimlerle tüm olası veri dışarı aktarma senaryolarını devre dışı bırakmak için 'Tümü'dür.

dataExfiltrationProtections?: string[]

Özellik Değeri

string[]

disableLocalAuth

True olarak ayarlandığında, arama hizmetine yapılan çağrıların kimlik doğrulaması için API anahtarlarını kullanmasına izin verilmez. 'dataPlaneAuthOptions' tanımlanmışsa bu true olarak ayarlanamaz.

disableLocalAuth?: boolean

Özellik Değeri

boolean

encryptionWithCmk

Arama hizmetindeki müşteri yöneticisi anahtarlarını kullanarak kaynakların (dizinler gibi) şifrelenmesiyle ilgili tüm ilkeleri belirtir.

encryptionWithCmk?: EncryptionWithCmk

Özellik Değeri

EncryptionWithCmk

endpoint

Azure AI Search hizmetinin uç noktası.

endpoint?: string

Özellik Değeri

string

eTag

Güncelleştirmeler sırasında iyimser eşzamanlılık denetimi için olabilecek hizmetin etiketini temsil eden sistem tarafından oluşturulan özellik. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

eTag?: string

Özellik Değeri

string

hostingMode

Yalnızca standart3 SKU için geçerlidir. Bu özelliği, diğer tüm SKU'lar için izin verilen en fazla dizinden çok daha yüksek olan 1000'e kadar dizine izin veren en fazla 3 yüksek yoğunluklu bölümü etkinleştirecek şekilde ayarlayabilirsiniz. Standart3 SKU'su için değer 'default' veya 'highDensity' şeklindedir. Diğer tüm SKU'lar için bu değer 'varsayılan' olmalıdır.

hostingMode?: HostingMode

Özellik Değeri

HostingMode

identity

Kaynağın kimliği.

identity?: Identity

Özellik Değeri

Identity

networkRuleSet

Azure AI Search hizmetine nasıl ulaşılabileceğini belirleyen ağa özgü kurallar.

networkRuleSet?: NetworkRuleSet

Özellik Değeri

NetworkRuleSet

partitionCount

Arama hizmetindeki bölüm sayısı; belirtilirse, 1, 2, 3, 4, 6 veya 12 olabilir. 1'den büyük değerler yalnızca standart SKU'lar için geçerlidir. hostingMode 'highDensity' olarak ayarlanmış 'standard3' hizmetleri için izin verilen değerler 1 ile 3 arasındadır.

partitionCount?: number

Özellik Değeri

number

privateEndpointConnections

Azure AI Search hizmetine özel uç nokta bağlantılarının listesi. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

privateEndpointConnections?: PrivateEndpointConnection[]

Özellik Değeri

PrivateEndpointConnection[]

provisioningState

Arama hizmetinde gerçekleştirilen son sağlama işleminin durumu. Sağlama, hizmet kapasitesi oluşturulurken oluşan bir ara durumdur. Kapasite ayarlandıktan sonra provisioningState değeri 'Başarılı' veya 'Başarısız' olarak değişir. İstemci uygulamaları, bir işlemin ne zaman tamamlandığını görmek için Arama Hizmeti Al işlemini kullanarak sağlama durumunu yoklayabilir (önerilen yoklama aralığı 30 saniyeden bir dakikaya kadardır). Ücretsiz hizmeti kullanıyorsanız, bu değer doğrudan Arama hizmeti oluşturma çağrısında 'Başarılı' olarak geri dönme eğilimindedir. Bunun nedeni, ücretsiz hizmetin zaten ayarlanmış kapasiteyi kullanmasıdır. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

provisioningState?: ProvisioningState

Özellik Değeri

ProvisioningState

publicNetworkAccess

Mevcut müşteri kaynaklarında ve şablonlarında hataya neden olan değişiklikleri önlemek için bu değer 'etkin' olarak ayarlanabilir. 'Devre dışı' olarak ayarlanırsa, genel arabirim üzerinden trafiğe izin verilmez ve özel uç nokta bağlantıları özel erişim yöntemi olacaktır.

publicNetworkAccess?: string

Özellik Değeri

string

replicaCount

Arama hizmetindeki çoğaltma sayısı. Belirtilirse, standart SKU'lar için 1 ile 12 arasında veya temel SKU'lar için 1 ile 3 arasında bir değer olmalıdır.

replicaCount?: number

Özellik Değeri

number

semanticSearch

Anlamsal aramanın kullanılabilirliğini denetleye seçenekleri ayarlar. Bu yapılandırma yalnızca belirli konumlardaki belirli Azure AI Arama SKU'ları için mümkündür.

semanticSearch?: string

Özellik Değeri

string

serviceUpgradedAt

Arama hizmetinin en son yükseltildiği tarih ve saat. Hizmet ilk kez yükseltilene kadar bu alan null olur. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

serviceUpgradedAt?: Date

Özellik Değeri

Date

sharedPrivateLinkResources

Azure AI Search hizmeti tarafından yönetilen paylaşılan özel bağlantı kaynaklarının listesi. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Özellik Değeri

SharedPrivateLinkResource[]

sku

Fiyat katmanını ve kapasite sınırlarını belirleyen arama hizmetinin SKU'su. Yeni bir arama hizmeti oluşturulurken bu özellik gereklidir.

sku?: Sku

Özellik Değeri

Sku

status

Arama hizmetinin durumu. Olası değerler şunlardır: 'running': Arama hizmeti çalışıyor ve hiçbir sağlama işlemi devam ediyor. 'sağlama': Arama hizmeti sağlanıyor veya ölçeği artırılıyor veya azaltılıyor. 'silme': Arama hizmeti siliniyor. 'düzeyi düşürüldü': Arama hizmetinin düzeyi düşürüldü. Temel alınan arama birimleri iyi durumda olmadığında bu durum oluşabilir. Arama hizmeti büyük olasılıkla çalışır durumdadır, ancak performans yavaş olabilir ve bazı istekler bırakılabilir. 'devre dışı': Arama hizmeti devre dışı bırakıldı. Bu durumda, hizmet tüm API isteklerini reddeder. 'error': Arama hizmeti bir hata durumunda. 'durduruldu': Arama hizmeti devre dışı bırakılmış bir abonelikte. Hizmetiniz düzeyi düşürülmüş, devre dışı bırakılmış veya hata durumlarındaysa, Azure AI Search ekibi temel alınan sorunu etkin bir şekilde araştırıyor demektir. Bu durumlardaki ayrılmış hizmetler, sağlanan arama birimi sayısına göre ücretlendirilebilir. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

status?: SearchServiceStatus

Özellik Değeri

SearchServiceStatus

statusDetails

Arama hizmeti durumunun ayrıntıları. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

statusDetails?: string

Özellik Değeri

string

upgradeAvailable

Arama hizmetinin kullanılabilir bir yükseltmesi olup olmadığını gösterir.

upgradeAvailable?: string

Özellik Değeri

string

Devralınan Özellik Detayları

id

Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

id?: string

Özellik Değeri

string

TrackedResource.id'dan Devralınan

location

Kaynağın bulunduğu coğrafi konum

location: string

Özellik Değeri

string

TrackedResource.location'dan Devralınmış

name

Kaynağın adı NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

name?: string

Özellik Değeri

string

TrackedResource.name'dan Devralınan

systemData

createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

systemData?: SystemData

Özellik Değeri

SystemData

TrackedResource.systemData'dan Devralınan

tags

Kaynak etiketleri.

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

Özellik Değeri

{[propertyName: string]: string}

TrackedResource.tagsDevralındı

type

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" NOT: Bu özellik seri hale getirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

type?: string

Özellik Değeri

string

DevralınanTrackedResource.type