Microsoft.Search searchServices 2023-11-01

Artikel
12/20/2024

Bicep-resursdefinition

Resurstypen searchServices kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Search/searchServices-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.Search/searchServices@2023-11-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    authOptions: {
      aadOrApiKey: {
        aadAuthFailureMode: 'string'
      }
      apiKeyOnly: any(Azure.Bicep.Types.Concrete.AnyType)
    }
    disableLocalAuth: bool
    encryptionWithCmk: {
      enforcement: 'string'
    }
    hostingMode: 'string'
    networkRuleSet: {
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
    semanticSearch: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Egenskapsvärden

DataPlaneAadOrApiKeyAuthOption

Namn	Beskrivning	Värde
aadAuthFailureMode	Beskriver vilket svar dataplanets API för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.	"http401WithBearerChallenge" "http403"

DataPlaneAuthOptions

Namn	Beskrivning	Värde
aadOrApiKey	Anger att antingen API-nyckeln eller en åtkomsttoken från en Microsoft Entra ID-klientorganisation kan användas för autentisering.	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	Anger att endast API-nyckeln kan användas för autentisering.	någon

EncryptionWithCmk

Namn	Beskrivning	Värde
tillämpning	Beskriver hur en söktjänst ska framtvinga att ha en eller flera icke-kundkrypterade resurser.	"Inaktiverad" "Aktiverad" "Ospecificerad"

Identitet

Namn	Beskrivning	Värde
typ	Identitetstypen.	"Ingen" "SystemAssigned" (krävs)

IpRule

Namn	Beskrivning	Värde
värde	Värde som motsvarar en enda IPv4-adress (till exempel 123.1.2.3) eller ett IP-intervall i CIDR-format (till exempel 123.1.2.3/24) som ska tillåtas.	sträng

Microsoft.Search/searchServices

Namn	Beskrivning	Värde
identitet	Resursens identitet.	identitet
plats	Den geo-plats där resursen finns	sträng (krävs)
Namn	Resursnamnet	sträng (krävs)
Egenskaper	Egenskaper för söktjänsten.	SearchServiceProperties
Sku	SKU:n för söktjänsten, som avgör faktureringshastighet och kapacitetsbegränsningar. Den här egenskapen krävs när du skapar en ny söktjänst.	Sku
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar

NetworkRuleSet

Namn	Beskrivning	Värde
ipRules	En lista över IP-begränsningsregler som används för en IP-brandvägg. Ip-adresser som inte matchar reglerna blockeras av brandväggen. Dessa regler tillämpas endast när "publicNetworkAccess" för söktjänsten är "aktiverad".	IpRule[]

SearchServiceProperties

Namn	Beskrivning	Värde
authOptions	Definierar alternativen för hur dataplans-API:et för en söktjänst autentiserar begäranden. Det går inte att ange om "disableLocalAuth" är inställt på sant.	DataPlaneAuthOptions
disableLocalAuth	När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.	Bool
encryptionWithCmk	Anger alla principer för kryptering av resurser (till exempel index) med hjälp av kundhanterarnycklar i en söktjänst.	EncryptionWithCmk
hostingMode	Gäller endast för standard3 SKU. Du kan ställa in den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För SKU:n standard3 är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".	"standard" "highDensity"
networkRuleSet	Nätverksspecifika regler som avgör hur söktjänsten kan nås.	NetworkRuleSet
partitionCount	Antalet partitioner i söktjänsten. Om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden som är större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.	Int Begränsningar: Minsta värde = 1 Maxvärde = 12
publicNetworkAccess	Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.	"inaktiverad" "aktiverad"
replicaCount	Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusive för standard-SKU:er eller mellan 1 och 3 inklusive för grundläggande SKU.	Int Begränsningar: Minsta värde = 1 Maxvärde = 12
semanticSearch	Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa sök-SKU:er på vissa platser.	"inaktiverad" "gratis" "standard"

Sku

Namn	Beskrivning	Värde
Namn	SKU:n för söktjänsten. Giltiga värden är: "kostnadsfri": Delad tjänst. "basic": Dedikerad tjänst med upp till 3 repliker. Standard: Dedikerad tjänst med upp till 12 partitioner och 12 repliker. "standard2": Liknar standard, men med mer kapacitet per sökenhet. "standard3": Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity"). "storage_optimized_l1": Stöder 1 TB per partition, upp till 12 partitioner. "storage_optimized_l2": Stöder 2 TB per partition, upp till 12 partitioner.	"grundläggande" "gratis" "standard" "standard2" "standard3" "storage_optimized_l1" "storage_optimized_l2"

TrackedResourceTags

Namn	Beskrivning	Värde

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil	Beskrivning
Azure AI Studio Network Restricted	Den här uppsättningen mallar visar hur du konfigurerar Azure AI Studio med privat länk och utgående inaktiverad, med hjälp av Microsoft-hanterade nycklar för kryptering och Microsoft-hanterad identitetskonfiguration för AI-resursen.
Azure Cognitive Search-tjänsten	Den här mallen skapar en Azure Cognitive Search-tjänst

Resursdefinition för ARM-mall

Resurstypen searchServices kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Search/searchServices-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2023-11-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "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"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Egenskapsvärden

DataPlaneAadOrApiKeyAuthOption

Namn	Beskrivning	Värde
aadAuthFailureMode	Beskriver vilket svar dataplanets API för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.	"http401WithBearerChallenge" "http403"

DataPlaneAuthOptions

Namn	Beskrivning	Värde
aadOrApiKey	Anger att antingen API-nyckeln eller en åtkomsttoken från en Microsoft Entra ID-klientorganisation kan användas för autentisering.	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	Anger att endast API-nyckeln kan användas för autentisering.	någon

EncryptionWithCmk

Namn	Beskrivning	Värde
tillämpning	Beskriver hur en söktjänst ska framtvinga att ha en eller flera icke-kundkrypterade resurser.	"Inaktiverad" "Aktiverad" "Ospecificerad"

Identitet

Namn	Beskrivning	Värde
typ	Identitetstypen.	"Ingen" "SystemAssigned" (krävs)

IpRule

Namn	Beskrivning	Värde
värde	Värde som motsvarar en enda IPv4-adress (till exempel 123.1.2.3) eller ett IP-intervall i CIDR-format (till exempel 123.1.2.3/24) som ska tillåtas.	sträng

Microsoft.Search/searchServices

Namn	Beskrivning	Värde
apiVersion	API-versionen	'2023-11-01'
identitet	Resursens identitet.	identitet
plats	Den geo-plats där resursen finns	sträng (krävs)
Namn	Resursnamnet	sträng (krävs)
Egenskaper	Egenskaper för söktjänsten.	SearchServiceProperties
Sku	SKU:n för söktjänsten, som avgör faktureringshastighet och kapacitetsbegränsningar. Den här egenskapen krävs när du skapar en ny söktjänst.	Sku
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar
typ	Resurstypen	"Microsoft.Search/searchServices"

NetworkRuleSet

Namn	Beskrivning	Värde
ipRules	En lista över IP-begränsningsregler som används för en IP-brandvägg. Ip-adresser som inte matchar reglerna blockeras av brandväggen. Dessa regler tillämpas endast när "publicNetworkAccess" för söktjänsten är "aktiverad".	IpRule[]

SearchServiceProperties

Namn	Beskrivning	Värde
authOptions	Definierar alternativen för hur dataplans-API:et för en söktjänst autentiserar begäranden. Det går inte att ange om "disableLocalAuth" är inställt på sant.	DataPlaneAuthOptions
disableLocalAuth	När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.	Bool
encryptionWithCmk	Anger alla principer för kryptering av resurser (till exempel index) med hjälp av kundhanterarnycklar i en söktjänst.	EncryptionWithCmk
hostingMode	Gäller endast för standard3 SKU. Du kan ställa in den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För SKU:n standard3 är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".	"standard" "highDensity"
networkRuleSet	Nätverksspecifika regler som avgör hur söktjänsten kan nås.	NetworkRuleSet
partitionCount	Antalet partitioner i söktjänsten. Om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden som är större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.	Int Begränsningar: Minsta värde = 1 Maxvärde = 12
publicNetworkAccess	Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.	"inaktiverad" "aktiverad"
replicaCount	Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusive för standard-SKU:er eller mellan 1 och 3 inklusive för grundläggande SKU.	Int Begränsningar: Minsta värde = 1 Maxvärde = 12
semanticSearch	Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa sök-SKU:er på vissa platser.	"inaktiverad" "gratis" "standard"

Sku

Namn	Beskrivning	Värde
Namn	SKU:n för söktjänsten. Giltiga värden är: "kostnadsfri": Delad tjänst. "basic": Dedikerad tjänst med upp till 3 repliker. Standard: Dedikerad tjänst med upp till 12 partitioner och 12 repliker. "standard2": Liknar standard, men med mer kapacitet per sökenhet. "standard3": Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity"). "storage_optimized_l1": Stöder 1 TB per partition, upp till 12 partitioner. "storage_optimized_l2": Stöder 2 TB per partition, upp till 12 partitioner.	"grundläggande" "gratis" "standard" "standard2" "standard3" "storage_optimized_l1" "storage_optimized_l2"

TrackedResourceTags

Namn	Beskrivning	Värde

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Beskrivning
Azure AI Studio Network Restricted	Den här uppsättningen mallar visar hur du konfigurerar Azure AI Studio med privat länk och utgående inaktiverad, med hjälp av Microsoft-hanterade nycklar för kryptering och Microsoft-hanterad identitetskonfiguration för AI-resursen.
Azure Cognitive Search-tjänsten	Den här mallen skapar en Azure Cognitive Search-tjänst
Azure Cognitive Search-tjänsten med privat slutpunkt	Den här mallen skapar en Azure Cognitive Search-tjänst med en privat slutpunkt.
webbapp med en SQL Database, Azure Cosmos DB, Azure Search	Den här mallen etablerar en webbapp, en SQL Database, Azure Cosmos DB, Azure Search och Application Insights.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen searchServices kan distribueras med åtgärder som mål:

Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Search/searchServices-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2023-11-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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"
    }
  })
}

