Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Bicep-Ressourcendefinition
Der SearchServices-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
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@2025-05-01' = {
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'
}
endpoint: 'string'
hostingMode: 'string'
networkRuleSet: {
bypass: 'string'
ipRules: [
{
value: 'string'
}
]
}
partitionCount: int
publicNetworkAccess: 'string'
replicaCount: int
semanticSearch: 'string'
upgradeAvailable: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Eigenschaftswerte
Microsoft.Search/searchServices
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Identität | Die Identität der Ressource. | Identität |
| Standort | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | string Zwänge: Pattern = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (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 |
| Schlagwörter | Ressourcenetiketten | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
DataPlaneAadOrApiKeyAuthOption
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| aadAuthFailureMode | Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen senden würde, bei denen die Authentifizierung fehlgeschlagen ist. | 'http401WithBearerChallenge' 'http403' |
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. | jegliche |
VerschlüsselungWithCmk
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Durchsetzung | Beschreibt, wie ein Suchdienst compliance erzwingen soll, wenn er Objekte findet, die nicht mit dem vom Kunden verwalteten Schlüssel verschlüsselt sind. | "Deaktiviert" "Aktiviert" "Nicht angegeben" |
Identität
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Typ | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine vom System erstellte Identität als auch einen Satz benutzerseitig zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" 'SystemZugewiesen' "SystemAssigned, UserAssigned" "UserAssigned" (erforderlich) |
| vom Benutzer zugewiesene Identitäten | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|
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 |
|---|---|---|
| Umgehungsstraße | Mögliche Ursprünge eingehender Datenverkehrs, die die im Abschnitt "ipRules" definierten Regeln umgehen können. | "AzureServices" "Keine" |
| 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 |
|---|---|---|
| authOptions | Definiert die Optionen, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist. | DataPlaneAuthOptions- |
| computeType | Konfigurieren Sie diese Eigenschaft, um den Suchdienst entweder mit dem Standardmäßigen Compute oder azure Confidential Compute zu unterstützen. | "Vertraulich" 'Standard' |
| dataExfiltrationSchutzmaßnahmen | Eine Liste der Datenexfiltrationsszenarien, die explizit für den Suchdienst unzulässig sind. Derzeit ist der einzige unterstützte Wert "Alle", um alle möglichen Datenexportszenarien mit feineren Steuerelementen zu deaktivieren, die für die Zukunft geplant sind. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'BlockAll' |
| disableLocalAuth | Wenn dieser Wert 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. | Boolesch |
| encryptionWithCmk | Gibt eine Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an. | EncryptionWithCmk- |
| Endpunkt | Der Endpunkt des Azure KI-Suche-Diensts. | Schnur |
| 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 SKU standard3 lautet der Wert entweder "Default" oder "HighDensity". Für alle anderen SKUs muss dieser Wert "Standard" sein. | 'Standard' "Hohe Dichte" |
| networkRuleSet | Netzwerkspezifische Regeln, die bestimmen, wie der Azure KI-Suche-Dienst erreicht werden kann. | NetworkRuleSet- |
| partitionCount | Die Anzahl der Partitionen im dedizierten 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 Breaking Changes an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn diese Option auf "Deaktiviert" festgelegt ist, ist der Datenverkehr über die öffentliche Schnittstelle nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. | "Deaktiviert" "Aktiviert" "SecuredByPerimeter" |
| replicaCount (englisch) | Die Anzahl der Repliken im dedizierten 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 |
| semanticSuche | Spezifiziert die Verfügbarkeit und den Abrechnungsplan für die semantische Suche im Azure KI-Suche-Service. Diese Konfiguration ist nur für bestimmte Preisstufen in bestimmten Regionen verfügbar. | "Deaktiviert" "kostenlos" "Standard" |
| UpgradeVerfügbar | Gibt an, ob der Suchdienst über ein Upgrade verfügt. | "verfügbar" 'notAvailable' |
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. 'Serverless': Serverlose Stufe mit automatischer Skalierung. | "einfach" "kostenlos" "Standard" "Standard2" "Standard3" "storage_optimized_l1" "storage_optimized_l2" |
Verfolgte ResourceTags
| Name | BESCHREIBUNG | Wert |
|---|
UserAssignedIdentity
| Name | BESCHREIBUNG | Wert |
|---|
ARM-Vorlagenressourcendefinition
Der SearchServices-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppen-Deployment-Befehle Für eine Liste der geänderten Eigenschaften in jeder API-Version siehe Änderungsprotokoll.
Verwendungsbeispiele
Azure-Schnellstartvorlagen
Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.
| Schablone | 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 |
|
Azure Cognitive Search-Dienst mit privatem Endpunkt |
Diese Vorlage erstellt einen Azure Cognitive Search-Dienst mit einem privaten Endpunkt. |
|
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. |
|
Web App mit einer SQL-Datenbank, Azure Cosmos DB, Azure Search |
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": "2025-05-01",
"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"
},
"endpoint": "string",
"hostingMode": "string",
"networkRuleSet": {
"bypass": "string",
"ipRules": [
{
"value": "string"
}
]
},
"partitionCount": "int",
"publicNetworkAccess": "string",
"replicaCount": "int",
"semanticSearch": "string",
"upgradeAvailable": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Eigenschaftswerte
Microsoft.Search/searchServices
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| apiVersion (Englisch) | Die API-Version | '2025-05-01' |
| Identität | Die Identität der Ressource. | Identität |
| Standort | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | string Zwänge: Pattern = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (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 |
| Schlagwörter | Ressourcenetiketten | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| Typ | Der Ressourcentyp | 'Microsoft.Search/searchServices' |
DataPlaneAadOrApiKeyAuthOption
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| aadAuthFailureMode | Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen senden würde, bei denen die Authentifizierung fehlgeschlagen ist. | 'http401WithBearerChallenge' 'http403' |
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. | jegliche |
VerschlüsselungWithCmk
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Durchsetzung | Beschreibt, wie ein Suchdienst compliance erzwingen soll, wenn er Objekte findet, die nicht mit dem vom Kunden verwalteten Schlüssel verschlüsselt sind. | "Deaktiviert" "Aktiviert" "Nicht angegeben" |
Identität
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Typ | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine vom System erstellte Identität als auch einen Satz benutzerseitig zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" 'SystemZugewiesen' "SystemAssigned, UserAssigned" "UserAssigned" (erforderlich) |
| vom Benutzer zugewiesene Identitäten | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|
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 |
|---|---|---|
| Umgehungsstraße | Mögliche Ursprünge eingehender Datenverkehrs, die die im Abschnitt "ipRules" definierten Regeln umgehen können. | "AzureServices" "Keine" |
| 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 |
|---|---|---|
| authOptions | Definiert die Optionen, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist. | DataPlaneAuthOptions- |
| computeType | Konfigurieren Sie diese Eigenschaft, um den Suchdienst entweder mit dem Standardmäßigen Compute oder azure Confidential Compute zu unterstützen. | "Vertraulich" 'Standard' |
| dataExfiltrationSchutzmaßnahmen | Eine Liste der Datenexfiltrationsszenarien, die explizit für den Suchdienst unzulässig sind. Derzeit ist der einzige unterstützte Wert "Alle", um alle möglichen Datenexportszenarien mit feineren Steuerelementen zu deaktivieren, die für die Zukunft geplant sind. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'BlockAll' |
| disableLocalAuth | Wenn dieser Wert 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. | Boolesch |
| encryptionWithCmk | Gibt eine Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an. | EncryptionWithCmk- |
| Endpunkt | Der Endpunkt des Azure KI-Suche-Diensts. | Schnur |
| 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 SKU standard3 lautet der Wert entweder "Default" oder "HighDensity". Für alle anderen SKUs muss dieser Wert "Standard" sein. | 'Standard' "Hohe Dichte" |
| networkRuleSet | Netzwerkspezifische Regeln, die bestimmen, wie der Azure KI-Suche-Dienst erreicht werden kann. | NetworkRuleSet- |
| partitionCount | Die Anzahl der Partitionen im dedizierten 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 Breaking Changes an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn diese Option auf "Deaktiviert" festgelegt ist, ist der Datenverkehr über die öffentliche Schnittstelle nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. | "Deaktiviert" "Aktiviert" "SecuredByPerimeter" |
| replicaCount (englisch) | Die Anzahl der Repliken im dedizierten 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 |
| semanticSuche | Spezifiziert die Verfügbarkeit und den Abrechnungsplan für die semantische Suche im Azure KI-Suche-Service. Diese Konfiguration ist nur für bestimmte Preisstufen in bestimmten Regionen verfügbar. | "Deaktiviert" "kostenlos" "Standard" |
| UpgradeVerfügbar | Gibt an, ob der Suchdienst über ein Upgrade verfügt. | "verfügbar" 'notAvailable' |
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. 'Serverless': Serverlose Stufe mit automatischer Skalierung. | "einfach" "kostenlos" "Standard" "Standard2" "Standard3" "storage_optimized_l1" "storage_optimized_l2" |
Verfolgte ResourceTags
| Name | BESCHREIBUNG | Wert |
|---|
UserAssignedIdentity
| 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@2025-05-01"
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"
}
endpoint = "string"
hostingMode = "string"
networkRuleSet = {
bypass = "string"
ipRules = [
{
value = "string"
}
]
}
partitionCount = int
publicNetworkAccess = "string"
replicaCount = int
semanticSearch = "string"
upgradeAvailable = "string"
}
sku = {
name = "string"
}
}
}
Eigenschaftswerte
Microsoft.Search/searchServices
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Identität | Die Identität der Ressource. | Identität |
| Standort | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | string Zwänge: Pattern = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (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 |
| Schlagwörter | Ressourcenetiketten | Wörterbuch der Tagnamen und -werte. |
| Typ | Der Ressourcentyp | "Microsoft.Search/searchServices@2025-05-01" |
DataPlaneAadOrApiKeyAuthOption
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| aadAuthFailureMode | Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen senden würde, bei denen die Authentifizierung fehlgeschlagen ist. | 'http401WithBearerChallenge' 'http403' |
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. | jegliche |
VerschlüsselungWithCmk
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Durchsetzung | Beschreibt, wie ein Suchdienst compliance erzwingen soll, wenn er Objekte findet, die nicht mit dem vom Kunden verwalteten Schlüssel verschlüsselt sind. | "Deaktiviert" "Aktiviert" "Nicht angegeben" |
Identität
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Typ | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine vom System erstellte Identität als auch einen Satz benutzerseitig zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" 'SystemZugewiesen' "SystemAssigned, UserAssigned" "UserAssigned" (erforderlich) |
| vom Benutzer zugewiesene Identitäten | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|
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 |
|---|---|---|
| Umgehungsstraße | Mögliche Ursprünge eingehender Datenverkehrs, die die im Abschnitt "ipRules" definierten Regeln umgehen können. | "AzureServices" "Keine" |
| 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 |
|---|---|---|
| authOptions | Definiert die Optionen, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist. | DataPlaneAuthOptions- |
| computeType | Konfigurieren Sie diese Eigenschaft, um den Suchdienst entweder mit dem Standardmäßigen Compute oder azure Confidential Compute zu unterstützen. | "Vertraulich" 'Standard' |
| dataExfiltrationSchutzmaßnahmen | Eine Liste der Datenexfiltrationsszenarien, die explizit für den Suchdienst unzulässig sind. Derzeit ist der einzige unterstützte Wert "Alle", um alle möglichen Datenexportszenarien mit feineren Steuerelementen zu deaktivieren, die für die Zukunft geplant sind. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'BlockAll' |
| disableLocalAuth | Wenn dieser Wert 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. | Boolesch |
| encryptionWithCmk | Gibt eine Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an. | EncryptionWithCmk- |
| Endpunkt | Der Endpunkt des Azure KI-Suche-Diensts. | Schnur |
| 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 SKU standard3 lautet der Wert entweder "Default" oder "HighDensity". Für alle anderen SKUs muss dieser Wert "Standard" sein. | 'Standard' "Hohe Dichte" |
| networkRuleSet | Netzwerkspezifische Regeln, die bestimmen, wie der Azure KI-Suche-Dienst erreicht werden kann. | NetworkRuleSet- |
| partitionCount | Die Anzahl der Partitionen im dedizierten 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 Breaking Changes an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn diese Option auf "Deaktiviert" festgelegt ist, ist der Datenverkehr über die öffentliche Schnittstelle nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode. | "Deaktiviert" "Aktiviert" "SecuredByPerimeter" |
| replicaCount (englisch) | Die Anzahl der Repliken im dedizierten 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 |
| semanticSuche | Spezifiziert die Verfügbarkeit und den Abrechnungsplan für die semantische Suche im Azure KI-Suche-Service. Diese Konfiguration ist nur für bestimmte Preisstufen in bestimmten Regionen verfügbar. | "Deaktiviert" "kostenlos" "Standard" |
| UpgradeVerfügbar | Gibt an, ob der Suchdienst über ein Upgrade verfügt. | "verfügbar" 'notAvailable' |
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. 'Serverless': Serverlose Stufe mit automatischer Skalierung. | "einfach" "kostenlos" "Standard" "Standard2" "Standard3" "storage_optimized_l1" "storage_optimized_l2" |
Verfolgte ResourceTags
| Name | BESCHREIBUNG | Wert |
|---|
UserAssignedIdentity
| Name | BESCHREIBUNG | Wert |
|---|