SearchService Osztály
Egy Azure Cognitive Search szolgáltatást és annak aktuális állapotát ismerteti.
A változókat csak a kiszolgáló tölti ki, és a rendszer figyelmen kívül hagyja a kérés küldésekor.
Az Azure-ba való küldéshez minden szükséges paramétert fel kell tölteni.
- Öröklődés
-
azure.mgmt.search.models._models_py3.TrackedResourceSearchService
Konstruktor
SearchService(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, identity: _models.Identity | None = None, replica_count: int = 1, partition_count: int = 1, hosting_mode: str | _models.HostingMode = 'default', public_network_access: str | _models.PublicNetworkAccess = 'enabled', network_rule_set: _models.NetworkRuleSet | None = None, encryption_with_cmk: _models.EncryptionWithCmk | None = None, disable_local_auth: bool | None = None, auth_options: _models.DataPlaneAuthOptions | None = None, **kwargs: Any)Paraméterek
- location
- str
A földrajzi hely, ahol az erőforrás található. Kötelező.
- sku
- Sku
A keresési szolgáltatás termékváltozata, amely meghatározza az árszintet és a kapacitáskorlátokat. Ez a tulajdonság új keresési szolgáltatás létrehozásakor szükséges.
- identity
- Identity
Az erőforrás identitása.
- replica_count
- int
A keresési szolgáltatás replikáinak száma. Ha meg van adva, akkor a standard termékváltozatok esetében 1 és 12 közötti, alapszintű termékváltozat esetén 1 és 3 közötti értéknek kell lennie.
- partition_count
- int
A keresési szolgáltatás partícióinak száma; ha meg van adva, 1, 2, 3, 4, 6 vagy 12 lehet. Az 1-nél nagyobb értékek csak standard termékváltozatokra érvényesek. A "standard3" szolgáltatások esetében a hostingMode értéke "highDensity", az engedélyezett értékek 1 és 3 között vannak.
- hosting_mode
- str vagy HostingMode
Csak a standard3 termékváltozatra alkalmazható. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek legfeljebb 1000 indexet tesznek lehetővé, ami sokkal magasabb, mint bármely más termékváltozat esetében engedélyezett maximális indexek. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie. Az ismert értékek a következők: "alapértelmezett" és "highDensity".
- public_network_access
- str vagy PublicNetworkAccess
Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha a "letiltva" értékre van állítva, a nyilvános adapteren keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer. Ismert értékek: "engedélyezve" és "letiltva".
- network_rule_set
- NetworkRuleSet
Hálózatspecifikus szabályok, amelyek meghatározzák, hogyan érhető el a Azure Cognitive Search szolgáltatás.
- encryption_with_cmk
- EncryptionWithCmk
Meghatározza az erőforrások (például indexek) ügyfélkezelői kulcsokkal történő titkosítására vonatkozó szabályzatokat a keresési szolgáltatáson belül.
- disable_local_auth
- bool
Ha igaz értékre van állítva, a keresési szolgáltatás hívásai nem használhatják az API-kulcsokat a hitelesítéshez. Ez nem állítható igaz értékre, ha a "dataPlaneAuthOptions" definiálva van.
- auth_options
- DataPlaneAuthOptions
Meghatározza, hogy a keresési szolgáltatás adatsík API-ja hogyan hitelesíti a kéréseket. Ez nem állítható be, ha a "disableLocalAuth" értéke igaz.
Változók
- id
- str
Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
- name
- str
Az erőforrás neve.
- type
- str
Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts".
- location
- str
A földrajzi hely, ahol az erőforrás található. Kötelező.
- sku
- Sku
A keresési szolgáltatás termékváltozata, amely meghatározza az árszintet és a kapacitáskorlátokat. Ez a tulajdonság új keresési szolgáltatás létrehozásakor szükséges.
- identity
- Identity
Az erőforrás identitása.
- replica_count
- int
A keresési szolgáltatás replikáinak száma. Ha meg van adva, akkor a standard termékváltozatok esetében 1 és 12 közötti, alapszintű termékváltozat esetén 1 és 3 közötti értéknek kell lennie.
- partition_count
- int
A keresési szolgáltatás partícióinak száma; ha meg van adva, 1, 2, 3, 4, 6 vagy 12 lehet. Az 1-nél nagyobb értékek csak standard termékváltozatokra érvényesek. A "standard3" szolgáltatások esetében a hostingMode értéke "highDensity", az engedélyezett értékek 1 és 3 között vannak.
- hosting_mode
- str vagy HostingMode
Csak a standard3 termékváltozatra alkalmazható. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek legfeljebb 1000 indexet tesznek lehetővé, ami sokkal magasabb, mint bármely más termékváltozat esetében engedélyezett maximális indexek. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie. Az ismert értékek a következők: "alapértelmezett" és "highDensity".
- public_network_access
- str vagy PublicNetworkAccess
Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha a "letiltva" értékre van állítva, a nyilvános adapteren keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer. Ismert értékek: "engedélyezve" és "letiltva".
- status
- str vagy SearchServiceStatus
A keresési szolgáltatás állapota. Lehetséges értékek: "futtatás": A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet. "kiépítés": A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van. Törlés: A keresési szolgáltatás törlődik. "csökkentett teljesítményű": A keresési szolgáltatás csökkentett teljesítményű. Ez akkor fordulhat elő, ha a mögöttes keresési egységek nem kifogástalan állapotban vannak. A keresési szolgáltatás valószínűleg működőképes, de a teljesítmény lassú lehet, és egyes kérések elvethetők. "letiltva": A keresési szolgáltatás le van tiltva. Ebben az állapotban a szolgáltatás elutasítja az összes API-kérést. "hiba": A keresési szolgáltatás hibaállapotban van. Ha a szolgáltatás csökkentett teljesítményű, letiltott vagy hibaállapotban van, az azt jelenti, hogy a Azure Cognitive Search csapat aktívan vizsgálja a mögöttes problémát. Ezekben az állapotokban a dedikált szolgáltatások továbbra is díjkötelesek a kiosztott keresési egységek száma alapján. Ismert értékek: "running", "provisioning", "deleting", "degraded", "disabled", "error" és "stopped".
- status_details
- str
A keresési szolgáltatás állapotának részletei.
- provisioning_state
- str vagy ProvisioningState
A keresési szolgáltatásban végrehajtott utolsó kiépítési művelet állapota. A kiépítés egy köztes állapot, amely a szolgáltatáskapacitás létrehozásakor következik be. A kapacitás beállítása után a provisioningState a "sikeres" vagy a "sikertelen" értékre változik. Az ügyfélalkalmazások lekérdezhetik a kiépítési állapotot (az ajánlott lekérdezési időköz 30 másodperctől egy percig tart), a Keresési szolgáltatás lekérése művelettel ellenőrizheti, hogy mikor fejeződik be egy művelet. Ha az ingyenes szolgáltatást használja, ez az érték általában "sikeresként" jelenik meg közvetlenül a Keresési szolgáltatás létrehozása hívásban. Ennek az az oka, hogy az ingyenes szolgáltatás már beállított kapacitást használ. Az ismert értékek a következők: "sikeres", "kiépítés" és "sikertelen".
- network_rule_set
- NetworkRuleSet
Hálózatspecifikus szabályok, amelyek meghatározzák, hogyan érhető el a Azure Cognitive Search szolgáltatás.
- encryption_with_cmk
- EncryptionWithCmk
Meghatározza az erőforrások (például indexek) ügyfélkezelői kulcsokkal történő titkosítására vonatkozó szabályzatokat a keresési szolgáltatáson belül.
- disable_local_auth
- bool
Ha igaz értékre van állítva, a keresési szolgáltatás hívásai nem használhatják az API-kulcsokat a hitelesítéshez. Ez nem állítható igaz értékre, ha a "dataPlaneAuthOptions" definiálva van.
- auth_options
- DataPlaneAuthOptions
Meghatározza, hogy a keresési szolgáltatás adatsík API-ja hogyan hitelesíti a kéréseket. Ez nem állítható be, ha a "disableLocalAuth" értéke igaz.
- private_endpoint_connections
- list[PrivateEndpointConnection]
A Azure Cognitive Search szolgáltatás privát végponti kapcsolatainak listája.
- shared_private_link_resources
- list[SharedPrivateLinkResource]
A Azure Cognitive Search szolgáltatás által felügyelt megosztott privát kapcsolati erőforrások listája.