Freigeben über

Erstellen oder Aktualisieren der Datenquelle (Vorschau-REST-API)

  • Artikel

gilt für: 2023-07-01-Preview. Diese Version wird nicht mehr unterstützt. Upgrade sofort auf eine neuere Version.

Wichtig

2023-07-01-Preview (keine Änderungen).

2021-04-30-Preview fügt verwaltete Identitätsunterstützung für Indexerverbindungen zu anderen Azure-Ressourcen hinzu:

  • "Anmeldeinformationen" akzeptiert eine Azure-Ressourcen-ID als Wert, vorausgesetzt, der Suchdienst wird unter einer verwalteten Identität ausgeführt, und Azure-Rollenzuweisungen gewähren Lesezugriff auf Daten.
  • "Identität" akzeptiert eine vom Benutzer zugewiesene verwaltete Identität. Diese Eigenschaft ist die erste Ebene für Datenverbindungen. Sie befindet sich auch unter "encryptionKey"- zum Abrufen eines vom Kunden verwalteten Schlüssels in Azure Key Vault.
  • Unterstützung von Azure Files ist in der Vorschau. Verwenden Sie eine Vorschau-API zum Indizieren aus dieser Datenquelle.

2020-06-30-Preview fügt Folgendes hinzu:

  • "dataDeletionDetectionPolicy" akzeptiert "NativeBlobSoftDeleteDeletionDetectionPolicy" für BLOB-Indexer.
  • Azure-Datenbank für MySQL-Unterstützung in der Vorschau. Verwenden Sie eine Vorschau-API zum Indizieren aus dieser Datenquelle.
  • Cosmos DB MongoDB-API und Gremlin-API Unterstützung in der Vorschau. Verwenden Sie eine Vorschau-API zum Indizieren aus dieser Datenquelle.

In Azure AI Search wird eine Datenquelle mit Indexernverwendet und stellt die Verbindungsinformationen für bedarfs- oder geplante Datenaktualisierung eines Zielindex bereit, wobei Daten aus unterstützten Datenquellenabgerufen werden.

Sie können ENTWEDER POST oder PUT für eine Erstellungsanforderung verwenden. Der Anforderungstext stellt entweder die Objektdefinition bereit.

POST https://[service name].search.windows.net/datasources?api-version=[api-version]  
    Content-Type: application/json  
    api-key: [admin key]

Verwenden Sie für Updateanforderungen PUT, und geben Sie den Indexernamen für den URI an.

PUT https://[service name].search.windows.net/datasources/[data source name]?api-version=[api-version]
    Content-Type: application/json  
    api-key: [admin key]

HTTPS ist für alle Serviceanfragen erforderlich. Wenn das Objekt nicht vorhanden ist, wird es erstellt. Wenn sie bereits vorhanden ist, wird sie mit der neuen Definition überschrieben.

Anmerkung

Sobald eine Datenquelle vorhanden ist, können Sie die Typeigenschaft für eine Aktualisierungsanforderung nicht mehr ändern. Stattdessen sollten Sie eine neue Datenquelle mit dem gewünschten Typ erstellen.

URI-Parameter

Parameter Beschreibung
Dienstname Erforderlich. Legen Sie dies auf den eindeutigen, benutzerdefinierten Namen Ihres Suchdiensts fest.
Name der Datenquelle Erforderlich für den URI, wenn PUT verwendet wird. Der Name muss klein geschrieben sein, beginnt mit einem Buchstaben oder einer Zahl, hat keine Schrägstriche oder Punkte und darf maximal 128 Zeichen lang sein. Nachdem Sie den Namen mit einem Buchstaben oder einer Zahl begonnen haben, kann der Rest des Namens beliebige Buchstaben, Zahlen und Gedankenstriche enthalten, solange die Striche nicht aufeinander folgen.
API-Version Erforderlich. Weitere Versionen finden Sie unter API-Versionen.

