Wyzwalacz usługi Azure Cosmos DB dla usługi Azure Functions w wersji 2.x lub nowszej

Artykuł
01/19/2024

Wyzwalacz usługi Azure Cosmos DB używa zestawienia zmian usługi Azure Cosmos DB do nasłuchiwania wstawiania i aktualizacji między partycjami. Kanał informacyjny zmian publikuje nowe i zaktualizowane elementy, a nie w tym aktualizacje z usuwania.

Aby uzyskać informacje na temat konfiguracji i konfiguracji, zobacz omówienie.

Decyzje dotyczące skalowania usługi Cosmos DB dla planów Zużycie i Premium są wykonywane za pośrednictwem skalowania na podstawie celu. Aby uzyskać więcej informacji, zobacz Skalowanie na podstawie celu.

Ważne

W tym artykule są używane karty do obsługi wielu wersji modelu programowania Node.js. Model w wersji 4 jest ogólnie dostępny i ma bardziej elastyczne i intuicyjne środowisko dla deweloperów języka JavaScript i Języka TypeScript. Aby uzyskać więcej informacji na temat sposobu działania modelu w wersji 4, zapoznaj się z przewodnikiem dewelopera dotyczącym usługi Azure Functions Node.js. Aby dowiedzieć się więcej o różnicach między wersjami 3 i v4, zapoznaj się z przewodnikiem migracji.

Usługa Azure Functions obsługuje dwa modele programowania dla języka Python. Sposób definiowania powiązań zależy od wybranego modelu programowania.

Wersja 2
Wersja 1

Model programowania w języku Python w wersji 2 umożliwia definiowanie powiązań przy użyciu dekoratorów bezpośrednio w kodzie funkcji języka Python. Aby uzyskać więcej informacji, zobacz przewodnik dla deweloperów języka Python.

Ten artykuł obsługuje oba modele programowania.

Przykład

Użycie wyzwalacza zależy od wersji pakietu rozszerzenia i modalności języka C# używanej w aplikacji funkcji, co może być jednym z następujących elementów:

Model izolowanego procesu roboczego
Model w procesie

Izolowana biblioteka klas procesów roboczych skompilowana funkcja języka C# jest uruchamiana w procesie odizolowanym od środowiska uruchomieniowego.

Poniższe przykłady zależą od wersji rozszerzenia dla danego trybu języka C#.

Aplikacje korzystające z rozszerzenia usługi Azure Cosmos DB w wersji 4.x lub nowszej mają różne właściwości atrybutów, które są wyświetlane tutaj. W tym przykładzie odwołuje się do prostego ToDoItem typu.

namespace CosmosDBSamplesV2
{
    // Customize the model with your own desired properties
    public class ToDoItem
    {
        public string id { get; set; }
        public string Description { get; set; }
    }
}

using System.Collections.Generic;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;

namespace CosmosDBSamplesV2
{
    public static class CosmosTrigger
    {
        [FunctionName("CosmosTrigger")]
        public static void Run([CosmosDBTrigger(
            databaseName: "databaseName",
            containerName: "containerName",
            Connection = "CosmosDBConnectionSetting",
            LeaseContainerName = "leases",
            CreateLeaseContainerIfNotExists = true)]IReadOnlyList<ToDoItem> input, ILogger log)
        {
            if (input != null && input.Count > 0)
            {
                log.LogInformation("Documents modified " + input.Count);
                log.LogInformation("First document Id " + input[0].id);
            }
        }
    }
}

W poniższym przykładzie pokazano funkcję języka C#, która jest wywoływana w przypadku wstawiania lub aktualizacji w określonej bazie danych i kolekcji.

using Microsoft.Azure.Documents;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using System.Collections.Generic;
using Microsoft.Extensions.Logging;

namespace CosmosDBSamplesV2
{
    public static class CosmosTrigger
    {
        [FunctionName("CosmosTrigger")]
        public static void Run([CosmosDBTrigger(
            databaseName: "ToDoItems",
            collectionName: "Items",
            ConnectionStringSetting = "CosmosDBConnection",
            LeaseCollectionName = "leases",
            CreateLeaseCollectionIfNotExists = true)]IReadOnlyList<Document> documents,
            ILogger log)
        {
            if (documents != null && documents.Count > 0)
            {
                log.LogInformation($"Documents modified: {documents.Count}");
                log.LogInformation($"First document Id: {documents[0].Id}");
            }
        }
    }
}

W tym przykładzie odwołuje się do prostego ToDoItem typu:

public class ToDoItem
{
    public string? Id { get; set; }
    public string? Description { get; set; }
}

Następująca funkcja jest wywoływana w przypadku wstawiania lub aktualizacji w określonej bazie danych i kolekcji.

[Function("CosmosTrigger")]
public void Run([CosmosDBTrigger(
    databaseName: "ToDoItems",
    containerName:"TriggerItems",
    Connection = "CosmosDBConnection",
    LeaseContainerName = "leases",
    CreateLeaseContainerIfNotExists = true)] IReadOnlyList<ToDoItem> todoItems,
    FunctionContext context)
{
    if (todoItems is not null && todoItems.Any())
    {
        foreach (var doc in todoItems)
        {
            _logger.LogInformation("ToDoItem: {desc}", doc.Description);
        }
    }
}

Poniższy kod definiuje MyDocument typ:

public class MyDocument
{
    public string? Id { get; set; }

    public string? Text { get; set; }

    public int Number { get; set; }

    public bool Boolean { get; set; }
}

Element IReadOnlyList<T> jest używany jako parametr powiązania wyzwalacza usługi Azure Cosmos DB w poniższym przykładzie:

[Function(nameof(CosmosDBFunction))]
[ExponentialBackoffRetry(5, "00:00:04", "00:15:00")]
[CosmosDBOutput("%CosmosDb%", "%CosmosContainerOut%", Connection = "CosmosDBConnection", CreateIfNotExists = true)]
public object? Run(
    [CosmosDBTrigger(
        "%CosmosDb%",
        "%CosmosContainerIn%",
        Connection = "CosmosDBConnection",
        LeaseContainerName = "leases",
        CreateLeaseContainerIfNotExists = true)] IReadOnlyList<MyDocument> input,
    FunctionContext context)
{
    if (input != null && input.Any())
    {
        foreach (var doc in input)
        {
            _logger.LogInformation("Doc Id: {id}", doc.Id);
        }

        // Cosmos Output
        return input.Select(p => new { id = p.Id });
    }

    return null;
}

W tym przykładzie wymagane są następujące using instrukcje:

using System.Collections.Generic;
using System.Linq;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.Logging;

Ta funkcja jest wywoływana w przypadku wstawiania lub aktualizacji w określonej bazie danych i kontenerze.

Rozszerzenie 4.x+
Funkcje 2.x+

Ze względu na zmiany schematu w zestawie SDK usługi Azure Cosmos DB wersja 4.x rozszerzenia usługi Azure Cosmos DB wymaga biblioteki azure-functions-java-library w wersji 3.0.0 dla funkcji Języka Java.

    @FunctionName("CosmosDBTriggerFunction")
    public void run(
        @CosmosDBTrigger(
            name = "items",
            databaseName = "ToDoList",
            containerName = "Items",
            leaseContainerName="leases",
            connection = "AzureCosmosDBConnection",
            createLeaseContainerIfNotExists = true
        )
        Object inputItem,
        final ExecutionContext context
    ) {
        context.getLogger().info("Items modified: " + inputItems.size());
    }

    @FunctionName("cosmosDBMonitor")
    public void cosmosDbProcessor(
        @CosmosDBTrigger(name = "items",
            databaseName = "ToDoList",
            collectionName = "Items",
            leaseCollectionName = "leases",
            createLeaseCollectionIfNotExists = true,
            connectionStringSetting = "AzureCosmosDBConnection") String[] items,
            final ExecutionContext context ) {
                context.getLogger().info(items.length + "item(s) is/are changed.");
            }