Egenskapsvärden

DataPlaneAadOrApiKeyAuthOption

Namn	Beskrivning	Värde
aadAuthFailureMode	Beskriver vilket svar dataplanets API för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.	"http401WithBearerChallenge" "http403"

DataPlaneAuthOptions

Namn	Beskrivning	Värde
aadOrApiKey	Anger att antingen API-nyckeln eller en åtkomsttoken från en Microsoft Entra ID-klientorganisation kan användas för autentisering.	DataPlaneAadOrApiKeyAuthOption
apiKeyOnly	Anger att endast API-nyckeln kan användas för autentisering.	någon

EncryptionWithCmk

Namn	Beskrivning	Värde
tillämpning	Beskriver hur en söktjänst ska framtvinga att ha en eller flera icke-kundkrypterade resurser.	"Inaktiverad" "Aktiverad" "Ospecificerad"

Identitet

Namn	Beskrivning	Värde
typ	Identitetstypen.	"Ingen" "SystemAssigned" (krävs)

IpRule

Namn	Beskrivning	Värde
värde	Värde som motsvarar en enda IPv4-adress (till exempel 123.1.2.3) eller ett IP-intervall i CIDR-format (till exempel 123.1.2.3/24) som ska tillåtas.	sträng

Microsoft.Search/searchServices

