Microsoft.Search SearchServices

Bicep-Ressourcendefinition

Der searchServices-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Search/searchServices-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

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'
  }
}

Eigenschaftswerte

searchServices

Name BESCHREIBUNG Wert
name Der Ressourcenname Zeichenfolge (erforderlich)
location Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
sku Die SKU des Suchdiensts, die Abrechnungsrate und Kapazitätsgrenzen bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich. sku
Identität Die Identität der Ressource. Identität
properties Eigenschaften des Suchdiensts. SearchServiceProperties

Identity

Name BESCHREIBUNG Wert
type Der Identitätstyp. "Keine"
"SystemAssigned" (erforderlich)

SearchServiceProperties

Name BESCHREIBUNG Wert
authOptions Definiert die Optionen dafür, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf true festgelegt ist. DataPlaneAuthOptions
disableLocalAuth Wenn auf true festgelegt ist, dürfen Aufrufe des Suchdiensts keine API-Schlüssel für die Authentifizierung verwenden. Dies kann nicht auf true festgelegt werden, wenn "dataPlaneAuthOptions" definiert ist. bool
encryptionWithCmk Gibt jede Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an. EncryptionWithCmk
hostingMode Gilt nur für die standard3-SKU. Sie können diese Eigenschaft so festlegen, dass bis zu 3 Partitionen mit hoher Dichte aktiviert werden, die bis zu 1.000 Indizes zulassen, was viel höher ist als die maximal zulässigen Indizes für jede andere SKU. Für die Standard3-SKU ist der Wert entweder "default" oder "highDensity". Für alle anderen SKUs muss dieser Wert "standard" sein. "Standard"
"highDensity"
networkRuleSet Netzwerkspezifische Regeln, die bestimmen, wie der Suchdienst erreicht werden kann. NetworkRuleSet
partitionCount Die Anzahl der Partitionen im Suchdienst; wenn angegeben, kann es 1, 2, 3, 4, 6 oder 12 sein. Werte größer als 1 sind nur für Standard-SKUs gültig. Bei "Standard3"-Diensten, bei denen hostingMode auf "highDensity" festgelegt ist, liegen die zulässigen Werte zwischen 1 und 3. INT

Einschränkungen:
Min-Wert = 1
Maximaler Wert = 12
publicNetworkAccess Dieser Wert kann auf "aktiviert" festgelegt werden, um fehlerhafte Änderungen an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn auf "deaktiviert" festgelegt ist, ist der Datenverkehr über die öffentliche Schnittstelle nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. "deaktiviert"
"aktiviert"
replicaCount Die Anzahl der Replikate im Suchdienst. Wenn angegeben, muss es sich um einen Wert zwischen 1 und 12 inklusive für Standard-SKUs oder zwischen 1 und 3 inklusive für die Basis-SKU sein. INT

Einschränkungen:
Min-Wert = 1
Maximaler Wert = 12
semanticSearch Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Such-SKUs an bestimmten Speicherorten möglich. "deaktiviert"
"frei"
"Standard"

DataPlaneAuthOptions

Name BESCHREIBUNG Wert
aadOrApiKey Gibt an, dass entweder der API-Schlüssel oder ein Zugriffstoken von einem Microsoft Entra ID Mandanten für die Authentifizierung verwendet werden kann. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Gibt an, dass nur der API-Schlüssel für die Authentifizierung verwendet werden kann. Für Bicep können Sie die funktion any() verwenden.

DataPlaneAadOrApiKeyAuthOption

Name BESCHREIBUNG Wert
aadAuthFailureMode Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen sendet, bei denen die Authentifizierung fehlgeschlagen ist. 'http401WithBearerChallenge'
'http403'

EncryptionWithCmk

Name BESCHREIBUNG Wert
Durchsetzung Beschreibt, wie ein Suchdienst erzwingen soll, dass mindestens eine nicht kundenseitig verschlüsselte Ressource vorhanden ist. "Deaktiviert"
"Aktiviert"
"Nicht angegeben"

NetworkRuleSet

Name BESCHREIBUNG Wert
ipRules Eine Liste der IP-Einschränkungsregeln, die für eine IP-Firewall verwendet werden. Alle IP-Adressen, die nicht den Regeln entsprechen, werden von der Firewall blockiert. Diese Regeln werden nur angewendet, wenn "publicNetworkAccess" des Suchdiensts "aktiviert" ist. IpRule[]

IpRule

Name BESCHREIBUNG Wert
value Der Wert, der einer einzelnen IPv4-Adresse (z. B. 123.1.2.3) oder einem IP-Bereich im CIDR-Format (z. B. 123.1.2.3/24) entspricht. Zeichenfolge