W bibliotece środowiska uruchomieniowego funkcji Języka Java użyj @CosmosDBTrigger adnotacji dotyczącej parametrów, których wartość pochodzi z usługi Azure Cosmos DB. Tej adnotacji można używać z natywnymi typami Języka Java, obiektami POJO lub wartościami dopuszczanymi wartościami null przy użyciu polecenia Optional<T>.

Model w wersji 4
Model w wersji 3

W poniższym przykładzie przedstawiono funkcję TypeScript wyzwalacza usługi Azure Cosmos DB. Funkcja zapisuje komunikaty dziennika podczas dodawania lub modyfikowania rekordów usługi Azure Cosmos DB.

import { app, InvocationContext } from '@azure/functions';

export async function cosmosDBTrigger1(documents: unknown[], context: InvocationContext): Promise<void> {
    context.log(`Cosmos DB function processed ${documents.length} documents`);
}

app.cosmosDB('cosmosDBTrigger1', {
    connection: '<connection-app-setting>',
    databaseName: 'Tasks',
    containerName: 'Items',
    createLeaseContainerIfNotExists: true,
    handler: cosmosDBTrigger1,
});

Model w wersji 4
Model w wersji 3

W poniższym przykładzie przedstawiono funkcję JavaScript wyzwalacza usługi Azure Cosmos DB. Funkcja zapisuje komunikaty dziennika podczas dodawania lub modyfikowania rekordów usługi Azure Cosmos DB.

const { app } = require('@azure/functions');

app.cosmosDB('cosmosDBTrigger1', {
    connection: '<connection-app-setting>',
    databaseName: 'Tasks',
    containerName: 'Items',
    createLeaseContainerIfNotExists: true,
    handler: (documents, context) => {
        context.log(`Cosmos DB function processed ${documents.length} documents`);
    },
});

W poniższym przykładzie pokazano powiązanie wyzwalacza usługi Azure Cosmos DB w pliku function.json i funkcję Języka JavaScript, która używa powiązania. Funkcja zapisuje komunikaty dziennika podczas dodawania lub modyfikowania rekordów usługi Azure Cosmos DB.

Oto dane powiązania w pliku function.json :

Funkcje 2.x+
Funkcje 4.x+

{
    "type": "cosmosDBTrigger",
    "name": "documents",
    "direction": "in",
    "leaseCollectionName": "leases",
    "connectionStringSetting": "<connection-app-setting>",
    "databaseName": "Tasks",
    "collectionName": "Items",
    "createLeaseCollectionIfNotExists": true
}

{
    "type": "cosmosDBTrigger",
    "name": "documents",
    "direction": "in",
    "leaseContainerName": "leases",
    "connection": "<connection-app-setting>",
    "databaseName": "Tasks",
    "containerName": "Items",
    "createLeaseContainerIfNotExists": true
}

Pamiętaj, że niektóre nazwy atrybutów powiązania zmieniły się w wersji 4.x rozszerzenia usługi Azure Cosmos DB.

Oto kod JavaScript:

    module.exports = async function (context, documents) {
      context.log('First document Id modified : ', documents[0].id);
    }

W poniższym przykładzie pokazano, jak uruchomić funkcję w miarę zmian danych w usłudze Azure Cosmos DB.

Funkcje 2.x+
Funkcje 4.x+

{
    "type": "cosmosDBTrigger",
    "name": "documents",
    "direction": "in",
    "leaseCollectionName": "leases",
    "connectionStringSetting": "<connection-app-setting>",
    "databaseName": "Tasks",
    "collectionName": "Items",
    "createLeaseCollectionIfNotExists": true
}

{
    "type": "cosmosDBTrigger",
    "name": "documents",
    "direction": "in",
    "leaseContainerName": "leases",
    "connection": "<connection-app-setting>",
    "databaseName": "Tasks",
    "containerName": "Items",
    "createLeaseContainerIfNotExists": true
}

Pamiętaj, że niektóre nazwy atrybutów powiązania zmieniły się w wersji 4.x rozszerzenia usługi Azure Cosmos DB.

W pliku run.ps1 masz dostęp do dokumentu, który wyzwala funkcję za pośrednictwem parametru $Documents .

param($Documents, $TriggerMetadata) 

Write-Host "First document Id modified : $($Documents[0].id)"

W poniższym przykładzie przedstawiono powiązanie wyzwalacza usługi Azure Cosmos DB. Przykład zależy od tego, czy używasz modelu programowania w wersji 1, czy w wersji 2 języka Python.

Wersja 2
Wersja 1

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="CosmosDBTrigger")
@app.cosmos_db_trigger(name="documents", 
                       connection="CONNECTION_SETTING",
                       database_name="DB_NAME", 
                       container_name="CONTAINER_NAME", 
                       lease_container_name="leases",
                       create_lease_container_if_not_exists="true")
def test_function(documents: func.DocumentList) -> str:
    if documents:
        logging.info('Document id: %s', documents[0]['id'])

Funkcja zapisuje komunikaty dziennika podczas modyfikowania rekordów usługi Azure Cosmos DB. Oto dane powiązania w pliku function.json :

Funkcje 2.x+
Funkcje 4.x+

{
    "type": "cosmosDBTrigger",
    "name": "documents",
    "direction": "in",
    "leaseCollectionName": "leases",
    "connectionStringSetting": "<connection-app-setting>",
    "databaseName": "Tasks",
    "collectionName": "Items",
    "createLeaseCollectionIfNotExists": true
}

{
    "type": "cosmosDBTrigger",
    "name": "documents",
    "direction": "in",
    "leaseContainerName": "leases",
    "connection": "<connection-app-setting>",
    "databaseName": "Tasks",
    "containerName": "Items",
    "createLeaseContainerIfNotExists": true
}

Pamiętaj, że niektóre nazwy atrybutów powiązania zmieniły się w wersji 4.x rozszerzenia usługi Azure Cosmos DB.

Oto kod języka Python:

    import logging
    import azure.functions as func


    def main(documents: func.DocumentList) -> str:
        if documents:
            logging.info('First document Id modified: %s', documents[0]['id'])

Atrybuty

Zarówno w procesie, jak i w izolowanym procesie biblioteki języka C# używają atrybutu CosmosDBTriggerAttribute do zdefiniowania funkcji. Zamiast tego skrypt języka C# używa pliku konfiguracji function.json zgodnie z opisem w przewodniku obsługi skryptów języka C#.