Anforderungsheader

In der folgenden Tabelle werden die erforderlichen und optionalen Anforderungsheader beschrieben.

Felder Beschreibung
Inhaltstyp Erforderlich. Legen Sie dies auf application/json fest.
API-Schlüssel Optional, wenn Sie Azure-Rollen verwenden und ein Bearertoken für die Anforderung bereitgestellt wird, andernfalls ist ein Schlüssel erforderlich. Ein API-Schlüssel ist eine eindeutige vom System generierte Zeichenfolge, die die Anforderung an Ihren Suchdienst authentifiziert. Create requests must include an api-key header set to your admin key (as as to a query key). Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Azure AI Search mithilfe der Schlüsselauthentifizierung.

Anforderungstext

Der Textkörper der Anforderung enthält eine Datenquellendefinition, die den Typ der Datenquelle, Anmeldeinformationen zum Lesen der Daten sowie eine optionale Erkennungs- und Datenlöscherkennungsrichtlinien enthält, die verwendet werden, um geänderte oder gelöschte Daten in der Datenquelle effizient zu identifizieren, wenn sie mit einem regelmäßig geplanten Indexer verwendet werden.

Der folgende JSON-Code ist eine allgemeine Darstellung der Hauptteile der Definition.

{   
    "name" : (optional on PUT; required on POST) "Name of the data source",  
    "description" : (optional) "Anything you want, or nothing at all",  
    "type" : (required) "Must be a supported data source",
    "credentials" : (required) { "connectionString" : "Connection string for your data source" },  
    "container" : (required) { "name" : "Name of the table, collection, or blob container you wish to index" },  
    "dataChangeDetectionPolicy" : (optional) {See below for details },
    "dataDeletionDetectionPolicy" : (optional) {See below for details },
    "identity": (optional) {Sets the Resource ID of a managed identity. See below for details },
    "encryptionKey":(optional) { 
      "keyVaultKeyName": "Name of the Azure Key Vault key used for encryption",
      "keyVaultKeyVersion": "Version of the Azure Key Vault key",
      "keyVaultUri": "URI of Azure Key Vault, also referred to as DNS name, that provides the key.",
      "identity": "(Resource ID of a user-assigned managed identity, used for connecting to key vault)",
      "accessCredentials": (Credentials for connecting to key vault. Omit if using a managed identity) {
        "applicationId": "Azure AD Application ID that has access permissions to the key vault",
        "applicationSecret": "Authentication key of the specified Azure AD application)"}
      }
}

Die Anforderung enthält die folgenden Eigenschaften:

Eigentum Beschreibung
Name Erforderlich. Der Name der Datenquelle. Ein Datenquellenname darf nur Kleinbuchstaben, Ziffern oder Gedankenstriche enthalten, darf nicht mit Bindestrichen beginnen oder enden und ist auf 128 Zeichen beschränkt.
Beschreibung Eine optionale Beschreibung.
Art Erforderlich. Muss einer der unterstützten Datenquellentypen sein:

