SearchService interface

Balíček:

@azure/arm-search

Popisuje službu Azure AI Search a její aktuální stav.

Extends

TrackedResource

Vlastnosti

authOptions	Definuje možnosti, jak rozhraní API roviny dat vyhledávací služby ověřuje požadavky. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.
computeType	Nakonfigurujte tuto vlastnost tak, aby podporovala vyhledávací službu pomocí výchozího výpočetního prostředí nebo důvěrného výpočetního prostředí Azure.
dataExfiltrationProtections	Seznamscénářůch V současné době je jedinou podporovanou hodnotou "Vše", která zakáže všechny možné scénáře exportu dat s jemněji odstupňovanými ovládacími prvky plánovanými pro budoucnost.
disableLocalAuth	Pokud je nastavená hodnota true, nebudou volání vyhledávací služby povolena k ověřování pomocí klíčů rozhraní API. Tuto hodnotu nelze nastavit na hodnotu true, pokud jsou definovány hodnoty dataPlaneAuthOptions.
encryptionWithCmk	Určuje všechny zásady týkající se šifrování prostředků (například indexů) pomocí klíčů správce zákazníků v rámci vyhledávací služby.
endpoint	Koncový bod služby Azure AI Search.
eTag	Systém vygenerovaná vlastnost představující jmenovku služby, která může být pro řízení optimistické souběžnosti během aktualizací. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
hostingMode	Platí pouze pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby umožňovala až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem vyšší než maximální povolený počet indexů pro jakoukoli jinou skladovou položku. U skladové položky Standard3 je tato hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.
identity	Identita prostředku.
networkRuleSet	Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search.
partitionCount	Počet oddílů ve vyhledávací službě; pokud je zadaný, může to být 1, 2, 3, 4, 6 nebo 12. Hodnoty větší než 1 jsou platné pouze pro standardní skladové položky. Pro služby standard3 s hostingMode nastaveným na highDensity jsou povolené hodnoty mezi 1 a 3.
privateEndpointConnections	Seznam připojení privátních koncových bodů ke službě Azure AI Search. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
provisioningState	Stav poslední operace zřizování prováděné ve vyhledávací službě. Zřizování je zprostředkující stav, ke kterému dochází při vytváření kapacity služby. Po nastavení kapacity se stav zřizování změní na Úspěch nebo Selhání. Klientské aplikace můžou dotazovat stav zřizování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Get Search Service a zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, tato hodnota se obvykle vrací jako úspěch přímo ve volání pro vytvoření vyhledávací služby. Důvodem je to, že bezplatná služba používá kapacitu, která je už nastavená. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
publicNetworkAccess	Tuto hodnotu je možné nastavit na povoleno, aby nedocházelo k zásadním změnám stávajících prostředků a šablon zákazníků. Pokud je tato možnost nastavená na zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátního koncového bodu by byla výhradní metodou přístupu.
replicaCount	Počet replik ve vyhledávací službě. Pokud je zadáno, musí být hodnota mezi 1 a 12 včetně pro standardní skladové položky nebo mezi 1 a 3 včetně pro základní skladovou položku.
semanticSearch	Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná jenom pro určité skladové položky služby Azure AI Search v určitých umístěních.
serviceUpgradedAt	Datum a čas posledního upgradu vyhledávací služby. Toto pole bude null, dokud se služba poprvé neupgraduje. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
sharedPrivateLinkResources	Seznam sdílených prostředků privátního propojení spravovaných službou Azure AI Search POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
sku	Skladová položka vyhledávací služby, která určuje cenové úrovně a limity kapacity. Tato vlastnost se vyžaduje při vytváření nové vyhledávací služby.
status	Stav vyhledávací služby. Mezi možné hodnoty patří: "running": Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování. Zřizování: Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů. "odstranění": Vyhledávací služba se odstraňuje. Degradováno: Vyhledávací služba je degradovaná. K tomu může dojít v případě, že základní vyhledávací jednotky nejsou v pořádku. Vyhledávací služba je pravděpodobně funkční, ale výkon může být pomalý a některé požadavky se můžou vynechat. Zakázáno: Vyhledávací služba je zakázaná. V tomto stavu služba odmítne všechny požadavky rozhraní API. Chyba: Vyhledávací služba je ve stavu chyby. Zastaveno: Vyhledávací služba je v předplatném, které je zakázané. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, znamená to, že tým Azure AI Search aktivně prošetřuje základní problém. Vyhrazené služby v těchto stavech jsou stále zpoplatněné na základě počtu zřízených jednotek vyhledávání. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
statusDetails	Podrobnosti o stavu vyhledávací služby. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
upgradeAvailable	Označuje, jestli má vyhledávací služba k dispozici upgrade.