Sku

Name BESCHREIBUNG Wert
name Die SKU des Suchdiensts. Gültige Werte sind: "free": Shared service. "basic": Dedizierter Dienst mit bis zu 3 Replikaten. "standard": Dedizierter Dienst mit bis zu 12 Partitionen und 12 Replikaten. 'standard2': Ähnlich wie standard, aber mit mehr Kapazität pro Sucheinheit. 'standard3': Das größte Standardangebot mit bis zu 12 Partitionen und 12 Replikaten (oder bis zu 3 Partitionen mit mehr Indizes, wenn Sie auch die hostingMode-Eigenschaft auf "highDensity" festlegen). 'storage_optimized_l1': Unterstützt 1 TB pro Partition, bis zu 12 Partitionen. 'storage_optimized_l2': Unterstützt 2 TB pro Partition, bis zu 12 Partitionen." "basic"
"frei"
"Standard"
'Standard2'
'Standard3'
"storage_optimized_l1"
"storage_optimized_l2"

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Web-App mit SQL-Datenbank, Azure Cosmos DB, Azure Search

Bereitstellen in Azure
Diese Vorlage stellt eine Web-App, eine SQL-Datenbank, Azure Cosmos DB, Azure Search und Application Insights bereit.
Dienst für die kognitive Azure-Suche

Bereitstellen in Azure
Mit dieser Vorlage wird ein Azure Cognitive Search-Dienst erstellt.
Azure Cognitive Search Dienst mit privatem Endpunkt

Bereitstellen in Azure
Diese Vorlage erstellt einen Azure Cognitive Search-Dienst mit einem privaten Endpunkt.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp searchServices kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Search/searchServices-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden JSON-Code hinzu.

{
  "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"
  }
}

Eigenschaftswerte

searchServices

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Search/searchServices"
apiVersion Die Version der Ressourcen-API '2023-11-01'
name Der Ressourcenname Zeichenfolge (erforderlich)
location Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
sku Die SKU des Suchdiensts, die Abrechnungsrate und Kapazitätsgrenzen bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich. sku
Identität Die Identität der Ressource. Identität
properties Eigenschaften des Suchdiensts. SearchServiceProperties

Identity

Name BESCHREIBUNG Wert
type Der Identitätstyp. "Keine"
"SystemAssigned" (erforderlich)

SearchServiceProperties

Name BESCHREIBUNG Wert
authOptions Definiert die Optionen dafür, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf true festgelegt ist. DataPlaneAuthOptions
disableLocalAuth Wenn auf true festgelegt ist, dürfen Aufrufe des Suchdiensts keine API-Schlüssel für die Authentifizierung verwenden. Dies kann nicht auf true festgelegt werden, wenn "dataPlaneAuthOptions" definiert ist. bool
encryptionWithCmk Gibt jede Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an. EncryptionWithCmk
hostingMode Gilt nur für die standard3-SKU. Sie können diese Eigenschaft so festlegen, dass bis zu 3 Partitionen mit hoher Dichte aktiviert werden, die bis zu 1.000 Indizes zulassen, was viel höher ist als die maximal zulässigen Indizes für jede andere SKU. Für die Standard3-SKU ist der Wert entweder "default" oder "highDensity". Für alle anderen SKUs muss dieser Wert "standard" sein. "Standard"
"highDensity"
networkRuleSet Netzwerkspezifische Regeln, die bestimmen, wie der Suchdienst erreicht werden kann. NetworkRuleSet
partitionCount Die Anzahl der Partitionen im Suchdienst; wenn angegeben, kann es 1, 2, 3, 4, 6 oder 12 sein. Werte größer als 1 sind nur für Standard-SKUs gültig. Bei "Standard3"-Diensten, bei denen hostingMode auf "highDensity" festgelegt ist, liegen die zulässigen Werte zwischen 1 und 3. INT

Einschränkungen:
Min-Wert = 1
Maximaler Wert = 12
publicNetworkAccess Dieser Wert kann auf "aktiviert" festgelegt werden, um fehlerhafte Änderungen an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn auf "deaktiviert" festgelegt ist, ist der Datenverkehr über die öffentliche Schnittstelle nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. "deaktiviert"
"aktiviert"
replicaCount Die Anzahl der Replikate im Suchdienst. Wenn angegeben, muss es sich um einen Wert zwischen 1 und 12 inklusive für Standard-SKUs oder zwischen 1 und 3 inklusive für die Basis-SKU sein. INT

