Freigeben über

Services - Update

  • Referenz
Dienst:
Search Management
API-Version:
2024-03-01-preview

Updates einen vorhandenen Suchdienst in der angegebenen Ressourcengruppe.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2024-03-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
 path True

string

Der Name der Ressourcengruppe im aktuellen Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
searchServiceName
 path True

string

Der Name der zu aktualisierenden Azure KI-Suchdienst.
subscriptionId
 path True

string

Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
api-version
 query True

string

Die API-Version, die für jede Anforderung verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string

uuid

Ein vom Client generierter GUID-Wert zur Identifizierung dieser Anforderung. Wenn angegeben, wird dies in die Antwortinformationen aufgenommen, um die Anforderung nachzuverfolgen.

Anforderungstext

Name Typ Beschreibung
identity

Identity

Details zur Identität des Suchdiensts. Ein NULL-Wert gibt an, dass dem Suchdienst keine Identität zugewiesen ist.
location

string

Der geografische Standort der Ressource. Dies muss eine der unterstützten und registrierten Azure-Georegionen sein (z. B. USA, Westen, USA, Osten, Asien, Südosten usw.). Diese Eigenschaft ist beim Erstellen einer neuen Ressource erforderlich.
properties.authOptions

DataPlaneAuthOptions

Definiert die Optionen, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist.
properties.disableLocalAuth

boolean

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.
properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Eine Liste von Datenexfiltrationsszenarien, die für den Suchdienst explizit nicht zulässig sind. Derzeit wird nur der Wert "All" unterstützt, um alle möglichen Datenexportszenarien zu deaktivieren, wobei für die Zukunft differenziertere Kontrollen geplant sind.
properties.encryptionWithCmk

EncryptionWithCmk

Gibt jede Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an.
properties.hostingMode

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.
properties.networkRuleSet

NetworkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie die Azure KI-Suchdienst erreicht werden kann.
properties.partitionCount

integer

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.
properties.publicNetworkAccess

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.
properties.replicaCount

integer

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.
properties.semanticSearch

SearchSemanticSearch

Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Azure KI Search-SKUs an bestimmten Standorten möglich.
sku

Sku

Die SKU des Suchdiensts, die preis- und kapazitätslimits bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich.
tags

object

Tags zum Kategorisieren der Ressource im Azure-Portal.

Antworten

Name Typ Beschreibung
200 OK

SearchService

Die vorhandene Dienstdefinition wurde erfolgreich aktualisiert. Wenn Sie die Anzahl der Replikate oder Partitionen geändert haben, erfolgt der Skalierungsvorgang asynchron. Sie können die status eines Skalierungsvorgangs über die provisioningState-Eigenschaft einer Get Service-Anforderung überprüfen.
Other Status Codes

CloudError

HTTP 400 (ungültige Anforderung): Die angegebene Dienstdefinition ist ungültig, oder Sie haben versucht, eine Eigenschaft zu ändern, die unveränderlich ist. Ausführliche Informationen finden Sie im Fehlercode und der Meldung in der Antwort. HTTP 404 (nicht gefunden): Das Abonnement oder die Ressourcengruppe wurde nicht gefunden. HTTP 409 (Konflikt): Das angegebene Abonnement ist deaktiviert.

Sicherheit

azure_auth

Gibt einen impliziten Gewährungsflow an, der von Microsoft Identity Platform unterstützt wird.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

SearchUpdateService
SearchUpdateServiceAuthOptions
SearchUpdateServiceDisableLocalAuth
SearchUpdateServiceToAllowAccessFromPrivateEndpoints
SearchUpdateServiceToAllowAccessFromPublicCustomIPs
SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchUpdateServiceToRemoveIdentity
SearchUpdateServiceWithCmkEnforcement
SearchUpdateServiceWithDataExfiltration
SearchUpdateServiceWithSemanticSearch

SearchUpdateService

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceAuthOptions

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceDisableLocalAuth

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "disableLocalAuth": true
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled"
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "basic"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    }
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    }
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToRemoveIdentity

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "sku": {
    "name": "standard"
  },
  "identity": {
    "type": "None"
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {},
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceWithCmkEnforcement

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    }
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceWithDataExfiltration

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

SearchUpdateServiceWithSemanticSearch

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "semanticSearch": "standard"
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "standard"
  }
}

Definitionen

Name Beschreibung
AadAuthFailureMode

Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen sendet, bei denen die Authentifizierung fehlgeschlagen ist.
ApiKeyOnly

Gibt an, dass nur der API-Schlüssel für die Authentifizierung verwendet werden kann.
CloudError

Enthält Informationen zu einem API-Fehler.
CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
DataPlaneAadOrApiKeyAuthOption

Gibt an, dass entweder der API-Schlüssel oder ein Zugriffstoken von einem Microsoft Entra ID Mandanten für die Authentifizierung verwendet werden kann.
DataPlaneAuthOptions