Właściwość atrybutu	opis
Połączenie	Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z monitorowanym kontem usługi Azure Cosmos DB. Aby uzyskać więcej informacji, zobacz Połączenia.
Nazwa bazy danych	Nazwa bazy danych usługi Azure Cosmos DB z monitorowanym kontenerem.
ContainerName	Nazwa monitorowanego kontenera.
LeaseConnection	(Opcjonalnie) Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z kontem usługi Azure Cosmos DB, które przechowuje kontener dzierżawy. Jeśli nie zostanie ustawiona, zostanie użyta `Connection` wartość. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania w portalu. Parametry połączenia kontenera dzierżaw musi mieć uprawnienia do zapisu.
LeaseDatabaseName	(Opcjonalnie) Nazwa bazy danych, która przechowuje kontener używany do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `databaseName` ustawienia.
LeaseContainerName	(Opcjonalnie) Nazwa kontenera używanego do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `leases` .
CreateLeaseContainerIfNotExists	(Opcjonalnie) Po ustawieniu `true`wartości parametru kontener dzierżaw jest tworzony automatycznie, gdy jeszcze nie istnieje. Domyślna wartość to `false`. W przypadku korzystania z tożsamości entra firmy Microsoft, jeśli ustawisz wartość `true`na , tworzenie kontenerów nie jest dozwoloną operacją , a funkcja nie będzie mogła uruchomić.
LeasesContainerThroughput	(Opcjonalnie) Definiuje liczbę jednostek żądań do przypisania podczas tworzenia kontenera dzierżaw. To ustawienie jest używane tylko wtedy, gdy `CreateLeaseContainerIfNotExists` jest ustawione na `true`. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania przy użyciu portalu.
LeaseContainerPrefix	(Opcjonalnie) Po ustawieniu wartość jest dodawana jako prefiks do dzierżaw utworzonych w kontenerze Dzierżawa dla tej funkcji. Użycie prefiksu umożliwia dwóm oddzielnym usłudze Azure Functions współużytkowania tego samego kontenera dzierżawy przy użyciu różnych prefiksów.
FeedPollDelay	(Opcjonalnie) Czas (w milisekundach) dla opóźnienia między sondowaniem partycji pod kątem nowych zmian w kanale informacyjnym, po opróżnieniu wszystkich bieżących zmian. Wartość domyślna to 5000 milisekund lub 5 sekund.
LeaseAcquireInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał uruchamiania zadania obliczeniowego, jeśli partycje są równomiernie dystrybuowane między znane wystąpienia hosta. Wartość domyślna to 13000 (13 sekund).
LeaseExpirationInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał, dla którego dzierżawa jest wykonywana w dzierżawie reprezentującej partycję. Jeśli dzierżawa nie zostanie odnowiona w tym interwale, spowoduje to wygaśnięcie, a własność partycji zostanie przeniesiona do innego wystąpienia. Wartość domyślna to 60000 (60 sekund).
LeaseRenewInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał odnawiania dla wszystkich dzierżaw dla partycji, które są obecnie przechowywane przez wystąpienie. Wartość domyślna to 17000 (17 sekund).
MaxItemsPerInvocation	(Opcjonalnie) Po ustawieniu ta właściwość ustawia maksymalną liczbę odebranych elementów na wywołanie funkcji. Jeśli operacje w monitorowanym kontenerze są wykonywane za pomocą procedur składowanych, zakres transakcji jest zachowywany podczas odczytywania elementów ze źródła zmian. W związku z tym liczba odebranych elementów może być większa niż określona wartość, aby elementy zmienione przez tę samą transakcję zostały zwrócone w ramach jednej partii niepodzielnej.
StartFromBeginning	(Opcjonalnie) Ta opcja nakazuje wyzwalaczowi odczytywanie zmian od początku historii zmian kontenera zamiast rozpoczynania się od bieżącej godziny. Odczyt od początku działa tylko przy pierwszym uruchomieniu wyzwalacza, tak jak w kolejnych uruchomieniach, punkty kontrolne są już przechowywane. Ustawienie tej opcji na `true` wartość , gdy istnieją już utworzone dzierżawy, nie ma wpływu.
StartFromTime	(Opcjonalnie) Pobiera lub ustawia datę i godzinę, z której ma być inicjowana operacja odczytu zestawienia zmian. Zalecanym formatem jest ISO 8601 z projektantem UTC, takim jak `2021-02-16T14:19:29Z`. Służy to tylko do ustawiania stanu początkowego wyzwalacza. Gdy wyzwalacz ma stan dzierżawy, zmiana tej wartości nie ma wpływu.
PreferredLocations	(Opcjonalnie) Definiuje preferowane lokalizacje (regiony) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB. Wartości powinny być rozdzielane przecinkami. Na przykład "Wschodnie stany USA,Południowo-środkowe stany USA,Europa Północna".

Właściwość atrybutu	opis
ConnectionStringSetting	Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z monitorowanym kontem usługi Azure Cosmos DB. Aby uzyskać więcej informacji, zobacz Połączenia.
Nazwa bazy danych	Nazwa bazy danych usługi Azure Cosmos DB z monitorowaną kolekcją.
CollectionName	Nazwa monitorowanej kolekcji.
LeaseConnectionStringSetting	(Opcjonalnie) Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z kontem usługi Azure Cosmos DB, które przechowuje kolekcję dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta `ConnectionStringSetting` wartość. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania w portalu. Parametry połączenia dla kolekcji dzierżaw musi mieć uprawnienia do zapisu.
LeaseDatabaseName	(Opcjonalnie) Nazwa bazy danych, która zawiera kolekcję używaną do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `databaseName` ustawienia.
LeaseCollectionName	(Opcjonalnie) Nazwa kolekcji używanej do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `leases` .
CreateLeaseCollectionIfNotExists	(Opcjonalnie) Gdy jest ustawiona wartość `true`, kolekcja dzierżaw jest tworzona automatycznie, gdy jeszcze nie istnieje. Domyślna wartość to `false`.
LeasesCollectionThroughput	(Opcjonalnie) Definiuje liczbę jednostek żądań do przypisania podczas tworzenia kolekcji dzierżaw. To ustawienie jest używane tylko wtedy, gdy `CreateLeaseCollectionIfNotExists` jest ustawione na `true`. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania przy użyciu portalu.
LeaseCollectionPrefix	(Opcjonalnie) Po ustawieniu wartość jest dodawana jako prefiks do dzierżaw utworzonych w kolekcji Dzierżawy dla tej funkcji. Użycie prefiksu umożliwia dwóm oddzielnym funkcjom usługi Azure Functions współużytkowania tej samej kolekcji dzierżaw przy użyciu różnych prefiksów.
FeedPollDelay	(Opcjonalnie) Czas (w milisekundach) dla opóźnienia między sondowaniem partycji pod kątem nowych zmian w kanale informacyjnym, po opróżnieniu wszystkich bieżących zmian. Wartość domyślna to 5000 milisekund lub 5 sekund.
LeaseAcquireInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał uruchamiania zadania obliczeniowego, jeśli partycje są równomiernie dystrybuowane między znane wystąpienia hosta. Wartość domyślna to 13000 (13 sekund).
LeaseExpirationInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał, dla którego dzierżawa jest wykonywana w dzierżawie reprezentującej partycję. Jeśli dzierżawa nie zostanie odnowiona w tym interwale, spowoduje to wygaśnięcie, a własność partycji zostanie przeniesiona do innego wystąpienia. Wartość domyślna to 60000 (60 sekund).
LeaseRenewInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał odnawiania dla wszystkich dzierżaw dla partycji, które są obecnie przechowywane przez wystąpienie. Wartość domyślna to 17000 (17 sekund).
Punkt kontrolnyInterval	(Opcjonalnie) Po ustawieniu definiuje interwał między punktami kontrolnymi dzierżawy w milisekundach. Wartość domyślna jest zawsze po każdym wywołaniu funkcji.
CheckpointDocumentCount	(Opcjonalnie) Dostosowuje ilość dokumentów między punktami kontrolnymi dzierżawy. Wartość domyślna jest po każdym wywołaniu funkcji.
MaxItemsPerInvocation	(Opcjonalnie) Po ustawieniu ta właściwość ustawia maksymalną liczbę odebranych elementów na wywołanie funkcji. Jeśli operacje w monitorowanej kolekcji są wykonywane za pomocą procedur składowanych, zakres transakcji jest zachowywany podczas odczytywania elementów ze źródła zmian. W związku z tym liczba odebranych elementów może być większa niż określona wartość, aby elementy zmienione przez tę samą transakcję zostały zwrócone w ramach jednej partii niepodzielnej.
StartFromBeginning	(Opcjonalnie) Ta opcja nakazuje wyzwalaczowi odczytywanie zmian od początku historii zmian kolekcji zamiast rozpoczynać się od bieżącej godziny. Odczyt od początku działa tylko przy pierwszym uruchomieniu wyzwalacza, tak jak w kolejnych uruchomieniach, punkty kontrolne są już przechowywane. Ustawienie tej opcji na `true` wartość , gdy istnieją już utworzone dzierżawy, nie ma wpływu.
PreferredLocations	(Opcjonalnie) Definiuje preferowane lokalizacje (regiony) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB. Wartości powinny być rozdzielane przecinkami. Na przykład "Wschodnie stany USA,Południowo-środkowe stany USA,Europa Północna".
UseMultipleWriteLocations	(Opcjonalnie) Umożliwia zapisywanie kont w wielu regionach w kolekcji dzierżaw.
UseDefaultJsonSerialization	(Opcjonalnie) Umożliwia korzystanie z `JsonConvert.DefaultSettings` monitorowanej kolekcji. To ustawienie dotyczy tylko monitorowanej kolekcji i odbiorcy w celu skonfigurowania serializacji używanej w monitorowanej kolekcji. Element `JsonConvert.DefaultSettings` musi być ustawiony w klasie pochodzącej z `CosmosDBWebJobsStartup`klasy .