Einschränkungen:
Min-Wert = 1
Maximaler Wert = 12
semanticSearch Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Such-SKUs an bestimmten Standorten möglich. "deaktiviert"
"kostenlos"
"Standard"

DataPlaneAuthOptions

Name BESCHREIBUNG Wert
aadOrApiKey Gibt an, dass entweder der API-Schlüssel oder ein Zugriffstoken von einem Microsoft Entra ID Mandanten für die Authentifizierung verwendet werden kann. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Gibt an, dass nur der API-Schlüssel für die Authentifizierung verwendet werden kann.

DataPlaneAadOrApiKeyAuthOption

Name BESCHREIBUNG Wert
aadAuthFailureMode Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen sendet, bei denen die Authentifizierung fehlgeschlagen ist. 'http401WithBearerChallenge'
'http403'

EncryptionWithCmk

Name BESCHREIBUNG Wert
Durchsetzung Beschreibt, wie ein Suchdienst eine oder mehrere nicht kundenseitig verschlüsselte Ressourcen erzwingen soll. "Deaktiviert"
"Aktiviert"
"Nicht angegeben"

NetworkRuleSet

Name BESCHREIBUNG Wert
ipRules Eine Liste von IP-Einschränkungsregeln, die für eine IP-Firewall verwendet werden. Alle IP-Adressen, die nicht mit den Regeln übereinstimmen, werden von der Firewall blockiert. Diese Regeln werden nur angewendet, wenn "publicNetworkAccess" des Suchdiensts aktiviert ist. IpRule[]

IpRule

Name BESCHREIBUNG Wert
value Wert, der einer einzelnen IPv4-Adresse (z. B. 123.1.2.3) oder einem IP-Bereich im CIDR-Format (z. B. 123.1.2.3/24) entspricht, soll zulässig sein. Zeichenfolge

Sku

Name BESCHREIBUNG Wert
name Die SKU des Suchdiensts. Gültige Werte sind: "free": Shared service. "basic": Dedizierter Dienst mit bis zu 3 Replikaten. "Standard": Dedizierter Dienst mit bis zu 12 Partitionen und 12 Replikaten. "standard2": Ähnlich wie standard, aber mit mehr Kapazität pro Sucheinheit. "Standard3": Das größte Standardangebot mit bis zu 12 Partitionen und 12 Replikaten (oder bis zu 3 Partitionen mit mehr Indizes, wenn Sie auch die hostingMode-Eigenschaft auf "highDensity" festlegen). 'storage_optimized_l1': Unterstützt 1 TB pro Partition, bis zu 12 Partitionen. 'storage_optimized_l2': Unterstützt 2 TB pro Partition, bis zu 12 Partitionen. "Basic"
"kostenlos"
"Standard"
'Standard2'
'Standard3'
"storage_optimized_l1"
"storage_optimized_l2"

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Web-App mit SQL-Datenbank, Azure Cosmos DB, Azure Search

Bereitstellen in Azure
Mit dieser Vorlage werden eine Web-App, eine SQL-Datenbank, Azure Cosmos DB, Azure Search und Application Insights bereitgestellt.
Dienst für die kognitive Azure-Suche

Bereitstellen in Azure
Mit dieser Vorlage wird ein Azure Cognitive Search Dienst erstellt.
Azure Cognitive Search Dienst mit privatem Endpunkt

Bereitstellen in Azure
Diese Vorlage erstellt einen Azure Cognitive Search-Dienst mit einem privaten Endpunkt.

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der searchServices-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Search/searchServices-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

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"
    }
  })
}

Eigenschaftswerte

searchServices

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.Search/searchServices@2023-11-01"
name Der Ressourcenname Zeichenfolge (erforderlich)
location Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
parent_id Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte.
sku Die SKU des Suchdiensts, die Abrechnungsrate und Kapazitätsgrenzen bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich. sku
Identität Die Identität der Ressource. Identität
properties Eigenschaften des Suchdiensts. SearchServiceProperties

Identity

Name BESCHREIBUNG Wert
type Der Identitätstyp. "SystemAssigned" (erforderlich)

SearchServiceProperties