Zděděné vlastnosti

id	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
location	Geografické umístění, ve kterém se nachází zdroj
name	Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
tags	Značky prostředků
type	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

Podrobnosti vlastnosti

authOptions

Definuje možnosti, jak rozhraní API roviny dat vyhledávací služby ověřuje požadavky. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.

authOptions?: DataPlaneAuthOptions

Hodnota vlastnosti

DataPlaneAuthOptions

computeType

Nakonfigurujte tuto vlastnost tak, aby podporovala vyhledávací službu pomocí výchozího výpočetního prostředí nebo důvěrného výpočetního prostředí Azure.

computeType?: string

Hodnota vlastnosti

string

dataExfiltrationProtections

Seznamscénářůch V současné době je jedinou podporovanou hodnotou "Vše", která zakáže všechny možné scénáře exportu dat s jemněji odstupňovanými ovládacími prvky plánovanými pro budoucnost.

dataExfiltrationProtections?: string[]

Hodnota vlastnosti

string[]

disableLocalAuth

Pokud je nastavená hodnota true, nebudou volání vyhledávací služby povolena k ověřování pomocí klíčů rozhraní API. Tuto hodnotu nelze nastavit na hodnotu true, pokud jsou definovány hodnoty dataPlaneAuthOptions.

disableLocalAuth?: boolean

Hodnota vlastnosti

boolean

encryptionWithCmk

Určuje všechny zásady týkající se šifrování prostředků (například indexů) pomocí klíčů správce zákazníků v rámci vyhledávací služby.

encryptionWithCmk?: EncryptionWithCmk

Hodnota vlastnosti

EncryptionWithCmk

endpoint

Koncový bod služby Azure AI Search.

endpoint?: string

Hodnota vlastnosti

string

eTag

Systém vygenerovaná vlastnost představující jmenovku služby, která může být pro řízení optimistické souběžnosti během aktualizací. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

eTag?: string

Hodnota vlastnosti

string

hostingMode

Platí pouze pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby umožňovala až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem vyšší než maximální povolený počet indexů pro jakoukoli jinou skladovou položku. U skladové položky Standard3 je tato hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.

hostingMode?: HostingMode

Hodnota vlastnosti

HostingMode

identity

Identita prostředku.

identity?: Identity

Hodnota vlastnosti

Identity

networkRuleSet

Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search.

networkRuleSet?: NetworkRuleSet

Hodnota vlastnosti

NetworkRuleSet

partitionCount

Počet oddílů ve vyhledávací službě; pokud je zadaný, může to být 1, 2, 3, 4, 6 nebo 12. Hodnoty větší než 1 jsou platné pouze pro standardní skladové položky. Pro služby standard3 s hostingMode nastaveným na highDensity jsou povolené hodnoty mezi 1 a 3.

partitionCount?: number

Hodnota vlastnosti

number

privateEndpointConnections

Seznam připojení privátních koncových bodů ke službě Azure AI Search. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

privateEndpointConnections?: PrivateEndpointConnection[]

Hodnota vlastnosti

PrivateEndpointConnection[]

provisioningState