Właściwość atrybutu	opis
Połączenie	Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z monitorowanym kontem usługi Azure Cosmos DB. Aby uzyskać więcej informacji, zobacz Połączenia.
Nazwa bazy danych	Nazwa bazy danych usługi Azure Cosmos DB z monitorowanym kontenerem.
ContainerName	Nazwa monitorowanego kontenera.
LeaseConnection	(Opcjonalnie) Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z kontem usługi Azure Cosmos DB, które przechowuje kontener dzierżawy. Jeśli nie zostanie ustawiona, zostanie użyta `Connection` wartość. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania w portalu. Parametry połączenia kontenera dzierżaw musi mieć uprawnienia do zapisu.
LeaseDatabaseName	(Opcjonalnie) Nazwa bazy danych, która przechowuje kontener używany do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `databaseName` ustawienia.
LeaseContainerName	(Opcjonalnie) Nazwa kontenera używanego do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `leases` .
CreateLeaseContainerIfNotExists	(Opcjonalnie) Po ustawieniu `true`wartości parametru kontener dzierżaw jest tworzony automatycznie, gdy jeszcze nie istnieje. Domyślna wartość to `false`. W przypadku korzystania z tożsamości entra firmy Microsoft, jeśli ustawisz wartość `true`na , tworzenie kontenerów nie jest dozwoloną operacją , a funkcja nie będzie mogła uruchomić.
LeasesContainerThroughput	(Opcjonalnie) Definiuje liczbę jednostek żądań do przypisania podczas tworzenia kontenera dzierżaw. To ustawienie jest używane tylko wtedy, gdy `CreateLeaseContainerIfNotExists` jest ustawione na `true`. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania przy użyciu portalu.
LeaseContainerPrefix	(Opcjonalnie) Po ustawieniu wartość jest dodawana jako prefiks do dzierżaw utworzonych w kontenerze Dzierżawa dla tej funkcji. Użycie prefiksu umożliwia dwóm oddzielnym usłudze Azure Functions współużytkowania tego samego kontenera dzierżawy przy użyciu różnych prefiksów.
FeedPollDelay	(Opcjonalnie) Czas (w milisekundach) dla opóźnienia między sondowaniem partycji pod kątem nowych zmian w kanale informacyjnym, po opróżnieniu wszystkich bieżących zmian. Wartość domyślna to 5000 milisekund lub 5 sekund.
LeaseAcquireInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał uruchamiania zadania obliczeniowego, jeśli partycje są równomiernie dystrybuowane między znane wystąpienia hosta. Wartość domyślna to 13000 (13 sekund).
LeaseExpirationInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał, dla którego dzierżawa jest wykonywana w dzierżawie reprezentującej partycję. Jeśli dzierżawa nie zostanie odnowiona w tym interwale, spowoduje to wygaśnięcie, a własność partycji zostanie przeniesiona do innego wystąpienia. Wartość domyślna to 60000 (60 sekund).
LeaseRenewInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał odnawiania dla wszystkich dzierżaw dla partycji, które są obecnie przechowywane przez wystąpienie. Wartość domyślna to 17000 (17 sekund).
MaxItemsPerInvocation	(Opcjonalnie) Po ustawieniu ta właściwość ustawia maksymalną liczbę odebranych elementów na wywołanie funkcji. Jeśli operacje w monitorowanym kontenerze są wykonywane za pomocą procedur składowanych, zakres transakcji jest zachowywany podczas odczytywania elementów ze źródła zmian. W związku z tym liczba odebranych elementów może być większa niż określona wartość, aby elementy zmienione przez tę samą transakcję zostały zwrócone w ramach jednej partii niepodzielnej.
StartFromBeginning	(Opcjonalnie) Ta opcja nakazuje wyzwalaczowi odczytywanie zmian od początku historii zmian kontenera zamiast rozpoczynania się od bieżącej godziny. Odczyt od początku działa tylko przy pierwszym uruchomieniu wyzwalacza, tak jak w kolejnych uruchomieniach, punkty kontrolne są już przechowywane. Ustawienie tej opcji na `true` wartość , gdy istnieją już utworzone dzierżawy, nie ma wpływu.
StartFromTime	(Opcjonalnie) Pobiera lub ustawia datę i godzinę, z której ma być inicjowana operacja odczytu zestawienia zmian. Zalecanym formatem jest ISO 8601 z projektantem UTC, takim jak `2021-02-16T14:19:29Z`. Służy to tylko do ustawiania stanu początkowego wyzwalacza. Gdy wyzwalacz ma stan dzierżawy, zmiana tej wartości nie ma wpływu.
PreferredLocations	(Opcjonalnie) Definiuje preferowane lokalizacje (regiony) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB. Wartości powinny być rozdzielane przecinkami. Na przykład "Wschodnie stany USA,Południowo-środkowe stany USA,Europa Północna".