adlsgen2 für Azure Data Lake Storage Gen2
azureblob für Azure Blob Storage
azurefiles für Azure File Storage
azuresql für Azure SQL-Datenbank
azuretable für Azure Table Storage
cosmosdb für die Azure Cosmos DB SQL-API-, MongoDB-API, Gremlin-API-
mysql für Azure-Datenbank für MySQL
Anmeldeinformationen Erforderlich. Enthält eine connectionString -Eigenschaft, die angibt, wie eine Verbindung hergestellt werden soll.
Container Erforderlich. Gibt den Container, die Auflistung, die Tabelle oder die Ansicht an, die die zu indizierten Daten enthält.
dataChangeDetectionPolicy- Wahlfrei. Gibt den Mechanismus an, der von der Datenplattform zum Identifizieren geänderter Datenelemente bereitgestellt wird.
dataDeletionDetectionPolicy Wahlfrei. Gibt an, wie die Datenplattform Daten löscht.
encryptionKey- Wahlfrei. Wird für die zusätzliche Verschlüsselung von Datenquellenanmeldeinformationen über vom Kunden verwaltete Verschlüsselungsschlüssel (CMK) in Azure Key Vault verwendet. Verfügbar für abrechnende Suchdienste, die am oder nach 2019-01-01 erstellt wurden.
arbeitsunfähig Wahlfrei. Boolescher Wert, der angibt, ob der Indexer in einem deaktivierten Zustand erstellt wird, wodurch die Ausführung nicht sofort verhindert wird. False standardmäßig.
Identität Wahlfrei. Sie enthält einen userAssignedIdentity vom Typ #Microsoft.Azure.Search.DataUserAssignedIdentity und gibt die vom Benutzer zugewiesenen verwalteten Identität der externen Ressource an. Diese Eigenschaft hängt davon ab, credentials die Verbindungszeichenfolge im richtigen Format (eine Ressourcen-ID) für verwaltete Identitätsverbindungen für jeden Datenquellentyp aufweist.

Wenn die identity-Eigenschaft NULL ist, wird die Verbindung mit einer Ressourcen-ID mithilfe der vom System verwalteten Eigenschaft hergestellt.

Wenn diese Eigenschaft dem Typ #Microsoft.Azure.Search.DataNoneIdentityzugewiesen ist, wird jede explizite Identität, die zuvor angegeben wurde, gelöscht.

Antwort

Für eine erfolgreiche Anforderung: 201 Erstellt, wenn eine neue Datenquelle erstellt wurde, und 204 Kein Inhalt, wenn eine vorhandene Datenquelle aktualisiert wurde.

Beispiele

Beispiel: Azure-Rollen und eine vom System zugewiesene verwaltete Identität

Wenn Ihr Suchdienst über eine vom System zugewiesene verwaltete Identität und eine Rollenzuweisung verfügt, kann die Datenquellenverbindung die eindeutige Ressourcen-ID Ihres Speicherkontos sein.

{
    "name": "azure-blob-ds",
    "description": "a description of the blob data",
    "type": "azureblob",
    "subtype": null,
    "credentials": {
      "connectionString": "ResourceId=/subscriptions/[subscription ID]/resourceGroups/[resource group name]/providers/Microsoft.Storage/storageAccounts/[storage account name]/;"
    },
    "container": {
      "name": "mycontainer"
    },
    "dataChangeDetectionPolicy": null,
    "dataDeletionDetectionPolicy": null,
  }

Beispiel: Azure-Rollen und eine vom Benutzer zugewiesene verwaltete Identität (Vorschau)

In diesem Beispiel wird eine azure AD-authentifizierte Verbindung für einen Suchdienst veranschaulicht, der über eine vom Benutzer zugewiesene verwaltete Identität verfügt.

{
    "name": "azure-blob-ds",
    "description": "a description of the blob data",
    "type": "azureblob",
    "subtype": null,
    "credentials": {
      "connectionString": "ResourceId=/subscriptions/[subscription ID]/resourceGroups/[resource group name]/providers/Microsoft.Storage/storageAccounts/[storage account name]/;"
    },
    "container": {
      "name": "mycontainer"
    },
    "dataChangeDetectionPolicy": null,
    "dataDeletionDetectionPolicy": null,
    "identity": {
      "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
      "userAssignedIdentity": "/subscriptions/[subscription ID]/resourceGroups/[resource group name]/providers/Microsoft.ManagedIdentity/userAssignedIdentities/[user identity name]"
    }
  }

Beispiel: Azure SQL mit Änderungserkennung (High Watermark Change Detection Policy)