Definiert die Optionen, wie der Suchdienst eine Datenebenenanforderung authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist.
EncryptionWithCmk

Beschreibt eine Richtlinie, die bestimmt, wie Ressourcen innerhalb des Suchdiensts mit kundenseitig verwalteten Schlüsseln verschlüsselt werden sollen.
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.
Identity

Details zur Identität des Suchdiensts. Ein NULL-Wert gibt an, dass dem Suchdienst keine Identität zugewiesen ist.
IdentityType

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.
IpRule

Die IP-Einschränkungsregel des Azure KI-Suchdienst.
NetworkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie die Azure KI-Suchdienst erreicht werden kann.
PrivateEndpoint

Die private Endpunktressource des Microsoft.Network-Anbieters.
PrivateEndpointConnection

Beschreibt eine vorhandene private Endpunktverbindung mit dem Azure KI-Suchdienst.
PrivateEndpointConnectionProperties

Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Suchdienst.
PrivateLinkServiceConnectionProvisioningState

Der Bereitstellungsstatus der Private Link-Dienstverbindung. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich, Unvollständig oder Abgebrochen.
PrivateLinkServiceConnectionState

Beschreibt den aktuellen Zustand einer vorhandenen Azure Private Link Dienstverbindung mit dem privaten Endpunkt.
PrivateLinkServiceConnectionStatus

Status der Private Link-Dienstverbindung. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.
ProvisioningState

Der Status des letzten Bereitstellungsvorgangs, der für den Suchdienst ausgeführt wurde. Die Bereitstellung ist ein vorübergehender Zustand während der Einrichtung der Dienstkapazität. Nachdem die Kapazität eingerichtet wurde, ändert sich provisioningState entweder in "succeeded" oder "failed". Clientanwendungen können die Bereitstellung status abfragen (das empfohlene Abrufintervall liegt zwischen 30 Sekunden und einer Minute), indem sie den Vorgang Suchdienst abrufen verwenden, um zu sehen, wann ein Vorgang abgeschlossen ist. Wenn Sie den kostenlosen Dienst verwenden, wird dieser Wert in der Regel direkt im Aufruf des Suchdiensts erstellen als "erfolgreich" zurückgegeben. Grund hierfür ist, dass der kostenlose Dienst bereits eingerichtete Kapazitäten verwendet.
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.
SearchBypass

Mögliche Ursprünge des eingehenden Datenverkehrs, der die im Abschnitt "ipRules" definierten Regeln umgehen kann.
SearchDisabledDataExfiltrationOption

Eine Liste von Datenexfiltrationsszenarien, die für den Suchdienst explizit nicht zulässig sind. Derzeit wird nur der Wert "All" unterstützt, um alle möglichen Datenexportszenarien zu deaktivieren, wobei für die Zukunft differenziertere Kontrollen geplant sind.
SearchEncryptionComplianceStatus

Gibt den status der Suchdienstkonformität in Bezug auf nicht CMK-verschlüsselte Objekte zurück. Wenn ein Dienst über mehrere unverschlüsselte Objekte verfügt und die Erzwingung aktiviert ist, wird der Dienst als nicht konform markiert.
SearchEncryptionWithCmk

Beschreibt, wie ein Suchdienst compliance erzwingen soll, wenn er Objekte findet, die nicht mit dem kundenseitig verwalteten Schlüssel verschlüsselt sind.
SearchSemanticSearch

Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Azure KI Search-SKUs an bestimmten Standorten möglich.
SearchService

Beschreibt eine Azure KI-Suchdienst und ihren aktuellen Zustand.
SearchServiceStatus

Die status des Suchdiensts. Mögliche Werte sind: "running": Der Suchdienst wird ausgeführt, und es werden keine Bereitstellungsvorgänge ausgeführt. "Bereitstellung": Der Suchdienst wird bereitgestellt oder hoch- oder herunterskaliert. "delete": Der Suchdienst wird gelöscht. "heruntergestuft": Der Suchdienst wird heruntergestuft. Dies kann auftreten, wenn die zugrunde liegenden Sucheinheiten nicht fehlerfrei sind. Der Suchdienst ist höchstwahrscheinlich betriebsbereit, aber die Leistung kann langsam sein, und einige Anforderungen werden möglicherweise gelöscht. 'disabled': Der Suchdienst ist deaktiviert. Mit diesem Status lehnt der Dienst alle API-Anforderungen ab. 'error': Der Suchdienst befindet sich in einem Fehlerzustand. "beendet": Der Suchdienst befindet sich in einem abonnement, das deaktiviert ist. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, bedeutet dies, dass das Azure AI Search-Team das zugrunde liegende Problem aktiv untersucht. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar.
SearchServiceUpdate

