Microsoft. Suche Suchdienste 2020-08-01-Vorschau

Bicep-Ressourcendefinition

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

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

Verwendungsbeispiele

Bicep-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung des Suchdiensts.

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

Von Azure verifizierte Module

Die folgenden Azure Verified Modules können verwendet werden, um diesen Ressourcentyp bereitzustellen.

Modul Beschreibung
Suchdienst- AVM-Ressourcenmodul für Suchdienst

Azure-Schnellstartbeispiele

Die folgenden Azure-Schnellstartvorlagen Bicep-Beispiele für die Bereitstellung dieses Ressourcentyps enthalten.

Bicep-Datei Beschreibung
Eingeschränktes Azure AI Foundry -Netzwerk Diese Gruppe von Vorlagen veranschaulicht, wie Sie Azure AI Foundry mit deaktivierter privater Verbindung und deaktiviertem Ausgang einrichten, indem Sie von Microsoft verwaltete Schlüssel für die Verschlüsselung und die von Microsoft verwaltete Identitätskonfiguration für die KI-Ressource verwenden.
Azure Cognitive Search-Dienst Diese Vorlage erstellt einen Azure Cognitive Search-Dienst
vom Netzwerk gesicherter Agent mit vom Benutzer verwalteter Identität Dieser Satz von Vorlagen veranschaulicht, wie Azure AI Agent Service mit virtueller Netzwerkisolation mithilfe der vom Benutzer verwalteten Identitätsauthentifizierung für die AI Service/AOAI-Verbindung und private Netzwerkverbindungen eingerichtet wird, um den Agent mit Ihren sicheren Daten zu verbinden.
Standard-Agent-Setup- Dieser Satz von Vorlagen veranschaulicht, wie Azure AI Agent Service mit dem Standardsetup eingerichtet wird, d. h. mit verwalteter Identitätsauthentifizierung für Projekt-/Hubverbindungen und aktiviertem öffentlichen Internetzugriff. Agents verwenden kundeneigene, einzelmandantenbasierte Such- und Speicherressourcen. Mit diesem Setup haben Sie die volle Kontrolle und Sichtbarkeit über diese Ressourcen, aber Sie verursachen Kosten basierend auf Ihrer Nutzung.

Ressourcenformat

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

