使用 Visual Studio Code 将 Azure Functions 连接到 Azure Cosmos DB

在开始之前，必须先完成快速入门：使用 Visual Studio Code 在 Azure 中创建 C# 函数。 如果在该文章结束时清理了资源，请再次执行相应的步骤，以在 Azure 中重新创建函数应用和相关资源。

在开始之前，必须先完成快速入门：使用 Visual Studio Code 在 Azure 中创建 JavaScript 函数。 如果在该文章结束时清理了资源，请再次执行相应的步骤，以在 Azure 中重新创建函数应用和相关资源。

在开始之前，必须先完成快速入门：使用 Visual Studio Code 在 Azure 中创建 Python 函数。 如果在该文章结束时清理了资源，请再次执行相应的步骤，以在 Azure 中重新创建函数应用和相关资源。

绑定（HTTP 和计时器触发器除外）将实现为扩展包。 在终端窗口中运行以下 dotnet add package 命令，将 Azure Cosmos DB 扩展包添加到项目中。

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.CosmosDB

项目已配置为使用扩展捆绑包，因此会自动安装一组预定义的扩展包。

在项目根目录下的 host.json 文件中启用扩展捆绑包，如下所示：

{
  "version": "2.0",
  "logging": {
    "applicationInsights": {
      "samplingSettings": {
        "isEnabled": true,
        "excludedTypes": "Request"
      }
    }
  },
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle",
    "version": "[4.*, 5.0.0)"
  },
  "concurrency": {
    "dynamicConcurrencyEnabled": true,
    "snapshotPersistenceEnabled": true
  },
  "extensions": {
    "cosmosDB": {
      "connectionMode": "Gateway"
    }
  }
}

项目已配置为使用扩展捆绑包，因此会自动安装一组预定义的扩展包。

在项目根目录下的 host.json 文件中启用扩展捆绑包，如下所示：

{
  "version": "2.0",
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle",
    "version": "[3.*, 4.0.0)"
  } 
}

在 C# 类库项目中，绑定被定义为函数方法上的绑定属性。

打开 HttpExample.cs 项目文件并添加以下类：

    public class MultiResponse
    {
        [CosmosDBOutput("my-database", "my-container",
            Connection = "CosmosDbConnectionSetting", CreateIfNotExists = true)]
        public MyDocument Document { get; set; }
        public HttpResponseData HttpResponse { get; set; }
    }
    public class MyDocument {
        public string id { get; set; }
        public string message { get; set; }
    }

MyDocument 类定义一个会写入数据库的对象。 存储帐户的连接字符串由 Connection 属性设置。 在本例中，可以省略 Connection，因为你已使用默认存储帐户。

MultiResponse 类允许在 Azure Cosmos DB 中写入指定集合，并返回 HTTP 成功消息。 由于需要返回 MultiResponse 对象，因此还需更新方法签名。

特定属性指定容器的名称及其父数据库的名称。 Azure Cosmos DB 帐户的连接字符串是由 CosmosDbConnectionSetting 设置。

绑定属性直接在函数代码中定义。 Azure Cosmos DB 输出配置描述了 Azure Cosmos DB 输出绑定必需的字段。