Die Parameter, die zum Aktualisieren einer Azure KI-Suchdienst verwendet werden.
SharedPrivateLinkResource

Beschreibt eine freigegebene Private Link-Ressource, die vom Azure KI-Suchdienst verwaltet wird.
SharedPrivateLinkResourceProperties

Beschreibt die Eigenschaften einer vorhandenen freigegebenen Private Link-Ressource, die vom Azure KI-Suchdienst verwaltet wird.
SharedPrivateLinkResourceProvisioningState

Der Bereitstellungsstatus der freigegebenen Private Link-Ressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.
SharedPrivateLinkResourceStatus

Status der freigegebenen Private Link-Ressource. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.
Sku

Definiert die SKU eines Suchdiensts, die Die Abrechnungsrate und Kapazitätsgrenzen bestimmt.
SkuName

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."
UserAssignedManagedIdentity

Die Details der vom Benutzer zugewiesenen verwalteten Identität, die dem Suchdienst zugewiesen ist.

AadAuthFailureMode

Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen sendet, bei denen die Authentifizierung fehlgeschlagen ist.

Name Typ Beschreibung
http401WithBearerChallenge

string

Gibt an, dass Anforderungen, bei denen die Authentifizierung fehlgeschlagen ist, mit dem HTTP-status Code 401 (Nicht autorisiert) angezeigt werden und eine Bearer challenge darstellen soll.
http403

string

Gibt an, dass Anforderungen, bei denen die Authentifizierung fehlgeschlagen ist, mit dem HTTP-status Code 403 (Verboten) angezeigt werden soll.

ApiKeyOnly

Gibt an, dass nur der API-Schlüssel für die Authentifizierung verwendet werden kann.

CloudError

Enthält Informationen zu einem API-Fehler.

Name Typ Beschreibung
error

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
message

string

Eine kurze Beschreibung des Fehlers, die darauf hinweist, was falsch gelaufen ist (details/Debuginformationen finden Sie in der Eigenschaft "error.message").

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name Typ Beschreibung
code

string

Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-status Code. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details

CloudErrorBody[]

Enthält geschachtelte Fehler, die sich auf diesen Fehler beziehen.
message

string

Eine Meldung, die den Fehler ausführlich beschreibt und Debuginformationen bereitstellt.
target

string

Das Ziel des bestimmten Fehlers (z. B. der Name der -Eigenschaft im Fehler).

DataPlaneAadOrApiKeyAuthOption

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

Name Typ Beschreibung
aadAuthFailureMode

AadAuthFailureMode

Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen sendet, bei denen die Authentifizierung fehlgeschlagen ist.

DataPlaneAuthOptions

Definiert die Optionen, wie der Suchdienst eine Datenebenenanforderung authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist.

Name Typ Beschreibung
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

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

ApiKeyOnly

Gibt an, dass nur der API-Schlüssel für die Authentifizierung verwendet werden kann.

EncryptionWithCmk

Beschreibt eine Richtlinie, die bestimmt, wie Ressourcen innerhalb des Suchdiensts mit kundenseitig verwalteten Schlüsseln verschlüsselt werden sollen.

Name Typ Beschreibung
encryptionComplianceStatus

SearchEncryptionComplianceStatus

Gibt den status der Suchdienstkonformität in Bezug auf nicht CMK-verschlüsselte Objekte zurück. Wenn ein Dienst über mehrere unverschlüsselte Objekte verfügt und die Erzwingung aktiviert ist, wird der Dienst als nicht konform markiert.
enforcement

SearchEncryptionWithCmk

Beschreibt, wie ein Suchdienst compliance erzwingen soll, wenn er Objekte findet, die nicht mit dem kundenseitig verwalteten Schlüssel verschlüsselt sind.

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.

Name Typ Beschreibung
default

string

Der Grenzwert für die Anzahl von Indizes wird durch die Standardgrenzwerte für die SKU bestimmt.
highDensity

string

Nur Anwendung für die Standard3-SKU, bei der der Suchdienst bis zu 1.000 Indizes aufweisen kann.

Identity

Details zur Identität des Suchdiensts. Ein NULL-Wert gibt an, dass dem Suchdienst keine Identität zugewiesen ist.

Name Typ Beschreibung
principalId

string

Die Prinzipal-ID der systemseitig zugewiesenen Identität des Suchdiensts.
tenantId

string

Die Mandanten-ID der systemseitig zugewiesenen Identität des Suchdiensts.
type

IdentityType

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.
userAssignedIdentities

<string,  UserAssignedManagedIdentity>

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

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.

Name Typ Beschreibung
None

string

Gibt an, dass alle Identitäten, die dem Suchdienst zugeordnet sind, entfernt werden müssen.
SystemAssigned

string

Gibt an, dass die systemseitig zugewiesene Identität für den Suchdienst aktiviert wird.
SystemAssigned, UserAssigned

