Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Note
Foundry IQ (Azure KI-Suche) bietet direkte Indizierungs- und Abfrage-APIs zusammen mit Wissensquellen- und Knowledge Base-APIs auf höherer Ebene für den verwalteten Abruf. Verwenden Sie das Azure Portal, REST-APIs oder Azure SDKs, um diese Funktionen zu konfigurieren, oder verbinden Sie Agents mit Wissensdatenbanken im Microsoft Foundry-Portal.
In Foundry IQ (Azure KI-Suche) werden vom Kunden verwaltete Verschlüsselungsschlüssel in Azure Key Vault erstellt, gespeichert und verwaltet. Wenn Sie ermitteln müssen, ob ein Objekt verschlüsselt ist oder welcher Schlüsselname bzw. welche Version in Azure Key Vault verwendet wird, verwenden Sie die REST-API oder ein Azure SDK, um die Eigenschaft encryptionKey aus der Definition des Objekts in Ihrem Foundry IQ-Dienst abzurufen.
Objekte, die nicht mit einem kundenseitig verwalteten Schlüssel verschlüsselt sind, weisen eine leere encryptionKey-Eigenschaft auf. Andernfalls wird Ihnen möglicherweise eine Definition ähnlich dem folgenden Beispiel angezeigt.
"encryptionKey":{
"keyVaultUri":"https://demokeyvault.vault.azure.net",
"keyVaultKeyName":"myEncryptionKey",
"keyVaultKeyVersion":"eaab6a663d59439ebb95ce2fe7d5f660",
"accessCredentials":{
"applicationId":"00001111-aaaa-2222-bbbb-3333cccc4444",
"applicationSecret":"myApplicationSecret"
}
}
Das encryptionKey-Konstrukt ist für alle verschlüsselten Objekte identisch. Hierbei handelt es sich um eine Eigenschaft der ersten Ebene, die sich auf derselben Ebene wie Name und Beschreibung befindet.
Berechtigungen zum Abrufen von Objektdefinitionen
Sie müssen Berechtigungen vom Typ Suchdienstmitwirkender oder gleichwertige Berechtigungen besitzen. Um stattdessen schlüsselbasierte Authentifizierung zu verwenden, geben Sie einen Administrator-API-Schlüssel an. Administratorberechtigungen sind für Anforderungen erforderlich, die Objektdefinitionen und Metadaten zurückgeben. Die einfachste Möglichkeit zum Abrufen des Administrator-API-Schlüssels erfolgt über das Azure-Portal.
Wechseln Sie im Azure Portal zu Ihrem Foundry IQ Service.
Wählen Sie auf der linken Seite Schlüssel aus, und kopieren Sie eine Admin-API.
Wechseln Sie für die restlichen Schritte zu PowerShell und der REST-API. Im Azure Portal werden keine Verschlüsselungsschlüsselinformationen für objekte angezeigt.
Abrufen von Objekteigenschaften
Führen Sie in PowerShell und REST die folgenden Befehle aus, um die Variablen einzurichten und Objektdefinitionen abzurufen.
Alternativ können Sie auch die Azure SDK für .NET, Python, JavaScript und Java verwenden.
Stellen Sie zunächst eine Verbindung mit Ihrem Azure Konto her.
Connect-AzAccount
Wenn Sie in Ihrem Mandanten mehr als ein aktives Abonnement haben, geben Sie das Abonnement an, in dem sich Ihr Foundry IQ-Dienst befindet:
Set-AzContext -Subscription <your-subscription-ID>
Richten Sie die für jede Anforderung in der aktuellen Sitzung verwendeten Header ein. Stellen Sie den Administrator-API-Schlüssel bereit, der für die Foundry IQ-Dienstauthentifizierung verwendet wird.
$headers = @{
'api-key' = '<YOUR-ADMIN-API-KEY>'
'Content-Type' = 'application/json'
'Accept' = 'application/json' }
Um eine Liste aller Suchindizes zurückzugeben, setzen Sie den Endpunkt auf die Indexsammlung.
$uri= 'https://<YOUR-SEARCH-SERVICE>.search.windows.net/indexes?api-version=2026-10-01&$select=name'
Invoke-RestMethod -Uri $uri -Headers $headers | ConvertTo-Json
Um eine bestimmte Indexdefinition zurückzugeben, geben Sie ihren Namen im Pfad an. Die Eigenschaft „encryptionKey“ befindet sich am Ende.
$uri= 'https://<YOUR-SEARCH-SERVICE>.search.windows.net/indexes/<YOUR-INDEX-NAME>?api-version=2026-10-01'
Invoke-RestMethod -Uri $uri -Headers $headers | ConvertTo-Json
Um Synonymzuordnungen zurückzugeben, legen Sie den Endpunkt auf die Synonymsammlung fest, und senden Sie dann die Anforderung.
$uri= 'https://<YOUR-SEARCH-SERVICE>.search.windows.net/synonyms?api-version=2026-10-01&$select=name'
Invoke-RestMethod -Uri $uri -Headers $headers | ConvertTo-Json
Im folgenden Beispiel wird eine bestimmte Synonymzuordnungsdefinition zurückgegeben, einschließlich der encryptionKey-Eigenschaft, die sich am Ende der Definition befindet.
$uri= 'https://<YOUR-SEARCH-SERVICE>.search.windows.net/synonyms/<YOUR-SYNONYM-MAP-NAME>?api-version=2026-10-01'
Invoke-RestMethod -Uri $uri -Headers $headers | ConvertTo-Json
Verwenden Sie das gleiche Muster, um die encryptionKey-Eigenschaft für andere Objekte auf oberster Ebene wie Indexer, Skillsets, Datenquellen und Indexaliase zurückzugeben.