resource symbolicname 'Microsoft.Search/searchServices@2020-08-01-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    hostingMode: 'string'
    networkRuleSet: {
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschaftswerte

Microsoft.Search/searchServices

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

Identität

Name Beschreibung Wert
Art Der Identitätstyp. "Keine"
'SystemAssigned' (erforderlich)

Ip-Regel

Name Beschreibung Wert
Wert 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, ist zulässig. Schnur

Netzwerk-Regelsatz

Name Beschreibung Wert
ipRegeln Eine Liste der IP-Einschränkungsregeln, die die eingehenden Netzwerke definieren, mit denen der Zugriff auf den Suchdienstendpunkt ermöglicht wird. In der Zwischenzeit werden alle anderen öffentlichen IP-Netzwerke durch die Firewall blockiert. Diese Einschränkungsregeln werden nur angewendet, wenn "publicNetworkAccess" des Suchdiensts aktiviert ist; andernfalls ist der Datenverkehr über die öffentliche Schnittstelle auch bei öffentlichen IP-Regeln nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. IpRule-[]

SearchServiceEigenschaften

Name Beschreibung Wert
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. "Standard"
"highDensity"
networkRuleSet Netzwerkspezifische Regeln, die bestimmen, wie der Azure Cognitive Search-Dienst 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. Für "Standard3"-Dienste mit hostingMode-Wert auf "highDensity" festgelegt, liegen die zulässigen Werte zwischen 1 und 3. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 12
Öffentlicher Netzwerkzugang Dieser Wert kann auf "aktiviert" festgelegt werden, um änderungen an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn dieser Wert auf "deaktiviert" festgelegt ist, ist der Datenverkehr über die öffentliche Schnittstelle nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. "Deaktiviert"
"aktiviert"
replicaCount (englisch) Die Anzahl der Replikate im Suchdienst. Wenn angegeben, muss es sich um einen Wert zwischen 1 und 12 einschließlich für Standard-SKUs oder zwischen 1 und 3 einschließlich für einfache SKU handeln. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 12

Sku

Name Beschreibung Wert
Name Die SKU des Suchdiensts. Gültige Werte sind: 'free': Gemeinsamer Dienst. "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.' "einfach"
"kostenlos"
"Standard"
"Standard2"
"Standard3"
"storage_optimized_l1"
"storage_optimized_l2"

Verfolgte ResourceTags

Name Beschreibung Wert

ARM-Vorlagenressourcendefinition

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

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.

Schablone Beschreibung
Eingeschränktes Azure AI Foundry -Netzwerk

Bereitstellen in Azure
Diese Gruppe von Vorlagen veranschaulicht, wie Sie Azure AI Foundry mit deaktivierter privater Verbindung und deaktiviertem Ausgang einrichten, indem Sie von Microsoft verwaltete Schlüssel für die Verschlüsselung und die von Microsoft verwaltete Identitätskonfiguration für die KI-Ressource verwenden.
Azure Cognitive Search-Dienst

Bereitstellen in Azure
Diese Vorlage erstellt einen Azure Cognitive Search-Dienst
Azure Cognitive Search-Dienst mit privatem Endpunkt

Bereitstellen in Azure
Diese Vorlage erstellt einen Azure Cognitive Search-Dienst mit einem privaten Endpunkt.
vom Netzwerk gesicherter Agent mit vom Benutzer verwalteter Identität

Bereitstellen in Azure
Dieser Satz von Vorlagen veranschaulicht, wie Azure AI Agent Service mit virtueller Netzwerkisolation mithilfe der vom Benutzer verwalteten Identitätsauthentifizierung für die AI Service/AOAI-Verbindung und private Netzwerkverbindungen eingerichtet wird, um den Agent mit Ihren sicheren Daten zu verbinden.
Standard-Agent-Setup-

Bereitstellen in Azure
Dieser Satz von Vorlagen veranschaulicht, wie Azure AI Agent Service mit dem Standardsetup eingerichtet wird, d. h. mit verwalteter Identitätsauthentifizierung für Projekt-/Hubverbindungen und aktiviertem öffentlichen Internetzugriff. Agents verwenden kundeneigene, einzelmandantenbasierte Such- und Speicherressourcen. Mit diesem Setup haben Sie die volle Kontrolle und Sichtbarkeit über diese Ressourcen, aber Sie verursachen Kosten basierend auf Ihrer Nutzung.
Web App mit einer SQL-Datenbank, Azure Cosmos DB, Azure Search

Bereitstellen in Azure
Diese Vorlage enthält eine Web App, eine SQL-Datenbank, Azure Cosmos DB, Azure Search und Application Insights.

Ressourcenformat

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

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2020-08-01-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "hostingMode": "string",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschaftswerte

Microsoft.Search/searchServices

Name Beschreibung Wert
apiVersion (Englisch) Die API-Version "2020-08-01-preview"
Identität Die Identität der Ressource. Identität
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften des Suchdiensts. SearchServiceProperties-
Sku Die SKU des Suchdiensts, die Preisniveau- und Kapazitätsgrenzen bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich. Sku-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp 'Microsoft.Search/searchServices'

Identität

Name Beschreibung Wert
Art Der Identitätstyp. "Keine"
'SystemAssigned' (erforderlich)

Ip-Regel

Name Beschreibung Wert
Wert 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, ist zulässig. Schnur

Netzwerk-Regelsatz

Name Beschreibung Wert
ipRegeln Eine Liste der IP-Einschränkungsregeln, die die eingehenden Netzwerke definieren, mit denen der Zugriff auf den Suchdienstendpunkt ermöglicht wird. In der Zwischenzeit werden alle anderen öffentlichen IP-Netzwerke durch die Firewall blockiert. Diese Einschränkungsregeln werden nur angewendet, wenn "publicNetworkAccess" des Suchdiensts aktiviert ist; andernfalls ist der Datenverkehr über die öffentliche Schnittstelle auch bei öffentlichen IP-Regeln nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. IpRule-[]

SearchServiceEigenschaften

Name Beschreibung Wert
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. "Standard"
"highDensity"
networkRuleSet Netzwerkspezifische Regeln, die bestimmen, wie der Azure Cognitive Search-Dienst 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. Für "Standard3"-Dienste mit hostingMode-Wert auf "highDensity" festgelegt, liegen die zulässigen Werte zwischen 1 und 3. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 12
Öffentlicher Netzwerkzugang Dieser Wert kann auf "aktiviert" festgelegt werden, um änderungen an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn dieser Wert auf "deaktiviert" festgelegt ist, ist der Datenverkehr über die öffentliche Schnittstelle nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. "Deaktiviert"
"aktiviert"
replicaCount (englisch) Die Anzahl der Replikate im Suchdienst. Wenn angegeben, muss es sich um einen Wert zwischen 1 und 12 einschließlich für Standard-SKUs oder zwischen 1 und 3 einschließlich für einfache SKU handeln. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 12

Sku

Name Beschreibung Wert
Name Die SKU des Suchdiensts. Gültige Werte sind: 'free': Gemeinsamer Dienst. "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.' "einfach"
"kostenlos"
"Standard"
"Standard2"
"Standard3"
"storage_optimized_l1"
"storage_optimized_l2"

Verfolgte ResourceTags

Name Beschreibung Wert

Terraform -Ressourcendefinition (AzAPI-Anbieter)

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

  • Ressourcengruppen Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Change Log.

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung des Suchdiensts.

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    = ["*"]
}

