Indexers - Reset Docs

Dienst:: Search Service

API-Version:: 2025-11-01-preview

Setzt bestimmte Dokumente in der Datenquelle zurück, die vom Indexer selektiv erneut erfasst werden sollen.

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2025-11-01-preview

Mit optionalen Parametern:

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2025-11-01-preview&overwrite={overwrite}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
indexerName	path	True	string	Der Name des Indexers.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
overwrite	query		boolean	Bei false werden Schlüssel oder IDs an vorhandene Schlüssel angehängt. Wenn true, werden nur die Schlüssel oder IDs in dieser Nutzlast in die Warteschlange eingereiht, um erneut aufgenommen zu werden.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept		Accept	Die Überschrift "Annehmen".
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Anforderungstext

Name	Typ	Beschreibung
datasourceDocumentIds	string[]	DataSource-Dokumentkennungen, die zurückgesetzt werden sollen
documentKeys	string[]	Dokumentschlüssel, die zurückgesetzt werden sollen

Antworten

Name	Typ	Beschreibung
204 No Content		Es gibt keinen Inhalt, der für diese Anforderung gesendet werden soll, aber die Header können nützlich sein.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

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

Bereiche

Name	Beschreibung
https://search.azure.com/.default

Beispiele

SearchServiceResetDocs

Beispielanforderung

HTTP

POST https://previewexampleservice.search.windows.net/indexers('myindexer')/search.resetdocs?api-version=2025-11-01-preview&overwrite=True


{
  "documentKeys": [
    "1",
    "2",
    "3"
  ]
}

Beispiel für eine Antwort

Statuscode:: 204

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
DocumentKeysOrIds	Der Typ der Schlüssel-Orlden.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=minimal

DocumentKeysOrIds

Objekt

Der Typ der Schlüssel-Orlden.

Name	Typ	Beschreibung
datasourceDocumentIds	string[]	DataSource-Dokumentkennungen, die zurückgesetzt werden sollen
documentKeys	string[]	Dokumentschlüssel, die zurückgesetzt werden sollen

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info		Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.