{   
    "name" : "asqldatasource",  
    "description" : "a description",  
    "type" : "azuresql",  
    "credentials" : { "connectionString" : "Server=tcp:....database.windows.net,1433;Database=...;User ID=...;Password=...;Trusted_Connection=False;Encrypt=True;Connection Timeout=30;" },  
    "container" : { "name" : "sometable" },  
    "dataChangeDetectionPolicy" : { "@odata.type" : "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", "highWaterMarkColumnName" : "RowVersion" }
}

Beispiel: Azure SQL mit Änderungserkennung (SQL Integrated Change Tracking Policy)

{   
    "name" : "asqldatasource",  
    "description" : "a description",  
    "type" : "azuresql",  
    "credentials" : { "connectionString" : "Server=tcp:....database.windows.net,1433;Database=...;User ID=...;Password=...;Trusted_Connection=False;Encrypt=True;Connection Timeout=30;" },  
    "container" : { "name" : "sometable" },  
    "dataChangeDetectionPolicy" : { "@odata.type" : "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy" }
}

Beispiel: Azure SQL mit Änderungserkennung mit Löscherkennung

Erinnern Sie sich daran, dass die Eigenschaften für die Löscherkennung "softDeleteColumnName" und "softDeleteMarkerValue" sind.

{   
    "name" : "asqldatasource",  
    "description" : "a description",  
    "type" : "azuresql",  
    "credentials" : { "connectionString" : "Server=tcp:....database.windows.net,1433;Database=...;User ID=...;Password=...;Trusted_Connection=False;Encrypt=True;Connection Timeout=30;" },  
    "container" : { "name" : "sometable" },   
    "dataDeletionDetectionPolicy" : { "@odata.type" : "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", "softDeleteColumnName" : "IsDeleted", "softDeleteMarkerValue" : "true" }  
}

Beispiel: Datenquelle mit erforderlichen Eigenschaften nur

Optionale Eigenschaften im Zusammenhang mit der Änderungs- und Löscherkennung können weggelassen werden, wenn Sie die Datenquelle nur für einmalige Kopie der Daten verwenden möchten:

{   
    "name" : "asqldatasource",  
    "description" : "anything you want, or nothing at all",  
    "type" : "azuresql",  
    "credentials" : { "connectionString" : "Server=tcp:....database.windows.net,1433;Database=...;User ID=...;Password=...;Trusted_Connection=False;Encrypt=True;Connection Timeout=30;" },  
    "container" : { "name" : "sometable" }  
}

Beispiel: Verwenden der unveränderten oder rotierten Anmeldeinformationsoption

Wenn Sie die Datenquelle aktualisieren möchten, sind die Anmeldeinformationen nicht erforderlich. Die Werte <unchanged> oder <redacted> können anstelle der Verbindungszeichenfolge verwendet werden.

{
    "name" : "adatasource",
    "description": "a description",
    "type": "azuresql",
    "credentials": { "connectionString": "<unchanged>" },
    "container" : { "name": "sometable" }
}

Beispiel: Verschlüsselungsschlüssel

Verschlüsselungsschlüssel sind vom Kunden verwaltete Schlüssel, die für zusätzliche Verschlüsselung verwendet werden. Weitere Informationen finden Sie unter Verschlüsselung mithilfe von vom Kunden verwalteten Schlüsseln in Azure Key Vault.

{
    "name" : "adatasource",
    "description": "a description",
    "type": "azuresql",
    "credentials": { "connectionString": "<unchanged>" },
    "container" : { "name": "sometable" },
    "encryptionKey": (optional) { 
      "keyVaultKeyName": "Name of the Azure Key Vault key used for encryption",
      "keyVaultKeyVersion": "Version of the Azure Key Vault key",
      "keyVaultUri": "URI of Azure Key Vault, also referred to as DNS name, that provides the key. An example URI might be https://my-keyvault-name.vault.azure.net",
      "accessCredentials": (optional, only if not using managed identity) {
        "applicationId": "Azure Active Directory Application ID that was granted access permissions to your specified Azure Key Vault",
        "applicationSecret": "Authentication key of the specified Azure AD application)"}
      }
}