Von Azure verifizierte Module

Die folgenden Azure Verified Modules können verwendet werden, um diesen Ressourcentyp bereitzustellen.

Modul Beschreibung
Suchdienst- AVM-Ressourcenmodul für Suchdienst

Ressourcenformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2020-08-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      hostingMode = "string"
      networkRuleSet = {
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
    }
    sku = {
      name = "string"
    }
  }
}

Eigenschaftswerte

Microsoft.Search/searchServices

Name Beschreibung Wert
Identität Die Identität der Ressource. Identität
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften des Suchdiensts. SearchServiceProperties-
Sku Die SKU des Suchdiensts, die Preisniveau- und Kapazitätsgrenzen bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich. Sku-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.Search/searchServices@2020-08-01-preview"

Identität

Name Beschreibung Wert
Art Der Identitätstyp. "Keine"
'SystemAssigned' (erforderlich)

Ip-Regel

Name Beschreibung Wert
Wert 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, ist zulässig. Schnur

Netzwerk-Regelsatz

Name Beschreibung Wert
ipRegeln Eine Liste der IP-Einschränkungsregeln, die die eingehenden Netzwerke definieren, mit denen der Zugriff auf den Suchdienstendpunkt ermöglicht wird. In der Zwischenzeit werden alle anderen öffentlichen IP-Netzwerke durch die Firewall blockiert. Diese Einschränkungsregeln werden nur angewendet, wenn "publicNetworkAccess" des Suchdiensts aktiviert ist; andernfalls ist der Datenverkehr über die öffentliche Schnittstelle auch bei öffentlichen IP-Regeln nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. IpRule-[]

SearchServiceEigenschaften

Name Beschreibung Wert
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. "Standard"
"highDensity"
networkRuleSet Netzwerkspezifische Regeln, die bestimmen, wie der Azure Cognitive Search-Dienst 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. Für "Standard3"-Dienste mit hostingMode-Wert auf "highDensity" festgelegt, liegen die zulässigen Werte zwischen 1 und 3. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 12
Öffentlicher Netzwerkzugang Dieser Wert kann auf "aktiviert" festgelegt werden, um änderungen an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn dieser Wert auf "deaktiviert" festgelegt ist, ist der Datenverkehr über die öffentliche Schnittstelle nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. "Deaktiviert"
"aktiviert"
replicaCount (englisch) Die Anzahl der Replikate im Suchdienst. Wenn angegeben, muss es sich um einen Wert zwischen 1 und 12 einschließlich für Standard-SKUs oder zwischen 1 und 3 einschließlich für einfache SKU handeln. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 12

Sku

Name Beschreibung Wert
Name Die SKU des Suchdiensts. Gültige Werte sind: 'free': Gemeinsamer Dienst. "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.' "einfach"
"kostenlos"
"Standard"
"Standard2"
"Standard3"
"storage_optimized_l1"
"storage_optimized_l2"

Verfolgte ResourceTags

Name Beschreibung Wert