Właściwość atrybutu	opis
ConnectionStringSetting	Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z monitorowanym kontem usługi Azure Cosmos DB. Aby uzyskać więcej informacji, zobacz Połączenia.
Nazwa bazy danych	Nazwa bazy danych usługi Azure Cosmos DB z monitorowaną kolekcją.
CollectionName	Nazwa monitorowanej kolekcji.
LeaseConnectionStringSetting	(Opcjonalnie) Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z kontem usługi Azure Cosmos DB, które przechowuje kolekcję dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta `ConnectionStringSetting` wartość. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania w portalu. Parametry połączenia dla kolekcji dzierżaw musi mieć uprawnienia do zapisu.
LeaseDatabaseName	(Opcjonalnie) Nazwa bazy danych, która zawiera kolekcję używaną do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `databaseName` ustawienia.
LeaseCollectionName	(Opcjonalnie) Nazwa kolekcji używanej do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `leases` .
CreateLeaseCollectionIfNotExists	(Opcjonalnie) Gdy jest ustawiona wartość `true`, kolekcja dzierżaw jest tworzona automatycznie, gdy jeszcze nie istnieje. Domyślna wartość to `false`.
LeasesCollectionThroughput	(Opcjonalnie) Definiuje liczbę jednostek żądań do przypisania podczas tworzenia kolekcji dzierżaw. To ustawienie jest używane tylko wtedy, gdy `CreateLeaseCollectionIfNotExists` jest ustawione na `true`. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania przy użyciu portalu.
LeaseCollectionPrefix	(Opcjonalnie) Po ustawieniu wartość jest dodawana jako prefiks do dzierżaw utworzonych w kolekcji Dzierżawy dla tej funkcji. Użycie prefiksu umożliwia dwóm oddzielnym funkcjom usługi Azure Functions współużytkowania tej samej kolekcji dzierżaw przy użyciu różnych prefiksów.
FeedPollDelay	(Opcjonalnie) Czas (w milisekundach) dla opóźnienia między sondowaniem partycji pod kątem nowych zmian w kanale informacyjnym, po opróżnieniu wszystkich bieżących zmian. Wartość domyślna to 5000 milisekund lub 5 sekund.
LeaseAcquireInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał uruchamiania zadania obliczeniowego, jeśli partycje są równomiernie dystrybuowane między znane wystąpienia hosta. Wartość domyślna to 13000 (13 sekund).
LeaseExpirationInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał, dla którego dzierżawa jest wykonywana w dzierżawie reprezentującej partycję. Jeśli dzierżawa nie zostanie odnowiona w tym interwale, spowoduje to wygaśnięcie, a własność partycji zostanie przeniesiona do innego wystąpienia. Wartość domyślna to 60000 (60 sekund).
LeaseRenewInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał odnawiania dla wszystkich dzierżaw dla partycji, które są obecnie przechowywane przez wystąpienie. Wartość domyślna to 17000 (17 sekund).
Punkt kontrolnyInterval	(Opcjonalnie) Po ustawieniu definiuje interwał między punktami kontrolnymi dzierżawy w milisekundach. Wartość domyślna jest zawsze po każdym wywołaniu funkcji.
CheckpointDocumentCount	(Opcjonalnie) Dostosowuje ilość dokumentów między punktami kontrolnymi dzierżawy. Wartość domyślna jest po każdym wywołaniu funkcji.
MaxItemsPerInvocation	(Opcjonalnie) Po ustawieniu ta właściwość ustawia maksymalną liczbę odebranych elementów na wywołanie funkcji. Jeśli operacje w monitorowanej kolekcji są wykonywane za pomocą procedur składowanych, zakres transakcji jest zachowywany podczas odczytywania elementów ze źródła zmian. W związku z tym liczba odebranych elementów może być większa niż określona wartość, aby elementy zmienione przez tę samą transakcję zostały zwrócone w ramach jednej partii niepodzielnej.
StartFromBeginning	(Opcjonalnie) Ta opcja nakazuje wyzwalaczowi odczytywanie zmian od początku historii zmian kolekcji zamiast rozpoczynać się od bieżącej godziny. Odczyt od początku działa tylko przy pierwszym uruchomieniu wyzwalacza, tak jak w kolejnych uruchomieniach, punkty kontrolne są już przechowywane. Ustawienie tej opcji na `true` wartość , gdy istnieją już utworzone dzierżawy, nie ma wpływu.
PreferredLocations	(Opcjonalnie) Definiuje preferowane lokalizacje (regiony) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB. Wartości powinny być rozdzielane przecinkami. Na przykład "Wschodnie stany USA,Południowo-środkowe stany USA,Europa Północna".
UseMultipleWriteLocations	(Opcjonalnie) Umożliwia zapisywanie kont w wielu regionach w kolekcji dzierżaw.
UseDefaultJsonSerialization	(Opcjonalnie) Umożliwia korzystanie z `JsonConvert.DefaultSettings` monitorowanej kolekcji. To ustawienie dotyczy tylko monitorowanej kolekcji i odbiorcy w celu skonfigurowania serializacji używanej w monitorowanej kolekcji. Element `JsonConvert.DefaultSettings` musi być ustawiony w klasie pochodzącej z `CosmosDBWebJobsStartup`klasy .

Dekoratory

Dotyczy tylko modelu programowania w wersji 2 języka Python.

W przypadku funkcji języka Python w wersji 2 zdefiniowanych przy użyciu dekoratora następujące właściwości w pliku cosmos_db_trigger:

Właściwości	opis
`arg_name`	Nazwa zmiennej używana w kodzie funkcji, która reprezentuje listę dokumentów ze zmianami.
`database_name`	Nazwa bazy danych usługi Azure Cosmos DB z monitorowaną kolekcją.
`collection_name`	Nazwa monitorowanej kolekcji usługi Azure Cosmos DB.
`connection`	Parametry połączenia monitorowanej usługi Azure Cosmos DB.

Aby zapoznać się z funkcjami języka Python zdefiniowanymi przy użyciu function.json, zobacz sekcję Konfiguracja .

Użyj adnotacji @CosmosDBTrigger dotyczącej parametrów odczytujących dane z usługi Azure Cosmos DB. Adnotacja obsługuje następujące właściwości:

Właściwość atrybutu	opis
połączenie	Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z monitorowanym kontem usługi Azure Cosmos DB. Aby uzyskać więcej informacji, zobacz Połączenia.
name	Nazwa funkcji.
databaseName	Nazwa bazy danych usługi Azure Cosmos DB z monitorowanym kontenerem.
containerName	Nazwa monitorowanego kontenera.
leaseConnectionStringSetting	(Opcjonalnie) Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z kontem usługi Azure Cosmos DB, które przechowuje kontener dzierżawy. Jeśli nie zostanie ustawiona, zostanie użyta `Connection` wartość. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania w portalu. Parametry połączenia kontenera dzierżaw musi mieć uprawnienia do zapisu.
leaseDatabaseName	(Opcjonalnie) Nazwa bazy danych, która przechowuje kontener używany do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `databaseName` ustawienia.
leaseContainerName	(Opcjonalnie) Nazwa kontenera używanego do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `leases` .
createLeaseContainerIfNotExists	(Opcjonalnie) Po ustawieniu `true`wartości parametru kontener dzierżaw jest tworzony automatycznie, gdy jeszcze nie istnieje. Domyślna wartość to `false`. W przypadku korzystania z tożsamości entra firmy Microsoft, jeśli ustawisz wartość na `true`, tworzenie kontenerów nie jest dozwoloną operacją , a funkcja nie zostanie uruchomiona.
leasesContainerThroughput	(Opcjonalnie) Definiuje liczbę jednostek żądań do przypisania podczas tworzenia kontenera dzierżaw. To ustawienie jest używane tylko wtedy, gdy `CreateLeaseContainerIfNotExists` jest ustawione na `true`. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania przy użyciu portalu.
leaseContainerPrefix	(Opcjonalnie) Po ustawieniu wartość jest dodawana jako prefiks do dzierżaw utworzonych w kontenerze Dzierżawa dla tej funkcji. Użycie prefiksu umożliwia dwóm oddzielnym usłudze Azure Functions współużytkowania tego samego kontenera dzierżawy przy użyciu różnych prefiksów.
feedPollDelay	(Opcjonalnie) Czas (w milisekundach) dla opóźnienia między sondowaniem partycji pod kątem nowych zmian w kanale informacyjnym, po opróżnieniu wszystkich bieżących zmian. Wartość domyślna to 5000 milisekund lub 5 sekund.
leaseAcquireInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał uruchamiania zadania obliczeniowego, jeśli partycje są równomiernie dystrybuowane między znane wystąpienia hosta. Wartość domyślna to 13000 (13 sekund).
leaseExpirationInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał, dla którego dzierżawa jest wykonywana w dzierżawie reprezentującej partycję. Jeśli dzierżawa nie zostanie odnowiona w tym interwale, wygaśnie, a własność partycji zostanie przeniesiona do innego wystąpienia. Wartość domyślna to 60000 (60 sekund).
leaseRenewInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał odnawiania dla wszystkich dzierżaw dla partycji, które są obecnie przechowywane przez wystąpienie. Wartość domyślna to 17000 (17 sekund).
maxItemsPerInvocation	(Opcjonalnie) Po ustawieniu ta właściwość ustawia maksymalną liczbę odebranych elementów na wywołanie funkcji. Jeśli operacje w monitorowanym kontenerze są wykonywane za pomocą procedur składowanych, zakres transakcji jest zachowywany podczas odczytywania elementów ze źródła zmian. W związku z tym liczba odebranych elementów może być większa niż określona wartość, aby elementy zmienione przez tę samą transakcję zostały zwrócone w ramach jednej partii niepodzielnej.
startFromBeginning	(Opcjonalnie) Ta opcja nakazuje wyzwalaczowi odczytywanie zmian od początku historii zmian kontenera zamiast rozpoczynania się od bieżącej godziny. Odczyt od początku działa tylko przy pierwszym uruchomieniu wyzwalacza, tak jak w kolejnych uruchomieniach, punkty kontrolne są już przechowywane. Ustawienie tej opcji na `true` wartość , gdy istnieją już utworzone dzierżawy, nie ma wpływu.
preferredLocations	(Opcjonalnie) Definiuje preferowane lokalizacje (regiony) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB. Wartości powinny być rozdzielane przecinkami. Na przykład "Wschodnie stany USA,Południowo-środkowe stany USA,Europa Północna".

Z biblioteki środowiska uruchomieniowego funkcji Języka Java użyj @CosmosDBTrigger adnotacji dotyczącej parametrów odczytujących dane z usługi Azure Cosmos DB. Adnotacja obsługuje następujące właściwości:

Konfigurowanie

Dotyczy tylko modelu programowania języka Python w wersji 1.

Model w wersji 4
Model w wersji 3

W poniższej tabeli opisano właściwości, które można ustawić dla options obiektu przekazanego app.cosmosDB() do metody . Właściwości type, directioni name nie mają zastosowania do modelu w wersji 4.

W poniższej tabeli opisano właściwości konfiguracji powiązania ustawione w pliku function.json , gdzie właściwości różnią się wersją rozszerzenia:

Rozszerzenie 4.x+
Funkcje 2.x+

właściwość function.json	opis
type	Musi być ustawiona wartość `cosmosDBTrigger`.
direction	Musi być ustawiona wartość `in`. Ten parametr jest ustawiany automatycznie podczas tworzenia wyzwalacza w witrynie Azure Portal.
name	Nazwa zmiennej używana w kodzie funkcji, która reprezentuje listę dokumentów ze zmianami.
połączenie	Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z monitorowanym kontem usługi Azure Cosmos DB. Aby uzyskać więcej informacji, zobacz Połączenia.
databaseName	Nazwa bazy danych usługi Azure Cosmos DB z monitorowanym kontenerem.
containerName	Nazwa monitorowanego kontenera.
leaseConnection	(Opcjonalnie) Nazwa ustawienia aplikacji lub kontenera ustawień, który określa sposób nawiązywania połączenia z kontem usługi Azure Cosmos DB, które przechowuje kontener dzierżawy. Jeśli nie zostanie ustawiona, zostanie użyta `connection` wartość. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania w portalu. Parametry połączenia kontenera dzierżaw musi mieć uprawnienia do zapisu.
leaseDatabaseName	(Opcjonalnie) Nazwa bazy danych, która przechowuje kontener używany do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `databaseName` ustawienia.
leaseContainerName	(Opcjonalnie) Nazwa kontenera używanego do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `leases` .
createLeaseContainerIfNotExists	(Opcjonalnie) Po ustawieniu `true`wartości parametru kontener dzierżaw jest tworzony automatycznie, gdy jeszcze nie istnieje. Domyślna wartość to `false`. W przypadku korzystania z tożsamości entra firmy Microsoft, jeśli ustawisz wartość `true`na , tworzenie kontenerów nie jest dozwoloną operacją , a funkcja nie będzie mogła uruchomić.
leasesContainerThroughput	(Opcjonalnie) Definiuje liczbę jednostek żądań do przypisania podczas tworzenia kontenera dzierżaw. To ustawienie jest używane tylko wtedy, gdy `createLeaseContainerIfNotExists` jest ustawione na `true`. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania przy użyciu portalu.
leaseContainerPrefix	(Opcjonalnie) Po ustawieniu wartość jest dodawana jako prefiks do dzierżaw utworzonych w kontenerze Dzierżawa dla tej funkcji. Użycie prefiksu umożliwia dwóm oddzielnym usłudze Azure Functions współużytkowania tego samego kontenera dzierżawy przy użyciu różnych prefiksów.
feedPollDelay	(Opcjonalnie) Czas (w milisekundach) dla opóźnienia między sondowaniem partycji pod kątem nowych zmian w kanale informacyjnym, po opróżnieniu wszystkich bieżących zmian. Wartość domyślna to 5000 milisekund lub 5 sekund.
leaseAcquireInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał uruchamiania zadania obliczeniowego, jeśli partycje są równomiernie dystrybuowane między znane wystąpienia hosta. Wartość domyślna to 13000 (13 sekund).
leaseExpirationInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał, dla którego dzierżawa jest wykonywana w dzierżawie reprezentującej partycję. Jeśli dzierżawa nie zostanie odnowiona w tym interwale, spowoduje to wygaśnięcie, a własność partycji zostanie przeniesiona do innego wystąpienia. Wartość domyślna to 60000 (60 sekund).
leaseRenewInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał odnawiania dla wszystkich dzierżaw dla partycji, które są obecnie przechowywane przez wystąpienie. Wartość domyślna to 17000 (17 sekund).
maxItemsPerInvocation	(Opcjonalnie) Po ustawieniu ta właściwość ustawia maksymalną liczbę odebranych elementów na wywołanie funkcji. Jeśli operacje w monitorowanym kontenerze są wykonywane za pomocą procedur składowanych, zakres transakcji jest zachowywany podczas odczytywania elementów ze źródła zmian. W związku z tym liczba odebranych elementów może być większa niż określona wartość, aby elementy zmienione przez tę samą transakcję zostały zwrócone w ramach jednej partii niepodzielnej.
startFromBeginning	(Opcjonalnie) Ta opcja nakazuje wyzwalaczowi odczytywanie zmian od początku historii zmian kontenera zamiast rozpoczynania się od bieżącej godziny. Odczyt od początku działa tylko przy pierwszym uruchomieniu wyzwalacza, tak jak w kolejnych uruchomieniach, punkty kontrolne są już przechowywane. Ustawienie tej opcji na `true` wartość , gdy istnieją już utworzone dzierżawy, nie ma wpływu.
startFromTime	(Opcjonalnie) Pobiera lub ustawia datę i godzinę, z której ma być inicjowana operacja odczytu zestawienia zmian. Zalecanym formatem jest ISO 8601 z projektantem UTC, takim jak `2021-02-16T14:19:29Z`. Służy to tylko do ustawiania stanu początkowego wyzwalacza. Gdy wyzwalacz ma stan dzierżawy, zmiana tej wartości nie ma wpływu.
preferredLocations	(Opcjonalnie) Definiuje preferowane lokalizacje (regiony) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB. Wartości powinny być rozdzielane przecinkami. Na przykład "Wschodnie stany USA,Południowo-środkowe stany USA,Europa Północna".