string

Gibt an, dass die systemseitig zugewiesene Identität für den Suchdienst zusammen mit der Zuweisung einer oder mehrerer benutzerseitig zugewiesener Identitäten aktiviert wird.
UserAssigned

string

Gibt an, dass dem Suchdienst eine oder mehrere benutzerseitig zugewiesene Identitäten zugewiesen werden.

IpRule

Die IP-Einschränkungsregel des Azure KI-Suchdienst.

Name Typ Beschreibung
value

string

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.

NetworkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie die Azure KI-Suchdienst erreicht werden kann.

Name Typ Beschreibung
bypass

SearchBypass

Mögliche Ursprünge des eingehenden Datenverkehrs, der die im Abschnitt "ipRules" definierten Regeln umgehen kann.
ipRules

IpRule[]

Eine Liste von IP-Einschränkungsregeln, die die eingehenden Netzwerke definieren und den Zugriff auf den Suchdienstendpunkt zulassen. In der Zwischenzeit werden alle anderen öffentlichen IP-Netzwerke durch die Firewall blockiert. Diese Einschränkungsregeln werden nur angewendet, wenn der "publicNetworkAccess" des Suchdiensts "aktiviert" ist; Andernfalls ist der Datenverkehr über eine öffentliche Schnittstelle auch bei öffentlichen IP-Regeln nicht zulässig, und Verbindungen mit privaten Endpunkten wären die exklusive Zugriffsmethode.

PrivateEndpoint

Die private Endpunktressource des Microsoft.Network-Anbieters.

Name Typ Beschreibung
id

string

Die Ressourcen-ID der privaten Endpunktressource des Microsoft.Network-Anbieters.

PrivateEndpointConnection

Beschreibt eine vorhandene private Endpunktverbindung mit dem Azure KI-Suchdienst.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Der Name der Ressource
properties

PrivateEndpointConnectionProperties

Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Azure KI-Suchdienst.
type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Suchdienst.

Name Typ Beschreibung
groupId

string

Die Gruppen-ID der Azure-Ressource, für die der Private Link-Dienst verwendet wird.
privateEndpoint

PrivateEndpoint

Die private Endpunktressource des Microsoft.Network-Anbieters.
privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Beschreibt den aktuellen Zustand einer vorhandenen Azure Private Link Dienstverbindung mit dem privaten Endpunkt.
provisioningState

PrivateLinkServiceConnectionProvisioningState

Der Bereitstellungsstatus der Private Link-Dienstverbindung. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich, Unvollständig oder Abgebrochen.

PrivateLinkServiceConnectionProvisioningState

Der Bereitstellungsstatus der Private Link-Dienstverbindung. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich, Unvollständig oder Abgebrochen.

Name Typ Beschreibung
Canceled

string

Die Bereitstellungsanforderung für die Private Link-Dienstverbindungsressource wurde abgebrochen.
Deleting

string

Die Private Link-Dienstverbindung wird gerade gelöscht.
Failed

string

Die Private Link-Dienstverbindung konnte nicht bereitgestellt oder gelöscht werden.
Incomplete

string

Die Bereitstellungsanforderung für die Private Link-Dienstverbindungsressource wurde akzeptiert, aber der Erstellungsprozess wurde noch nicht begonnen.
Succeeded

string

Die Private Link-Dienstverbindung wurde bereitgestellt und kann genehmigt werden.
Updating

string

Die Private Link-Dienstverbindung wird gerade zusammen mit anderen Ressourcen erstellt, damit sie voll funktionsfähig ist.

PrivateLinkServiceConnectionState

Beschreibt den aktuellen Zustand einer vorhandenen Azure Private Link Dienstverbindung mit dem privaten Endpunkt.

Name Typ Standardwert Beschreibung
actionsRequired

string

None

Eine Beschreibung aller zusätzlichen Aktionen, die möglicherweise erforderlich sind.
description

string

Die Beschreibung für den Verbindungsstatus des Private Link-Diensts.
status

PrivateLinkServiceConnectionStatus

Status der Private Link-Dienstverbindung. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.

PrivateLinkServiceConnectionStatus

Status der Private Link-Dienstverbindung. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.

Name Typ Beschreibung
Approved

string

Die Verbindung mit dem privaten Endpunkt ist genehmigt und kann verwendet werden.
Disconnected

string

Die Verbindung mit dem privaten Endpunkt wurde aus dem Dienst entfernt.
Pending

string

Die Verbindung mit dem privaten Endpunkt wurde erstellt und steht noch aus.
Rejected

string

Die Verbindung mit dem privaten Endpunkt wurde abgelehnt und kann nicht verwendet werden.

ProvisioningState