Stav poslední operace zřizování prováděné ve vyhledávací službě. Zřizování je zprostředkující stav, ke kterému dochází při vytváření kapacity služby. Po nastavení kapacity se stav zřizování změní na Úspěch nebo Selhání. Klientské aplikace můžou dotazovat stav zřizování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Get Search Service a zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, tato hodnota se obvykle vrací jako úspěch přímo ve volání pro vytvoření vyhledávací služby. Důvodem je to, že bezplatná služba používá kapacitu, která je už nastavená. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

provisioningState?: ProvisioningState

Hodnota vlastnosti

ProvisioningState

publicNetworkAccess

Tuto hodnotu je možné nastavit na povoleno, aby nedocházelo k zásadním změnám stávajících prostředků a šablon zákazníků. Pokud je tato možnost nastavená na zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátního koncového bodu by byla výhradní metodou přístupu.

publicNetworkAccess?: string

Hodnota vlastnosti

string

replicaCount

Počet replik ve vyhledávací službě. Pokud je zadáno, musí být hodnota mezi 1 a 12 včetně pro standardní skladové položky nebo mezi 1 a 3 včetně pro základní skladovou položku.

replicaCount?: number

Hodnota vlastnosti

number

semanticSearch

Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná jenom pro určité skladové položky služby Azure AI Search v určitých umístěních.

semanticSearch?: string

Hodnota vlastnosti

string

serviceUpgradedAt

Datum a čas posledního upgradu vyhledávací služby. Toto pole bude null, dokud se služba poprvé neupgraduje. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

serviceUpgradedAt?: Date

Hodnota vlastnosti

Date

sharedPrivateLinkResources

Seznam sdílených prostředků privátního propojení spravovaných službou Azure AI Search POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Hodnota vlastnosti

SharedPrivateLinkResource[]

sku

Skladová položka vyhledávací služby, která určuje cenové úrovně a limity kapacity. Tato vlastnost se vyžaduje při vytváření nové vyhledávací služby.

sku?: Sku

Hodnota vlastnosti

Sku

status

Stav vyhledávací služby. Mezi možné hodnoty patří: "running": Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování. Zřizování: Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů. "odstranění": Vyhledávací služba se odstraňuje. Degradováno: Vyhledávací služba je degradovaná. K tomu může dojít v případě, že základní vyhledávací jednotky nejsou v pořádku. Vyhledávací služba je pravděpodobně funkční, ale výkon může být pomalý a některé požadavky se můžou vynechat. Zakázáno: Vyhledávací služba je zakázaná. V tomto stavu služba odmítne všechny požadavky rozhraní API. Chyba: Vyhledávací služba je ve stavu chyby. Zastaveno: Vyhledávací služba je v předplatném, které je zakázané. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, znamená to, že tým Azure AI Search aktivně prošetřuje základní problém. Vyhrazené služby v těchto stavech jsou stále zpoplatněné na základě počtu zřízených jednotek vyhledávání. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

status?: SearchServiceStatus

Hodnota vlastnosti

SearchServiceStatus

statusDetails

Podrobnosti o stavu vyhledávací služby. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

statusDetails?: string

Hodnota vlastnosti

string

upgradeAvailable

Označuje, jestli má vyhledávací služba k dispozici upgrade.

upgradeAvailable?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

id

Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

id?: string

Hodnota vlastnosti

string

zděděno zTrackedResource.id

location

Geografické umístění, ve kterém se nachází zdroj

location: string

Hodnota vlastnosti

string

zděděno zTrackedResource.location

name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

name?: string

Hodnota vlastnosti

string

zděděno zTrackedResource.name

systemData

Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

systemData?: SystemData

Hodnota vlastnosti

SystemData

zděděno ztrackedResource.systemData

tags

Značky prostředků

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

Hodnota vlastnosti

{[propertyName: string]: string}

zděděno zeTrackedResource.tags

type

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

type?: string

Hodnota vlastnosti

string

zděděno zeTrackedResource.type