Panoramica Cosmos trigger e associazioni del database di Azure Funzioni di Azure 2.x e versioni successive

Questo set di articoli illustra come usare le associazioni di database Cosmos Azure in Funzioni di Azure 2.x e versioni successive. Funzioni di Azure supporta i trigger e le associazioni di input e output per Azure Cosmos DB.

Azione Tipo
Eseguire una funzione quando viene creato o modificato un documento Cosmos database di Azure Trigger
Leggere un documento di Azure Cosmos DB Associazione di input
Salvare le modifiche in un documento di Azure Cosmos DB Associazione di output

Nota

Questo riferimento è per Funzioni di Azure versione 2.x e successive. Per informazioni su come usare le associazioni in Funzioni 1.x, vedere Associazioni di Azure Cosmos DB per Funzioni di Azure 1.x.

Questa associazione è stata originariamente denominata DocumentDB. In Funzioni versione 2.x e successive il trigger, le associazioni e il pacchetto sono tutti denominati Cosmos DATABASE.

API supportate

Le associazioni di Azure Cosmos DB sono supportate solo per l'uso con l'API SQL. Per tutte le altre API di Azure Cosmos DB è necessario accedere al database dalla funzione usando il client statico per l'API, incluse l'API MongoDB, l'API Cassandra, l'API Gremlin e l'API Tabella.

Aggiungere all'app Funzioni

Funzioni 2.x e versioni successive

Per l'uso del trigger e delle associazioni è necessario fare riferimento al pacchetto appropriato. Il NuGet pacchetto viene usato per le librerie di classi .NET, mentre il bundle di estensioni viene usato per tutti gli altri tipi di applicazione.

Linguaggio Aggiungi da... Commenti
C# Installazione del pacchetto NuGetversione 3.x
Script C#, Java, JavaScript, Python, PowerShell Registrazione dell'aggregazione di estensioni È consigliabile usare l'estensione Strumenti di Azure con Visual Studio Code.
Script C# (solo online in portale di Azure) Aggiunta di un'associazione Per aggiornare le estensioni di binding esistenti senza dover ripubblicare l'app per le funzioni, vedere Aggiornare le estensioni.

Cosmos'estensione del database 4.x e versioni successive

Una nuova versione dell'estensione Cosmos binding del database è disponibile in anteprima. Introduce la possibilità di connettersi usando un'identità anziché un segreto. Per un'esercitazione sulla configurazione delle app per le funzioni con identità gestite, vedere l'esercitazione sulla creazione di un'app per le funzioni con connessioni basate su identità. Per le applicazioni .NET, la nuova versione dell'estensione modifica anche i tipi a cui è possibile eseguire l'associazione, sostituendo i tipi dall'SDK v2 con i tipi più recenti di Microsoft.Azure.DocumentDBMicrosoft.Azure.DocumentDBv3 SDK. Altre informazioni su come sono diversi questi nuovi tipi e su come eseguirne la migrazione dagli esempi di guida alla migrazione dell'SDK,trigger,associazione di inputed associazione di output.

Questa versione dell'estensione è disponibile come pacchetto NuGet di anteprima. Per altre informazioni, vedere Aggiornare le estensioni.

Nota

Attualmente, l'autenticazione con un'identità anziché un segreto usando l'estensione di anteprima 4.x è disponibile solo per i piani di Premium elastici.

Funzioni 1.x

Le app Functions 1.x hanno automaticamente un riferimento al pacchetto microsoft.Azure.WebJobs NuGet, versione 2.x.

Eccezioni e codici restituiti

Binding Informazioni di riferimento
Cosmos DB Codici di errore di CosmosDB

impostazioni host.json

In questa sezione vengono descritte le impostazioni di configurazione disponibili per questa associazione nelle versioni 2.x e successive. Impostazioni nel file host.json si applicano a tutte le funzioni in un'istanza dell'app per le funzioni. Il file host.json di esempio seguente contiene solo le impostazioni della versione 2.x+ per questa associazione. Per altre informazioni sulle impostazioni di configurazione delle app per le funzioni nelle versioni 2.x e successive, vedere le informazioni di riferimento su host.json perFunzioni di Azure .

{
    "version": "2.0",
    "extensions": {
        "cosmosDB": {
            "connectionMode": "Gateway",
            "protocol": "Https",
            "leaseOptions": {
                "leasePrefix": "prefix1"
            }
        }
    }
}
Proprietà Predefinito Descrizione
GatewayMode Gateway La modalità di connessione usata dalla funzione durante la connessione al servizio di Azure Cosmos DB. Le opzioni sono Direct e Gateway
Protocollo Https Il protocollo di connessione usato dalla funzione durante la connessione al servizio di Azure Cosmos DB. Leggere qui per una spiegazione di entrambe le modalità.

Questa impostazione non è disponibile nella versione 4.x dell'estensione.
leasePrefix n/d Prefisso di lease da usare in tutte le funzioni in un'app.

Questa impostazione non è disponibile nella versione 4.x dell'estensione.

Passaggi successivi