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 do C# isolado. Para saber mais, confira o Guia para executar C# do Azure Functions em um processo de trabalho isolado.

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

Em uma variação desse modelo, o Functions pode ser executado usando scripts C#, que é compatível principalmente com a edição do portal C#. Para atualizar as extensões de associação existentes dos aplicativos do script do C# no portal sem precisar republicar o aplicativo de funções, consulte Atualizar as extensões.

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

Esta versão da extensão de associações do Azure Cosmos DB introduz a capacidade de conexão usando uma identidade em vez de um segredo. Para ver um tutorial sobre a configuração de aplicativos de funções com identidades gerenciadas, confira o tutorial sobre como criar um aplicativo de funções 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 v2 Microsoft.Azure.DocumentDB por tipos mais novos do SDK v3 Microsoft.Azure.Cosmos. Saiba mais sobre como esses novos tipos são diferentes e como migrá-los dos exemplos guia de migração do SDK, gatilho, associação de entrada e associação de saída.

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

Essa seção descreve como usar uma biblioteca de classes. Para scripts 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ê referencie o pacote NuGet adequado. Instale o pacote NuGet versão 3.x.

Esta versão da extensão de associações do Azure Cosmos DB introduz a capacidade de conexão usando uma identidade em vez de um segredo. Para ver um tutorial sobre a configuração de aplicativos de funções com identidades gerenciadas, confira o tutorial sobre como criar um aplicativo de funções 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 representante que usa um parâmetro IFunctionsWorkerApplication. Em seguida, dentro do corpo desse representante, chame ConfigureCosmosDBExtension() no 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 função C# compilada da biblioteca de classes do processo de trabalho isolado é executada em um processo isolado do runtime.

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

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

¹ Documentos que contêm dados JSON podem ser desserializados em tipos POCO (objeto CLR) conhecidos.

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 dá suporte a tipos de parâmetro de acordo com a tabela abaixo. A compatibilidade com associações a tipo do Microsoft.Azure.Cosmos está em versão prévia.

Gatilho do Azure Cosmos DB

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

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

Associação de entrada do Azure Cosmos DB

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

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

¹ Para usar esses tipos, você precisa referenciar Microsoft.Azure.Functions.Worker.Extensions.CosmosDB 4.4.0-preview1 ou posterior e as dependências comuns para associações de tipo SDK.

Associação de saída do Cosmos DB

Quando você desejar que a função seja gravada em um único documento, a associação de saída do Cosmos DB poderá ser associada aos seguintes tipos:

Quando você desejar que a função seja gravada em vários documentos, a associação de saída do Cosmos DB poderá ser associada aos seguintes tipos:

Para outros cenários de saída, crie e use um CosmosClient com outros tipos diretamente de 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 do SDK do Azure.

Versões anteriores de extensões no processo de trabalho isolado só dão suporte à associação a tipos serializáveis JSON. Opções adicionais estão disponíveis para extensão 4.x e superior.