Beispiel: Verschlüsselungsschlüsseltresorverbindungen durch Suchdienste mit einer vom Benutzer zugewiesenen verwalteten Identität

In diesem Beispiel wird accessCredentials weggelassen. Für eine Ressource, der eine vom Benutzer zugewiesene verwaltete Identität zugewiesen ist, können Sie die Identität in encryptionKey angeben und den Schlüssel mithilfe dieser Identitäts- und Azure-Rollenzuweisungen abrufen.

{
    "name" : "adatasource",
    "description": "a description",
    "type": "azuresql",
    "credentials": { "connectionString": "<unchanged>" },
    "container" : { "name": "sometable" },
    "encryptionKey": (optional) { 
      "keyVaultKeyName": "Name of the Azure Key Vault key used for encryption",
      "keyVaultKeyVersion": "Version of the Azure Key Vault key",
      "keyVaultUri": "URI of Azure Key Vault, also referred to as DNS name, that provides the key. An example URI might be https://my-keyvault-name.vault.azure.net",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity"
        }
    }
}

Definitionen

Verbinden Beschreibung
Container- Gibt den Container, die Auflistung, die Tabelle oder die Ansicht an, die die zu indizierten Daten enthält.
Anmeldeinformationen Enthält eine connectionString -Eigenschaft, die angibt, wie ein Indexer eine Verbindung mit einer Azure-Ressource herstellt.
dataChangeDetectionPolicy- Gibt den Mechanismus an, der von der Datenplattform zum Identifizieren geänderter Daten bereitgestellt wird.
dataDeletionDetectionPolicy Gibt den Mechanismus zum Erkennen gelöschter Daten an.
encryptionKey- Konfiguriert eine Verbindung mit Azure Key Vault für die vom Kunden verwaltete Verschlüsselung.

Container

Gibt den Container, die Auflistung, die Tabelle oder die Ansicht an, die die zu indizierten Daten enthält.

Attribut Beschreibung
Name Erforderlich. Gibt für Azure Cosmos DB die SQL-API-Auflistung an. Gibt für Azure Blob Storage den Speichercontainer an. Gibt für Azure SQL die Tabelle oder Ansicht an. Sie können schemaqualifizierte Namen wie [dbo].[mytable]verwenden. Gibt für Azure Table Storage den Namen der Tabelle an.
Frage Wahlfrei. Bei Azure Cosmos DB können Sie eine Abfrage angeben, die ein beliebiges JSON-Dokumentlayout in ein flaches Schema abschrägt, das Azure AI Search indizieren kann. Bei Azure Blob Storage können Sie einen virtuellen Ordner innerhalb des Blobcontainers angeben. Beispielsweise kann documents für blobpfad mycontainer/documents/blob.pdfals virtueller Ordner verwendet werden. Bei Azure Table Storage können Sie eine Abfrage angeben, die den zu importierenden Zeilensatz filtert. Für Azure SQL wird die Abfrage nicht unterstützt (verwenden Sie stattdessen Ansichten).

Beglaubigungsschreiben

Enthält eine "connectionString"-Eigenschaft, die angibt, wie ein Indexer eine Verbindung mit einer Azure-Ressource herstellt.

Attribut Beschreibung
connectionString Erforderlich. Gibt eine Verbindung mit einer Indexerdatenquelle an. Wenn Sie die Datenquellendefinition aktualisieren, ist die Verbindungszeichenfolge nicht erforderlich. Die Werte <unchanged> oder <redacted> können anstelle der tatsächlichen Verbindungszeichenfolge verwendet werden.

Bei Verbindungen, die mithilfe von Schlüsseln oder Anmeldeinformationen authentifiziert werden, sind diese Werte in der Verbindungszeichenfolge sichtbar. Das Format der Verbindungszeichenfolge hängt vom Datenquellentyp ab:

