триггер Azure Cosmos DB для Функции Azure 2.x и более поздних версий

Триггер Azure Cosmos DB использует канал изменений Azure Cosmos DB для прослушивания вставок и обновлений между секциями. Канал изменений публикует новые и обновленные элементы, не включая обновления из удаления. Полный сценарий, использующий триггер Azure Cosmos DB, см. в разделе Quickstart: реагирование на изменения базы данных в Azure Cosmos DB с помощью Функции Azure.

Сведения об установке и настройке см. в обзорной статье.

Решения по масштабированию Cosmos DB для планов "Потребление" и "Премиум" выполняются с помощью масштабирования на основе целевого объекта. Дополнительные сведения см. в статье о масштабировании на основе целевого объекта.

Внимание

В этой статье используются вкладки для поддержки нескольких версий модели программирования Node.js. Модель версии 4 общедоступна и предназначена для более гибкого и интуитивно понятного интерфейса для разработчиков JavaScript и TypeScript. Дополнительные сведения о работе модели версии 4 см. в руководстве разработчика Функции Azure Node.js разработчика. Дополнительные сведения о различиях между версиями 3 и 4 см. в руководстве по миграции.

Функции Azure поддерживает две модели программирования для Python. Способ определения привязок зависит от выбранной модели программирования.

версия 2

Модель программирования Python версии 2 позволяет определять привязки с помощью декораторов непосредственно в коде функции Python. Дополнительные сведения см. в руководстве разработчика Python.

версия 1

Модель программирования Python версии 1 требует определения привязок в отдельном файле function.json в папке функции. Дополнительные сведения см. в руководстве разработчика Python.

Эта статья поддерживает обе модели программирования.

Пример

Использование триггера зависит от версии пакета расширения и модальности C#, применяемой в приложении-функции. Это может быть один из следующих вариантов:

Изолированная рабочая модель

Изолированная библиотека классов рабочих процессов, скомпилированная функция C# выполняется в процессе, изолированном от среды выполнения.

Модель внутрипроцессного процесса

Внимание

Поддержка будет завершена для модели в процессе 10 ноября 2026 г. Настоятельно рекомендуется перенести приложения в изолированную рабочую модель для полной поддержки.

Библиотека внутрипроцессных классов — это скомпилированная функция C#, которая выполняется в том же процессе, что и среда выполнения Функций.

Следующие примеры зависят от версии расширения для заданного режима C#.

Расширение 4.x+

Приложения, использующие расширение Azure Cosmos DB версии 4.x или более поздней версии, используют различные свойства атрибутов. В этом разделе показаны эти свойства. В этом примере используются ссылки на параметры приложения и включается обработка ошибок.

namespace CosmosDBSamplesV2
{
    public class ToDoItem
    {
        public string id { get; set; }
        public string Description { get; set; }
    }
}

using System;
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: "%COSMOS_DATABASE_NAME%",
            containerName: "%COSMOS_CONTAINER_NAME%",
            Connection = "COSMOS_CONNECTION",
            LeaseContainerName = "leases",
            CreateLeaseContainerIfNotExists = true)]IReadOnlyList<ToDoItem> documents, ILogger log)
        {
            if (documents != null && documents.Count > 0)
            {
                log.LogInformation("Documents modified: {count}", documents.Count);
                foreach (var doc in documents)
                {
                    try
                    {
                        log.LogInformation("Processing document Id: {id}", doc.id);
                        // Add your business logic here
                    }
                    catch (Exception ex)
                    {
                        log.LogError(ex, "Error processing document {id}", doc.id);
                        // Continue processing remaining documents
                    }
                }
            }
        }

        [FunctionName("health")]
        public static IActionResult HealthCheck(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "health")] HttpRequest req)
        {
            return new OkResult();
        }
    }
}

В предыдущем примере используются ссылки на параметры приложения (%VAR_NAME%) вместо жестко закодированных значений.

Параметры приложения

Настройте эти параметры приложения для подключений на основе удостоверений:

Setting	Description	Пример
COSMOS_DATABASE_NAME	Имя базы данных Azure Cosmos DB	my-database
COSMOS_CONTAINER_NAME	Имя контейнера для мониторинга	my-container
COSMOS_CONNECTION__accountEndpoint	конечная точка учетной записи Azure Cosmos DB	https://mycosmosdb.documents.azure.com:443/
COSMOS_CONNECTION__credential	Для UAMI задано значение managedidentity	managedidentity
COSMOS_CONNECTION__clientId	Идентификатор клиента управляемой идентичности, назначенной пользователем	00000000-0000-0000-0000-000000000000

Локальная разработка

Для локальной разработки local.settings.json создайте файл:

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobsStorage": "UseDevelopmentStorage=true",
        "FUNCTIONS_WORKER_RUNTIME": "dotnet",
        "COSMOS_DATABASE_NAME": "my-database",
        "COSMOS_CONTAINER_NAME": "my-container",
        "COSMOS_CONNECTION__accountEndpoint": "https://mycosmosdb.documents.azure.com:443/"
    }
}

Подсказка

Для локальной разработки опущений COSMOS_CONNECTION__credential и COSMOS_CONNECTION__clientId. DefaultAzureCredential пытается выполнить несколько учетных данных, включая учетные данные входа Azure CLI.

Необходимые условия для локальной разработки:

• Azure CLI с завершенным az login
• Запущен эмулятор хранилища Azurite (azurite --silent)

Функции 2.x+

В следующем примере показана функция C# , которая выполняется при вставке или обновлении в указанной базе данных и коллекции.

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}");
            }
        }
    }
}

Расширение 4.x+

В этом примере используются ссылки на параметры приложения и включается обработка ошибок. Сначала определите тип модели:

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

Следующая функция выполняется при вставке или обновлении в указанной базе данных и контейнере:

[Function("CosmosTrigger")]
public void Run([CosmosDBTrigger(
    databaseName: "%COSMOS_DATABASE_NAME%",
    containerName: "%COSMOS_CONTAINER_NAME%",
    Connection = "COSMOS_CONNECTION",
    LeaseContainerName = "leases",
    CreateLeaseContainerIfNotExists = true)] IReadOnlyList<ToDoItem> documents,
    FunctionContext context)
{
    if (documents is not null && documents.Any())
    {
        _logger.LogInformation("Documents modified: {count}", documents.Count);
        foreach (var doc in documents)
        {
            try
            {
                _logger.LogInformation("Processing document Id: {id}", doc.Id);
                // Add your business logic here
            }
            catch (Exception ex)
            {
                _logger.LogError(ex, "Error processing document {id}", doc.Id);
                // Continue processing remaining documents
            }
        }
    }
}

[Function("health")]
public IActionResult HealthCheck([HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "health")] HttpRequest req)
{
    return new OkResult();
}

В предыдущем примере используются ссылки на параметры приложения (%VAR_NAME%) вместо жестко закодированных значений. Сведения о конфигурации см. на вкладке "Параметры приложения" и руководство по локальной разработке.

Функции 2.x+

Следующий код определяет тип MyDocument:

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

    public string? Text { get; set; }

    public int Number { get; set; }

    public bool Boolean { get; set; }
}

В следующем примере используется IReadOnlyList<T> в качестве параметра привязки триггера Azure Cosmos DB:

[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;
}

В этом примере требуются следующие using инструкции:

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

Эта функция вызывается при вставке или обновлении в указанной базе данных и контейнере.

Расширение 4.x+

Из-за изменений схемы в пакете SDK Azure Cosmos DB версии 4.x расширения Azure Cosmos DB требуется azure-functions-java-library версии 3.0.0 для функций 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());
    }

Функции 2.x+

    @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.");
            }

В библиотеке среды выполнения функций Java используйте заметку @CosmosDBTrigger для параметров, значение которых исходит от Azure Cosmos DB. Используйте эту заметку с собственными типами Java, обычными объектами Java (POJOs) или значениями, допускаемыми значением NULL, с помощью Optional<T>.

Модель версии 4

В следующем примере показана функция триггера Azure Cosmos DB TypeScript. Функция записывает сообщения журнала при добавлении или изменении записей 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,
});

Модель версии 3

Примеры TypeScript не документируются для модели версии 3.

Модель версии 4

