Visão geral do gatilho e associações do Azure Cosmos DB para o Azure Functions

As funções são executadas em um processo de trabalho C# isolado. Para saber mais, consulte Guia para executar o C# Azure Functions em um processo de trabalho isolado.

As funções são executadas no mesmo processo que o host Functions. Para saber mais, consulte Desenvolver funções de biblioteca de classes C# usando o Azure Functions.

Em uma variação desse modelo, as funções podem ser executadas usando scripts em C#, que são suportados principalmente para edição de portal em C#. Para atualizar extensões de vinculação existentes para aplicativos de script C# em execução no portal sem precisar publicar novamente seu aplicativo de função, consulte Atualizar suas extensões.

Esta seção descreve o uso de uma biblioteca de classes. Para scripts em C#, você precisaria instalar o pacote de extensão, versão 4.x.

Esta versão da extensão de ligações do Azure Cosmos DB introduz a capacidade de se conectar usando uma identidade em vez de um segredo. Para obter um tutorial sobre como configurar seus aplicativos de função com identidades gerenciadas, consulte o tutorial de criação de um aplicativo de função com conexões baseadas em identidade.

Esta versão também altera os tipos aos quais você pode se associar, substituindo os tipos do SDK Microsoft.Azure.DocumentDB v2 por tipos mais recentes do SDK v3 Microsoft.Azure.Cosmos. Saiba mais sobre como esses novos tipos são diferentes e como migrar para eles a partir do guia de migração do SDK, gatilho, vinculação de entrada e exemplos de vinculação de saída.

Esta versão de extensão está disponível como um pacote NuGet, versão 4.x.

Esta seção descreve o uso de uma biblioteca de classes. Para scripts em C#, você precisaria instalar o pacote de extensão, versão 2.x ou 3.x.

Trabalhar com o gatilho e as associações requer que você faça referência ao pacote NuGet apropriado. Instale o pacote NuGet, versão 3.x.

Esta versão da extensão de ligações do Azure Cosmos DB introduz a capacidade de se conectar usando uma identidade em vez de um segredo. Para obter um tutorial sobre como configurar seus aplicativos de função com identidades gerenciadas, consulte o tutorial de criação de um aplicativo de função com conexões baseadas em identidade.

Adicione a extensão ao seu projeto instalando o pacote NuGet, versão 4.x.

Se você estiver escrevendo seu aplicativo usando F#, também deverá configurar essa extensão como parte da configuração de inicialização do aplicativo. Na chamada para ConfigureFunctionsWorkerDefaults() ou ConfigureFunctionsWebApplication(), adicione um delegado que usa um IFunctionsWorkerApplication parâmetro. Em seguida, dentro do corpo desse delegado, chame ConfigureCosmosDBExtension() o objeto:

let hostBuilder = new HostBuilder()
hostBuilder.ConfigureFunctionsWorkerDefaults(fun (context: HostBuilderContext) (appBuilder: IFunctionsWorkerApplicationBuilder) ->
    appBuilder.ConfigureCosmosDBExtension() |> ignore
) |> ignore

Adicione a extensão ao seu projeto instalando o pacote NuGet, versão 3.x.

Uma biblioteca de classes de processo de trabalho isolada compilada função C# é executada em um processo isolado do tempo de execução.

Uma biblioteca de classes em processo é uma função C# compilada executada no mesmo processo que o tempo de execução do Functions.

A extensão do Azure Cosmos DB dá suporte a tipos de parâmetros de acordo com a tabela abaixo.

1 Os documentos que contêm dados JSON podem ser desserializados em tipos conhecidos de objeto CLR (POCO) simples.

Versões anteriores da extensão expuseram tipos do namespace Microsoft.Azure.Documents agora preterido. Os tipos mais recentes do Microsoft.Azure.Cosmos são exclusivos da extensão 4.x e superior.

O processo de trabalho isolado suporta tipos de parâmetros de acordo com as tabelas abaixo. O suporte para associação a tipos de Microsoft.Azure.Cosmosestá em visualização.

Gatilho do Cosmos DB

Quando você deseja que a função processe um único documento, o gatilho do Cosmos DB pode se vincular aos seguintes tipos:

Quando você deseja que a função processe um lote de documentos, o gatilho do Cosmos DB pode se vincular aos seguintes tipos:

Vinculação de entrada do Cosmos DB

Quando você deseja que a função processe um único documento, a associação de entrada do Cosmos DB pode se vincular aos seguintes tipos:

Quando você deseja que a função processe vários documentos de uma consulta, a associação de entrada do Cosmos DB pode se vincular aos seguintes tipos:

1 Para usar esses tipos, você precisa fazer referência a Microsoft.Azure.Functions.Worker.Extensions.CosmosDB 4.4.0 ou posterior e às dependências comuns para associações de tipo SDK.

Ligação de saída do Cosmos DB

Quando você deseja que a função grave em um único documento, a associação de saída do Cosmos DB pode se vincular aos seguintes tipos:

Quando você deseja que a função grave em vários documentos, a associação de saída do Cosmos DB pode se vincular aos seguintes tipos:

Para outros cenários de saída, crie e use um CosmosClient diretamente com outros tipos do Microsoft.Azure.Cosmos . Consulte Registrar clientes do Azure para obter um exemplo de como usar a injeção de dependência para criar um tipo de cliente a partir do SDK do Azure.

As versões anteriores das extensões no processo de trabalho isolado suportam apenas a vinculação a tipos serializáveis JSON. Opções adicionais estão disponíveis para a extensão 4.x e superior.