Name BESCHREIBUNG Wert
authOptions Definiert die Optionen dafür, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist. DataPlaneAuthOptions
disableLocalAuth Wenn diese Einstellung auf TRUE festgelegt ist, dürfen Aufrufe des Suchdiensts keine API-Schlüssel für die Authentifizierung verwenden. Dies kann nicht auf true festgelegt werden, wenn "dataPlaneAuthOptions" definiert ist. bool
encryptionWithCmk Gibt jede Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an. EncryptionWithCmk
hostingMode Gilt nur für die Standard3-SKU. Sie können diese Eigenschaft so festlegen, dass bis zu 3 Partitionen mit hoher Dichte aktiviert werden, die bis zu 1000 Indizes zulassen, was viel höher ist als die maximal zulässigen Indizes für jede andere SKU. Für die Standard3-SKU ist der Wert entweder "default" oder "highDensity". Für alle anderen SKUs muss dieser Wert "default" sein. "default"
"highDensity"
networkRuleSet Netzwerkspezifische Regeln, die bestimmen, wie der Suchdienst erreicht werden kann. NetworkRuleSet
partitionCount Die Anzahl der Partitionen im Suchdienst; wenn angegeben, kann es 1, 2, 3, 4, 6 oder 12 sein. Werte größer als 1 sind nur für Standard-SKUs gültig. Bei "Standard3"-Diensten, bei denen hostingMode auf "highDensity" festgelegt ist, liegen die zulässigen Werte zwischen 1 und 3. INT

Einschränkungen:
Minimaler Wert = 1
Maximaler Wert = 12
publicNetworkAccess Dieser Wert kann auf "aktiviert" festgelegt werden, um Breaking Changes an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn diese Einstellung auf "deaktiviert" festgelegt ist, ist datenverkehr über die öffentliche Schnittstelle nicht zulässig, und Verbindungen mit privaten Endpunkten sind die exklusive Zugriffsmethode. "disabled"
"enabled"
replicaCount Die Anzahl der Replikate im Suchdienst. Wenn angegeben, muss es sich um einen Wert zwischen 1 und 12 inklusive für Standard-SKUs oder zwischen 1 und 3 einschließlich für die Basis-SKU sein. INT

Einschränkungen:
Minimaler Wert = 1
Maximaler Wert = 12
semanticSearch Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Such-SKUs an bestimmten Speicherorten möglich. "disabled"
"kostenlos"
"Standard"

DataPlaneAuthOptions

Name BESCHREIBUNG Wert
aadOrApiKey Gibt an, dass entweder der API-Schlüssel oder ein Zugriffstoken von einem Microsoft Entra ID Mandanten für die Authentifizierung verwendet werden kann. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Gibt an, dass nur der API-Schlüssel für die Authentifizierung verwendet werden kann.

DataPlaneAadOrApiKeyAuthOption

Name BESCHREIBUNG Wert
aadAuthFailureMode Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen sendet, bei denen die Authentifizierung fehlgeschlagen ist. "http401WithBearerChallenge"
"http403"

EncryptionWithCmk

Name BESCHREIBUNG Wert
Durchsetzung Beschreibt, wie ein Suchdienst erzwingen soll, dass mindestens eine nicht kundenseitig verschlüsselte Ressource vorhanden ist. "Deaktiviert"
"Aktiviert"
"Nicht angegeben"

NetworkRuleSet

Name BESCHREIBUNG Wert
ipRules Eine Liste der IP-Einschränkungsregeln, die für eine IP-Firewall verwendet werden. Alle IP-Adressen, die nicht den Regeln entsprechen, werden von der Firewall blockiert. Diese Regeln werden nur angewendet, wenn "publicNetworkAccess" des Suchdiensts "aktiviert" ist. IpRule[]

IpRule

Name BESCHREIBUNG Wert
value Der Wert, der einer einzelnen IPv4-Adresse (z. B. 123.1.2.3) oder einem IP-Bereich im CIDR-Format (z. B. 123.1.2.3/24) entspricht. Zeichenfolge

Sku

Name BESCHREIBUNG Wert
name Die SKU des Suchdiensts. Gültige Werte sind: "free": Shared service. "basic": Dedizierter Dienst mit bis zu 3 Replikaten. "standard": Dedizierter Dienst mit bis zu 12 Partitionen und 12 Replikaten. 'standard2': Ähnlich wie standard, aber mit mehr Kapazität pro Sucheinheit. 'standard3': Das größte Standardangebot mit bis zu 12 Partitionen und 12 Replikaten (oder bis zu 3 Partitionen mit mehr Indizes, wenn Sie auch die hostingMode-Eigenschaft auf "highDensity" festlegen). 'storage_optimized_l1': Unterstützt 1 TB pro Partition, bis zu 12 Partitionen. 'storage_optimized_l2': Unterstützt 2 TB pro Partition, bis zu 12 Partitionen." "basic"
"kostenlos"
"Standard"
"Standard2"
"Standard3"
"storage_optimized_l1"
"storage_optimized_l2"