Vyhledávací služby Microsoft.Search
Definice prostředku Bicep
Typ prostředku searchServices je možné nasadit s operacemi, které cílí na:
- 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.
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@2023-11-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
identity: {
type: 'string'
}
properties: {
authOptions: {
aadOrApiKey: {
aadAuthFailureMode: 'string'
}
apiKeyOnly: any()
}
disableLocalAuth: bool
encryptionWithCmk: {
enforcement: 'string'
}
hostingMode: 'string'
networkRuleSet: {
ipRules: [
{
value: 'string'
}
]
}
partitionCount: int
publicNetworkAccess: 'string'
replicaCount: int
semanticSearch: 'string'
}
}
Hodnoty vlastností
searchServices
| Název | Description | Hodnota |
|---|---|---|
| name | Název prostředku | string (povinné) |
| location | Geografické umístění, ve kterém se nachází prostředek | string (povinné) |
| tags | Značky prostředků. | Slovník názvů značek a hodnot. Viz Značky v šablonách |
| Sku | Skladová položka vyhledávací služby, která určuje fakturační sazbu a limity kapacity. Tato vlastnost se vyžaduje při vytváření nové vyhledávací služby. | Sku |
| identity | Identita prostředku. | Identita |
| properties | Vlastnosti vyhledávací služby. | SearchServiceProperties |
Identita
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ identity. | 'Žádný' 'SystemAssigned' (povinné) |
SearchServiceProperties
| Název | Description | Hodnota |
|---|---|---|
| Možnosti ověřování | Definuje možnosti, jak rozhraní API roviny dat vyhledávací služby ověřuje požadavky. Tuto možnost nelze nastavit, pokud je vlastnost disableLocalAuth nastavená na hodnotu true. | DataPlaneAuthOptions |
| disableLocalAuth | Pokud je nastavená hodnota true, volání vyhledávací služby nebudou moct využívat klíče rozhraní API k ověřování. Tuto hodnotu nelze nastavit na hodnotu true, pokud jsou definována dataPlaneAuthOptions. | bool |
| šifrováníWithCmk | 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. | ŠifrováníWithCmk |
| hostingMode | Platí jenom pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby povolila 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ď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí. | 'výchozí' 'highDensity' |
| networkRuleSet | Pravidla specifická pro síť, která určují, jak může být vyhledávací služba přístupná. | 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 hostovacímmodem nastaveným na highDensity jsou povolené hodnoty mezi 1 a 3. | int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| publicNetworkAccess | Tuto hodnotu je možné nastavit na povoleno, aby nedošlo k zásadním změnám u existujících prostředků a šablon zákazníků. 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 |
| replicaCount | Počet replik ve vyhledávací službě. Pokud je zadáno, musí to být hodnota mezi 1 a 12 včetně pro standardní skladové položky nebo mezi 1 a 3 včetně pro skladovou položku Basic. | int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| sémanticSearch | Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná pouze pro určité skladové položky vyhledávání v určitých umístěních. | Zakázáno "zdarma" 'standard' |
DataPlaneAuthOptions
| Název | Description | 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. | DataPlaneAadOrApiKeyAuthOption |
| Klíč rozhraní API Jen | Označuje, že k ověřování je možné použít pouze klíč rozhraní API. | Pro Bicep můžete použít funkci any(). |
DataPlaneAadOrApiKeyAuthOption
| Název | Description | Hodnota |
|---|---|---|
| aadAuthFailureMode | Popisuje, jakou odpověď by rozhraní API roviny dat vyhledávací služby odeslalo na požadavky, které selhaly při ověřování. | 'http401WithBearerChallenge' http403 |
ŠifrováníWithCmk
| Název | Description | Hodnota |
|---|---|---|
| Výkonu | Popisuje, jak by vyhledávací služba měla vynucovat jeden nebo více prostředků nešifrovaných zákazníkem. | Zakázáno Povoleno Neurčené |
Sada pravidel sítě
| Název | Description | Hodnota |
|---|---|---|
| pravidla ipRules | Seznam pravidel omezení IP adres používaných pro bránu firewall protokolu IP. Všechny IP adresy, které neodpovídají pravidlu, jsou blokovány bránou firewall. Tato pravidla se použijí pouze v případech, kdy je povolená možnost publicNetworkAccess vyhledávací služby. | IpRule[] |
Pravidla ip adresy
| Název | Description | Hodnota |
|---|---|---|
| hodnota | Povolená hodnota odpovídající jedné IPv4 adrese (například 123.1.2.3) nebo rozsahu IP adres ve formátu CIDR (například 123.1.2.3/24). | řetězec |
Skladová jednotka (SKU)
| Název | Description | Hodnota |
|---|---|---|
| name | 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ší nabídka standardu s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud také nastavíte vlastnost hostingMode na "highDensity"). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2 TB na oddíl, až 12 oddílů. | 'basic' "zdarma" 'standard' 'standard2' 'standard3' "storage_optimized_l1" "storage_optimized_l2" |
Šablony pro rychlý start
Následující šablony pro rychlý start nasadí tento typ prostředku.
| Template (Šablona) | Description |
|---|---|
Webová aplikace s SQL Database, Azure Cosmos DB, Azure Search |
Tato šablona zřídí webovou aplikaci, SQL Database, Azure Cosmos DB, Azure Search a Application Insights. |
| Azure Cognitive Search služba |
Tato šablona vytvoří službu Azure Cognitive Search. |
| Azure Cognitive Search služba s privátním koncovým bodem |
Tato šablona vytvoří službu Azure Cognitive Search s privátním koncovým bodem. |
Definice prostředku šablony ARM
Typ prostředku searchServices je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy pro nasazení skupin prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Search/searchServices, přidejte do šablony následující kód JSON.
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2023-11-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"identity": {
"type": "string"
},
"properties": {
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "string"
},
"apiKeyOnly": {}
},
"disableLocalAuth": "bool",
"encryptionWithCmk": {
"enforcement": "string"
},
"hostingMode": "string",
"networkRuleSet": {
"ipRules": [
{
"value": "string"
}
]
},
"partitionCount": "int",
"publicNetworkAccess": "string",
"replicaCount": "int",
"semanticSearch": "string"
}
}
Hodnoty vlastností
searchServices
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.Search/searchServices |
| apiVersion | Verze rozhraní API prostředku | '2023-11-01' |
| name | Název prostředku | string (povinné) |
| location | Geografické umístění, ve kterém se nachází prostředek | string (povinné) |
| tags | Značky prostředků. | Slovník názvů značek a hodnot. Viz Značky v šablonách |
| Sku | Skladová položka vyhledávací služby, která určuje fakturační sazbu a limity kapacity. Tato vlastnost se vyžaduje při vytváření nové vyhledávací služby. | Sku |
| identity | Identita prostředku. | Identita |
| properties | Vlastnosti vyhledávací služby. | SearchServiceProperties |
Identita
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ identity. | 'Žádný' 'SystemAssigned' (povinné) |
SearchServiceProperties
| Název | Description | Hodnota |
|---|---|---|
| Možnosti ověřování | Definuje možnosti, jak rozhraní API roviny dat vyhledávací služby ověřuje požadavky. Tuto možnost nelze nastavit, pokud je vlastnost disableLocalAuth nastavená na hodnotu true. | DataPlaneAuthOptions |
| disableLocalAuth | Pokud je nastavená hodnota true, volání vyhledávací služby nebudou moct využívat klíče rozhraní API k ověřování. Tuto hodnotu nelze nastavit na hodnotu true, pokud jsou definována dataPlaneAuthOptions. | bool |
| šifrováníWithCmk | 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. | ŠifrováníWithCmk |
| hostingMode | Platí jenom pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby povolila 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ď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí. | 'výchozí' 'highDensity' |
| networkRuleSet | Pravidla specifická pro síť, která určují, jak může být vyhledávací služba přístupná. | 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 hostovacímmodem nastaveným na highDensity jsou povolené hodnoty mezi 1 a 3. | int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| publicNetworkAccess | Tuto hodnotu je možné nastavit na povoleno, aby nedošlo k zásadním změnám u existujících prostředků a šablon zákazníků. 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 |
| replicaCount | Počet replik ve vyhledávací službě. Pokud je zadáno, musí to být hodnota mezi 1 a 12 včetně pro standardní skladové položky nebo mezi 1 a 3 včetně pro skladovou položku Basic. | int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| sémanticSearch | Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná pouze pro určité skladové položky vyhledávání v určitých umístěních. | "zakázáno" "zdarma" 'standard' |
DataPlaneAuthOptions
| Název | Description | 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. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Označuje, že k ověřování je možné použít pouze klíč rozhraní API. |
DataPlaneAadOrApiKeyAuthOption
| Název | Description | Hodnota |
|---|---|---|
| aadAuthFailureMode | Popisuje, jakou odpověď by rozhraní API roviny dat vyhledávací služby odeslalo na požadavky, které selhaly při ověřování. | 'http401WithBearerChallenge' http403 |
ŠifrováníWithCmk
| Název | Description | Hodnota |
|---|---|---|
| Výkonu | Popisuje, jak by vyhledávací služba měla vynutit jeden nebo více prostředků nešifrovaných zákazníkem. | Zakázáno Povoleno Neurčené |
Sada pravidel sítě
| Název | Description | Hodnota |
|---|---|---|
| pravidla ipRules | Seznam pravidel omezení IP adres používaných pro bránu firewall protokolu IP. Všechny IP adresy, které neodpovídají pravidlu, jsou blokovány bránou firewall. Tato pravidla se použijí pouze v případech, kdy je povolená možnost publicNetworkAccess vyhledávací služby. | IpRule[] |
Pravidla ip adresy
| Název | Description | Hodnota |
|---|---|---|
| hodnota | Povolená hodnota odpovídající jedné IPv4 adrese (například 123.1.2.3) nebo rozsahu IP adres ve formátu CIDR (například 123.1.2.3/24). | řetězec |
Skladová jednotka (SKU)
| Název | Description | Hodnota |
|---|---|---|
| name | 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ší nabídka standardu s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud také nastavíte vlastnost hostingMode na "highDensity"). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2 TB na oddíl, až 12 oddílů. | 'basic' "zdarma" 'standard' 'standard2' 'standard3' "storage_optimized_l1" "storage_optimized_l2" |
Šablony pro rychlý start
Následující šablony pro rychlý start nasadí tento typ prostředku.
| Template (Šablona) | Description |
|---|---|
| Webová aplikace s SQL Database, Azure Cosmos DB, Azure Search |
Tato šablona zřídí webovou aplikaci, SQL Database, Azure Cosmos DB, Azure Search a Application Insights. |
| Azure Cognitive Search služba |
Tato šablona vytvoří službu Azure Cognitive Search. |
| Azure Cognitive Search služba s privátním koncovým bodem |
Tato šablona vytvoří službu Azure Cognitive Search s privátním koncovým bodem. |
Definice prostředku Terraform (poskytovatel AzAPI)
Typ prostředku searchServices je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
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@2023-11-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
authOptions = {
aadOrApiKey = {
aadAuthFailureMode = "string"
}
}
disableLocalAuth = bool
encryptionWithCmk = {
enforcement = "string"
}
hostingMode = "string"
networkRuleSet = {
ipRules = [
{
value = "string"
}
]
}
partitionCount = int
publicNetworkAccess = "string"
replicaCount = int
semanticSearch = "string"
}
sku = {
name = "string"
}
})
}
Hodnoty vlastností
searchServices
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | "Microsoft.Search/searchServices@2023-11-01" |
| name | Název prostředku | string (povinné) |
| location | Geografické umístění, kde se prostředek nachází | string (povinné) |
| parent_id | K nasazení do skupiny prostředků použijte ID této skupiny prostředků. | string (povinné) |
| tags | Značky prostředků. | Slovník názvů a hodnot značek. |
| Sku | Skladová položka vyhledávací služby, která určuje fakturační sazbu a limity kapacity. Tato vlastnost se vyžaduje při vytváření nové vyhledávací služby. | Sku |
| identity | Identita prostředku. | Identita |
| properties | Vlastnosti vyhledávací služby. | Vlastnosti vyhledávací služby |
Identita
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ identity. | "SystemAssigned" (povinné) |
Vlastnosti vyhledávací služby
| Název | Description | Hodnota |
|---|---|---|
| Možnosti ověřování | Definuje možnosti, jak rozhraní API roviny dat vyhledávací služby ověřuje požadavky. Tuto hodnotu nelze nastavit, pokud je vlastnost disableLocalAuth nastavená na hodnotu true. | DataPlaneAuthOptions |
| disableLocalAuth | Pokud je nastavená hodnota true, volání vyhledávací služby nebudou moct k ověřování využívat klíče rozhraní API. Pokud jsou definovány možnosti dataPlaneAuthOptions, nedá se nastavit na hodnotu true. | bool |
| šifrováníWithCmk | 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. | ŠifrováníWithCmk |
| hostingMode | Platí jenom pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby povolte až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem více 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 default. | "výchozí" "highDensity" |
| sada pravidel sítě | Pravidla specifická pro síť, která určují, jak může být vyhledávací služba dosažitelná. | Sada pravidel sítě |
| 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 režimem hostingMode nastaveným na highDensity jsou povolené hodnoty mezi 1 a 3. | int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| publicNetworkAccess | Tuto hodnotu je možné nastavit na povoleno, aby nedošlo k zásadním změnám u stávajících zákaznických prostředků a šablon. Pokud je nastavená hodnota zakázáno, provoz přes veřejné rozhraní není povolený a výhradní metodou přístupu by byla připojení privátních koncových bodů. | "zakázáno" "povoleno" |
| počet replik | Počet replik ve vyhledávací službě. Pokud je zadaný, musí to být hodnota od 1 do 12 (včetně) pro standardní skladové položky (SKU) nebo 1 až 3 (včetně) pro skladovou položku Basic. | int Omezení: Minimální hodnota = 1 Maximální hodnota = 12 |
| sémanticSearch | Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná pouze pro určité skladové položky vyhledávání v určitých umístěních. | "zakázáno" "zdarma" "standardní" |
DataPlaneAuthOptions
| Název | Description | 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. | DataPlaneAadOrApiKeyAuthOption |
| Klíč rozhraní API Jen | Označuje, že k ověřování je možné použít pouze klíč rozhraní API. |
DataPlaneAadOrApiKeyAuthOption
| Název | Description | Hodnota |
|---|---|---|
| aadAuthFailureMode | Popisuje, jakou odpověď by rozhraní API roviny dat vyhledávací služby odeslalo na požadavky, které selhaly při ověřování. | "http401WithBearerChallenge" "http403" |
ŠifrováníWithCmk
| Název | Description | Hodnota |
|---|---|---|
| Výkonu | Popisuje, jak by vyhledávací služba měla vynucovat jeden nebo více prostředků nešifrovaných zákazníkem. | "Zakázáno" "Povoleno" "Neurčené" |
Sada pravidel sítě
| Název | Description | Hodnota |
|---|---|---|
| pravidla ipRules | Seznam pravidel omezení IP adres používaných pro bránu firewall protokolu IP. Všechny IP adresy, které neodpovídají pravidlu, jsou blokovány bránou firewall. Tato pravidla se použijí pouze v případech, kdy je povolená možnost publicNetworkAccess vyhledávací služby. | IpRule[] |
Pravidla ip adresy
| Název | Description | Hodnota |
|---|---|---|
| hodnota | Povolená hodnota odpovídající jedné IPv4 adrese (například 123.1.2.3) nebo rozsahu IP adres ve formátu CIDR (například 123.1.2.3/24). | řetězec |
Skladová jednotka (SKU)
| Název | Description | Hodnota |
|---|---|---|
| name | 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ší nabídka standardu s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud také nastavíte vlastnost hostingMode na "highDensity"). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2 TB na oddíl, až 12 oddílů. | "basic" "zdarma" "standardní" "standard2" "standard3" "storage_optimized_l1" "storage_optimized_l2" |
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro