Knowledge Sources - Create Or Update

Dienst:: Search Service

API-Version:: 2026-04-01

Erstellt eine neue Wissensquelle oder aktualisiert eine Wissensquelle, wenn sie bereits vorhanden ist.

PUT {endpoint}/knowledgesources('{sourceName}')?api-version=2026-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
sourceName	path	True	string	Der Name der Wissensquelle.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept		Accept	Die Überschrift "Annehmen".
If-Match		string	Definiert die If-Match Bedingung. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server mit diesem Wert übereinstimmt.
If-None-Match		string	Definiert die Bedingung Wenn-None-Match. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server nicht mit diesem Wert übereinstimmt.
Prefer	True	Prefer	Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Anforderungstext

Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:

Name	Beschreibung
AzureBlobKnowledgeSource	Konfiguration für die Azure Blob Storage-Wissensquelle.
IndexedOneLakeKnowledgeSource	Konfiguration für die OneLake-Wissensquelle.
SearchIndexKnowledgeSource	Wissensquelle, die auf einen Suchindex abzielt.
WebKnowledgeSource	Wissensquelle, die auf Webergebnisse abzielt.

AzureBlobKnowledgeSource

Konfiguration für die Azure Blob Storage-Wissensquelle.

Name	Erforderlich	Typ	Beschreibung
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	Der Typ der Wissensquelle.
kind	True	string: azureBlob	Der Typ der Wissensquelle.
name	True	string	Der Name der Wissensquelle.
@odata.etag		string	Die ETag der Wissensquelle.
description		string	Optionale benutzerdefinierte Beschreibung.
encryptionKey		SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.

IndexedOneLakeKnowledgeSource

Konfiguration für die OneLake-Wissensquelle.

Name	Erforderlich	Typ	Beschreibung
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	Die Parameter für die Wissensquelle.
kind	True	string: indexedOneLake	Der Typ der Wissensquelle.
name	True	string	Der Name der Wissensquelle.
@odata.etag		string	Die ETag der Wissensquelle.
description		string	Optionale benutzerdefinierte Beschreibung.
encryptionKey		SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.

SearchIndexKnowledgeSource

Wissensquelle, die auf einen Suchindex abzielt.

Name	Erforderlich	Typ	Beschreibung
kind	True	string: searchIndex	Der Typ der Wissensquelle.
name	True	string	Der Name der Wissensquelle.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Die Parameter für die Wissensquelle.
@odata.etag		string	Die ETag der Wissensquelle.
description		string	Optionale benutzerdefinierte Beschreibung.
encryptionKey		SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.

WebKnowledgeSource

Wissensquelle, die auf Webergebnisse abzielt.

Name	Erforderlich	Typ	Beschreibung
kind	True	string: web	Der Typ der Wissensquelle.
name	True	string	Der Name der Wissensquelle.
@odata.etag		string	Die ETag der Wissensquelle.
description		string	Optionale benutzerdefinierte Beschreibung.
encryptionKey		SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.
webParameters		WebKnowledgeSourceParameters	Die Parameter für die Web-Wissensquelle.

Antworten

Name	Typ	Beschreibung
200 OK	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	Die Anforderung ist erfolgreich.
201 Created	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.
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

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

SearchServiceCreateOrUpdateKnowledgeSourceWeb

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

Beispielanforderung

HTTP

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01





{
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-example-index",
  "description": "Description of the knowledge source.",
  "kind": "azureBlob",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-example-index-datasource",
      "indexer": "ks-example-index-indexer",
      "skillset": "ks-example-index-skillset",
      "index": "ks-example-index-index"
    }
  }
}

Statuscode:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-example-index-datasource",
      "indexer": "ks-example-index-indexer",
      "skillset": "ks-example-index-skillset",
      "index": "ks-example-index-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

Beispielanforderung

HTTP

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01





{
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-example-index",
  "description": "Description of the OneLake knowledge source.",
  "kind": "indexedOneLake",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

Statuscode:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWeb

Beispielanforderung

HTTP

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01





{
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  },
  "name": "ks-example-index",
  "description": "Description of the knowledge source.",
  "kind": "web",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  }
}

Statuscode:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  }
}

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
AIServices	Parameter für KI-Dienste.
AzureBlobKnowledgeSource	Konfiguration für die Azure Blob Storage-Wissensquelle.
AzureBlobKnowledgeSourceParameters	Parameter für die Azure Blob Storage-Wissensquelle.
AzureOpenAIModelName	Der Name des Azure Open AI-Modells, der aufgerufen wird.
AzureOpenAIVectorizerParameters	Gibt die Parameter für die Verbindung mit der Azure OpenAI-Ressource an.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
IndexedOneLakeKnowledgeSource	Konfiguration für die OneLake-Wissensquelle.
IndexedOneLakeKnowledgeSourceParameters	Parameter für die OneLake-Wissensquelle.
IndexingSchedule	Stellt einen Zeitplan für die Indizierungsausführung dar.
KnowledgeBaseAzureOpenAIModel	Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird.
KnowledgeBaseModelKind	Das KI-Modell, das für die Abfrageplanung verwendet werden soll.
KnowledgeSourceAzureOpenAIVectorizer	Gibt die Azure OpenAI-Ressource an, die zum Vektorisieren einer Abfragezeichenfolge verwendet wird.
KnowledgeSourceIngestionParameters	Konsolidiert alle allgemeinen Erfassungseinstellungen für Wissensquellen.
KnowledgeSourceKind	Die Art der Wissensquelle.
Prefer	Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.
SearchIndexerDataNoneIdentity	Löscht die Identitätseigenschaft einer Datenquelle.
SearchIndexerDataUserAssignedIdentity	Gibt die Identität für eine zu verwendende Datenquelle an.
SearchIndexFieldReference	Feldreferenz für einen Suchindex.
SearchIndexKnowledgeSource	Wissensquelle, die auf einen Suchindex abzielt.
SearchIndexKnowledgeSourceParameters	Parameter für die Wissensquelle für den Suchindex.
SearchResourceEncryptionKey	Ein vom Kunden verwalteter Verschlüsselungsschlüssel im Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.
VectorSearchVectorizerKind	Die Vektorisierungsmethode, die während der Abfragezeit verwendet werden soll.
WebKnowledgeSource	Wissensquelle, die auf Webergebnisse abzielt.
WebKnowledgeSourceDomain	Konfiguration für die Web-Wissensquellendomäne.
WebKnowledgeSourceDomains	Konfiguration der Domäne für Web-Wissensquelle zulassen/blockieren.
WebKnowledgeSourceParameters	Parameter für die Web-Wissensquelle.

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=minimal

AIServices

Objekt

Parameter für KI-Dienste.

Name	Typ	Beschreibung
apiKey	string	Der API-Schlüssel für den Zugriff auf KI-Dienste.
uri	string (uri)	Der URI des AI Services-Endpunkts.

AzureBlobKnowledgeSource

Objekt

Konfiguration für die Azure Blob Storage-Wissensquelle.

Name	Typ	Beschreibung
@odata.etag	string	Die ETag der Wissensquelle.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	Der Typ der Wissensquelle.
description	string	Optionale benutzerdefinierte Beschreibung.
encryptionKey	SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.
kind	string: azureBlob	Der Typ der Wissensquelle.
name	string	Der Name der Wissensquelle.

AzureBlobKnowledgeSourceParameters

Objekt

Parameter für die Azure Blob Storage-Wissensquelle.

Name	Typ	Standardwert	Beschreibung
connectionString	string		Schlüsselbasierte Verbindungszeichenfolge oder das ResourceId-Format, wenn eine verwaltete Identität verwendet wird.
containerName	string		Den Namen des Blobspeichercontainers
createdResources	object		Ressourcen, die von der Wissensquelle erstellt wurden.
folderPath	string		Optionaler Ordnerpfad innerhalb des Containers.
ingestionParameters	KnowledgeSourceIngestionParameters		Konsolidiert alle allgemeinen Erfassungseinstellungen.
isADLSGen2	boolean	False	Legen Sie diesen Wert auf true fest, wenn eine Verbindung mit einem ADLS Gen2-Speicherkonto hergestellt wird. Die Standardeinstellung ist "false".

AzureOpenAIModelName

Enumeration

Der Name des Azure Open AI-Modells, der aufgerufen wird.

Wert	Beschreibung
text-embedding-ada-002	TextEmbeddingAda002 Modell.
text-embedding-3-large	TextEmbedding3Großes Modell.
text-embedding-3-small	TextEmbedding3Kleines Modell.
gpt-5-mini	Gpt5Mini-Modell.
gpt-5-nano	Gpt5Nano-Modell.
gpt-5.4-mini	Gpt54Mini Modell.
gpt-5.4-nano	Gpt54Nano-Modell.

AzureOpenAIVectorizerParameters

Objekt

Gibt die Parameter für die Verbindung mit der Azure OpenAI-Ressource an.

Name	Typ	Beschreibung
apiKey	string	API-Schlüssel der angegebenen Azure OpenAI-Ressource.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Die vom Benutzer zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird.
deploymentId	string	ID der Azure OpenAI-Modellbereitstellung für die angegebene Ressource.
modelName	AzureOpenAIModelName	Der Name des Einbettungsmodells, das im bereitgestellten deploymentId-Pfad bereitgestellt wird.
resourceUri	string (uri)	Der Ressourcen-URI der Azure OpenAI-Ressource.

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

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IndexedOneLakeKnowledgeSource

Objekt