Der Status des letzten Bereitstellungsvorgangs, der für den Suchdienst ausgeführt wurde. Die Bereitstellung ist ein vorübergehender Zustand während der Einrichtung der Dienstkapazität. Nachdem die Kapazität eingerichtet wurde, ändert sich provisioningState entweder in "succeeded" oder "failed". Clientanwendungen können die Bereitstellung status abfragen (das empfohlene Abrufintervall liegt zwischen 30 Sekunden und einer Minute), indem sie den Vorgang Suchdienst abrufen verwenden, um zu sehen, wann ein Vorgang abgeschlossen ist. Wenn Sie den kostenlosen Dienst verwenden, wird dieser Wert in der Regel direkt im Aufruf des Suchdiensts erstellen als "erfolgreich" zurückgegeben. Grund hierfür ist, dass der kostenlose Dienst bereits eingerichtete Kapazitäten verwendet.

Name Typ Beschreibung
failed

string

Der letzte Bereitstellungsvorgang ist fehlgeschlagen.
provisioning

string

Der Suchdienst wird bereitgestellt oder hoch- oder herunterskaliert.
succeeded

string

Der letzte Bereitstellungsvorgang wurde erfolgreich abgeschlossen.

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.

Name Typ Beschreibung
disabled

string

Auf den Suchdienst kann nicht über Datenverkehr aus dem öffentlichen Internet zugegriffen werden. Der Zugriff ist nur über genehmigte private Endpunktverbindungen zulässig.
enabled

string

Auf den Suchdienst kann über Datenverkehr aus dem öffentlichen Internet zugegriffen werden.

SearchBypass

Mögliche Ursprünge des eingehenden Datenverkehrs, der die im Abschnitt "ipRules" definierten Regeln umgehen kann.

Name Typ Beschreibung
AzurePortal

string

Gibt an, dass Anforderungen aus dem Azure-Portal die im Abschnitt "ipRules" definierten Regeln umgehen können.
None

string

Gibt an, dass kein Ursprung die im Abschnitt "ipRules" definierten Regeln umgehen kann. Dies ist die Standardoption.

SearchDisabledDataExfiltrationOption

Eine Liste von Datenexfiltrationsszenarien, die für den Suchdienst explizit nicht zulässig sind. Derzeit wird nur der Wert "All" unterstützt, um alle möglichen Datenexportszenarien zu deaktivieren, wobei für die Zukunft differenziertere Kontrollen geplant sind.

Name Typ Beschreibung
All

string

Gibt an, dass alle Datenexfiltrationsszenarien deaktiviert sind.

SearchEncryptionComplianceStatus

Gibt den status der Suchdienstkonformität in Bezug auf nicht CMK-verschlüsselte Objekte zurück. Wenn ein Dienst über mehrere unverschlüsselte Objekte verfügt und die Erzwingung aktiviert ist, wird der Dienst als nicht konform markiert.

Name Typ Beschreibung
Compliant

string

Gibt an, dass der Suchdienst konform ist, weil die Anzahl der nicht CMK-verschlüsselten Objekte null ist oder die Erzwingung deaktiviert ist.
NonCompliant

string

Gibt an, dass der Suchdienst über mehrere nicht CMK-verschlüsselte Objekte verfügt.

SearchEncryptionWithCmk

Beschreibt, wie ein Suchdienst compliance erzwingen soll, wenn er Objekte findet, die nicht mit dem kundenseitig verwalteten Schlüssel verschlüsselt sind.

Name Typ Beschreibung
Disabled

string

Es wird keine Erzwingung der Verschlüsselung von kundenseitig verwalteten Schlüsseln durchgeführt. Es wird nur die integrierte vom Dienst verwaltete Verschlüsselung verwendet.
Enabled

string

Suchdienst wird als nicht konform markiert, wenn mindestens ein Objekt nicht mit einem kundenseitig verwalteten Schlüssel verschlüsselt wird.
Unspecified

string

Die Erzwingungsrichtlinie wird nicht explizit angegeben, wobei das Verhalten dasselbe ist, als wäre sie auf "Deaktiviert" festgelegt.

SearchSemanticSearch

Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Azure KI Search-SKUs an bestimmten Standorten möglich.

Name Typ Beschreibung
disabled

string

Gibt an, dass der semantische Reranker für den Suchdienst deaktiviert ist. Dies ist die Standardoption.
free

string

Aktiviert semantisches Reranker für einen Suchdienst und gibt an, dass er innerhalb der Grenzen des kostenlosen Plans verwendet werden soll. Der kostenlose Plan würde das Volumen der semantischen Rangfolgeanforderungen begrenzt und wird ohne zusätzliche Kosten angeboten. Dies ist die Standardeinstellung für neu bereitgestellte Suchdienste.
standard

string

Ermöglicht semantisches Reranker für einen Suchdienst als abrechenbares Feature mit höherem Durchsatz und höherem Volumen semantisch neu sortierter Abfragen.

SearchService