Namn	Beskrivning	Värde
identitet	Resursens identitet.	identitet
plats	Den geo-plats där resursen finns	sträng (krävs)
Namn	Resursnamnet	sträng (krävs)
Egenskaper	Egenskaper för söktjänsten.	SearchServiceProperties
Sku	SKU:n för söktjänsten, som avgör faktureringshastighet och kapacitetsbegränsningar. Den här egenskapen krävs när du skapar en ny söktjänst.	Sku
Taggar	Resurstaggar	Ordlista med taggnamn och värden.
typ	Resurstypen	"Microsoft.Search/searchServices@2023-11-01"

NetworkRuleSet

Namn	Beskrivning	Värde
ipRules	En lista över IP-begränsningsregler som används för en IP-brandvägg. Ip-adresser som inte matchar reglerna blockeras av brandväggen. Dessa regler tillämpas endast när "publicNetworkAccess" för söktjänsten är "aktiverad".	IpRule[]

SearchServiceProperties

Namn	Beskrivning	Värde
authOptions	Definierar alternativen för hur dataplans-API:et för en söktjänst autentiserar begäranden. Det går inte att ange om "disableLocalAuth" är inställt på sant.	DataPlaneAuthOptions
disableLocalAuth	När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.	Bool
encryptionWithCmk	Anger alla principer för kryptering av resurser (till exempel index) med hjälp av kundhanterarnycklar i en söktjänst.	EncryptionWithCmk
hostingMode	Gäller endast för standard3 SKU. Du kan ställa in den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För SKU:n standard3 är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".	"standard" "highDensity"
networkRuleSet	Nätverksspecifika regler som avgör hur söktjänsten kan nås.	NetworkRuleSet
partitionCount	Antalet partitioner i söktjänsten. Om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden som är större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.	Int Begränsningar: Minsta värde = 1 Maxvärde = 12
publicNetworkAccess	Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.	"inaktiverad" "aktiverad"
replicaCount	Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusive för standard-SKU:er eller mellan 1 och 3 inklusive för grundläggande SKU.	Int Begränsningar: Minsta värde = 1 Maxvärde = 12
semanticSearch	Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa sök-SKU:er på vissa platser.	"inaktiverad" "gratis" "standard"

Sku

Namn	Beskrivning	Värde
Namn	SKU:n för söktjänsten. Giltiga värden är: "kostnadsfri": Delad tjänst. "basic": Dedikerad tjänst med upp till 3 repliker. Standard: Dedikerad tjänst med upp till 12 partitioner och 12 repliker. "standard2": Liknar standard, men med mer kapacitet per sökenhet. "standard3": Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity"). "storage_optimized_l1": Stöder 1 TB per partition, upp till 12 partitioner. "storage_optimized_l2": Stöder 2 TB per partition, upp till 12 partitioner.	"grundläggande" "gratis" "standard" "standard2" "standard3" "storage_optimized_l1" "storage_optimized_l2"

TrackedResourceTags

Namn	Beskrivning	Värde

Dela via

Microsoft.Search searchServices 2023-11-01

Bicep-resursdefinition

Resursformat

Egenskapsvärden

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Identitet

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Snabbstartsexempel

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Identitet

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Snabbstartsmallar

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Identitet

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Feedback

Ytterligare resurser