Konfiguration für die OneLake-Wissensquelle.

Name	Typ	Beschreibung
@odata.etag	string	Die ETag der Wissensquelle.
description	string	Optionale benutzerdefinierte Beschreibung.
encryptionKey	SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	Die Parameter für die Wissensquelle.
kind	string: indexedOneLake	Der Typ der Wissensquelle.
name	string	Der Name der Wissensquelle.

IndexedOneLakeKnowledgeSourceParameters

Objekt

Parameter für die OneLake-Wissensquelle.

Name	Typ	Beschreibung
createdResources	object	Ressourcen, die von der Wissensquelle erstellt wurden.
fabricWorkspaceId	string	OneLake-Arbeitsbereichs-ID.
ingestionParameters	KnowledgeSourceIngestionParameters	Konsolidiert alle allgemeinen Erfassungseinstellungen.
lakehouseId	string	Gibt an, auf welches OneLake-Seehaus zugegriffen werden soll.
targetPath	string	Optionaler OneLakehouse-Ordner oder Verknüpfung zum Filtern von OneLake-Inhalten.

IndexingSchedule

Objekt

Stellt einen Zeitplan für die Indizierungsausführung dar.

Name	Typ	Beschreibung
interval	string (duration)	Das Zeitintervall zwischen den Indexerausführungen.
startTime	string (date-time)	Der Zeitpunkt, zu dem die Ausführung eines Indexers gestartet werden soll.

KnowledgeBaseAzureOpenAIModel

Objekt

Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird.

Name	Typ	Beschreibung
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI parameters.
kind	string: azureOpenAI	Das KI-Modell, das für die Abfrageplanung verwendet werden soll.

KnowledgeBaseModelKind

Enumeration

Das KI-Modell, das für die Abfrageplanung verwendet werden soll.

Wert	Beschreibung
azureOpenAI	Verwenden Sie Azure Open AI-Modelle für die Abfrageplanung.

KnowledgeSourceAzureOpenAIVectorizer

Objekt

Gibt die Azure OpenAI-Ressource an, die zum Vektorisieren einer Abfragezeichenfolge verwendet wird.

Name	Typ	Beschreibung
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Enthält die Parameter, die für die Vektorisierung der Azure OpenAI-Einbettung spezifisch sind.
kind	string: azureOpenAI	Der Name der Art von Vektorisierungsmethode, die für die Verwendung mit der Vektorsuche konfiguriert wird.

KnowledgeSourceIngestionParameters

Objekt

Konsolidiert alle allgemeinen Erfassungseinstellungen für Wissensquellen.

Name	Typ	Standardwert	Beschreibung
aiServices	AIServices		Optionale AI Services-Konfiguration für die Inhaltsverarbeitung.
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		Optionales Chat-Vervollständigungsmodell für die Verbalisierung von Bildern oder die Extraktion von Kontexten.
contentExtractionMode	enum: minimal standard	minimal	Optionaler Modus zur Extraktion von Inhalten. Der Standardwert ist 'minimal'.
disableImageVerbalization	boolean	False	Gibt an, ob die Bildverbalisierung deaktiviert werden soll. Die Standardeinstellung ist "false".
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		Optionale Vektorisiererkonfiguration zum Vektorisieren von Inhalten.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Eine explizite Identität, die für diese Wissensquelle verwendet werden soll.
ingestionSchedule	IndexingSchedule		Optionaler Zeitplan für die Datenerfassung.

KnowledgeSourceKind

Enumeration

Die Art der Wissensquelle.

Wert	Beschreibung
searchIndex	Eine Wissensquelle, die Daten aus einem Suchindex liest.
azureBlob	Eine Wissensquelle, die Daten aus Azure Blob Storage liest und in einem Suchindex erfasst.
indexedOneLake	Eine Wissensquelle, die Daten von indexierten OneLake ausliest.
web	Eine Wissensquelle, die Daten aus dem Web liest.

Prefer

Enumeration

Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.

Wert	Beschreibung
return=representation

SearchIndexerDataNoneIdentity

Objekt

Löscht die Identitätseigenschaft einer Datenquelle.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Ein URI-Fragment, das den Typ der Identität angibt.

SearchIndexerDataUserAssignedIdentity

Objekt

Gibt die Identität für eine zu verwendende Datenquelle an.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Ein URI-Fragment, das den Typ der Identität angibt.
userAssignedIdentity	string	Die vollqualifizierte Azure-Ressourcen-ID einer vom Benutzer zugewiesenen verwalteten Identität in der Regel im Format "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", die dem Suchdienst zugewiesen werden sollen.

SearchIndexFieldReference

Objekt

Feldreferenz für einen Suchindex.

Name	Typ	Beschreibung
name	string	Der Name des Felds.

SearchIndexKnowledgeSource

Objekt