对于此 MultiResponse 方案，你需要向函数添加 extraOutputs 输出绑定。

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  extraOutputs: [sendToCosmosDb],
  handler: async (request, context) => {

将以下属性添加到绑定配置：

const sendToCosmosDb = output.cosmosDB({
  databaseName: 'my-database',
  containerName: 'my-container',
  createIfNotExists: false,
  connection: 'CosmosDBConnectionString',
});

直接在 function_app.py 文件中定义绑定属性。 使用 cosmos_db_output 修饰器添加 Azure Cosmos DB 输出绑定：

@app.cosmos_db_output(arg_name="outputDocument", database_name="my-database", 
    container_name="my-container", connection="CosmosDbConnectionSetting")

在此代码中，arg_name 标识代码中引用的绑定参数，database_name 和 container_name 是绑定写入到的数据库和集合名称，connection 是包含 Azure Cosmos DB 帐户连接字符串的应用程序设置的名称，该字符串位于 local.settings.json 文件的 CosmosDbConnectionSetting 设置中。

使用下面的代码替换现有 Run 方法：

        [Function("HttpExample")]
        public static MultiResponse Run([HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req,
            FunctionContext executionContext)
        {
            var logger = executionContext.GetLogger("HttpExample");
            logger.LogInformation("C# HTTP trigger function processed a request.");

            var message = "Welcome to Azure Functions!";

            var response = req.CreateResponse(HttpStatusCode.OK);
            response.Headers.Add("Content-Type", "text/plain; charset=utf-8");
            response.WriteString(message);

            // Return a response to both HTTP trigger and Azure Cosmos DB output binding.
            return new MultiResponse()
            {
                 Document = new MyDocument
                {
                    id = System.Guid.NewGuid().ToString(),
                    message = message
                },
                HttpResponse = response
            };
        }

添加使用 context 上的 extraInputs 输出绑定对象将 JSON 文档发送到命名输出绑定函数 sendToCosmosDb 的代码。 请在 return 语句之前添加此代码。

      context.extraOutputs.set(sendToCosmosDb, {
        // create a random ID
        id:
          new Date().toISOString() + Math.random().toString().substring(2, 10),
        name: name,
      });

此时，你的函数应如下所示：

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

const sendToCosmosDb = output.cosmosDB({
  databaseName: 'my-database',
  containerName: 'my-container',
  createIfNotExists: false,
  connection: 'CosmosDBConnectionString',
});

app.http('HttpExampleToCosmosDB', {
  methods: ['GET', 'POST'],
  extraOutputs: [sendToCosmosDb],
  handler: async (request, context) => {
    try {
      context.log(`Http function processed request for url "${request.url}"`);

      const name = request.query.get('name') || (await request.text());

      if (!name) {
        return { status: 404, body: 'Missing required data' };
      }

      // Output to Database
      context.extraOutputs.set(sendToCosmosDb, {
        // create a random ID
        id:
          new Date().toISOString() + Math.random().toString().substring(2, 10),
        name: name,
      });

      const responseMessage = name
        ? 'Hello, ' +
          name +
          '. This HTTP triggered function executed successfully.'
        : 'This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response.';

      // Return to HTTP client
      return { body: responseMessage };
    } catch (error) {
      context.log(`Error: ${error}`);
      return { status: 500, body: 'Internal Server Error' };
    }
  },
});

此代码现在将返回一个包含文档和 HTTP 响应的 MultiResponse 对象。

按以下代码所示更新 HttpExample\function_app.py。 将 outputDocument 参数添加到函数定义，并将 outputDocument.set() 添加到 if name: 语句下：

import azure.functions as func
import logging

app = func.FunctionApp()

@app.function_name(name="HttpTrigger1")
@app.route(route="hello", auth_level=func.AuthLevel.ANONYMOUS)
@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")
@app.cosmos_db_output(arg_name="outputDocument", database_name="my-database", container_name="my-container", connection="CosmosDbConnectionSetting")
def test_function(req: func.HttpRequest, msg: func.Out[func.QueueMessage],
    outputDocument: func.Out[func.Document]) -> func.HttpResponse:
     logging.info('Python HTTP trigger function processed a request.')
     logging.info('Python Cosmos DB trigger function processed a request.')
     name = req.params.get('name')
     if not name:
        try:
            req_body = req.get_json()
        except ValueError:
            pass
        else:
            name = req_body.get('name')

     if name:
        outputDocument.set(func.Document.from_dict({"id": name}))
        msg.set(name)
        return func.HttpResponse(f"Hello {name}!")
     else:
        return func.HttpResponse(
                    "Please pass a name on the query string or in the request body",
                    status_code=400
                )

文档 {"id": "name"} 在绑定中指定的数据库集合中创建。

在本地运行函数

Visual Studio Code 与 Azure Functions Core Tools 相集成，便于你在发布到 Azure 之前在本地开发计算机上运行此项目。

1. 若要调用函数，请按 F5 启动函数应用项目。 “终端”面板将显示 Core Tools 的输出。 应用将在“终端”面板中启动。 可以看到 HTTP 触发函数的 URL 终结点在本地运行。

   

   如果在 Windows 上运行时遇到问题，请确保用于 Visual Studio Code 的默认终端未设置为“WSL Bash”。

2. 运行 Core Tools 后，转到“Azure: Functions”区域。 在“Functions”下，展开“本地项目”>“Functions” 。 右键单击 (Windows) 或按 Ctrl - 单击 (macOS) HttpExample 函数，然后选择“立即执行函数...”。

   

3. 在“输入请求正文”中，按 Enter 向函数发送请求消息。

4. 当函数在本地执行并返回响应时，Visual Studio Code 中将引发通知。 函数执行的相关信息将显示在“终端”面板中。

5. 按 Ctrl + C 停止 Core Tools 并断开调试器的连接。

在本地运行函数

1. 与上一篇文章中所述，按 F5 启动函数应用项目和 Core Tools。

2. 运行 Core Tools 后，转到“Azure:Functions”区域。 在“Functions”下，展开“本地项目”>“Functions” 。 右键单击 HttpExample 函数（在 Mac 按 Ctrl-单击），然后选择“立即执行函数...”。

   

3. 在“输入请求正文”中，你将看到请求消息正文值 。 按 Enter 将此请求消息发送给函数。

4. 返回响应后，按 Ctrl + C 停用 Core Tools。

• C# 中完整 Function 项目的示例。

• Azure Functions C# 开发人员参考

• JavaScript 中完整函数项目的示例。

• Azure Functions JavaScript 开发人员指南

• Python 中完整函数项目的示例。

• Azure Functions Python 开发人员指南