Adatforrás létrehozása (Azure AI Search REST API)

Az Azure AI Searchben az indexelők egy adatforrást használnak, amely megadja a célindex igény szerinti vagy ütemezett adatfrissítésének kapcsolati adatait, és adatokat kér le a támogatott Azure-adatforrásokból.

A kérelemhez használhatJA a POST vagy a PUT elemet. Mindkét esetben a kérelem törzsében található JSON-dokumentum biztosítja az objektumdefiníciót.

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

Másik lehetőségként használhatja a PUT parancsot, és megadhatja a nevet az URI-n.

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

MINDEN szolgáltatáskéréshez HTTPS szükséges. Ha az objektum nem létezik, létrejön. Ha már létezik, az új definícióra frissül.

URI-paraméterek

Kérelemfejlécek

Az alábbi táblázat a szükséges és nem kötelező kérésfejléceket ismerteti.

Kérelem törzse

A kérelem törzse tartalmaz egy adatforrás-definíciót, amely tartalmazza az adatforrás típusát, az adatok olvasásához szükséges hitelesítő adatokat, valamint egy választható adatváltozás-észlelési és adattörlési észlelési szabályzatot, amelyek az adatforrásban lévő módosított vagy törölt adatok hatékony azonosítására szolgálnak, ha rendszeres időközönként ütemezett indexelővel használják őket.

A következő JSON a definíció fő részeinek magas szintű ábrázolása.

{   
    "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": {
        "name": "Name of the table, view, collection, or blob container you wish to index",
        "query": (optional) 
    },
    "dataChangeDetectionPolicy" : (optional) {See below for details },
    "dataDeletionDetectionPolicy" : (optional) {See below for details },
    "encryptionKey":(optional) { }
}  

A kérelem a következő tulajdonságokat tartalmazza:

Reagálás

Sikeres kérés esetén: 201 Létrehozva.

Példák

Példa: Azure SQL változásészleléssel (magas vízjeles változásészlelési szabályzat)

{   
    "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" }
}  

Példa: változásészlelési Azure SQL (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" }
}  

Példa: Azure SQL törlésészleléssel rendelkező változásészleléssel

Ne feledje, hogy a törlésészlelési tulajdonságok a és softDeleteMarkerValueasoftDeleteColumnName.

{   
    "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" }  
}  

Példa: Adatforrás csak kötelező tulajdonságokkal

A változás- és törlésészleléshez kapcsolódó választható tulajdonságok elhagyhatók, ha csak az adatforrást szeretné használni az adatok egyszeri másolatához:

{   
    "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" }  
}   

Példa: Hitelesítő adatok kihagyása

Ha frissíteni szeretné az adatforrást, a hitelesítő adatokra nincs szükség. Az értékek<unchanged>, vagy <redacted> használhatók a kapcsolati karakterlánc helyett.

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

Példa: Titkosítási kulcsok

A titkosítási kulcsok az ügyfél által felügyelt kulcsok, amelyeket a további titkosításhoz használnak. További információ: Titkosítás ügyfél által felügyelt kulcsokkal az 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 system identity) {
        "applicationId": "Microsoft Entra ID application ID that was granted access permissions to your specified Azure Key Vault",
        "applicationSecret": "Authentication key of the registered application)"}
      }
}

Lásd még

• Az indexelő áttekintése
• Indexelők létrehozása
• Adatforrások gyűjteménye