Beschreibt eine Azure KI-Suchdienst und ihren aktuellen Zustand.

Name Typ Standardwert Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

Identity

Die Identität der Ressource.
location

string

Der geografische Standort, an dem sich die Ressource befindet
name

string

Der Name der Ressource
properties.authOptions

DataPlaneAuthOptions

Definiert die Optionen, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist.
properties.disableLocalAuth

boolean

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.
properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Eine Liste von Datenexfiltrationsszenarien, die für den Suchdienst explizit nicht zulässig sind. Derzeit wird nur der Wert "All" unterstützt, um alle möglichen Datenexportszenarien zu deaktivieren, wobei für die Zukunft differenziertere Kontrollen geplant sind.
properties.eTag

string

Eine vom System generierte Eigenschaft, die das etag des Diensts darstellt, das für die Steuerung der optimistischen Parallelität während Updates dienen kann.
properties.encryptionWithCmk

EncryptionWithCmk

Gibt jede Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an.
properties.hostingMode

HostingMode

default

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.
properties.networkRuleSet

NetworkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie die Azure KI-Suchdienst erreicht werden kann.
properties.partitionCount

integer

1

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.
properties.privateEndpointConnections

PrivateEndpointConnection[]

Die Liste der privaten Endpunktverbindungen mit dem Azure KI-Suchdienst.
properties.provisioningState

ProvisioningState

Der Status des letzten Bereitstellungsvorgangs, der für den Suchdienst ausgeführt wurde. Die Bereitstellung ist ein vorübergehender Zustand während der Einrichtung der Dienstkapazität. Nachdem die Kapazität eingerichtet wurde, ändert sich provisioningState entweder in "succeeded" oder "failed". Clientanwendungen können die Bereitstellung status abfragen (das empfohlene Abrufintervall liegt zwischen 30 Sekunden und einer Minute), indem sie den Vorgang Suchdienst abrufen verwenden, um zu sehen, wann ein Vorgang abgeschlossen ist. Wenn Sie den kostenlosen Dienst verwenden, wird dieser Wert in der Regel direkt im Aufruf des Suchdiensts erstellen als "erfolgreich" zurückgegeben. Grund hierfür ist, dass der kostenlose Dienst bereits eingerichtete Kapazitäten verwendet.
properties.publicNetworkAccess

PublicNetworkAccess

enabled

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.
properties.replicaCount

integer

1

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.
properties.semanticSearch

SearchSemanticSearch

Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Azure KI Search-SKUs an bestimmten Standorten möglich.
properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Die Liste der freigegebenen Private Link-Ressourcen, die vom Azure KI-Suchdienst verwaltet werden.
properties.status

SearchServiceStatus

Die status des Suchdiensts. Mögliche Werte sind: "running": Der Suchdienst wird ausgeführt, und es werden keine Bereitstellungsvorgänge ausgeführt. "Bereitstellung": Der Suchdienst wird bereitgestellt oder hoch- oder herunterskaliert. "delete": Der Suchdienst wird gelöscht. "heruntergestuft": Der Suchdienst wird heruntergestuft. Dies kann auftreten, wenn die zugrunde liegenden Sucheinheiten nicht fehlerfrei sind. Der Suchdienst ist höchstwahrscheinlich betriebsbereit, aber die Leistung kann langsam sein, und einige Anforderungen werden möglicherweise gelöscht. 'disabled': Der Suchdienst ist deaktiviert. Mit diesem Status lehnt der Dienst alle API-Anforderungen ab. 'error': Der Suchdienst befindet sich in einem Fehlerzustand. "beendet": Der Suchdienst befindet sich in einem abonnement, das deaktiviert ist. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, bedeutet dies, dass das Azure AI Search-Team das zugrunde liegende Problem aktiv untersucht. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar.
properties.statusDetails

string

Die Details des Suchdiensts status.
sku

Sku

Die SKU des Suchdiensts, die preis- und kapazitätslimits bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich.
tags

object

Ressourcentags.
type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SearchServiceStatus

Die status des Suchdiensts. Mögliche Werte sind: "running": Der Suchdienst wird ausgeführt, und es werden keine Bereitstellungsvorgänge ausgeführt. "Bereitstellung": Der Suchdienst wird bereitgestellt oder hoch- oder herunterskaliert. "delete": Der Suchdienst wird gelöscht. "heruntergestuft": Der Suchdienst wird heruntergestuft. Dies kann auftreten, wenn die zugrunde liegenden Sucheinheiten nicht fehlerfrei sind. Der Suchdienst ist höchstwahrscheinlich betriebsbereit, aber die Leistung kann langsam sein, und einige Anforderungen werden möglicherweise gelöscht. 'disabled': Der Suchdienst ist deaktiviert. Mit diesem Status lehnt der Dienst alle API-Anforderungen ab. 'error': Der Suchdienst befindet sich in einem Fehlerzustand. "beendet": Der Suchdienst befindet sich in einem abonnement, das deaktiviert ist. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, bedeutet dies, dass das Azure AI Search-Team das zugrunde liegende Problem aktiv untersucht. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar.

