Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
- nejnovější
- 2026-03-01-preview
- 2025-05-01
- 2025-02-01-preview
-
2024-06-01-preview - 2024-03-01-náhled
- 11. 11. 2023
- 2022-09-01
-
2021-04-01-preview -
2020-08-01 -
2020-08-01-preview - 13. 3. 2020
- 10. 10. 2019 ve verzi Preview
- 19. 8. 2015
- 2015-02-28
Definice prostředku Bicep
Typ prostředku searchServices je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Příklady použití
Ukázky Bicep
Základní příklad nasazení vyhledávací služby.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource searchService 'Microsoft.Search/searchServices@2022-09-01' = {
name: resourceName
location: location
sku: {
name: 'standard'
}
properties: {
authOptions: {
apiKeyOnly: {}
}
disableLocalAuth: false
encryptionWithCmk: {
enforcement: 'Disabled'
}
hostingMode: 'default'
networkRuleSet: {
ipRules: []
}
partitionCount: 1
publicNetworkAccess: 'Enabled'
replicaCount: 1
}
tags: {
environment: 'staging'
}
}
Ověřené moduly Azure
K nasazení tohoto typu prostředku je možné použít následující ověřené moduly Azure.
| Modul | Popis |
|---|---|
| vyhledávací služby | Modul prostředků AVM pro vyhledávací službu |
Ukázky rychlého startu Azure
Následující šablony Azure pro rychlý start obsahují ukázky Bicep pro nasazení tohoto typu prostředku.
| Soubor Bicep | Popis |
|---|---|
| Síť Azure AI Foundry je omezena | Tato sada šablon ukazuje, jak nastavit Azure AI Foundry se zakázaným privátním propojením a výstupním přenosem pomocí klíčů spravovaných Microsoftem pro šifrování a konfigurace identity spravované Microsoftem pro prostředek AI. |
| služby Azure Cognitive Search | Tato šablona vytvoří službu Azure Cognitive Search. |
| agenta zabezpečeného sítí s identitou spravovanou uživatelem | Tato sada šablon ukazuje, jak nastavit službu agenta Azure AI s izolací virtuální sítě pomocí autetika identity spravované uživatelem pro připojení a AI Service/AOAI a privátní síťové propojení pro připojení agenta k zabezpečeným datům. |
| nastavení standardního agenta | Tato sada šablon ukazuje, jak nastavit službu agenta Azure AI se standardním nastavením, což znamená ověřování spravovaných identit pro připojení k projektu nebo centru a povolený veřejný přístup k internetu. Agenti používají prostředky vyhledávání a úložiště vlastněné zákazníky s jedním tenantem. Díky tomuto nastavení máte plnou kontrolu a přehled o těchto prostředcích, ale na základě využití vám budou účtovány náklady. |
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Search/searchServices, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.Search/searchServices@2026-03-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
authOptions: {
aadOrApiKey: {
aadAuthFailureMode: 'string'
}
apiKeyOnly: any(...)
}
computeType: 'string'
dataExfiltrationProtections: [
'string'
]
disableLocalAuth: bool
encryptionWithCmk: {
enforcement: 'string'
serviceLevelEncryptionKey: {
accessCredentials: {
applicationId: 'string'
applicationSecret: 'string'
}
identity: {
@odata.type: 'string'
// For remaining properties, see DataIdentity objects
}
keyVaultKeyName: 'string'
keyVaultKeyVersion: 'string'
keyVaultUri: 'string'
}
}
endpoint: 'string'
hostingMode: 'string'
knowledgeRetrieval: 'string'
networkRuleSet: {
bypass: 'string'
ipRules: [
{
value: 'string'
}
]
}
partitionCount: int
publicNetworkAccess: 'string'
replicaCount: int
semanticSearch: 'string'
upgradeAvailable: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Objekty DataIdentity
Nastavte vlastnost @odata.type pro určení typu objektu.
Pro #Microsoft.Azure.Search.DataNoneIdentity použijte:
{
@odata.type: '#Microsoft.Azure.Search.DataNoneIdentity'
}
Pro #Microsoft.Azure.Search.DataUserAssignedIdentity použijte:
{
@odata.type: '#Microsoft.Azure.Search.DataUserAssignedIdentity'
federatedIdentityClientId: 'string'
userAssignedIdentity: 'string'
}
Hodnoty vlastností
Microsoft.Search/searchServices
| Jméno | Popis | Hodnota |
|---|---|---|
| identita | Identita prostředku. | identity |
| poloha | Geografické umístění, ve kterém se nachází zdroj | string (povinné) |
| Jméno | Název prostředku | string Omezení: Model = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (povinné) |
| vlastnosti | Vlastnosti vyhledávací služby. | SearchServiceProperties |
| SKU (identifikátor zboží) | 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. | skladové položky |
| visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
AzureActiveDirectoryApplicationCredentials
| Jméno | Popis | Hodnota |
|---|---|---|
| ID aplikace | ID aplikace (klienta) registrace aplikace v tenantu. | řetězec |
| tajný kód aplikace | Tajemství klienta AAD, které bylo vytvořeno pro registraci aplikace a použilo se k autentizaci s Azure Key Vault. | string Omezení: Citlivá hodnota. Předejte ho jako zabezpečený parametr. |
Datová identita
| Jméno | Popis | Hodnota |
|---|---|---|
| @odata.type | Nastavte na "#Microsoft.Azure.Search.DataNoneIdentity" pro typ DataNoneIdentity. Nastavte na #Microsoft.Azure.Search.DataUserAssignedIdentity pro typ DataUserAssignedIdentity. | '#Microsoft.Azure.Search.DataNoneIdentity' '#Microsoft.Azure.Search.DataUserAssignedIdentity' (povinné) |
Identifikátor DataNoneIdentity
| Jméno | Popis | Hodnota |
|---|---|---|
| @odata.type | Fragment identifikátoru URI určující typ identity. | '#Microsoft.Azure.Search.DataNoneIdentity' (povinné) |
DataPlaneAaadOrApiKeyAuthOption
| Jméno | Popis | Hodnota |
|---|---|---|
| aadAuthFailureMode | Popisuje, jaká odpověď rozhraní API roviny dat vyhledávací služby by odeslala požadavky, které selhaly při ověřování. | Http401WithBearerChallenge Http403 |
Možnosti datové roviny
| Jméno | Popis | Hodnota |
|---|---|---|
| aadOrApiKey | Označuje, že k ověřování je možné použít klíč rozhraní API nebo přístupový token z tenanta Microsoft Entra ID. | DataPlaneAaadOrApiKeyAuthOption |
| apiKeyOnly | Označuje, že k ověřování je možné použít pouze klíč rozhraní API. | jakýkoliv |
Přiřazená identita uživatele DataUser
| Jméno | Popis | Hodnota |
|---|---|---|
| @odata.type | Fragment identifikátoru URI určující typ identity. | '#Microsoft.Azure.Search.DataUserAssignedIdentity' (povinné) |
| Identita_identifikátoru federatedClientId | Volitelné pro podporu CMK pro více nájemců User-Assigned spravovanou identitu: Klientské ID (jako UUID) registrace aplikace pro více nájemců, která byla nakonfigurována tak, aby se federovala s uživatelskou přiřazenou identitou. | řetězec |
| userAssignedIdentity | Plně kvalifikované ID prostředku Azure spravované identity přiřazené uživatelem obvykle ve formátu "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", které by mělo být přiřazeno vyhledávací službě. | string (povinné) |
EncryptionWithCmk
| Jméno | Popis | Hodnota |
|---|---|---|
| vynucení | Popisuje, jak by vyhledávací služba měla vynutit dodržování předpisů, pokud najde objekty, které nejsou šifrované pomocí klíče spravovaného zákazníkem. | Zakázáno Povoleno Není zadáno. |
| serviceLevelEncryptionKey | Popisuje konfiguraci klíčů spravovanou zákazníkem pro šifrování vyhledávací služby. | SearchResourceEncryptionKey |
Identita
| Jméno | Popis | Hodnota |
|---|---|---|
| typ | Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje identitu vytvořenou systémem i sadu identit přiřazených uživatelem. Typ None odebere všechny identity ze služby. | None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned (povinné) |
| uživatelem přiřazené identity | Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Jméno | Popis | Hodnota |
|---|
Pravidlo protokolu IpRule
| Jméno | Popis | Hodnota |
|---|---|---|
| hodnota | Hodnota odpovídající jedné adrese IPv4 (např. 123.1.2.3) nebo rozsahu IP adres ve formátu CIDR (např. 123.1.2.3/24). | řetězec |
Sada pravidel sítě
| Jméno | Popis | Hodnota |
|---|---|---|
| obejít | Možný původ příchozího provozu, který může obejít pravidla definovaná v části "ipRules". | AzurePortal AzureServices None (Žádný) |
| IpRules | Seznam pravidel omezení PROTOKOLU IP, která definují příchozí sítě s povolením přístupu ke koncovému bodu vyhledávací služby. Mezitím brána firewall blokuje všechny ostatní veřejné IP sítě. Tato pravidla omezení se použijí pouze v případech, kdy je povolená "publicNetworkAccess" vyhledávací služby; jinak provoz přes veřejné rozhraní není povolen ani s pravidly veřejné IP adresy a připojení privátních koncových bodů by byla výhradní metodou přístupu. | iprule[] |
Klíč šifrování zdrojů
| Jméno | Popis | Hodnota |
|---|---|---|
| accessCredentials | Volitelné přihlašovací údaje Azure Active Directory používané pro přístup k Azure Key Vault. Není vyžadováno, pokud místo toho používáte spravovanou identitu. | AzureActiveDirectoryApplicationCredentials |
| identita | Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadána vlastnost přihlašovacích údajů přístupu null, použije se spravovaná identita přiřazená systémem. Při aktualizaci prostředku zůstane explicitní identita beze změny. Pokud je zadána hodnota "none", hodnota této vlastnosti je vymazána. | Datová identita |
| Klíčové_jméno trezoru klíčů | Název klíče služby Azure Key Vault, který se má použít k šifrování neaktivních uložených dat. | řetězec |
| keyVaultKeyVersion | Verze klíče služby Azure Key Vault, která se má použít k šifrování neaktivních uložených dat. | řetězec |
| klíč VaultUri | Identifikátor URI služby Azure Key Vault, označovaný také jako název DNS, který obsahuje klíč, který se má použít k šifrování neaktivních uložených dat. Příkladem identifikátoru URI může být https://my-keyvault-name.vault.azure.net. |
řetězec |
Vlastnosti služby SearchService
| Jméno | Popis | Hodnota |
|---|---|---|
| Možnosti 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. | Důvěrné 'Default' |
| 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. | Řetězcové pole obsahující některou z těchto možností: 'BlockAll' |
| 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. | Bool |
| 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 |
| koncový bod | Koncový bod služby Azure AI Vyhledávač. | řetězec |
| Režim hostování | 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. Pro skladovou položku standard3 je hodnota buď "Default" nebo "HighDensity". U všech ostatních skladových položek musí být tato hodnota Výchozí. | 'Default' "Vysoká hustota" |
| knowledgeRetrieval | Specifikuje fakturační plán pro agentické vyhledávání ve službě Azure AI Vyhledávač. Tato konfigurace je dostupná pouze pro určité cenové kategorie v určitých regionech. | "free" "standard" |
| networkRuleSet | Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Vyhledávač. | Sada pravidel sítě |
| partitionCount | Počet oddílů v dedikované vyhledávací službě; pokud je uvedeno, 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. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| přístup k veřejné síti | Tuto hodnotu lze nastavit na "Povoleno", aby nedocházelo k zásadním změnám ve stávajících zákaznických zdrojích a šablonách. Pokud je nastavená hodnota Zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátních koncových bodů by byla výhradní metodou přístupu. | Zakázáno Povoleno SecuredByPerimeter |
| Počet replik | Počet replik v dedikované 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. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| sémantické hledání | Specifikuje dostupnost a fakturační plán pro sémantické vyhledávání ve službě Azure AI Vyhledávač. Tato konfigurace je dostupná pouze pro určité cenové kategorie v určitých regionech. | Zakázáno "free" "standard" |
| upgradeK dispozici | Označuje, jestli má vyhledávací služba k dispozici upgrade. | "k dispozici" 'není k dispozici' |
Sku
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Skladová položka vyhledávací služby. Mezi platné hodnoty patří: free: Sdílená služba. 'basic': Vyhrazená služba s až 3 replikami. Standard: Vyhrazená služba s až 12 oddíly a 12 replikami. Standard2: Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání. Standard3: Největší standardní nabídka s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2TB na oddíl, až 12 oddílů. 'serverless': Serverless tier s automatickým škálováním. | "basic" "free" 'serverless' "standard" "standard2" Standard3 Storage_optimized_l1 "storage_optimized_l2" |
TrackedResourceTags
| Jméno | Popis | Hodnota |
|---|
Identita přiřazená uživatelem (UserAssignedIdentity)
| Jméno | Popis | Hodnota |
|---|
Definice prostředku šablony ARM
Typ prostředku searchServices je možné nasadit s operacemi, které cílí:
- Skupiny zdrojů – viz příkazy pro nasazení skupin zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.
Příklady použití
Šablony azure pro rychlý start
Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.
| Šablona | Popis |
|---|---|
|
Síť Azure AI Foundry je omezena nasazení |
Tato sada šablon ukazuje, jak nastavit Azure AI Foundry se zakázaným privátním propojením a výstupním přenosem pomocí klíčů spravovaných Microsoftem pro šifrování a konfigurace identity spravované Microsoftem pro prostředek AI. |
|
služby Azure Cognitive Search nasazení |
Tato šablona vytvoří službu Azure Cognitive Search. |
|
služby Azure Cognitive Search s privátním koncovým bodem nasazení |
Tato šablona vytvoří službu Azure Cognitive Search s privátním koncovým bodem. |
|
agenta zabezpečeného sítí s identitou spravovanou uživatelem nasazení |
Tato sada šablon ukazuje, jak nastavit službu agenta Azure AI s izolací virtuální sítě pomocí autetika identity spravované uživatelem pro připojení a AI Service/AOAI a privátní síťové propojení pro připojení agenta k zabezpečeným datům. |
|
nastavení standardního agenta nasazení |
Tato sada šablon ukazuje, jak nastavit službu agenta Azure AI se standardním nastavením, což znamená ověřování spravovaných identit pro připojení k projektu nebo centru a povolený veřejný přístup k internetu. Agenti používají prostředky vyhledávání a úložiště vlastněné zákazníky s jedním tenantem. Díky tomuto nastavení máte plnou kontrolu a přehled o těchto prostředcích, ale na základě využití vám budou účtovány náklady. |
|
webovou aplikaci se službou SQL Database, Azure Cosmos DB, službou Azure Search nasazení |
Tato šablona zřídí webovou aplikaci, službu SQL Database, Azure Cosmos DB, Azure Search a Application Insights. |
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Search/searchServices, přidejte do šablony následující JSON.
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2026-03-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "string"
},
"apiKeyOnly": {}
},
"computeType": "string",
"dataExfiltrationProtections": [ "string" ],
"disableLocalAuth": "bool",
"encryptionWithCmk": {
"enforcement": "string",
"serviceLevelEncryptionKey": {
"accessCredentials": {
"applicationId": "string",
"applicationSecret": "string"
},
"identity": {
"@odata.type": "string"
// For remaining properties, see DataIdentity objects
},
"keyVaultKeyName": "string",
"keyVaultKeyVersion": "string",
"keyVaultUri": "string"
}
},
"endpoint": "string",
"hostingMode": "string",
"knowledgeRetrieval": "string",
"networkRuleSet": {
"bypass": "string",
"ipRules": [
{
"value": "string"
}
]
},
"partitionCount": "int",
"publicNetworkAccess": "string",
"replicaCount": "int",
"semanticSearch": "string",
"upgradeAvailable": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Objekty DataIdentity
Nastavte vlastnost @odata.type pro určení typu objektu.
Pro #Microsoft.Azure.Search.DataNoneIdentity použijte:
{
"@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
}
Pro #Microsoft.Azure.Search.DataUserAssignedIdentity použijte:
{
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"federatedIdentityClientId": "string",
"userAssignedIdentity": "string"
}
Hodnoty vlastností
Microsoft.Search/searchServices
| Jméno | Popis | Hodnota |
|---|---|---|
| Verze rozhraní apiVersion | Verze rozhraní API | 'Náhled 1. 3. 2026' |
| identita | Identita prostředku. | identity |
| poloha | Geografické umístění, ve kterém se nachází zdroj | string (povinné) |
| Jméno | Název prostředku | string Omezení: Model = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (povinné) |
| vlastnosti | Vlastnosti vyhledávací služby. | SearchServiceProperties |
| SKU (identifikátor zboží) | 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. | skladové položky |
| visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
| typ | Typ prostředku | Microsoft.Search/searchServices |
AzureActiveDirectoryApplicationCredentials
| Jméno | Popis | Hodnota |
|---|---|---|
| ID aplikace | ID aplikace (klienta) registrace aplikace v tenantu. | řetězec |
| tajný kód aplikace | Tajemství klienta AAD, které bylo vytvořeno pro registraci aplikace a použilo se k autentizaci s Azure Key Vault. | string Omezení: Citlivá hodnota. Předejte ho jako zabezpečený parametr. |
Datová identita
| Jméno | Popis | Hodnota |
|---|---|---|
| @odata.type | Nastavte na "#Microsoft.Azure.Search.DataNoneIdentity" pro typ DataNoneIdentity. Nastavte na #Microsoft.Azure.Search.DataUserAssignedIdentity pro typ DataUserAssignedIdentity. | '#Microsoft.Azure.Search.DataNoneIdentity' '#Microsoft.Azure.Search.DataUserAssignedIdentity' (povinné) |
Identifikátor DataNoneIdentity
| Jméno | Popis | Hodnota |
|---|---|---|
| @odata.type | Fragment identifikátoru URI určující typ identity. | '#Microsoft.Azure.Search.DataNoneIdentity' (povinné) |
DataPlaneAaadOrApiKeyAuthOption
| Jméno | Popis | Hodnota |
|---|---|---|
| aadAuthFailureMode | Popisuje, jaká odpověď rozhraní API roviny dat vyhledávací služby by odeslala požadavky, které selhaly při ověřování. | Http401WithBearerChallenge Http403 |
Možnosti datové roviny
| Jméno | Popis | Hodnota |
|---|---|---|
| aadOrApiKey | Označuje, že k ověřování je možné použít klíč rozhraní API nebo přístupový token z tenanta Microsoft Entra ID. | DataPlaneAaadOrApiKeyAuthOption |
| apiKeyOnly | Označuje, že k ověřování je možné použít pouze klíč rozhraní API. | jakýkoliv |
Přiřazená identita uživatele DataUser
| Jméno | Popis | Hodnota |
|---|---|---|
| @odata.type | Fragment identifikátoru URI určující typ identity. | '#Microsoft.Azure.Search.DataUserAssignedIdentity' (povinné) |
| Identita_identifikátoru federatedClientId | Volitelné pro podporu CMK pro více nájemců User-Assigned spravovanou identitu: Klientské ID (jako UUID) registrace aplikace pro více nájemců, která byla nakonfigurována tak, aby se federovala s uživatelskou přiřazenou identitou. | řetězec |
| userAssignedIdentity | Plně kvalifikované ID prostředku Azure spravované identity přiřazené uživatelem obvykle ve formátu "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", které by mělo být přiřazeno vyhledávací službě. | string (povinné) |
EncryptionWithCmk
| Jméno | Popis | Hodnota |
|---|---|---|
| vynucení | Popisuje, jak by vyhledávací služba měla vynutit dodržování předpisů, pokud najde objekty, které nejsou šifrované pomocí klíče spravovaného zákazníkem. | Zakázáno Povoleno Není zadáno. |
| serviceLevelEncryptionKey | Popisuje konfiguraci klíčů spravovanou zákazníkem pro šifrování vyhledávací služby. | SearchResourceEncryptionKey |
Identita
| Jméno | Popis | Hodnota |
|---|---|---|
| typ | Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje identitu vytvořenou systémem i sadu identit přiřazených uživatelem. Typ None odebere všechny identity ze služby. | None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned (povinné) |
| uživatelem přiřazené identity | Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Jméno | Popis | Hodnota |
|---|
Pravidlo protokolu IpRule
| Jméno | Popis | Hodnota |
|---|---|---|
| hodnota | Hodnota odpovídající jedné adrese IPv4 (např. 123.1.2.3) nebo rozsahu IP adres ve formátu CIDR (např. 123.1.2.3/24). | řetězec |
Sada pravidel sítě
| Jméno | Popis | Hodnota |
|---|---|---|
| obejít | Možný původ příchozího provozu, který může obejít pravidla definovaná v části "ipRules". | AzurePortal AzureServices None (Žádný) |
| IpRules | Seznam pravidel omezení PROTOKOLU IP, která definují příchozí sítě s povolením přístupu ke koncovému bodu vyhledávací služby. Mezitím brána firewall blokuje všechny ostatní veřejné IP sítě. Tato pravidla omezení se použijí pouze v případech, kdy je povolená "publicNetworkAccess" vyhledávací služby; jinak provoz přes veřejné rozhraní není povolen ani s pravidly veřejné IP adresy a připojení privátních koncových bodů by byla výhradní metodou přístupu. | iprule[] |
Klíč šifrování zdrojů
| Jméno | Popis | Hodnota |
|---|---|---|
| accessCredentials | Volitelné přihlašovací údaje Azure Active Directory používané pro přístup k Azure Key Vault. Není vyžadováno, pokud místo toho používáte spravovanou identitu. | AzureActiveDirectoryApplicationCredentials |
| identita | Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadána vlastnost přihlašovacích údajů přístupu null, použije se spravovaná identita přiřazená systémem. Při aktualizaci prostředku zůstane explicitní identita beze změny. Pokud je zadána hodnota "none", hodnota této vlastnosti je vymazána. | Datová identita |
| Klíčové_jméno trezoru klíčů | Název klíče služby Azure Key Vault, který se má použít k šifrování neaktivních uložených dat. | řetězec |
| keyVaultKeyVersion | Verze klíče služby Azure Key Vault, která se má použít k šifrování neaktivních uložených dat. | řetězec |
| klíč VaultUri | Identifikátor URI služby Azure Key Vault, označovaný také jako název DNS, který obsahuje klíč, který se má použít k šifrování neaktivních uložených dat. Příkladem identifikátoru URI může být https://my-keyvault-name.vault.azure.net. |
řetězec |
Vlastnosti služby SearchService
| Jméno | Popis | Hodnota |
|---|---|---|
| Možnosti 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. | Důvěrné 'Default' |
| 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. | Řetězcové pole obsahující některou z těchto možností: 'BlockAll' |
| 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. | Bool |
| 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 |
| koncový bod | Koncový bod služby Azure AI Vyhledávač. | řetězec |
| Režim hostování | 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. Pro skladovou položku standard3 je hodnota buď "Default" nebo "HighDensity". U všech ostatních skladových položek musí být tato hodnota Výchozí. | 'Default' "Vysoká hustota" |
| knowledgeRetrieval | Specifikuje fakturační plán pro agentické vyhledávání ve službě Azure AI Vyhledávač. Tato konfigurace je dostupná pouze pro určité cenové kategorie v určitých regionech. | "free" "standard" |
| networkRuleSet | Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Vyhledávač. | Sada pravidel sítě |
| partitionCount | Počet oddílů v dedikované vyhledávací službě; pokud je uvedeno, 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. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| přístup k veřejné síti | Tuto hodnotu lze nastavit na "Povoleno", aby nedocházelo k zásadním změnám ve stávajících zákaznických zdrojích a šablonách. Pokud je nastavená hodnota Zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátních koncových bodů by byla výhradní metodou přístupu. | Zakázáno Povoleno SecuredByPerimeter |
| Počet replik | Počet replik v dedikované 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. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| sémantické hledání | Specifikuje dostupnost a fakturační plán pro sémantické vyhledávání ve službě Azure AI Vyhledávač. Tato konfigurace je dostupná pouze pro určité cenové kategorie v určitých regionech. | Zakázáno "free" "standard" |
| upgradeK dispozici | Označuje, jestli má vyhledávací služba k dispozici upgrade. | "k dispozici" 'není k dispozici' |
Sku
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Skladová položka vyhledávací služby. Mezi platné hodnoty patří: free: Sdílená služba. 'basic': Vyhrazená služba s až 3 replikami. Standard: Vyhrazená služba s až 12 oddíly a 12 replikami. Standard2: Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání. Standard3: Největší standardní nabídka s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2TB na oddíl, až 12 oddílů. 'serverless': Serverless tier s automatickým škálováním. | "basic" "free" 'serverless' "standard" "standard2" Standard3 Storage_optimized_l1 "storage_optimized_l2" |
TrackedResourceTags
| Jméno | Popis | Hodnota |
|---|
Identita přiřazená uživatelem (UserAssignedIdentity)
| Jméno | Popis | Hodnota |
|---|
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku searchServices je možné nasadit s operacemi, které cílí:
- Skupiny zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.
Příklady použití
Ukázky Terraformu
Základní příklad nasazení vyhledávací služby.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "searchService" {
type = "Microsoft.Search/searchServices@2022-09-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
authOptions = {
apiKeyOnly = {
}
}
disableLocalAuth = false
encryptionWithCmk = {
enforcement = "Disabled"
}
hostingMode = "default"
networkRuleSet = {
ipRules = [
]
}
partitionCount = 1
publicNetworkAccess = "Enabled"
replicaCount = 1
}
sku = {
name = "standard"
}
tags = {
environment = "staging"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Ověřené moduly Azure
K nasazení tohoto typu prostředku je možné použít následující ověřené moduly Azure.
| Modul | Popis |
|---|---|
| vyhledávací služby | Modul prostředků AVM pro vyhledávací službu |
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Search/searchServices, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices@2026-03-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
authOptions = {
aadOrApiKey = {
aadAuthFailureMode = "string"
}
apiKeyOnly = ?
}
computeType = "string"
dataExfiltrationProtections = [
"string"
]
disableLocalAuth = bool
encryptionWithCmk = {
enforcement = "string"
serviceLevelEncryptionKey = {
accessCredentials = {
applicationId = "string"
applicationSecret = "string"
}
identity = {
@odata.type = "string"
// For remaining properties, see DataIdentity objects
}
keyVaultKeyName = "string"
keyVaultKeyVersion = "string"
keyVaultUri = "string"
}
}
endpoint = "string"
hostingMode = "string"
knowledgeRetrieval = "string"
networkRuleSet = {
bypass = "string"
ipRules = [
{
value = "string"
}
]
}
partitionCount = int
publicNetworkAccess = "string"
replicaCount = int
semanticSearch = "string"
upgradeAvailable = "string"
}
sku = {
name = "string"
}
}
}
Objekty DataIdentity
Nastavte vlastnost @odata.type pro určení typu objektu.
Pro #Microsoft.Azure.Search.DataNoneIdentity použijte:
{
@odata.type = "#Microsoft.Azure.Search.DataNoneIdentity"
}
Pro #Microsoft.Azure.Search.DataUserAssignedIdentity použijte:
{
@odata.type = "#Microsoft.Azure.Search.DataUserAssignedIdentity"
federatedIdentityClientId = "string"
userAssignedIdentity = "string"
}
Hodnoty vlastností
Microsoft.Search/searchServices
AzureActiveDirectoryApplicationCredentials
| Jméno | Popis | Hodnota |
|---|---|---|
| ID aplikace | ID aplikace (klienta) registrace aplikace v tenantu. | řetězec |
| tajný kód aplikace | Tajemství klienta AAD, které bylo vytvořeno pro registraci aplikace a použilo se k autentizaci s Azure Key Vault. | string Omezení: Citlivá hodnota. Předejte ho jako zabezpečený parametr. |
Datová identita
| Jméno | Popis | Hodnota |
|---|---|---|
| @odata.type | Nastavte na "#Microsoft.Azure.Search.DataNoneIdentity" pro typ DataNoneIdentity. Nastavte na #Microsoft.Azure.Search.DataUserAssignedIdentity pro typ DataUserAssignedIdentity. | '#Microsoft.Azure.Search.DataNoneIdentity' '#Microsoft.Azure.Search.DataUserAssignedIdentity' (povinné) |
Identifikátor DataNoneIdentity
| Jméno | Popis | Hodnota |
|---|---|---|
| @odata.type | Fragment identifikátoru URI určující typ identity. | '#Microsoft.Azure.Search.DataNoneIdentity' (povinné) |
DataPlaneAaadOrApiKeyAuthOption
| Jméno | Popis | Hodnota |
|---|---|---|
| aadAuthFailureMode | Popisuje, jaká odpověď rozhraní API roviny dat vyhledávací služby by odeslala požadavky, které selhaly při ověřování. | Http401WithBearerChallenge Http403 |
Možnosti datové roviny
| Jméno | Popis | Hodnota |
|---|---|---|
| aadOrApiKey | Označuje, že k ověřování je možné použít klíč rozhraní API nebo přístupový token z tenanta Microsoft Entra ID. | DataPlaneAaadOrApiKeyAuthOption |
| apiKeyOnly | Označuje, že k ověřování je možné použít pouze klíč rozhraní API. | jakýkoliv |
Přiřazená identita uživatele DataUser
| Jméno | Popis | Hodnota |
|---|---|---|
| @odata.type | Fragment identifikátoru URI určující typ identity. | '#Microsoft.Azure.Search.DataUserAssignedIdentity' (povinné) |
| Identita_identifikátoru federatedClientId | Volitelné pro podporu CMK pro více nájemců User-Assigned spravovanou identitu: Klientské ID (jako UUID) registrace aplikace pro více nájemců, která byla nakonfigurována tak, aby se federovala s uživatelskou přiřazenou identitou. | řetězec |
| userAssignedIdentity | Plně kvalifikované ID prostředku Azure spravované identity přiřazené uživatelem obvykle ve formátu "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", které by mělo být přiřazeno vyhledávací službě. | string (povinné) |
EncryptionWithCmk
| Jméno | Popis | Hodnota |
|---|---|---|
| vynucení | Popisuje, jak by vyhledávací služba měla vynutit dodržování předpisů, pokud najde objekty, které nejsou šifrované pomocí klíče spravovaného zákazníkem. | Zakázáno Povoleno Není zadáno. |
| serviceLevelEncryptionKey | Popisuje konfiguraci klíčů spravovanou zákazníkem pro šifrování vyhledávací služby. | SearchResourceEncryptionKey |
Identita
| Jméno | Popis | Hodnota |
|---|---|---|
| typ | Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje identitu vytvořenou systémem i sadu identit přiřazených uživatelem. Typ None odebere všechny identity ze služby. | None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned (povinné) |
| uživatelem přiřazené identity | Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Jméno | Popis | Hodnota |
|---|
Pravidlo protokolu IpRule
| Jméno | Popis | Hodnota |
|---|---|---|
| hodnota | Hodnota odpovídající jedné adrese IPv4 (např. 123.1.2.3) nebo rozsahu IP adres ve formátu CIDR (např. 123.1.2.3/24). | řetězec |
Sada pravidel sítě
| Jméno | Popis | Hodnota |
|---|---|---|
| obejít | Možný původ příchozího provozu, který může obejít pravidla definovaná v části "ipRules". | AzurePortal AzureServices None (Žádný) |
| IpRules | Seznam pravidel omezení PROTOKOLU IP, která definují příchozí sítě s povolením přístupu ke koncovému bodu vyhledávací služby. Mezitím brána firewall blokuje všechny ostatní veřejné IP sítě. Tato pravidla omezení se použijí pouze v případech, kdy je povolená "publicNetworkAccess" vyhledávací služby; jinak provoz přes veřejné rozhraní není povolen ani s pravidly veřejné IP adresy a připojení privátních koncových bodů by byla výhradní metodou přístupu. | iprule[] |
Klíč šifrování zdrojů
| Jméno | Popis | Hodnota |
|---|---|---|
| accessCredentials | Volitelné přihlašovací údaje Azure Active Directory používané pro přístup k Azure Key Vault. Není vyžadováno, pokud místo toho používáte spravovanou identitu. | AzureActiveDirectoryApplicationCredentials |
| identita | Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadána vlastnost přihlašovacích údajů přístupu null, použije se spravovaná identita přiřazená systémem. Při aktualizaci prostředku zůstane explicitní identita beze změny. Pokud je zadána hodnota "none", hodnota této vlastnosti je vymazána. | Datová identita |
| Klíčové_jméno trezoru klíčů | Název klíče služby Azure Key Vault, který se má použít k šifrování neaktivních uložených dat. | řetězec |
| keyVaultKeyVersion | Verze klíče služby Azure Key Vault, která se má použít k šifrování neaktivních uložených dat. | řetězec |
| klíč VaultUri | Identifikátor URI služby Azure Key Vault, označovaný také jako název DNS, který obsahuje klíč, který se má použít k šifrování neaktivních uložených dat. Příkladem identifikátoru URI může být https://my-keyvault-name.vault.azure.net. |
řetězec |
Vlastnosti služby SearchService
| Jméno | Popis | Hodnota |
|---|---|---|
| Možnosti 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. | Důvěrné 'Default' |
| 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. | Řetězcové pole obsahující některou z těchto možností: 'BlockAll' |
| 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. | Bool |
| 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 |
| koncový bod | Koncový bod služby Azure AI Vyhledávač. | řetězec |
| Režim hostování | 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. Pro skladovou položku standard3 je hodnota buď "Default" nebo "HighDensity". U všech ostatních skladových položek musí být tato hodnota Výchozí. | 'Default' "Vysoká hustota" |
| knowledgeRetrieval | Specifikuje fakturační plán pro agentické vyhledávání ve službě Azure AI Vyhledávač. Tato konfigurace je dostupná pouze pro určité cenové kategorie v určitých regionech. | "free" "standard" |
| networkRuleSet | Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Vyhledávač. | Sada pravidel sítě |
| partitionCount | Počet oddílů v dedikované vyhledávací službě; pokud je uvedeno, 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. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| přístup k veřejné síti | Tuto hodnotu lze nastavit na "Povoleno", aby nedocházelo k zásadním změnám ve stávajících zákaznických zdrojích a šablonách. Pokud je nastavená hodnota Zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátních koncových bodů by byla výhradní metodou přístupu. | Zakázáno Povoleno SecuredByPerimeter |
| Počet replik | Počet replik v dedikované 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. | Int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| sémantické hledání | Specifikuje dostupnost a fakturační plán pro sémantické vyhledávání ve službě Azure AI Vyhledávač. Tato konfigurace je dostupná pouze pro určité cenové kategorie v určitých regionech. | Zakázáno "free" "standard" |
| upgradeK dispozici | Označuje, jestli má vyhledávací služba k dispozici upgrade. | "k dispozici" 'není k dispozici' |
Sku
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Skladová položka vyhledávací služby. Mezi platné hodnoty patří: free: Sdílená služba. 'basic': Vyhrazená služba s až 3 replikami. Standard: Vyhrazená služba s až 12 oddíly a 12 replikami. Standard2: Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání. Standard3: Největší standardní nabídka s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2TB na oddíl, až 12 oddílů. 'serverless': Serverless tier s automatickým škálováním. | "basic" "free" 'serverless' "standard" "standard2" Standard3 Storage_optimized_l1 "storage_optimized_l2" |
TrackedResourceTags
| Jméno | Popis | Hodnota |
|---|
Identita přiřazená uživatelem (UserAssignedIdentity)
| Jméno | Popis | Hodnota |
|---|