Für Azure SQL-Datenbank ist dies die übliche SQL Server-Verbindungszeichenfolge. Wenn Sie das Azure-Portal zum Abrufen der Verbindungszeichenfolge verwenden, wählen Sie die Option ADO.NET connection string aus.

Für Azure Cosmos DB muss die Verbindungszeichenfolge im folgenden Format vorliegen: "AccountEndpoint=https://[your account name].documents.azure.com;AccountKey=[your account key];Database=[your database id]". Alle Werte sind erforderlich. Sie finden sie im Azure-Portal.

Wenn Sie eine verwaltete Identität zum Authentifizieren vonverwenden, können Sie Anmeldeinformationen für die Verbindung weglassen.

Für Verbindungen, die mithilfe einer verwalteten Identität authentifiziert werden, gibt die Verbindungszeichenfolge die Azure-Ressourcen-ID an (siehe diese Links für das Verbindungszeichenfolgenformat: Azure Storage, Cosmos DB,SQL-Datenbank).

Rollenzuweisungen, die auf die externe Datenquelle ausgelegt sind, bestimmen, ob der Indexer eine Verbindung herstellen kann, und der Suchdienst muss so konfiguriert werden, dass er als vertrauenswürdiger Dienst in Azure Active Directory ausgeführt wird.

Wenn die Eigenschaft "Identity" ebenfalls angegeben wird, wird die Verbindung mithilfe der vom Suchdienst zugewiesenen verwalteten Identität hergestellt, die von der Eigenschaft "Identity" bereitgestellt wird. Andernfalls erfolgt die Verbindung über die vom System verwaltete Identität, wenn "Identity" nicht angegeben oder NULL ist.

dataChangeDetectionPolicy

Gibt den Mechanismus an, der von der Datenplattform zum Identifizieren geänderter Daten bereitgestellt wird. Unterstützte Richtlinien variieren je nach Datenquellentyp.

Attribut Beschreibung
dataChangeDetectionPolicy Wahlfrei. Gültige Richtlinien umfassen HighWatermarkChangeDetectionPolicy oder SqlIntegratedChangeDetectionPolicy.

HighWatermarkChangeDetectionPolicy hängt von einer vorhandenen Spalte oder Eigenschaft ab, die zusammen mit anderen Aktualisierungen aktualisiert wird (alle Einfügungen führen zu einer Aktualisierung der Wasserzeichenspalte), und die Änderung des Werts ist höher.

SqlIntegratedChangeDetectionPolicy wird verwendet, um auf die systemeigenen Änderungserkennungsfeatures in SQL Server zu verweisen. Diese Richtlinie kann nur mit Tabellen verwendet werden. sie kann nicht mit Ansichten verwendet werden. Sie müssen die Änderungsnachverfolgung für die tabelle aktivieren, die Sie verwenden, bevor Sie diese Richtlinie verwenden können. Anweisungen finden Sie unter Aktivieren und Deaktivieren der Änderungsnachverfolgung.
highWaterMarkColumnName Erforderlich für HighWatermarkChangeDetectionPolicy. Für Cosmos DB muss die Spalte _ts Eigenschaft sein. Für Azure SQL wird eine indizierte rowversion Spalte empfohlen. Bei Azure Storage ist die Änderungserkennung mithilfe von lastModified-Werten integriert, sodass keine Notwendigkeit besteht, die dataChangeDetectionPolicy festzulegen.

dataDeletionDetectionPolicy

Gibt den Mechanismus an, der von der Datenplattform zum Identifizieren gelöschter Daten bereitgestellt wird. Unterstützte Richtlinien variieren je nach Datenquellentyp.

Attribut Beschreibung
dataDeletionDetectionPolicy Wahlfrei. Gültige Werte sind SoftDeleteColumnDeletionDetectionPolicy oder NativeBlobSoftDeleteDeletionDetectionPolicy (siehe Native Blob Soft Delete (Vorschau)).