В следующем примере показана функция триггера Azure Cosmos DB JavaScript. Функция записывает сообщения журнала при добавлении или изменении записей 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`);
    },
});

Модель версии 3

В следующем примере показана привязка триггера Azure Cosmos DB в файле function.json и функция JavaScript, использующая привязку. Функция записывает сообщения журнала при добавлении или изменении записей Azure Cosmos DB.

Данные привязки в файле function.json:

Функции 2.x+

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

Функции 4.x+

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

Обратите внимание, что некоторые имена атрибутов привязки изменились в версии 4.x расширения Azure Cosmos DB.

Ниже показан код JavaScript.

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

В следующем примере показано, как запустить функцию в качестве изменений данных в Azure Cosmos DB.

Функции 2.x+

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

Функции 4.x+

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

Обратите внимание, что некоторые имена атрибутов привязки изменились в версии 4.x расширения Azure Cosmos DB.

В файле run.ps1 вы имеете доступ к документу, активирующему функцию, через параметр $Documents.

param($Documents, $TriggerMetadata) 

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

В следующем примере показана привязка триггера Azure Cosmos DB. Пример зависит от того, используется ли модель программирования v1 или версии Python 2.

версия 2

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="CosmosDBTrigger")
@app.cosmos_db_trigger(arg_name="documents", 
                       database_name="%COSMOS_DATABASE_NAME%", 
                       container_name="%COSMOS_CONTAINER_NAME%",
                       connection="COSMOS_CONNECTION",
                       lease_container_name="leases",
                       create_lease_container_if_not_exists="true")
def cosmos_trigger(documents: func.DocumentList) -> str:
    if documents:
        for doc in documents:
            try:
                logging.info('Processing document id: %s', doc['id'])
                # Add your business logic here
            except Exception as e:
                logging.error('Error processing document %s: %s', doc.get('id', 'unknown'), str(e))
                # Continue processing remaining documents

@app.function_name(name="health")
@app.route(route="health", methods=["GET"])
def health_check(req: func.HttpRequest) -> func.HttpResponse:
    """Health check endpoint for monitoring."""
    return func.HttpResponse("OK", status_code=200)

В предыдущем примере используются ссылки на параметры приложения (%VAR_NAME%) вместо жестко закодированных значений.

Параметры приложения

Настройте эти параметры приложения для подключений на основе удостоверений:

Setting	Description	Пример
COSMOS_DATABASE_NAME	Имя базы данных Azure Cosmos DB	my-database
COSMOS_CONTAINER_NAME	Имя контейнера для мониторинга	my-container
COSMOS_CONNECTION__accountEndpoint	конечная точка учетной записи Azure Cosmos DB	https://mycosmosdb.documents.azure.com:443/
COSMOS_CONNECTION__credential	Для UAMI задано значение managedidentity	managedidentity
COSMOS_CONNECTION__clientId	Идентификатор клиента управляемой идентичности, назначенной пользователем	00000000-0000-0000-0000-000000000000

Локальная разработка

Для локальной разработки local.settings.json создайте файл:

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobsStorage": "UseDevelopmentStorage=true",
        "FUNCTIONS_WORKER_RUNTIME": "python",
        "COSMOS_DATABASE_NAME": "my-database",
        "COSMOS_CONTAINER_NAME": "my-container",
        "COSMOS_CONNECTION__accountEndpoint": "https://mycosmosdb.documents.azure.com:443/"
    }
}

Подсказка

Для локальной разработки опущений COSMOS_CONNECTION__credential и COSMOS_CONNECTION__clientId. DefaultAzureCredential пытается выполнить несколько учетных данных, включая учетные данные входа Azure CLI.

Необходимые условия для локальной разработки:

• Azure CLI с завершенным az login
• Запущен эмулятор хранилища Azurite (azurite --silent)

версия 1

Функция записывает сообщения журнала при изменении Azure Cosmos DB записей. Данные привязки в файле function.json:

Функции 2.x+

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

Функции 4.x+

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

Обратите внимание, что некоторые имена атрибутов привязки изменились в версии 4.x расширения Azure Cosmos DB.

Ниже приведен код 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'])

Атрибуты

Библиотеки C# для определения функции используются как внутрипроцессные, так и CosmosDBTriggerAttribute библиотеки C#. Вместо этого скрипт C# использует файл конфигурации function.json, как описано в руководстве по скриптам C#.

Определенные свойства зависят от модели процесса и версии расширения:

Расширение 4.x+

Библиотеки в процессе используют CosmosDBTriggerAttribute из пространства имен Майкрософт.Azure.WebJobs, которое определяет следующие свойства:

Свойство атрибута	Description
Соединение	Имя коллекции параметров или параметров приложения, указывающее, как подключиться к отслеживаемой учетной записи Azure Cosmos DB. Дополнительные сведения см. в разделе Соединения.
DatabaseName	Имя базы данных Azure Cosmos DB с отслеживаемой контейнером.
Имя контейнера	Имя отслеживаемого контейнера.
LeaseConnection	(Необязательно) Имя параметра или коллекции параметров приложения, указывающее, как подключиться к учетной записи Azure Cosmos DB, содержащей контейнер аренды. Если значение не задано, используется значение Connection. Этот параметр задается автоматически при создании привязки на портале. Connection string для контейнера аренды должны иметь разрешения на запись.
LeaseDatabaseName	(Необязательно.) Имя базы данных, в которой содержится контейнер, используемый для хранения аренд. Если значение не задано, используется значение параметра databaseName.
LeaseContainerName	(Необязательно.) Имя контейнера, используемого для хранения аренд. Если значение не задано, используется значение leases.
CreateLeaseContainerIfNotExists	(Необязательно.) Если задано значение true, контейнер аренд создается автоматически, если он еще не создан. Значение по умолчанию — false. При использовании удостоверений Microsoft Entra, если задано значение true, создание контейнеров не разрешенной операции и функция не сможет запуститься.
LeasesContainerThroughput	(Необязательно.) Определяет количество единиц запроса для назначения при создании контейнера аренд. Этот параметр используется, только если для CreateLeaseContainerIfNotExists задано значение true. Этот параметр задается автоматически при создании привязки с помощью портала.
LeaseContainerPrefix	(Необязательно.) Если этот параметр задан, значение добавляется в качестве префикса к арендам, созданным в контейнере аренд для этой функции. Использование префикса позволяет двум отдельным Функции Azure совместно использовать один контейнер аренды с помощью разных префиксов.
FeedPollDelay	(Необязательно.) Определяет задержку между опросами секции на наличие новых изменений в веб-канале, после того как все текущие изменения будут утеряны (в миллисекундах). Значение по умолчанию равно 5000 миллисекунд, или 5 секундам.
LeaseAcquireInterval	(Дополнительно) Если параметр задан, то он определяет интервал для запуска задачи вычисления при условии равномерности распределения секций между известными экземплярами узла (в миллисекундах). По умолчанию это 13000 (13 секунд).
LeaseExpirationInterval	(Дополнительно) Если параметр задан, то он определяет интервал, за который берется аренда, представляющая секцию (в миллисекундах). Если аренда не будет обновлена в течение этого интервала, это приведет к ее истечению и владение секцией перейдет к другому экземпляру. По умолчанию это 60000 (60 секунд).
LeaseRenewInterval	(Дополнительно) Если параметр задан, то он определяет интервал продления для всех аренд в разделах, которые на данный момент занятые экземплярами (в миллисекундах). По умолчанию это 17000 (17 секунд).
MaxItemsPerInvocation	(Необязательно.) Если это свойство задано, оно устанавливает максимальное число полученных элементов на вызов функции. Если операции в отслеживаемом контейнере выполняются с помощью хранимых процедур, область транзакции сохраняется при считывании элементов из канала изменений. В результате число полученных элементов может быть выше указанного значения, чтобы элементы, измененные одной транзакцией, возвращались как часть одного атомарного пакета.
StartFromBeginning	(Необязательно.) Этот параметр указывает триггеру считывать изменения с начала истории изменений контейнера, а не с текущего момента времени. Считывание с начала возможно только при первом запуске триггера, так как при последующих запусках контрольные точки уже будут сохранены. Если установить для этого параметра значение true при уже созданных арендах, этот параметр не будет иметь никакого эффекта.
StartFromTime	(Необязательно.) Возвращает или задает дату и время для начала инициализации операции чтения канала изменений. Рекомендуемый формат — ISO 8601 с указателем UTC, например 2021-02-16T14:19:29Z. Такой подход используется только для задания начального состояния триггера. После того как триггер перешел в состояние аренды, изменение этого значения не будет иметь никакого эффекта.
PreferredLocations	(Необязательно) Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например, "Восточная часть США,Центрально-южная часть США,Северная Европа".

Функции 2.x+

Библиотеки в процессе используют CosmosDBTriggerAttribute из пространства имен Майкрософт.Azure.WebJobs, которое определяет следующие свойства:

Свойство атрибута	Description
ConnectionStringSetting	Имя коллекции параметров или параметров приложения, указывающее, как подключиться к отслеживаемой учетной записи Azure Cosmos DB. Дополнительные сведения см. в разделе Соединения.
DatabaseName	Имя базы данных Azure Cosmos DB с отслеживаемой коллекцией.
CollectionName	Имя отслеживаемой коллекции.
LeaseConnectionStringSetting	(Необязательно) Имя параметра или коллекции параметров приложения, указывающее, как подключиться к учетной записи Azure Cosmos DB, содержащей коллекцию аренды. Если значение не задано, используется значение ConnectionStringSetting. Этот параметр задается автоматически при создании привязки на портале. Connection string для коллекции аренды должны иметь разрешения на запись.
LeaseDatabaseName	(Необязательно.) Имя базы данных, в которой содержится коллекция, используемая для хранения аренд. Если значение не задано, используется значение параметра databaseName.
LeaseCollectionName	(Необязательно.) Имя коллекции, используемой для хранения аренд. Если значение не задано, используется значение leases.
CreateLeaseCollectionIfNotExists	(Необязательно.) Если задано значение true, коллекция аренд создается автоматически, если она не создана. Значение по умолчанию — false.
LeasesCollectionThroughput	(Необязательно.) Определяет количество единиц запроса для назначения при создании коллекции аренд. Этот параметр используется, только если для CreateLeaseCollectionIfNotExists задано значение true. Этот параметр задается автоматически при создании привязки с помощью портала.
LeaseCollectionPrefix	(Необязательно.) Если этот параметр задан, значение добавляется в качестве префикса к арендам, созданным в коллекции аренд для этой функции. Использование префикса позволяет двум отдельным Функции Azure совместно использовать одну коллекцию аренды с помощью разных префиксов.
FeedPollDelay	(Необязательно.) Определяет задержку между опросами секции на наличие новых изменений в веб-канале, после того как все текущие изменения будут утеряны (в миллисекундах). Значение по умолчанию равно 5000 миллисекунд, или 5 секундам.
LeaseAcquireInterval	(Дополнительно) Если параметр задан, то он определяет интервал для запуска задачи вычисления при условии равномерности распределения секций между известными экземплярами узла (в миллисекундах). По умолчанию это 13000 (13 секунд).
LeaseExpirationInterval	(Дополнительно) Если параметр задан, то он определяет интервал, за который берется аренда, представляющая секцию (в миллисекундах). Если аренда не будет обновлена в течение этого интервала, это приведет к ее истечению и владение секцией перейдет к другому экземпляру. По умолчанию это 60000 (60 секунд).
LeaseRenewInterval	(Дополнительно) Если параметр задан, то он определяет интервал продления для всех аренд в разделах, которые на данный момент занятые экземплярами (в миллисекундах). По умолчанию это 17000 (17 секунд).
CheckpointInterval	(Дополнительно) Если параметр задан, то он определяет интервал между контрольными точками аренды (в миллисекундах). После каждого вызова функции всегда используется значение по умолчанию.
CheckpointDocumentCount	(Необязательно.) Настраивает количество документов между контрольными точками аренды. Значение по умолчанию — после каждого вызова функции.
MaxItemsPerInvocation	(Необязательно.) Если это свойство задано, оно устанавливает максимальное число полученных элементов на вызов функции. Если операции в отслеживаемой коллекции выполняются с помощью хранимых процедур, область транзакции сохраняется при считывании элементов из канала изменений. В результате число полученных элементов может быть выше указанного значения, чтобы элементы, измененные одной транзакцией, возвращались как часть одного атомарного пакета.
StartFromBeginning	(Необязательно.) Этот параметр указывает триггеру считывать изменения с начала истории изменений коллекции, а не с текущего момента времени. Считывание с начала возможно только при первом запуске триггера, так как при последующих запусках контрольные точки уже будут сохранены. Если установить для этого параметра значение true при уже созданных арендах, этот параметр не будет иметь никакого эффекта.
PreferredLocations	(Необязательно) Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например, "Восточная часть США,Центрально-южная часть США,Северная Европа".
UseMultipleWriteLocations	(Необязательно.) Включает учетные записи с несколькими регионами для записи в коллекцию аренд.
UseDefaultJsonSerialization	(Необязательно.) Позволяет использовать JsonConvert.DefaultSettings в отслеживаемой коллекции. Этот параметр применяется только к отслеживаемой коллекции и потребителю для настройки сериализации, используемой в отслеживаемой коллекции. JsonConvert.DefaultSettings необходимо задать в классе, производном от CosmosDBWebJobsStartup.

Расширение 4.x+

Изолированные библиотеки рабочих процессов используют CosmosDBTriggerAttribute из пространства имен Майкрософт.Azure.Functions.Worker, которое определяет следующие свойства:

Свойство атрибута	Description
Соединение	Имя коллекции параметров или параметров приложения, указывающее, как подключиться к отслеживаемой учетной записи Azure Cosmos DB. Дополнительные сведения см. в разделе Соединения.
DatabaseName	Имя базы данных Azure Cosmos DB с отслеживаемой контейнером.
Имя контейнера	Имя отслеживаемого контейнера.
LeaseConnection	(Необязательно) Имя параметра или коллекции параметров приложения, указывающее, как подключиться к учетной записи Azure Cosmos DB, содержащей контейнер аренды. Если значение не задано, используется значение Connection. Этот параметр задается автоматически при создании привязки на портале. Connection string для контейнера аренды должны иметь разрешения на запись.
LeaseDatabaseName	(Необязательно.) Имя базы данных, в которой содержится контейнер, используемый для хранения аренд. Если значение не задано, используется значение параметра databaseName.
LeaseContainerName	(Необязательно.) Имя контейнера, используемого для хранения аренд. Если значение не задано, используется значение leases.
CreateLeaseContainerIfNotExists	(Необязательно.) Если задано значение true, контейнер аренд создается автоматически, если он еще не создан. Значение по умолчанию — false. При использовании удостоверений Microsoft Entra, если задано значение true, создание контейнеров не разрешенной операции и функция не сможет запуститься.
LeasesContainerThroughput	(Необязательно.) Определяет количество единиц запроса для назначения при создании контейнера аренд. Этот параметр используется, только если для CreateLeaseContainerIfNotExists задано значение true. Этот параметр задается автоматически при создании привязки с помощью портала.
LeaseContainerPrefix	(Необязательно.) Если этот параметр задан, значение добавляется в качестве префикса к арендам, созданным в контейнере аренд для этой функции. Использование префикса позволяет двум отдельным Функции Azure совместно использовать один контейнер аренды с помощью разных префиксов.
FeedPollDelay	(Необязательно.) Определяет задержку между опросами секции на наличие новых изменений в веб-канале, после того как все текущие изменения будут утеряны (в миллисекундах). Значение по умолчанию равно 5000 миллисекунд, или 5 секундам.
LeaseAcquireInterval	(Дополнительно) Если параметр задан, то он определяет интервал для запуска задачи вычисления при условии равномерности распределения секций между известными экземплярами узла (в миллисекундах). По умолчанию это 13000 (13 секунд).
LeaseExpirationInterval	(Дополнительно) Если параметр задан, то он определяет интервал, за который берется аренда, представляющая секцию (в миллисекундах). Если аренда не будет обновлена в течение этого интервала, это приведет к ее истечению и владение секцией перейдет к другому экземпляру. По умолчанию это 60000 (60 секунд).
LeaseRenewInterval	(Дополнительно) Если параметр задан, то он определяет интервал продления для всех аренд в разделах, которые на данный момент занятые экземплярами (в миллисекундах). По умолчанию это 17000 (17 секунд).
MaxItemsPerInvocation	(Необязательно.) Если это свойство задано, оно устанавливает максимальное число полученных элементов на вызов функции. Если операции в отслеживаемом контейнере выполняются с помощью хранимых процедур, область транзакции сохраняется при считывании элементов из канала изменений. В результате число полученных элементов может быть выше указанного значения, чтобы элементы, измененные одной транзакцией, возвращались как часть одного атомарного пакета.
StartFromBeginning	(Необязательно.) Этот параметр указывает триггеру считывать изменения с начала истории изменений контейнера, а не с текущего момента времени. Считывание с начала возможно только при первом запуске триггера, так как при последующих запусках контрольные точки уже будут сохранены. Если установить для этого параметра значение true при уже созданных арендах, этот параметр не будет иметь никакого эффекта.
StartFromTime	(Необязательно.) Возвращает или задает дату и время для начала инициализации операции чтения канала изменений. Рекомендуемый формат — ISO 8601 с указателем UTC, например 2021-02-16T14:19:29Z. Такой подход используется только для задания начального состояния триггера. После того как триггер перешел в состояние аренды, изменение этого значения не будет иметь никакого эффекта.
PreferredLocations	(Необязательно) Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например, "Восточная часть США,Центрально-южная часть США,Северная Европа".

Функции 2.x+

Изолированные библиотеки рабочих процессов используют CosmosDBTriggerAttribute из пространства имен Майкрософт.Azure.Functions.Worker, которое определяет следующие свойства:

Свойство атрибута	Description
ConnectionStringSetting	Имя коллекции параметров или параметров приложения, указывающее, как подключиться к отслеживаемой учетной записи Azure Cosmos DB. Дополнительные сведения см. в разделе Соединения.
DatabaseName	Имя базы данных Azure Cosmos DB с отслеживаемой коллекцией.
CollectionName	Имя отслеживаемой коллекции.
LeaseConnectionStringSetting	(Необязательно) Имя параметра или коллекции параметров приложения, указывающее, как подключиться к учетной записи Azure Cosmos DB, содержащей коллекцию аренды. Если значение не задано, используется значение ConnectionStringSetting. Этот параметр задается автоматически при создании привязки на портале. Connection string для коллекции аренды должны иметь разрешения на запись.
LeaseDatabaseName	(Необязательно.) Имя базы данных, в которой содержится коллекция, используемая для хранения аренд. Если значение не задано, используется значение параметра databaseName.
LeaseCollectionName	(Необязательно.) Имя коллекции, используемой для хранения аренд. Если значение не задано, используется значение leases.
CreateLeaseCollectionIfNotExists	(Необязательно.) Если задано значение true, коллекция аренд создается автоматически, если она не создана. Значение по умолчанию — false.
LeasesCollectionThroughput	(Необязательно.) Определяет количество единиц запроса для назначения при создании коллекции аренд. Этот параметр используется, только если для CreateLeaseCollectionIfNotExists задано значение true. Этот параметр задается автоматически при создании привязки с помощью портала.
LeaseCollectionPrefix	(Необязательно.) Если этот параметр задан, значение добавляется в качестве префикса к арендам, созданным в коллекции аренд для этой функции. Использование префикса позволяет двум отдельным Функции Azure совместно использовать одну коллекцию аренды с помощью разных префиксов.
FeedPollDelay	(Необязательно.) Определяет задержку между опросами секции на наличие новых изменений в веб-канале, после того как все текущие изменения будут утеряны (в миллисекундах). Значение по умолчанию равно 5000 миллисекунд, или 5 секундам.
LeaseAcquireInterval	(Дополнительно) Если параметр задан, то он определяет интервал для запуска задачи вычисления при условии равномерности распределения секций между известными экземплярами узла (в миллисекундах). По умолчанию это 13000 (13 секунд).
LeaseExpirationInterval	(Дополнительно) Если параметр задан, то он определяет интервал, за который берется аренда, представляющая секцию (в миллисекундах). Если аренда не будет обновлена в течение этого интервала, это приведет к ее истечению и владение секцией перейдет к другому экземпляру. По умолчанию это 60000 (60 секунд).
LeaseRenewInterval	(Дополнительно) Если параметр задан, то он определяет интервал продления для всех аренд в разделах, которые на данный момент занятые экземплярами (в миллисекундах). По умолчанию это 17000 (17 секунд).
CheckpointInterval	(Дополнительно) Если параметр задан, то он определяет интервал между контрольными точками аренды (в миллисекундах). После каждого вызова функции всегда используется значение по умолчанию.
CheckpointDocumentCount	(Необязательно.) Настраивает количество документов между контрольными точками аренды. Значение по умолчанию — после каждого вызова функции.
MaxItemsPerInvocation	(Необязательно.) Если это свойство задано, оно устанавливает максимальное число полученных элементов на вызов функции. Если операции в отслеживаемой коллекции выполняются с помощью хранимых процедур, область транзакции сохраняется при считывании элементов из канала изменений. В результате число полученных элементов может быть выше указанного значения, чтобы элементы, измененные одной транзакцией, возвращались как часть одного атомарного пакета.
StartFromBeginning	(Необязательно.) Этот параметр указывает триггеру считывать изменения с начала истории изменений коллекции, а не с текущего момента времени. Считывание с начала возможно только при первом запуске триггера, так как при последующих запусках контрольные точки уже будут сохранены. Если установить для этого параметра значение true при уже созданных арендах, этот параметр не будет иметь никакого эффекта.
PreferredLocations	(Необязательно) Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например, "Восточная часть США,Центрально-южная часть США,Северная Европа".
UseMultipleWriteLocations	(Необязательно.) Включает учетные записи с несколькими регионами для записи в коллекцию аренд.
UseDefaultJsonSerialization	(Необязательно.) Позволяет использовать JsonConvert.DefaultSettings в отслеживаемой коллекции. Этот параметр применяется только к отслеживаемой коллекции и потребителю для настройки сериализации, используемой в отслеживаемой коллекции. JsonConvert.DefaultSettings необходимо задать в классе, производном от CosmosDBWebJobsStartup.

Декораторы

Применяется только к модели программирования Python версии 2.

Для функций Python версии 2, определенных с помощью декоратора, cosmos_db_trigger (extension 4.x) поддерживает следующие свойства:

Свойство	Description
arg_name	Имя переменной, используемое в коде функции, представляющей список документов с изменениями.
database_name	Имя базы данных Azure Cosmos DB. Поддерживает %VAR_NAME% синтаксис для ссылки на параметры приложения.
container_name	Имя отслеживаемого контейнера Azure Cosmos DB. Поддерживает %VAR_NAME% синтаксис.
connection	Имя параметра приложения или префикса параметров для подключений на основе удостоверений (например, COSMOS_CONNECTION разрешает и COSMOS_CONNECTION__accountEndpointт. д.).
lease_container_name	Имя контейнера, используемого для хранения аренды.
create_lease_container_if_not_exists	При trueавтоматическом создании контейнера аренды, если он не существует.

Сведения о функциях Python, определенных с помощью function.json<>/c0> см. в разделе Configuration.

Заметки

Расширение 4.x+

Из-за изменений схемы в пакете SDK Azure Cosmos DB версии 4.x расширения Azure Cosmos DB требуется azure-functions-java-library версии 3.0.0 для функций Java.

Используйте заметку @CosmosDBTrigger для параметров, которые считывают данные из Azure Cosmos DB. Эта заметка поддерживает следующие свойства:

Свойство атрибута	Description
Подключение	Имя коллекции параметров или параметров приложения, указывающее, как подключиться к отслеживаемой учетной записи Azure Cosmos DB. Дополнительные сведения см. в разделе Соединения.
name	Имя функции.
databaseName	Имя базы данных Azure Cosmos DB с отслеживаемой контейнером.
containerName	Имя отслеживаемого контейнера.
leaseConnectionStringSetting	(Необязательно) Имя параметра или коллекции параметров приложения, указывающее, как подключиться к учетной записи Azure Cosmos DB, содержащей контейнер аренды. Если значение не задано, используется значение Connection. Этот параметр задается автоматически при создании привязки на портале. Connection string для контейнера аренды должны иметь разрешения на запись.
leaseDatabaseName	(Необязательно.) Имя базы данных, в которой содержится контейнер, используемый для хранения аренд. Если значение не задано, используется значение параметра databaseName.
leaseContainerName	(Необязательно.) Имя контейнера, используемого для хранения аренд. Если значение не задано, используется значение leases.
createLeaseContainerIfNotExists	(Необязательно.) Если задано значение true, контейнер аренд создается автоматически, если он еще не создан. Значение по умолчанию — false. При использовании удостоверений Microsoft Entra, если задано значение true, создание контейнеров не разрешенной операции и приложение-функция не может запускаться.
leasesContainerThroughput	(Необязательно.) Определяет количество единиц запроса для назначения при создании контейнера аренд. Этот параметр используется, только если для CreateLeaseContainerIfNotExists задано значение true. Этот параметр задается автоматически при создании привязки с помощью портала.
leaseContainerPrefix	(Необязательно.) Если этот параметр задан, значение добавляется в качестве префикса к арендам, созданным в контейнере аренд для этой функции. Использование префикса позволяет двум отдельным Функции Azure совместно использовать один контейнер аренды с помощью разных префиксов.
feedPollDelay	(Необязательно.) Определяет задержку между опросами секции на наличие новых изменений в веб-канале, после того как все текущие изменения будут утеряны (в миллисекундах). Значение по умолчанию равно 5000 миллисекунд, или 5 секундам.
leaseAcquireInterval	(Дополнительно) Если параметр задан, то он определяет интервал для запуска задачи вычисления при условии равномерности распределения секций между известными экземплярами узла (в миллисекундах). По умолчанию это 13000 (13 секунд).
leaseExpirationInterval	(Дополнительно) Если параметр задан, то он определяет интервал, за который берется аренда, представляющая секцию (в миллисекундах). Если аренда не продлевается в течение этого интервала, срок ее действия истекает, а владение секцией переходит к другому экземпляру. По умолчанию это 60000 (60 секунд).
leaseRenewInterval	(Необязательно) Если задано, он определяет интервал продления для всех арендных разделов, хранящиеся в настоящее время экземпляром. По умолчанию это 17000 (17 секунд).
maxItemsPerInvocation	(Необязательно.) Если это свойство задано, оно устанавливает максимальное число полученных элементов на вызов функции. Если операции в отслеживаемом контейнере выполняются с помощью хранимых процедур, область транзакции сохраняется при считывании элементов из канала изменений. В результате число полученных элементов может быть выше указанного значения, чтобы элементы, измененные одной транзакцией, возвращались как часть одного атомарного пакета.
startFromBeginning	(Необязательно.) Этот параметр указывает триггеру считывать изменения с начала истории изменений контейнера, а не с текущего момента времени. Считывание с начала возможно только при первом запуске триггера, так как при последующих запусках контрольные точки уже будут сохранены. Если установить для этого параметра значение true при уже созданных арендах, этот параметр не будет иметь никакого эффекта.
preferredLocations	(Необязательно) Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например: East US,South Central US,North Europe.

Функции 2.x+

В библиотеке среды выполнения функций Java используйте заметку @CosmosDBTrigger для параметров, которые считывают данные из Azure Cosmos DB. Эта заметка поддерживает следующие свойства:

• name
• connectionStringSetting
• databaseName
• collectionName
• leaseConnectionStringSetting
• leaseDatabaseName
• leaseCollectionName
• createLeaseCollectionIfNotExists
• leasesCollectionThroughput
• leaseCollectionPrefix
• feedPollDelay
• leaseAcquireInterval
• leaseExpirationInterval
• leaseRenewInterval
• checkpointInterval
• checkpointDocumentCount
• maxItemsPerInvocation
• startFromBeginning
• preferredLocations

Настройка

Применяется только к модели программирования Python версии 1.

Модель версии 4

В следующей таблице описываются свойства, которые можно задать в объекте options , который передается методу app.cosmosDB() . typeСвойства directionи name свойства не применяются к модели версии 4.

Модель версии 3

В следующей таблице описаны свойства конфигурации привязки, задаваемые в файле function.json, свойства в котором различаются по версии расширения:

В следующей таблице описаны свойства конфигурации привязки, задаваемые в файле function.json, свойства в котором различаются по версии расширения:

Расширение 4.x+

Свойство в function.json	Description
type	Должен иметь значениеcosmosDBTrigger.
direction	Должен иметь значениеin. Этот параметр устанавливается автоматически при создании триггера на портале Azure.
name	Имя переменной, используемое в коде функции, представляющей список документов с изменениями.
Подключение	Имя коллекции параметров или параметров приложения, указывающее, как подключиться к отслеживаемой учетной записи Azure Cosmos DB. Дополнительные сведения см. в разделе Соединения.
databaseName	Имя базы данных Azure Cosmos DB с отслеживаемой контейнером.
containerName	Имя отслеживаемого контейнера.
leaseConnection	(Необязательно) Имя параметра или контейнера приложения, указывающего, как подключиться к учетной записи Azure Cosmos DB, содержащей контейнер аренды. Если значение не задано, используется значение connection. Этот параметр задается автоматически при создании привязки на портале. Connection string для контейнера аренды должны иметь разрешения на запись.
leaseDatabaseName	(Необязательно.) Имя базы данных, в которой содержится контейнер, используемый для хранения аренд. Если значение не задано, используется значение параметра databaseName.
leaseContainerName	(Необязательно.) Имя контейнера, используемого для хранения аренд. Если значение не задано, используется значение leases.
createLeaseContainerIfNotExists	(Необязательно.) Если задано значение true, контейнер аренд создается автоматически, если он еще не создан. Значение по умолчанию — false. При использовании удостоверений Microsoft Entra, если задано значение true, создание контейнеров не разрешенной операции и функция не сможет запуститься.
leasesContainerThroughput	(Необязательно.) Определяет количество единиц запроса для назначения при создании контейнера аренд. Этот параметр используется, только если для createLeaseContainerIfNotExists задано значение true. Этот параметр задается автоматически при создании привязки с помощью портала.
leaseContainerPrefix	(Необязательно.) Если этот параметр задан, значение добавляется в качестве префикса к арендам, созданным в контейнере аренд для этой функции. Использование префикса позволяет двум отдельным Функции Azure совместно использовать один контейнер аренды с помощью разных префиксов.
feedPollDelay	(Необязательно.) Определяет задержку между опросами секции на наличие новых изменений в веб-канале, после того как все текущие изменения будут утеряны (в миллисекундах). Значение по умолчанию равно 5000 миллисекунд, или 5 секундам.
leaseAcquireInterval	(Дополнительно) Если параметр задан, то он определяет интервал для запуска задачи вычисления при условии равномерности распределения секций между известными экземплярами узла (в миллисекундах). По умолчанию это 13000 (13 секунд).
leaseExpirationInterval	(Дополнительно) Если параметр задан, то он определяет интервал, за который берется аренда, представляющая секцию (в миллисекундах). Если аренда не будет обновлена в течение этого интервала, это приведет к ее истечению и владение секцией перейдет к другому экземпляру. По умолчанию это 60000 (60 секунд).
leaseRenewInterval	(Дополнительно) Если параметр задан, то он определяет интервал продления для всех аренд в разделах, которые на данный момент занятые экземплярами (в миллисекундах). По умолчанию это 17000 (17 секунд).
maxItemsPerInvocation	(Необязательно.) Если это свойство задано, оно устанавливает максимальное число полученных элементов на вызов функции. Если операции в отслеживаемом контейнере выполняются с помощью хранимых процедур, область транзакции сохраняется при считывании элементов из канала изменений. В результате число полученных элементов может быть выше указанного значения, чтобы элементы, измененные одной транзакцией, возвращались как часть одного атомарного пакета.
startFromBeginning	(Необязательно.) Этот параметр указывает триггеру считывать изменения с начала истории изменений контейнера, а не с текущего момента времени. Считывание с начала возможно только при первом запуске триггера, так как при последующих запусках контрольные точки уже будут сохранены. Если установить для этого параметра значение true при уже созданных арендах, этот параметр не будет иметь никакого эффекта.
startFromTime	(Необязательно.) Возвращает или задает дату и время для начала инициализации операции чтения канала изменений. Рекомендуемый формат — ISO 8601 с указателем UTC, например 2021-02-16T14:19:29Z. Такой подход используется только для задания начального состояния триггера. После того как триггер перешел в состояние аренды, изменение этого значения не будет иметь никакого эффекта.
preferredLocations	(Необязательно) Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например, "Восточная часть США,Центрально-южная часть США,Северная Европа".

Функции 2.x+

Свойство в function.json	Description
type	Должен иметь значениеcosmosDBTrigger.
direction	Должен иметь значениеin. Этот параметр устанавливается автоматически при создании триггера на портале Azure.
name	Имя переменной, используемое в коде функции, представляющей список документов с изменениями.
connectionStringSetting	Имя коллекции параметров или параметров приложения, указывающее, как подключиться к отслеживаемой учетной записи Azure Cosmos DB. Дополнительные сведения см. в разделе Соединения.
databaseName	Имя базы данных Azure Cosmos DB с отслеживаемой коллекцией.
collectionName	Имя отслеживаемой коллекции.
leaseConnectionStringSetting	(Необязательно) Имя параметра или коллекции параметров приложения, указывающее, как подключиться к учетной записи Azure Cosmos DB, содержащей коллекцию аренды. Если значение не задано, используется значение connectionStringSetting. Этот параметр задается автоматически при создании привязки на портале. Connection string для коллекции аренды должны иметь разрешения на запись.
leaseDatabaseName	(Необязательно.) Имя базы данных, в которой содержится коллекция, используемая для хранения аренд. Если значение не задано, используется значение параметра databaseName.
leaseCollectionName	(Необязательно.) Имя коллекции, используемой для хранения аренд. Если значение не задано, используется значение leases.
createLeaseCollectionIfNotExists	(Необязательно.) Если задано значение true, коллекция аренд создается автоматически, если она не создана. Значение по умолчанию — false.
leasesCollectionThroughput	(Необязательно.) Определяет количество единиц запроса для назначения при создании коллекции аренд. Этот параметр используется, только если для createLeaseCollectionIfNotExists задано значение true. Этот параметр задается автоматически при создании привязки с помощью портала.
leaseCollectionPrefix	(Необязательно.) Если этот параметр задан, значение добавляется в качестве префикса к арендам, созданным в коллекции аренд для этой функции. Использование префикса позволяет двум отдельным Функции Azure совместно использовать одну коллекцию аренды с помощью разных префиксов.
feedPollDelay	(Необязательно.) Определяет задержку между опросами секции на наличие новых изменений в веб-канале, после того как все текущие изменения будут утеряны (в миллисекундах). Значение по умолчанию равно 5000 миллисекунд, или 5 секундам.
leaseAcquireInterval	(Дополнительно) Если параметр задан, то он определяет интервал для запуска задачи вычисления при условии равномерности распределения секций между известными экземплярами узла (в миллисекундах). По умолчанию это 13000 (13 секунд).
leaseExpirationInterval	(Дополнительно) Если параметр задан, то он определяет интервал, за который берется аренда, представляющая секцию (в миллисекундах). Если аренда не будет обновлена в течение этого интервала, это приведет к ее истечению и владение секцией перейдет к другому экземпляру. По умолчанию это 60000 (60 секунд).
leaseRenewInterval	(Дополнительно) Если параметр задан, то он определяет интервал продления для всех аренд в разделах, которые на данный момент занятые экземплярами (в миллисекундах). По умолчанию это 17000 (17 секунд).
checkpointInterval	(Дополнительно) Если параметр задан, то он определяет интервал между контрольными точками аренды (в миллисекундах). После каждого вызова функции всегда используется значение по умолчанию.
checkpointDocumentCount	(Необязательно.) Настраивает количество документов между контрольными точками аренды. Значение по умолчанию — после каждого вызова функции.
maxItemsPerInvocation	(Необязательно.) Если это свойство задано, оно устанавливает максимальное число полученных элементов на вызов функции. Если операции в отслеживаемой коллекции выполняются с помощью хранимых процедур, область транзакции сохраняется при считывании элементов из канала изменений. В результате число полученных элементов может быть выше указанного значения, чтобы элементы, измененные одной транзакцией, возвращались как часть одного атомарного пакета.
startFromBeginning	(Необязательно.) Этот параметр указывает триггеру считывать изменения с начала истории изменений коллекции, а не с текущего момента времени. Считывание с начала возможно только при первом запуске триггера, так как при последующих запусках контрольные точки уже будут сохранены. Если установить для этого параметра значение true при уже созданных арендах, этот параметр не будет иметь никакого эффекта.
preferredLocations	(Необязательно) Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например, "Восточная часть США,Центрально-южная часть США,Северная Европа".
useMultipleWriteLocations	(Необязательно.) Включает учетные записи с несколькими регионами для записи в коллекцию аренд.

Полные примеры см. в разделе "Пример".

Использование

Триггеру требуется вторая коллекция, которая используется для хранения аренды в разделах. Триггер работает только в том случае, если доступны как отслеживаемая коллекция, так и коллекция, содержащая аренды.

Внимание

Если вы настроите несколько функций для использования триггера Azure Cosmos DB для одной коллекции, каждая функция должна использовать выделенную коллекцию аренды или указать другую LeaseCollectionPrefix для каждой функции. В противном случае активируется только одна из функций. Сведения о префиксе см. в разделе Атрибуты.

Внимание

Если вы настроите несколько функций для использования триггера Azure Cosmos DB для одной коллекции, каждая функция должна использовать выделенную коллекцию аренды или указать другую leaseCollectionPrefix для каждой функции. В противном случае активируется только одна из функций. Сведения о префиксе см. в разделе Заметки.

Внимание

Если вы настроите несколько функций для использования триггера Azure Cosmos DB для одной коллекции, каждая функция должна использовать выделенную коллекцию аренды или указать другую leaseCollectionPrefix для каждой функции. В противном случае активируется только одна из функций. Сведения о префиксе см. в разделе с конфигурацией.

Триггер не указывает, был ли документ обновлен или вставлен. Он просто предоставляет сам документ. Если необходимо обрабатывать обновления и вставлять изменения по-другому, реализуйте поля метки времени для вставки или обновления.

Тип параметра, поддерживаемый триггером Azure Cosmos DB, зависит от версии среды выполнения Функций, версии пакета расширения и используемой модальности C#.

Расширение 4.x+

Список поддерживаемых типов см. в разделе "Типы привязки".

Функции 2.x+

Список поддерживаемых типов см. в разделе "Типы привязки".

Расширение 4.x+

Если требуется, чтобы функция обрабатывала один документ, триггер Cosmos DB может привязаться к следующим типам:

Тип	Description
Сериализуемые в JSON типы	Функции пытаются десериализировать данные JSON документа из канала изменений Cosmos DB в обычный тип объекта CLR (POCO).

Если требуется, чтобы функция обрабатывала пакет документов, триггер Cosmos DB может привязаться к следующим типам:

Тип	Description
IEnumerable<T>где T является сериализуемым типом JSON	Перечисление сущностей, включенных в пакет. Каждая запись представляет один документ из канала изменений Cosmos DB.

Функции 2.x+

Список поддерживаемых типов см. в разделе "Типы привязки".

Связи

Конфигурация connectionStringSetting/connection и leaseConnectionStringSetting/leaseConnection свойства ссылочной среды, указывающая, как приложение подключается к Azure Cosmos DB. Они могут указать следующее:

• Имя параметра приложения, содержащего строка подключения.
• Имя общего префикса для нескольких параметров приложения, которое вместе определяет подключение к управляемому удостоверению. Этот параметр доступен только для версий connection и leaseConnection из версии расширения 4.x или выше.

Если настроенное значение одновременно точно соответствует одному параметру и является префиксом для других параметров, то используется точное совпадение.

Подсказка

Для повышения безопасности рекомендуется использовать подключения к управляемому удостоверению. Строки подключения включают учетные данные, которые могут быть предоставлены, а управляемые удостоверения устраняют необходимость управления секретами.

Управляемая идентичность

Если вы используете version 4.x или более поздней версии расширения вместо использования строка подключения с секретом, приложение может использовать удостоверение Microsoft Entra. Для этого определите параметры под общим префиксом, который сопоставляется со свойством подключения в конфигурации триггера и привязки.

В этом режиме расширение требует следующих параметров приложения:

Параметр на основе шаблона	Description	Тип идентификации
<CONNECTION_NAME_PREFIX>__accountEndpoint	URI конечной точки учетной записи Azure Cosmos DB.	Назначаемое системой или назначаемое пользователем
<CONNECTION_NAME_PREFIX>__credential	Должен иметь значениеmanagedidentity.	Назначено пользователем
<CONNECTION_NAME_PREFIX>__clientId	Идентификатор клиента управляемой идентификации, назначаемой пользователем.	Назначено пользователем

Значение, которое вы заменяете <CONNECTION_NAME_PREFIX> , обрабатывается расширением привязки в качестве имени параметра подключения.

Например, если конфигурация привязки задает connection = "CosmosDBConnection" управляемое удостоверение, назначаемое пользователем, настройте следующие параметры приложения:

{
    "CosmosDBConnection__accountEndpoint": "https://mycosmosdb.documents.azure.com:443/",
    "CosmosDBConnection__credential": "managedidentity",
    "CosmosDBConnection__clientId": "00000000-0000-0000-0000-000000000000"
}

Подсказка

Используйте управляемые удостоверения, назначаемые пользователем, для рабочих сценариев, где требуется подробный контроль над разрешениями удостоверения в нескольких ресурсах.

Дополнительные параметры в шаблоне можно использовать для дальнейшей настройки подключения. См. раздел Общие свойства подключений на основе удостоверений.

При размещении в службе Функции Azure подключения на основе удостоверений используют удостоверение управляемое удостоверение. По умолчанию используется назначаемое системой удостоверение, однако вы можете указать назначаемое пользователем удостоверение с помощью свойств credential и clientID. Обратите внимание, что настройка назначаемого пользователем удостоверения с идентификатором ресурса не поддерживается. При выполнении в других контекстах, например при локальной разработке, вместо этого используется удостоверение разработчика, хотя это можно настроить. См. раздел Локальная разработка с использованием подключений на основе удостоверений.

Предоставление разрешения удостоверению

Любое используемое удостоверение должно иметь разрешения на выполнение предполагаемых действий. Для большинства служб Azure это означает, что необходимо назначение роли в Azure RBAC с помощью встроенных или настраиваемых ролей, которые предоставляют эти разрешения.

Внимание

Иногда целевая служба может предоставлять разрешения, которые не являются обязательными для всех контекстов. Там, где это возможно, придерживайтесь принципа минимальных привилегий, предоставляя удостоверению лишь самые необходимые привилегии. Например, если приложению требуется только возможность чтения из источника данных, используйте роль, которая имеет разрешение только на чтение. Было бы неуместным назначить роль, которая также разрешает запись в эту службу, так как это разрешение не требуется для операции чтения. Соответственно необходимо еще проверить, что область действия назначенной роли ограничена только теми ресурсами, которые необходимо прочитать.

Cosmos DB не использует Azure RBAC для операций с данными. Вместо этого она использует встроенную систему RBAC Cosmos DB, созданную на основе аналогичных концепций. Вам потребуется создать назначение ролей, которое предоставляет доступ к учетной записи базы данных во время выполнения. Azure роли управления RBAC, такие как Owner недостаточно. В следующей таблице показаны встроенные роли, которые рекомендуется использовать при использовании расширения Azure Cosmos DB в обычной работе. Приложению могут потребоваться дополнительные разрешения в зависимости от написанного кода.

Тип привязки	Пример встроенных ролей1
Триггер2	Встроенный участник данных Cosmos DB
Входные привязки	Встроенное средство чтения данных Cosmos DB
Выходные привязки	Встроенный участник данных Cosmos DB

¹ Эти роли нельзя использовать в назначении ролей RBAC Azure. Дополнительные сведения о назначении этих ролей см. в встроенной системной документации по RBAC Cosmos DB.

² При использовании удостоверения Cosmos DB обрабатывает создание контейнера как операцию управления. Он недоступен в качестве операции плоскости данных для триггера. Перед настройкой функции необходимо создать контейнеры, необходимые триггеру (включая контейнер аренды).

Строка соединения

Сохраните строка подключения для учетной записи базы данных в параметре приложения с именем, соответствующим значению, указанному в свойстве подключения конфигурации привязки.

Следующие шаги

• Read an Azure Cosmos DB document (Input binding)
• Сохранение изменяет документ Azure Cosmos DB (привязка вывода)