właściwość function.json	opis
type	Musi być ustawiona wartość `cosmosDBTrigger`.
direction	Musi być ustawiona wartość `in`. Ten parametr jest ustawiany automatycznie podczas tworzenia wyzwalacza w witrynie Azure Portal.
name	Nazwa zmiennej używana w kodzie funkcji, która reprezentuje listę dokumentów ze zmianami.
connectionStringSetting	Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z monitorowanym kontem usługi Azure Cosmos DB. Aby uzyskać więcej informacji, zobacz Połączenia.
databaseName	Nazwa bazy danych usługi Azure Cosmos DB z monitorowaną kolekcją.
collectionName	Nazwa monitorowanej kolekcji.
leaseConnectionStringSetting	(Opcjonalnie) Nazwa ustawienia aplikacji lub kolekcji ustawień, która określa sposób nawiązywania połączenia z kontem usługi Azure Cosmos DB, które przechowuje kolekcję dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta `connectionStringSetting` wartość. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania w portalu. Parametry połączenia dla kolekcji dzierżaw musi mieć uprawnienia do zapisu.
leaseDatabaseName	(Opcjonalnie) Nazwa bazy danych, która zawiera kolekcję używaną do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `databaseName` ustawienia.
leaseCollectionName	(Opcjonalnie) Nazwa kolekcji używanej do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość `leases` .
createLeaseCollectionIfNotExists	(Opcjonalnie) Gdy jest ustawiona wartość `true`, kolekcja dzierżaw jest tworzona automatycznie, gdy jeszcze nie istnieje. Domyślna wartość to `false`.
leasesCollectionThroughput	(Opcjonalnie) Definiuje liczbę jednostek żądań do przypisania podczas tworzenia kolekcji dzierżaw. To ustawienie jest używane tylko wtedy, gdy `createLeaseCollectionIfNotExists` jest ustawione na `true`. Ten parametr jest ustawiany automatycznie podczas tworzenia powiązania przy użyciu portalu.
leaseCollectionPrefix	(Opcjonalnie) Po ustawieniu wartość jest dodawana jako prefiks do dzierżaw utworzonych w kolekcji Dzierżawy dla tej funkcji. Użycie prefiksu umożliwia dwóm oddzielnym funkcjom usługi Azure Functions współużytkowania tej samej kolekcji dzierżaw przy użyciu różnych prefiksów.
feedPollDelay	(Opcjonalnie) Czas (w milisekundach) dla opóźnienia między sondowaniem partycji pod kątem nowych zmian w kanale informacyjnym, po opróżnieniu wszystkich bieżących zmian. Wartość domyślna to 5000 milisekund lub 5 sekund.
leaseAcquireInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał uruchamiania zadania obliczeniowego, jeśli partycje są równomiernie dystrybuowane między znane wystąpienia hosta. Wartość domyślna to 13000 (13 sekund).
leaseExpirationInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał, dla którego dzierżawa jest wykonywana w dzierżawie reprezentującej partycję. Jeśli dzierżawa nie zostanie odnowiona w tym interwale, spowoduje to wygaśnięcie, a własność partycji zostanie przeniesiona do innego wystąpienia. Wartość domyślna to 60000 (60 sekund).
leaseRenewInterval	(Opcjonalnie) Po ustawieniu definiuje, w milisekundach, interwał odnawiania dla wszystkich dzierżaw dla partycji, które są obecnie przechowywane przez wystąpienie. Wartość domyślna to 17000 (17 sekund).
checkpointInterval	(Opcjonalnie) Po ustawieniu definiuje interwał między punktami kontrolnymi dzierżawy w milisekundach. Wartość domyślna jest zawsze po każdym wywołaniu funkcji.
checkpointDocumentCount	(Opcjonalnie) Dostosowuje ilość dokumentów między punktami kontrolnymi dzierżawy. Wartość domyślna jest po każdym wywołaniu funkcji.
maxItemsPerInvocation	(Opcjonalnie) Po ustawieniu ta właściwość ustawia maksymalną liczbę odebranych elementów na wywołanie funkcji. Jeśli operacje w monitorowanej kolekcji są wykonywane za pomocą procedur składowanych, zakres transakcji jest zachowywany podczas odczytywania elementów ze źródła zmian. W związku z tym liczba odebranych elementów może być większa niż określona wartość, aby elementy zmienione przez tę samą transakcję zostały zwrócone w ramach jednej partii niepodzielnej.
startFromBeginning	(Opcjonalnie) Ta opcja nakazuje wyzwalaczowi odczytywanie zmian od początku historii zmian kolekcji zamiast rozpoczynać się od bieżącej godziny. Odczyt od początku działa tylko przy pierwszym uruchomieniu wyzwalacza, tak jak w kolejnych uruchomieniach, punkty kontrolne są już przechowywane. Ustawienie tej opcji na `true` wartość , gdy istnieją już utworzone dzierżawy, nie ma wpływu.
preferredLocations	(Opcjonalnie) Definiuje preferowane lokalizacje (regiony) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB. Wartości powinny być rozdzielane przecinkami. Na przykład "Wschodnie stany USA,Południowo-środkowe stany USA,Europa Północna".
useMultipleWriteLocations	(Opcjonalnie) Umożliwia zapisywanie kont w wielu regionach w kolekcji dzierżaw.

Zobacz sekcję Przykład, aby zapoznać się z kompletnymi przykładami.

Użycie

Wyzwalacz wymaga drugiej kolekcji używanej do przechowywania dzierżaw w partycjach. Zarówno monitorowana kolekcja, jak i kolekcja zawierająca dzierżawy muszą być dostępne, aby wyzwalacz działał.

Ważne

Jeśli wiele funkcji jest skonfigurowanych do używania wyzwalacza usługi Azure Cosmos DB dla tej samej kolekcji, każda z funkcji powinna używać dedykowanej kolekcji dzierżaw lub określać inną LeaseCollectionPrefix dla każdej funkcji. W przeciwnym razie wyzwalana jest tylko jedna z funkcji. Aby uzyskać informacje o prefiksie, zobacz sekcję Atrybuty.

Ważne

Jeśli wiele funkcji jest skonfigurowanych do używania wyzwalacza usługi Azure Cosmos DB dla tej samej kolekcji, każda z funkcji powinna używać dedykowanej kolekcji dzierżaw lub określać inną leaseCollectionPrefix dla każdej funkcji. W przeciwnym razie wyzwalana jest tylko jedna z funkcji. Aby uzyskać informacje o prefiksie, zobacz sekcję Adnotacje.