Derzeit ist die einzige allgemein verfügbare RichtlinieSoftDeleteColumnDeletionDetectionPolicy, die gelöschte Elemente basierend auf dem Wert einer Spalte oder Eigenschaft für vorläufiges Löschen in der Datenquelle identifiziert.

softDeleteColumnName" Erforderlich. Der Name einer Spalte in Ihrer Datenquelle, die einen Wert angibt, der den Löschstatus einer Zeile angibt. Sie können beispielsweise eine Spalte mit dem Namen "IsDeleted" erstellen. Es werden nur Spalten mit Zeichenfolgen-, Ganzzahl- oder booleschen Werten unterstützt.
softDeleteMarkerValue Erforderlich. Der Wert der Spalte für das vorläufige Löschen. Der wert, der als softDeleteMarkerValue verwendet wird, muss eine Zeichenfolge sein, auch wenn die entsprechende Spalte ganze Zahlen oder Booleane enthält. Wenn beispielsweise der Wert, der in Ihrer Datenquelle angezeigt wird, 1 ist, verwenden Sie "1" als softDeleteMarkerValue. Wenn der Indexer diesen Wert aus der Spalte für vorläufiges Löschen liest, wird das entsprechende Suchdokument aus dem Suchindex gelöscht.

encryptionKey

Konfiguriert eine Verbindung mit Azure Key Vault für zusätzliche vom Kunden verwalteten Verschlüsselungsschlüssel (CMK). Verschlüsselung mit vom Kunden verwalteten Schlüsseln ist für kostenlose Dienste nicht verfügbar. Für abrechnende Dienste ist sie nur für Suchdienste verfügbar, die am oder nach 2019-01-01 erstellt wurden.

Eine Verbindung mit dem Schlüsseltresor muss authentifiziert werden. Sie können zu diesem Zweck entweder "accessCredentials" oder eine verwaltete Identität verwenden.

Verwaltete Identitäten können vom System oder vom Benutzer zugewiesen werden (Vorschau). Wenn der Suchdienst sowohl über eine vom System zugewiesene verwaltete Identität als auch eine Rollenzuweisung verfügt, die Lesezugriff auf den Schlüsseltresor gewährt, können Sie sowohl "Identität" als auch "accessCredentials" weglassen, und die Anforderung authentifiziert sich mithilfe der verwalteten Identität. Wenn der Suchdienst über eine vom Benutzer zugewiesene Identität und Rollenzuweisung verfügt, legen Sie die Eigenschaft "Identity" auf die Ressourcen-ID dieser Identität fest.

Attribut Beschreibung
keyVaultKeyName Erforderlich. Name des azure Key Vault-Schlüssels, der für die Verschlüsselung verwendet wird.
keyVaultKeyVersion Erforderlich. Version des Azure Key Vault-Schlüssels.
keyVaultUri Erforderlich. URI von Azure Key Vault (auch als DNS-Name bezeichnet), der den Schlüssel bereitstellt. Ein Beispiel-URI kann https://my-keyvault-name.vault.azure.netsein.
accessCredentials Lassen Sie aus, wenn Sie eine verwaltete Identität verwenden. Andernfalls enthalten die Eigenschaften von accessCredentialsapplicationId (eine Azure Active Directory-Anwendungs-ID mit Zugriffsberechtigungen für Ihren angegebenen Azure Key Vault) und applicationSecret (den Authentifizierungsschlüssel der angegebenen Azure AD-Anwendung).
Identität Optional, es sei denn, Sie verwenden eine vom Benutzer zugewiesene verwaltete Identität für die Suchdienstverbindung mit Azure Key Vault. Das Format ist "/subscriptions/[subscription ID]/resourceGroups/[resource group name]/providers/Microsoft.ManagedIdentity/userAssignedIdentities/[managed identity name]".

Siehe auch