Data Sources - Get

Usługa:: Search Service

Wersja interfejsu API:: 2025-08-01-preview

Pobiera definicję źródła danych.

GET {endpoint}/datasources('{dataSourceName}')?api-version=2025-08-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dataSourceName	path	True	string	Nazwa źródła danych do pobrania.
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Identyfikator śledzenia wysłany z żądaniem, aby pomóc w debugowaniu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchServiceGetDataSource

Przykładowe żądanie

HTTP

GET https://previewexampleservice.search.windows.net/datasources('mydocdbdatasource')?api-version=2025-08-01-preview

Przykładowa odpowiedź

Kod stanu:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "mydocdbdatasource",
  "description": "My Azure Adls Gen2 data source with ACLs.",
  "type": "adlsgen2",
  "indexerPermissionOptions": [
    "userIds",
    "groupIds",
    "rbacScope"
  ],
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "adls-gen2-doc-extraction-acl",
    "query": "folder_has_final_acl"
  },
  "dataChangeDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy",
    "highWaterMarkColumnName": "metadata_storage_last_modified"
  },
  "dataDeletionDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy",
    "softDeleteColumnName": "isDeleted",
    "softDeleteMarkerValue": "true"
  }
}

Definicje

Nazwa	Opis
AzureActiveDirectoryApplicationCredentials	Poświadczenia zarejestrowanej aplikacji utworzonej dla usługi wyszukiwania, używanej do uwierzytelnionego dostępu do kluczy szyfrowania przechowywanych w usłudze Azure Key Vault.
DataSourceCredentials	Reprezentuje poświadczenia, których można użyć do nawiązania połączenia ze źródłem danych.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
HighWaterMarkChangeDetectionPolicy	Definiuje zasady wykrywania zmian danych, które przechwytują zmiany na podstawie wartości kolumny znacznika górnego limitu.
IndexerPermissionOption	Opcje z różnymi typami danych uprawnień do indeksowania.
NativeBlobSoftDeleteDeletionDetectionPolicy	Definiuje zasady wykrywania usuwania danych przy użyciu natywnej funkcji usuwania nietrwałego Azure Blob Storage do wykrywania usuwania.
SearchIndexerDataContainer	Reprezentuje informacje o jednostce (takiej jak tabela Azure SQL lub kolekcja CosmosDB), która zostanie zindeksowana.
SearchIndexerDataNoneIdentity	Czyści właściwość tożsamości źródła danych.
SearchIndexerDataSource	Reprezentuje definicję źródła danych, której można użyć do skonfigurowania indeksatora.
SearchIndexerDataSourceType	Definiuje typ źródła danych.
SearchIndexerDataUserAssignedIdentity	Określa tożsamość źródła danych, które ma być używane.
SearchResourceEncryptionKey	Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.
SoftDeleteColumnDeletionDetectionPolicy	Definiuje zasady wykrywania usuwania danych, które implementują strategię usuwania nietrwałego. Określa, czy element powinien zostać usunięty, na podstawie wartości wyznaczonej kolumny "usuwanie nietrwałe".
SqlIntegratedChangeTrackingPolicy	Definiuje zasady wykrywania zmian danych, które przechwytują zmiany przy użyciu funkcji zintegrowanego śledzenia zmian Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Objekt

Poświadczenia zarejestrowanej aplikacji utworzonej dla usługi wyszukiwania, używanej do uwierzytelnionego dostępu do kluczy szyfrowania przechowywanych w usłudze Azure Key Vault.

Nazwa	Typ	Opis
applicationId	string	Identyfikator aplikacji usługi AAD, któremu udzielono wymaganych uprawnień dostępu do usługi Azure Key Vault, który ma być używany podczas szyfrowania danych magazynowanych. Identyfikatora aplikacji nie należy mylić z identyfikatorem obiektu aplikacji usługi AAD.
applicationSecret	string	Klucz uwierzytelniania określonej aplikacji usługi AAD.

DataSourceCredentials

Objekt

Reprezentuje poświadczenia, których można użyć do nawiązania połączenia ze źródłem danych.

Nazwa	Typ	Opis
connectionString	string	Parametry połączenia dla źródła danych. Ustaw wartość `<unchanged>` (w nawiasach), jeśli nie chcesz, aby parametry połączenia były aktualizowane. Ustaw na `<redacted>` , jeśli chcesz usunąć wartość parametrów połączenia ze źródła danych.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

HighWaterMarkChangeDetectionPolicy

Objekt

Definiuje zasady wykrywania zmian danych, które przechwytują zmiany na podstawie wartości kolumny znacznika górnego limitu.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Fragment identyfikatora URI określający typ zasad wykrywania zmian danych.
highWaterMarkColumnName	string	Nazwa kolumny znaku wysokiej wody.

IndexerPermissionOption

Wyliczenie

Opcje z różnymi typami danych uprawnień do indeksowania.

Wartość	Opis
userIds	Indeksator do pozyskiwania identyfikatorów użytkowników listy ACL ze źródła danych do indeksu.
groupIds	Indeksator do pozyskiwania identyfikatorów grup ACL ze źródła danych do indeksu.
rbacScope	Indeksator do pozyskiwania zakresu RBAC platformy Azure ze źródła danych do indeksu.

NativeBlobSoftDeleteDeletionDetectionPolicy

Objekt

Definiuje zasady wykrywania usuwania danych przy użyciu natywnej funkcji usuwania nietrwałego Azure Blob Storage do wykrywania usuwania.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	Fragment identyfikatora URI określający typ zasad wykrywania usuwania danych.