Ważne

Jeśli wiele funkcji jest skonfigurowanych do używania wyzwalacza usługi Azure Cosmos DB dla tej samej kolekcji, każda z funkcji powinna używać dedykowanej kolekcji dzierżaw lub określać inną leaseCollectionPrefix dla każdej funkcji. W przeciwnym razie zostanie wyzwolona tylko jedna z funkcji. Aby uzyskać informacje o prefiksie, zobacz sekcję Konfiguracja.

Wyzwalacz nie wskazuje, czy dokument został zaktualizowany, czy wstawiony, tylko udostępnia sam dokument. Jeśli musisz obsługiwać aktualizacje i wstawiać inaczej, możesz to zrobić, implementując pola znacznika czasu na potrzeby wstawiania lub aktualizacji.

Typ parametru obsługiwany przez wyzwalacz usługi Azure Cosmos DB zależy od wersji środowiska uruchomieniowego usługi Functions, wersji pakietu rozszerzenia i używanej modalności języka C#.

Jeśli chcesz, aby funkcja przetwarzała pojedynczy dokument, wyzwalacz usługi Cosmos DB może powiązać z następującymi typami:

Type	Opis
Typy serializowalne w formacie JSON	Usługa Functions próbuje wykonać deserializacji danych JSON dokumentu z zestawienia zmian usługi Cosmos DB na zwykły typ obiektu CLR (POCO).

Jeśli chcesz, aby funkcja przetwarzała partię dokumentów, wyzwalacz usługi Cosmos DB może powiązać z następującymi typami:

Type	Opis
`IEnumerable<T>`gdzie `T` jest typem serializowalnym JSON	Wyliczenie jednostek uwzględnionych w partii. Każdy wpis reprezentuje jeden dokument ze źródła zmian usługi Cosmos DB.

Połączenia

Właściwości connectionStringSetting/connection i leaseConnectionStringSetting/leaseConnection są odwołaniami do konfiguracji środowiska, która określa sposób łączenia aplikacji z usługą Azure Cosmos DB. Mogą one określać:

Nazwa ustawienia aplikacji zawierającego parametry połączenia
Nazwa udostępnionego prefiksu dla wielu ustawień aplikacji, definiująca połączenie oparte na tożsamościach. Ta opcja jest dostępna tylko dla connection wersji i leaseConnection z wersji 4.x lub nowszej rozszerzenia.

Jeśli skonfigurowana wartość jest dokładnie zgodna z pojedynczym ustawieniem i dopasowaniem prefiksu dla innych ustawień, zostanie użyte dokładne dopasowanie.

Connection string

Parametry połączenia dla konta bazy danych powinny być przechowywane w ustawieniu aplikacji z nazwą zgodną z wartością określoną przez właściwość połączenia konfiguracji powiązania.

Połączenia oparte na tożsamościach

Jeśli używasz rozszerzenia w wersji 4.x lub nowszej, zamiast używać parametry połączenia z wpisem tajnym, możesz użyć tożsamości Microsoft Entra. W tym celu należy zdefiniować ustawienia w ramach wspólnego prefiksu, który mapuje na właściwość connection w konfiguracji wyzwalacza i powiązania.

W tym trybie rozszerzenie wymaga następujących właściwości:

Właściwości	Szablon zmiennej środowiskowej	opis	Przykładowa wartość
Punkt końcowy konta	`<CONNECTION_NAME_PREFIX>__accountEndpoint`	Identyfikator URI punktu końcowego konta usługi Azure Cosmos DB.	<https:// database_account_name.documents.azure.com:443/>

Aby dostosować połączenie, można ustawić dodatkowe właściwości. Zobacz Typowe właściwości połączeń opartych na tożsamościach.

W przypadku hostowania w usłudze Azure Functions połączenia oparte na tożsamościach używają tożsamości zarządzanej. Tożsamość przypisana przez system jest używana domyślnie, chociaż tożsamości przypisanej przez użytkownika można określić za credential pomocą właściwości i clientID . Należy pamiętać, że konfigurowanie tożsamości przypisanej przez użytkownika przy użyciu identyfikatora zasobu nie jest obsługiwane. W przypadku uruchamiania w innych kontekstach, takich jak programowanie lokalne, tożsamość dewelopera jest używana, chociaż można to dostosować. Zobacz Programowanie lokalne z połączeniami opartymi na tożsamościach.

Udzielanie uprawnień tożsamości

Niezależnie od używanej tożsamości musi mieć uprawnienia do wykonywania zamierzonych akcji. W przypadku większości usług platformy Azure oznacza to, że musisz przypisać rolę w kontroli dostępu opartej na rolach platformy Azure przy użyciu wbudowanych lub niestandardowych ról, które zapewniają te uprawnienia.

Ważne

Niektóre uprawnienia mogą być uwidocznione przez usługę docelową, które nie są niezbędne dla wszystkich kontekstów. Jeśli to możliwe, przestrzegaj zasady najniższych uprawnień, udzielając tożsamości tylko wymaganych uprawnień. Jeśli na przykład aplikacja musi mieć możliwość odczytu tylko ze źródła danych, użyj roli, która ma uprawnienia tylko do odczytu. Niewłaściwe byłoby przypisanie roli, która umożliwia również zapisywanie w tej usłudze, ponieważ byłoby to nadmierne uprawnienie do operacji odczytu. Podobnie należy upewnić się, że przypisanie roli jest ograniczone tylko do zasobów, które należy odczytać.

Usługa Cosmos DB nie używa kontroli dostępu opartej na rolach platformy Azure na potrzeby operacji na danych. Zamiast tego używa wbudowanego systemu RBAC usługi Cosmos DB, który jest oparty na podobnych pojęciach. Należy utworzyć przypisanie roli, które zapewnia dostęp do konta bazy danych w czasie wykonywania. Role zarządzania RBAC platformy Azure, takie jak Właściciel , nie są wystarczające. W poniższej tabeli przedstawiono wbudowane role, które są zalecane podczas korzystania z rozszerzenia usługi Azure Cosmos DB w normalnej operacji. Aplikacja może wymagać dodatkowych uprawnień na podstawie zapisanego kodu.

Typ powiązania	Przykładowe wbudowane role¹
Wyzwalacz²	Współautor danych wbudowanych w usłudze Cosmos DB
Powiązanie wejściowe	Wbudowany czytnik danych usługi Cosmos DB
Powiązanie wyjściowe	Współautor danych wbudowanych w usłudze Cosmos DB

¹ Tych ról nie można używać w przypisaniu roli RBAC platformy Azure. Aby uzyskać szczegółowe informacje na temat przypisywania tych ról, zobacz wbudowaną dokumentację systemu RBAC usługi Cosmos DB.

² W przypadku korzystania z tożsamości usługa Cosmos DB traktuje tworzenie kontenera jako operację zarządzania. Nie jest ona dostępna jako operacja płaszczyzny danych dla wyzwalacza. Przed skonfigurowaniem funkcji należy upewnić się, że utworzysz kontenery wymagane przez wyzwalacz (w tym kontener dzierżawy).

Udostępnij za pośrednictwem

Wyzwalacz usługi Azure Cosmos DB dla usługi Azure Functions w wersji 2.x lub nowszej

Przykład

Atrybuty

Dekoratory

Adnotacje

Konfigurowanie

Użycie

Połączenia

Connection string

Połączenia oparte na tożsamościach

Udzielanie uprawnień tożsamości

Następne kroki

Opinia

Dodatkowe zasoby