Name Typ Beschreibung
degraded

string

Der Suchdienst wird heruntergestuft, da zugrunde liegende Sucheinheiten nicht fehlerfrei sind.
deleting

string

Der Suchdienst wird gelöscht.
disabled

string

Der Suchdienst ist deaktiviert, und alle API-Anforderungen werden abgelehnt.
error

string

Der Suchdienst befindet sich im Fehlerzustand, der entweder auf einen Fehler bei der Bereitstellung oder auf das Löschen hinweist.
provisioning

string

Der Suchdienst wird bereitgestellt oder hoch- oder herunterskaliert.
running

string

Der Suchdienst wird ausgeführt, und es werden keine Bereitstellungsvorgänge ausgeführt.
stopped

string

Der Suchdienst befindet sich in einem Abonnement, das deaktiviert ist.

SearchServiceUpdate

Die Parameter, die zum Aktualisieren einer Azure KI-Suchdienst verwendet werden.

Name Typ Standardwert Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

Identity

Details zur Identität des Suchdiensts. Ein NULL-Wert gibt an, dass dem Suchdienst keine Identität zugewiesen ist.
location

string

Der geografische Standort der Ressource. Dies muss eine der unterstützten und registrierten Azure-Georegionen sein (z. B. USA, Westen, USA, Osten, Asien, Südosten usw.). Diese Eigenschaft ist beim Erstellen einer neuen Ressource erforderlich.
name

string

Der Name der Ressource
properties.authOptions

DataPlaneAuthOptions

Definiert die Optionen, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist.
properties.disableLocalAuth

boolean

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.
properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Eine Liste von Datenexfiltrationsszenarien, die für den Suchdienst explizit nicht zulässig sind. Derzeit wird nur der Wert "All" unterstützt, um alle möglichen Datenexportszenarien zu deaktivieren, wobei für die Zukunft differenziertere Kontrollen geplant sind.
properties.eTag

string

Eine vom System generierte Eigenschaft, die das etag des Diensts darstellt, das für die Steuerung der optimistischen Parallelität während Updates dienen kann.
properties.encryptionWithCmk

EncryptionWithCmk

Gibt jede Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an.
properties.hostingMode

HostingMode

default

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.
properties.networkRuleSet

NetworkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie die Azure KI-Suchdienst erreicht werden kann.
properties.partitionCount

integer

1

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.
properties.privateEndpointConnections

PrivateEndpointConnection[]

Die Liste der privaten Endpunktverbindungen mit dem Azure KI-Suchdienst.
properties.provisioningState

ProvisioningState

Der Status des letzten Bereitstellungsvorgangs, der für den Suchdienst ausgeführt wurde. Die Bereitstellung ist ein vorübergehender Zustand während der Einrichtung der Dienstkapazität. Nachdem die Kapazität eingerichtet wurde, ändert sich provisioningState entweder in "succeeded" oder "failed". Clientanwendungen können die Bereitstellung status abfragen (das empfohlene Abrufintervall liegt zwischen 30 Sekunden und einer Minute), indem sie den Vorgang Suchdienst abrufen verwenden, um zu sehen, wann ein Vorgang abgeschlossen ist. Wenn Sie den kostenlosen Dienst verwenden, wird dieser Wert in der Regel direkt im Aufruf des Suchdiensts erstellen als "erfolgreich" zurückgegeben. Grund hierfür ist, dass der kostenlose Dienst bereits eingerichtete Kapazitäten verwendet.
properties.publicNetworkAccess

PublicNetworkAccess

enabled

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.
properties.replicaCount

integer

1

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.
properties.semanticSearch

SearchSemanticSearch

Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Azure KI Search-SKUs an bestimmten Standorten möglich.
properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Die Liste der freigegebenen Private Link-Ressourcen, die vom Azure KI-Suchdienst verwaltet werden.
properties.status

SearchServiceStatus

Die status des Suchdiensts. Mögliche Werte sind: "running": Der Suchdienst wird ausgeführt, und es werden keine Bereitstellungsvorgänge ausgeführt. "Bereitstellung": Der Suchdienst wird bereitgestellt oder hoch- oder herunterskaliert. "delete": Der Suchdienst wird gelöscht. "heruntergestuft": Der Suchdienst wird heruntergestuft. Dies kann auftreten, wenn die zugrunde liegenden Sucheinheiten nicht fehlerfrei sind. Der Suchdienst ist höchstwahrscheinlich betriebsbereit, aber die Leistung kann langsam sein, und einige Anforderungen werden möglicherweise gelöscht. 'disabled': Der Suchdienst ist deaktiviert. Mit diesem Status lehnt der Dienst alle API-Anforderungen ab. 'error': Der Suchdienst befindet sich in einem Fehlerzustand. "beendet": Der Suchdienst befindet sich in einem abonnement, das deaktiviert ist. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, bedeutet dies, dass das Azure AI Search-Team das zugrunde liegende Problem aktiv untersucht. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar.
properties.statusDetails