SearchIndexerDataContainer

Objekt

Reprezentuje informacje o jednostce (takiej jak tabela Azure SQL lub kolekcja CosmosDB), która zostanie zindeksowana.

Nazwa	Typ	Opis
name	string	Nazwa tabeli lub widoku (dla źródła danych Azure SQL) lub kolekcji (dla źródła danych CosmosDB), która zostanie zindeksowana.
query	string	Zapytanie, które jest stosowane do tego kontenera danych. Składnia i znaczenie tego parametru jest specyficzne dla źródła danych. Nie jest obsługiwane przez źródła danych Azure SQL.

SearchIndexerDataNoneIdentity

Objekt

Czyści właściwość tożsamości źródła danych.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment identyfikatora URI określający typ tożsamości.

SearchIndexerDataSource

Objekt

Reprezentuje definicję źródła danych, której można użyć do skonfigurowania indeksatora.

Nazwa	Typ	Opis
@odata.etag	string	Element ETag źródła danych.
container	SearchIndexerDataContainer	Kontener danych dla źródła danych.
credentials	DataSourceCredentials	Poświadczenia źródła danych.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Zasady wykrywania zmian danych dla źródła danych.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	Zasady wykrywania usuwania danych dla źródła danych.
description	string	Opis źródła danych.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania magazynowanego dla definicji źródła danych, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może odszyfrować definicji źródła danych. Po zaszyfrowaniu definicji źródła danych zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Nie będzie to miało wpływu na definicję źródła danych. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne w przypadku bezpłatnych usług wyszukiwania i jest dostępne tylko w przypadku płatnych usług utworzonych 1 stycznia 2019 r. lub później.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Jawna tożsamość zarządzana do użycia dla tego źródła danych. Jeśli nie zostanie określony, a parametry połączenia są tożsamością zarządzaną, zostanie użyta tożsamość zarządzana przypisana przez system. Jeśli nie zostanie określona, wartość pozostanie niezmieniona. Jeśli określono wartość "none", wartość tej właściwości jest czyszczona.
indexerPermissionOptions	IndexerPermissionOption[]	Opcje pozyskiwania z różnymi typami danych uprawnień.
name	string	Nazwa źródła danych.
subType	string	Określony typ źródła danych, w przypadku gdy zasób może obsługiwać różne modalności. Na przykład "MongoDb" dla niektórych kont "cosmosDb".
type	SearchIndexerDataSourceType	Typ źródła danych.

SearchIndexerDataSourceType

Wyliczenie

Definiuje typ źródła danych.

Wartość	Opis
azuresql	Wskazuje źródło danych Azure SQL.
cosmosdb	Wskazuje źródło danych CosmosDB.
azureblob	Wskazuje źródło danych obiektu blob platformy Azure.
azuretable	Wskazuje źródło danych tabeli platformy Azure.
mysql	Wskazuje źródło danych MySql.
adlsgen2	Wskazuje źródło danych usługi ADLS Gen2.
onelake	Wskazuje źródło danych usługi Microsoft Fabric OneLake.

SearchIndexerDataUserAssignedIdentity

Objekt

Określa tożsamość źródła danych, które ma być używane.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment identyfikatora URI określający typ tożsamości.
userAssignedIdentity	string	W pełni kwalifikowany identyfikator zasobu platformy Azure tożsamości zarządzanej przypisanej przez użytkownika zwykle w postaci "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", który powinien zostać przypisany do usługi wyszukiwania.

SearchResourceEncryptionKey

Objekt

Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.

Nazwa	Typ	Opis
accessCredentials	AzureActiveDirectoryApplicationCredentials	Opcjonalne poświadczenia usługi Azure Active Directory używane do uzyskiwania dostępu do usługi Azure Key Vault. Nie jest to wymagane, jeśli zamiast tego używasz tożsamości zarządzanej.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Jawna tożsamość zarządzana do użycia dla tego klucza szyfrowania. Jeśli nie zostanie określona, a właściwość poświadczeń dostępu ma wartość null, zostanie użyta tożsamość zarządzana przypisana przez system. Podczas aktualizacji zasobu, jeśli jawna tożsamość nie jest określona, pozostaje niezmieniona. Jeśli określono wartość "none", wartość tej właściwości jest czyszczona.
keyVaultKeyName	string	Nazwa klucza usługi Azure Key Vault, który ma być używany do szyfrowania danych magazynowanych.
keyVaultKeyVersion	string	Wersja klucza usługi Azure Key Vault, która ma być używana do szyfrowania danych magazynowanych.
keyVaultUri	string	Identyfikator URI usługi Azure Key Vault, nazywany również nazwą DNS, który zawiera klucz, który ma być używany do szyfrowania danych magazynowanych. Przykładowym identyfikatorem URI może być `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Objekt

Definiuje zasady wykrywania usuwania danych, które implementują strategię usuwania nietrwałego. Określa, czy element powinien zostać usunięty, na podstawie wartości wyznaczonej kolumny "usuwanie nietrwałe".

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Fragment identyfikatora URI określający typ zasad wykrywania usuwania danych.
softDeleteColumnName	string	Nazwa kolumny, która ma być używana do wykrywania usuwania nietrwałego.
softDeleteMarkerValue	string	Wartość znacznika identyfikująca element jako usunięty.

SqlIntegratedChangeTrackingPolicy

Objekt

Definiuje zasady wykrywania zmian danych, które przechwytują zmiany przy użyciu funkcji zintegrowanego śledzenia zmian Azure SQL Database.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Fragment identyfikatora URI określający typ zasad wykrywania zmian danych.