Wissensquelle, die auf einen Suchindex abzielt.

Name	Typ	Beschreibung
@odata.etag	string	Die ETag der Wissensquelle.
description	string	Optionale benutzerdefinierte Beschreibung.
encryptionKey	SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.
kind	string: searchIndex	Der Typ der Wissensquelle.
name	string	Der Name der Wissensquelle.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Die Parameter für die Wissensquelle.

SearchIndexKnowledgeSourceParameters

Objekt

Parameter für die Wissensquelle für den Suchindex.

Name	Typ	Beschreibung
searchFields	SearchIndexFieldReference[]	Wird verwendet, um einzuschränken, welche Felder im Suchindex durchsucht werden sollen.
searchIndexName	string	Der Name des Suchindexes.
semanticConfigurationName	string	Wird verwendet, um eine andere semantische Konfiguration für den Zielsuchindex als die Standardkonfiguration anzugeben.
sourceDataFields	SearchIndexFieldReference[]	Wird verwendet, um zusätzliche Felder für referenzierte Quelldaten anzufordern.

SearchResourceEncryptionKey

Objekt

Ein vom Kunden verwalteter Verschlüsselungsschlüssel im Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.

Name	Typ	Beschreibung
accessCredentials.applicationId	string	Eine AAD-Anwendungs-ID, die die erforderlichen Zugriffsberechtigungen für den Azure Key Vault erteilt hat, die beim Verschlüsseln Ihrer ruhenden Daten verwendet werden sollen. Die Anwendungs-ID sollte nicht mit der Objekt-ID für Ihre AAD-Anwendung verwechselt werden.
accessCredentials.applicationSecret	string	Der Authentifizierungsschlüssel der angegebenen AAD-Anwendung.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Eine explizite verwaltete Identität, die für diesen Verschlüsselungsschlüssel verwendet werden soll. Wenn diese Eigenschaft nicht angegeben ist und die Eigenschaft für Zugriffsanmeldeinformationen null ist, wird die vom System zugewiesene verwaltete Identität verwendet. Wenn die explizite Identität nicht angegeben ist, bleibt die Aktualisierung der Ressource unverändert. Wenn "none" angegeben wird, wird der Wert dieser Eigenschaft gelöscht.
keyVaultKeyName	string	Der Name Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll.
keyVaultKeyVersion	string	Die Version Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll.
keyVaultUri	string	Der URI Ihres Azure Key Vault, auch als DNS-Name bezeichnet, der den Schlüssel enthält, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll. Ein Beispiel-URI kann `https://my-keyvault-name.vault.azure.net`sein.

VectorSearchVectorizerKind

Enumeration

Die Vektorisierungsmethode, die während der Abfragezeit verwendet werden soll.

Wert	Beschreibung
azureOpenAI	Generieren Sie Einbettungen mithilfe einer Azure OpenAI-Ressource zur Abfragezeit.
customWebApi	Generieren Sie Einbettungen mithilfe eines benutzerdefinierten Webendpunkts zur Abfragezeit.
aiServicesVision	Generieren Sie Einbettungen für ein Bild oder eine Texteingabe zur Abfragezeit mithilfe der Azure AI Services Vision Vectorize-API.
aml	Generieren Sie Einbettungen mithilfe eines Azure Machine Learning-Endpunkts, der zur Abfragezeit über den Azure AI Foundry -Modellkatalog bereitgestellt wird.

WebKnowledgeSource

Objekt

Wissensquelle, die auf Webergebnisse abzielt.

Name	Typ	Beschreibung
@odata.etag	string	Die ETag der Wissensquelle.
description	string	Optionale benutzerdefinierte Beschreibung.
encryptionKey	SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.
kind	string: web	Der Typ der Wissensquelle.
name	string	Der Name der Wissensquelle.
webParameters	WebKnowledgeSourceParameters	Die Parameter für die Web-Wissensquelle.

WebKnowledgeSourceDomain

Objekt

Konfiguration für die Web-Wissensquellendomäne.

Name	Typ	Beschreibung
address	string	Die Adresse der Domain.
includeSubpages	boolean	Ob Unterseiten aus dieser Domain eingebunden werden sollen oder nicht.

WebKnowledgeSourceDomains

Objekt

Konfiguration der Domäne für Web-Wissensquelle zulassen/blockieren.

Name	Typ	Beschreibung
allowedDomains	WebKnowledgeSourceDomain[]	Domains, die für Webergebnisse erlaubt sind.
blockedDomains	WebKnowledgeSourceDomain[]	Domains, die aus Webergebnissen blockiert sind.

WebKnowledgeSourceParameters

Objekt

Parameter für die Web-Wissensquelle.

Name	Typ	Beschreibung
domains	WebKnowledgeSourceDomains	Konfiguration des Zulassens/Blockierens von Domänen für Webergebnisse.