string

Die Details des Suchdiensts status.
sku

Sku

Die SKU des Suchdiensts, die preis- und kapazitätslimits bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich.
tags

object

Tags zum Kategorisieren der Ressource im Azure-Portal.
type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResource

Beschreibt eine freigegebene Private Link-Ressource, die vom Azure KI-Suchdienst verwaltet wird.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Der Name der Ressource
properties

SharedPrivateLinkResourceProperties

Beschreibt die Eigenschaften einer freigegebenen Private Link-Ressource, die vom Azure KI-Suchdienst verwaltet wird.
type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Beschreibt die Eigenschaften einer vorhandenen freigegebenen Private Link-Ressource, die vom Azure KI-Suchdienst verwaltet wird.

Name Typ Beschreibung
groupId

string

Die Gruppen-ID des Ressourcenanbieters, für den die freigegebene Private Link-Ressource verwendet wird.
privateLinkResourceId

string

Die Ressourcen-ID der Ressource, für die die freigegebene Private Link-Ressource verwendet wird.
provisioningState

SharedPrivateLinkResourceProvisioningState

Der Bereitstellungsstatus der freigegebenen Private Link-Ressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.
requestMessage

string

Die Meldung zum Anfordern der Genehmigung der freigegebenen Private Link-Ressource.
resourceRegion

string

Optional. Kann verwendet werden, um den Azure Resource Manager Speicherort der Ressource anzugeben, für die eine freigegebene private Verknüpfung erstellt wird. Dies ist nur für Ressourcen erforderlich, deren DNS-Konfiguration regional ist (z. B. Azure Kubernetes Service).
status

SharedPrivateLinkResourceStatus

Status der freigegebenen Private Link-Ressource. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.

SharedPrivateLinkResourceProvisioningState

Der Bereitstellungsstatus der freigegebenen Private Link-Ressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.

Name Typ Beschreibung
Deleting

string

Die freigegebene Private Link-Ressource wird gerade gelöscht.
Failed

string

Die freigegebene Private Link-Ressource konnte nicht bereitgestellt oder gelöscht werden.
Incomplete

string

Die Bereitstellungsanforderung für die freigegebene Private Link-Ressource wurde akzeptiert, aber der Erstellungsprozess wurde noch nicht begonnen.
Succeeded

string

Die freigegebene Private Link-Ressource wurde bereitgestellt und kann genehmigt werden.
Updating

string

Die freigegebene Private Link-Ressource wird gerade zusammen mit anderen Ressourcen erstellt, damit sie voll funktionsfähig ist.

SharedPrivateLinkResourceStatus

Status der freigegebenen Private Link-Ressource. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.

Name Typ Beschreibung
Approved

string

Die freigegebene Private Link-Ressource ist genehmigt und kann verwendet werden.
Disconnected

string

Die freigegebene Private Link-Ressource wurde aus dem Dienst entfernt.
Pending

string

Die freigegebene Private Link-Ressource wurde erstellt und steht noch aus.
Rejected

string

Die freigegebene Private Link-Ressource wurde abgelehnt und kann nicht verwendet werden.

Sku

Definiert die SKU eines Suchdiensts, die Die Abrechnungsrate und Kapazitätsgrenzen bestimmt.

Name Typ Beschreibung
name

SkuName

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."

SkuName

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."

Name Typ Beschreibung
basic

string

Abrechenbarer Tarif für einen dedizierten Dienst mit bis zu 3 Replikaten.
free

string

Free-Tarif, ohne SLA-Garantien und eine Teilmenge der Features, die auf abrechenbaren Tarifen angeboten werden.
standard

string

Abrechenbarer Tarif für einen dedizierten Dienst mit bis zu 12 Partitionen und 12 Replikaten.
standard2

string

Ähnlich wie "Standard", aber mit mehr Kapazität pro Sucheinheit.
standard3

string

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

string

Abrechenbarer Tarif für einen dedizierten Dienst, der 1 TB pro Partition unterstützt, bis zu 12 Partitionen.
storage_optimized_l2

string

Abrechenbarer Tarif für einen dedizierten Dienst, der 2 TB pro Partition unterstützt, bis zu 12 Partitionen.

UserAssignedManagedIdentity

Die Details der vom Benutzer zugewiesenen verwalteten Identität, die dem Suchdienst zugewiesen ist.

Name Typ Beschreibung
clientId

string

Die Client-ID der vom Benutzer zugewiesenen Identität.
principalId

string

Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.