Azure Functions 2.x 以降のAzure Cosmos DB入力バインド

Azure Cosmos DB入力バインドでは、SQL API を使用して 1 つ以上のAzure Cosmos DB ドキュメントを取得し、それらを関数の入力パラメーターに渡します。ドキュメント ID またはクエリパラメーターは、関数を呼び出したトリガーに基づいて決定することができます。

セットアップと構成の詳細については、概要に関するページをご覧ください。

注

コレクションがパーティション分割されている場合、検索操作では、パーティションキーの値も指定する必要があります。

重要

この記事では、タブを使用して、Node.js プログラミングモデルの複数のバージョンに対応しています。 v4 モデルは一般提供されており、JavaScript と TypeScript の開発者にとって、より柔軟で直感的なエクスペリエンスが得られるように設計されています。 v4 モデルの動作の詳細については、Azure Functions Node.js 開発者ガイドを参照してください。 v3 と v4 の違いの詳細については、移行ガイドを参照してください。

Azure Functionsでは、Python用の 2 つのプログラミングモデルがサポートされています。バインドを定義する方法は、選択したプログラミングモデルによって異なります。

Python v2 プログラミングモデルを使用すると、Python関数コードでデコレーターを使用してバインドを直接定義できます。詳細については、Python 開発者ガイドを参照してください。

この記事は、両方のプログラミングモデルをサポートしています。

例

特に明記されていない限り、この記事の例では、Azure Cosmos DB 拡張機能のバージョン 3.x を対象とします。拡張機能バージョン 4.x で使用するには、プロパティ名や属性名の文字列 collection を container に置き換える必要があります。

このバインドに関しては現在、Goのサポートは利用できません。

A C# 関数は、次の C# モードのいずれかを使用して作成できます。

分離されたワーカーモデル: ランタイムから分離されたワーカープロセスで実行されるコンパイル済みの C# 関数。分離ワーカープロセスは、.NETおよび .NET Framework の LTS および LTS 以外のバージョンで実行されている C# 関数をサポートするために必要です。分離ワーカープロセス関数の拡張機能では、Microsoft.Azure.Functions.Worker.Extensions.* 名前空間が使用されます。
インプロセスモデル: Functions ランタイムと同じプロセスで実行されるコンパイル済みの C# 関数。このモデルの一部では、主に C# ポータルの編集のためにサポートされている C# スクリプトを使用して Functions を実行できます。インプロセス関数の拡張機能では、Microsoft.Azure.WebJobs.Extensions.* 名前空間を使用します。

重要

インプロセスモデルのサポートは 2026 年 11 月 10 日に終了します。完全なサポートのために、分離ワーカーモデルにアプリを移行することを強くお勧めします。

分離ワーカーモデル
インプロセスモデル

このセクションには、バージョン 3.x のAzure Cosmos DB拡張機能と 5.x のAzure Storage拡張機能が必要な例が含まれています。関数アプリにない場合は、次の NuGet パッケージへの参照を追加します。

例では、次のようなシンプルな ToDoItem タイプを参照します。

キュートリガー、JSON からの ID の検索

次の例は、単一のドキュメントを取得する関数を示しています。この関数は、ストレージキュー内の JSON メッセージによってトリガーされます。キュートリガーにより、取得する ID とパーティションキー値を含む、ToDoItemLookup 型のオブジェクトに JSON が解析されます。その ID とパーティションキー値は、指定されたデータベースとコレクションから ToDoItem ドキュメントを返すために使用されます。

このセクションには、拡張バージョン3.x でインプロセス C# クラスライブラリ関数を使用するための次の例が含まれています。

キュートリガー、JSON からの ID の検索
HTTP トリガー、クエリ文字列からの ID の検索
HTTP トリガー、ルートデータからの ID の検索
HTTP トリガー、SqlQuery を使用したルートデータからの ID の検索
HTTP トリガー、SqlQuery を使用した複数のドキュメントの取得
HTTP トリガー、DocumentClient を使用した複数のドキュメントの取得
HTTP トリガー、CosmosClient (v4 拡張機能) を使用した複数のドキュメントの取得

例では、次のようなシンプルな ToDoItem タイプを参照します。

namespace CosmosDBSamplesV2
{
    public class ToDoItem
    {
        [JsonProperty("id")]
        public string Id { get; set; }

        [JsonProperty("partitionKey")]
        public string PartitionKey { get; set; }

        public string Description { get; set; }
    }
}

キュートリガー、JSON からの ID の検索

次の例は、単一のドキュメントを取得する C# 関数を示しています。関数は、JSON オブジェクトを含むキューメッセージによってトリガーされます。キュートリガーにより、検索する ID とパーティションキー値を含む、ToDoItemLookup タイプのオブジェクトに JSON が解析されます。その ID とパーティションキー値は、指定されたデータベースとコレクションから ToDoItem ドキュメントを取得するために使用されます。

namespace CosmosDBSamplesV2
{
    public class ToDoItemLookup
    {
        public string ToDoItemId { get; set; }

        public string ToDoItemPartitionKeyValue { get; set; }
    }
}

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;

namespace CosmosDBSamplesV2
{
    public static class DocByIdFromJSON
    {
        [FunctionName("DocByIdFromJSON")]
        public static void Run(
            [QueueTrigger("todoqueueforlookup")] ToDoItemLookup toDoItemLookup,
            [CosmosDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection",
                Id = "{ToDoItemId}",
                PartitionKey = "{ToDoItemPartitionKeyValue}")]ToDoItem toDoItem,
            ILogger log)
        {
            log.LogInformation($"C# Queue trigger function processed Id={toDoItemLookup?.ToDoItemId} Key={toDoItemLookup?.ToDoItemPartitionKeyValue}");

            if (toDoItem == null)
            {
                log.LogInformation($"ToDo item not found");
            }
            else
            {
                log.LogInformation($"Found ToDo item, Description={toDoItem.Description}");
            }
        }
    }
}

HTTP トリガー、クエリ文字列からの ID の検索

次の例は、単一のドキュメントを取得する C# 関数を示しています。関数は、クエリ文字列を使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションから ToDoItem ドキュメントを取得するために使用されます。

注

HTTP クエリ文字列パラメーターは大文字と小文字が区別されます。

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;

namespace CosmosDBSamplesV2
{
    public static class DocByIdFromQueryString
    {
        [FunctionName("DocByIdFromQueryString")]
        public static IActionResult Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)]
                HttpRequest req,
            [CosmosDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection",
                Id = "{Query.id}",
                PartitionKey = "{Query.partitionKey}")] ToDoItem toDoItem,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

            if (toDoItem == null)
            {
                log.LogInformation($"ToDo item not found");
            }
            else
            {
                log.LogInformation($"Found ToDo item, Description={toDoItem.Description}");
            }
            return new OkResult();
        }
    }
}

HTTP トリガー、ルートデータからの ID の検索

次の例は、単一のドキュメントを取得する C# 関数を示しています。関数は、ルートデータを使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションから ToDoItem ドキュメントを取得するために使用されます。

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;

namespace CosmosDBSamplesV2
{
    public static class DocByIdFromRouteData
    {
        [FunctionName("DocByIdFromRouteData")]
        public static IActionResult Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post",
                Route = "todoitems/{partitionKey}/{id}")]HttpRequest req,
            [CosmosDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection",
                Id = "{id}",
                PartitionKey = "{partitionKey}")] ToDoItem toDoItem,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

            if (toDoItem == null)
            {
                log.LogInformation($"ToDo item not found");
            }
            else
            {
                log.LogInformation($"Found ToDo item, Description={toDoItem.Description}");
            }
            return new OkResult();
        }
    }
}

HTTP トリガー、SqlQuery を使用したルートデータからの ID の検索

次の例は、単一のドキュメントを取得する C# 関数を示しています。関数は、ルートデータを使用して検索のための ID を指定する HTTP 要求によってトリガーされます。該当の ID は、指定されたデータベースとコレクションからの ToDoItem ドキュメントの取得に使用されます。

例では、SqlQuery パラメーターでバインド式を使用する方法を示しています。次に示すように、ルートデータを SqlQuery パラメーターに渡すことができますが、現在クエリ文字列値を渡すことはできません。

注

ID だけを使用してクエリを実行する必要がある場合は、前の例のように検索を使用することをお勧めします。これは、要求ユニットの消費量が少ないためです。ポイント読み取り操作 (GET) は ID によるクエリより効率性に優れています。

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

namespace CosmosDBSamplesV2
{
    public static class DocByIdFromRouteDataUsingSqlQuery
    {
        [FunctionName("DocByIdFromRouteDataUsingSqlQuery")]
        public static IActionResult Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post",
                Route = "todoitems2/{id}")]HttpRequest req,
            [CosmosDB("ToDoItems", "Items",
                ConnectionStringSetting = "CosmosDBConnection",
                SqlQuery = "select * from ToDoItems r where r.id = {id}")]
                IEnumerable<ToDoItem> toDoItems,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

            foreach (ToDoItem toDoItem in toDoItems)
            {
                log.LogInformation(toDoItem.Description);
            }
            return new OkResult();
        }
    }
}

HTTP トリガー、SqlQuery を使用した複数のドキュメントの取得

次の例は、ドキュメントの一覧を取得する C# 関数を示しています。関数は、HTTP 要求によってトリガーされます。クエリは、SqlQuery 属性プロパティで指定されます。

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

namespace CosmosDBSamplesV2
{
    public static class DocsBySqlQuery
    {
        [FunctionName("DocsBySqlQuery")]
        public static IActionResult Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)]
                HttpRequest req,
            [CosmosDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection",
                SqlQuery = "SELECT top 2 * FROM c order by c._ts desc")]
                IEnumerable<ToDoItem> toDoItems,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");
            foreach (ToDoItem toDoItem in toDoItems)
            {
                log.LogInformation(toDoItem.Description);
            }
            return new OkResult();
        }
    }
}

HTTP トリガー、DocumentClient を使用した複数のドキュメントの取得

次の例は、ドキュメントの一覧を取得する C# 関数を示しています。関数は、HTTP 要求によってトリガーされます。このコードでは、Azure Cosmos DB バインドによって提供される DocumentClient インスタンスを使用して、ドキュメントの一覧を読み取ります。また、DocumentClient インスタンスは、書き込み操作に使用できます。

注

IDocumentClient インターフェイスを使用してテストを容易にすることもできます。

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.Documents.Client;
using Microsoft.Azure.Documents.Linq;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;
using System;
using System.Linq;
using System.Threading.Tasks;

namespace CosmosDBSamplesV2
{
    public static class DocsByUsingDocumentClient
    {
        [FunctionName("DocsByUsingDocumentClient")]
        public static async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post",
                Route = null)]HttpRequest req,
            [CosmosDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection")] DocumentClient client,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

            var searchterm = req.Query["searchterm"];
            if (string.IsNullOrWhiteSpace(searchterm))
            {
                return (ActionResult)new NotFoundResult();
            }

            Uri collectionUri = UriFactory.CreateDocumentCollectionUri("ToDoItems", "Items");

            log.LogInformation($"Searching for: {searchterm}");

            IDocumentQuery<ToDoItem> query = client.CreateDocumentQuery<ToDoItem>(collectionUri)
                .Where(p => p.Description.Contains(searchterm))
                .AsDocumentQuery();

            while (query.HasMoreResults)
            {
                foreach (ToDoItem result in await query.ExecuteNextAsync())
                {
                    log.LogInformation(result.Description);
                }
            }
            return new OkResult();
        }
    }
}

HTTP トリガー、CosmosClient を使用した複数のドキュメントの取得

次の例は、ドキュメントの一覧を取得する C# 関数を示しています。関数は、HTTP 要求によってトリガーされます。このコードでは、Azure Cosmos DB バインドによって提供される CosmosClient インスタンスを使用します。extension バージョン 4.x で使用して、ドキュメントの一覧を読み取ります。また、CosmosClient インスタンスは、書き込み操作に使用できます。

using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.Cosmos;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Extensions.Logging;

namespace CosmosDBSamplesV2
{
    public static class DocsByUsingCosmosClient
    {  
        [FunctionName("DocsByUsingCosmosClient")]
        public static async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post",
                Route = null)]HttpRequest req,
            [CosmosDB(
                databaseName: "ToDoItems",
                containerName: "Items",
                Connection = "CosmosDBConnection")] CosmosClient client,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

            var searchterm = req.Query["searchterm"].ToString();
            if (string.IsNullOrWhiteSpace(searchterm))
            {
                return (ActionResult)new NotFoundResult();
            }

            Container container = client.GetDatabase("ToDoItems").GetContainer("Items");

            log.LogInformation($"Searching for: {searchterm}");

            QueryDefinition queryDefinition = new QueryDefinition(
                "SELECT * FROM items i WHERE CONTAINS(i.Description, @searchterm)")
                .WithParameter("@searchterm", searchterm);
            using (FeedIterator<ToDoItem> resultSet = container.GetItemQueryIterator<ToDoItem>(queryDefinition))
            {
                while (resultSet.HasMoreResults)
                {
                    FeedResponse<ToDoItem> response = await resultSet.ReadNextAsync();
                    ToDoItem item = response.First();
                    log.LogInformation(item.Description);
                }
            }

            return new OkResult();
        }
    }
}

このセクションには、次の例が含まれています。

HTTP トリガー、クエリ文字列からの ID の検索 - String パラメーター
HTTP トリガー、クエリ文字列からの ID の検索 - POJO パラメーター
HTTP トリガー、ルートデータからの ID の検索
HTTP トリガー、SqlQuery を使用したルートデータからの ID の検索
HTTP トリガー、ルートデータからの複数のドキュメントの取得、SqlQuery を使用

例では、次のようなシンプルな ToDoItem タイプを参照します。

public class ToDoItem {

  private String id;
  private String description;

  public String getId() {
    return id;
  }

  public String getDescription() {
    return description;
  }

  @Override
  public String toString() {
    return "ToDoItem={id=" + id + ",description=" + description + "}";
  }
}

HTTP トリガー、クエリ文字列からの ID の検索 - String パラメーター

次の例は、1 つのドキュメントを取得するJava関数を示しています。関数は、クエリ文字列を使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションからドキュメントを String 形式で取得するために使用されます。

public class DocByIdFromQueryString {

    @FunctionName("DocByIdFromQueryString")
    public HttpResponseMessage run(
            @HttpTrigger(name = "req",
              methods = {HttpMethod.GET, HttpMethod.POST},
              authLevel = AuthorizationLevel.ANONYMOUS)
            HttpRequestMessage<Optional<String>> request,
            @CosmosDBInput(name = "database",
              databaseName = "ToDoList",
              collectionName = "Items",
              id = "{Query.id}",
              partitionKey = "{Query.partitionKeyValue}",
              connectionStringSetting = "Cosmos_DB_Connection_String")
            Optional<String> item,
            final ExecutionContext context) {

        // Item list
        context.getLogger().info("Parameters are: " + request.getQueryParameters());
        context.getLogger().info("String from the database is " + (item.isPresent() ? item.get() : null));

        // Convert and display
        if (!item.isPresent()) {
            return request.createResponseBuilder(HttpStatus.BAD_REQUEST)
                          .body("Document not found.")
                          .build();
        }
        else {
            // return JSON from Cosmos. Alternatively, we can parse the JSON string
            // and return an enriched JSON object.
            return request.createResponseBuilder(HttpStatus.OK)
                          .header("Content-Type", "application/json")
                          .body(item.get())
                          .build();
        }
    }
}

Java関数ランタイムライブラリで、Azure Cosmos DBから取得される値を持つ関数パラメーターに対して @CosmosDBInput 注釈を使用します。この注釈は、Optional<T> を使用して、ネイティブ Java型、POJO、または null 許容値と共に使用できます。

HTTP トリガー、クエリ文字列からの ID の検索 - POJO パラメーター

次の例は、1 つのドキュメントを取得するJava関数を示しています。関数は、クエリ文字列を使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションからドキュメントを取得するために使用されます。このドキュメントはその後、前に作成した ToDoItem POJO のインスタンスに変換され、引数として関数に渡されます。

public class DocByIdFromQueryStringPojo {

    @FunctionName("DocByIdFromQueryStringPojo")
    public HttpResponseMessage run(
            @HttpTrigger(name = "req",
              methods = {HttpMethod.GET, HttpMethod.POST},
              authLevel = AuthorizationLevel.ANONYMOUS)
            HttpRequestMessage<Optional<String>> request,
            @CosmosDBInput(name = "database",
              databaseName = "ToDoList",
              collectionName = "Items",
              id = "{Query.id}",
              partitionKey = "{Query.partitionKeyValue}",
              connectionStringSetting = "Cosmos_DB_Connection_String")
            ToDoItem item,
            final ExecutionContext context) {

        // Item list
        context.getLogger().info("Parameters are: " + request.getQueryParameters());
        context.getLogger().info("Item from the database is " + item);

        // Convert and display
        if (item == null) {
            return request.createResponseBuilder(HttpStatus.BAD_REQUEST)
                          .body("Document not found.")
                          .build();
        }
        else {
            return request.createResponseBuilder(HttpStatus.OK)
                          .header("Content-Type", "application/json")
                          .body(item)
                          .build();
        }
    }
}

HTTP トリガー、ルートデータからの ID の検索

次の例は、1 つのドキュメントを取得するJava関数を示しています。関数は、ルートパラメーターを使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションからドキュメントを取得し、Optional<String> として返すために使用されます。

public class DocByIdFromRoute {

    @FunctionName("DocByIdFromRoute")
    public HttpResponseMessage run(
            @HttpTrigger(name = "req",
              methods = {HttpMethod.GET, HttpMethod.POST},
              authLevel = AuthorizationLevel.ANONYMOUS,
              route = "todoitems/{partitionKeyValue}/{id}")
            HttpRequestMessage<Optional<String>> request,
            @CosmosDBInput(name = "database",
              databaseName = "ToDoList",
              collectionName = "Items",
              id = "{id}",
              partitionKey = "{partitionKeyValue}",
              connectionStringSetting = "Cosmos_DB_Connection_String")
            Optional<String> item,
            final ExecutionContext context) {

        // Item list
        context.getLogger().info("Parameters are: " + request.getQueryParameters());
        context.getLogger().info("String from the database is " + (item.isPresent() ? item.get() : null));

        // Convert and display
        if (!item.isPresent()) {
            return request.createResponseBuilder(HttpStatus.BAD_REQUEST)
                          .body("Document not found.")
                          .build();
        }
        else {
            // return JSON from Cosmos. Alternatively, we can parse the JSON string
            // and return an enriched JSON object.
            return request.createResponseBuilder(HttpStatus.OK)
                          .header("Content-Type", "application/json")
                          .body(item.get())
                          .build();
        }
    }
}

HTTP トリガー、SqlQuery を使用したルートデータからの ID の検索

次の例は、1 つのドキュメントを取得するJava関数を示しています。この関数は、ルートパラメーターを使用して検索する ID を指定する HTTP 要求によってトリガーされます。クエリ条件によっては多数のドキュメントが返される可能性があるため、その ID は、指定されたデータベースとコレクションからドキュメントを取得し、結果セットを ToDoItem[] に変換するために使用されます。

注

public class DocByIdFromRouteSqlQuery {

    @FunctionName("DocByIdFromRouteSqlQuery")
    public HttpResponseMessage run(
            @HttpTrigger(name = "req",
              methods = {HttpMethod.GET, HttpMethod.POST},
              authLevel = AuthorizationLevel.ANONYMOUS,
              route = "todoitems2/{id}")
            HttpRequestMessage<Optional<String>> request,
            @CosmosDBInput(name = "database",
              databaseName = "ToDoList",
              collectionName = "Items",
              sqlQuery = "select * from Items r where r.id = {id}",
              connectionStringSetting = "Cosmos_DB_Connection_String")
            ToDoItem[] item,
            final ExecutionContext context) {

        // Item list
        context.getLogger().info("Parameters are: " + request.getQueryParameters());
        context.getLogger().info("Items from the database are " + item);

        // Convert and display
        if (item == null) {
            return request.createResponseBuilder(HttpStatus.BAD_REQUEST)
                          .body("Document not found.")
                          .build();
        }
        else {
            return request.createResponseBuilder(HttpStatus.OK)
                          .header("Content-Type", "application/json")
                          .body(item)
                          .build();
        }
    }
}

HTTP トリガー、ルートデータからの複数のドキュメントの取得、SqlQuery を使用

次の例は、複数のドキュメントを取得するJava関数を示しています。この関数は、ルートパラメーター desc を使用して description フィールドで検索する文字列を指定する HTTP 要求によってトリガーされます。この検索用語は、指定されたデータベースとコレクションからドキュメントのコレクションを取得し、結果セットを ToDoItem[] に変換して、それを引数として関数に渡すために使用されます。

public class DocsFromRouteSqlQuery {

    @FunctionName("DocsFromRouteSqlQuery")
    public HttpResponseMessage run(
            @HttpTrigger(name = "req",
              methods = {HttpMethod.GET},
              authLevel = AuthorizationLevel.ANONYMOUS,
              route = "todoitems3/{desc}")
            HttpRequestMessage<Optional<String>> request,
            @CosmosDBInput(name = "database",
              databaseName = "ToDoList",
              collectionName = "Items",
              sqlQuery = "select * from Items r where contains(r.description, {desc})",
              connectionStringSetting = "Cosmos_DB_Connection_String")
            ToDoItem[] items,
            final ExecutionContext context) {

        // Item list
        context.getLogger().info("Parameters are: " + request.getQueryParameters());
        context.getLogger().info("Number of items from the database is " + (items == null ? 0 : items.length));

        // Convert and display
        if (items == null) {
            return request.createResponseBuilder(HttpStatus.BAD_REQUEST)
                          .body("No documents found.")
                          .build();
        }
        else {
            return request.createResponseBuilder(HttpStatus.OK)
                          .header("Content-Type", "application/json")
                          .body(items)
                          .build();
        }
    }
}

このセクションには、次の例が含まれています。各例では、さまざまなソースから ID 値を指定して単一のドキュメントを読み取ります。

キュートリガー、JSON からの ID の検索
HTTP トリガー、クエリ文字列からの ID の検索
HTTP トリガー、ルートデータからの ID の検索
キュートリガー、SqlQuery を使用した複数のドキュメントの取得

キュートリガー、JSON からの ID の検索

次の例は、単一のドキュメントを読み取り、そのドキュメントのテキスト値を更新する TypeScript 関数を示しています。

モデル v4
モデル v3

HTTP トリガー、クエリ文字列からの ID の検索

次の例は、単一のドキュメントを取得する TypeScript 関数を示しています。関数は、クエリ文字列を使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションから ToDoItem ドキュメントを取得するために使用されます。

モデル v4
モデル v3

HTTP トリガー、ルートデータからの ID の検索

次の例は、単一のドキュメントを取得する TypeScript 関数を示しています。関数は、ルートデータを使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションから ToDoItem ドキュメントを取得するために使用されます。

モデル v4
モデル v3

キュートリガー、SqlQuery を使用した複数のドキュメントの取得

次の例は、SQL クエリで指定されている複数のドキュメントを、キュートリガーを使用してクエリパラメーターをカスタマイズすることで取得する TypeScript 関数を示しています。

キュートリガーがパラメーター departmentId を提供します。 { "departmentId" : "Finance" } のキューメッセージは、金融部門のすべてのレコードを返します。

モデル v4
モデル v3

このセクションには、次の例が含まれています。各例では、さまざまなソースから ID 値を指定して単一のドキュメントを読み取ります。

キュートリガー、JSON からの ID の検索
HTTP トリガー、クエリ文字列からの ID の検索
HTTP トリガー、ルートデータからの ID の検索
キュートリガー、SqlQuery を使用した複数のドキュメントの取得

キュートリガー、JSON からの ID の検索

次の例は、単一のドキュメントを読み取り、そのドキュメントのテキスト値を更新する JavaScript 関数を示しています。

モデル v4
モデル v3

function.json ファイルのバインディングデータを次に示します。

{
    "name": "inputDocumentIn",
    "type": "cosmosDB",
    "databaseName": "MyDatabase",
    "collectionName": "MyCollection",
    "id" : "{queueTrigger_payload_property}",
    "partitionKey": "{queueTrigger_payload_property}",
    "connectionStringSetting": "MyAccount_COSMOSDB",
    "direction": "in"
},
{
    "name": "inputDocumentOut",
    "type": "cosmosDB",
    "databaseName": "MyDatabase",
    "collectionName": "MyCollection",
    "createIfNotExists": false,
    "partitionKey": "{queueTrigger_payload_property}",
    "connectionStringSetting": "MyAccount_COSMOSDB",
    "direction": "out"
}

これらのプロパティについては、「構成」セクションを参照してください。

JavaScript コードを次に示します。

    // Change input document contents using Azure Cosmos DB input binding, using context.bindings.inputDocumentOut
    module.exports = async function (context) {
        context.bindings.inputDocumentOut = context.bindings.inputDocumentIn;
        context.bindings.inputDocumentOut.text = "This was updated!";
    };

HTTP トリガー、クエリ文字列からの ID の検索

次の例は、単一のドキュメントを取得する JavaScript 関数を示しています。関数は、クエリ文字列を使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションから ToDoItem ドキュメントを取得するために使用されます。

モデル v4
モデル v3

function.json ファイルを次に示します。

{
  "bindings": [
    {
      "authLevel": "anonymous",
      "name": "req",
      "type": "httpTrigger",
      "direction": "in",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "name": "$return",
      "type": "http",
      "direction": "out"
    },
    {
      "type": "cosmosDB",
      "name": "toDoItem",
      "databaseName": "ToDoItems",
      "collectionName": "Items",
      "connectionStringSetting": "CosmosDBConnection",
      "direction": "in",
      "Id": "{Query.id}",
      "PartitionKey": "{Query.partitionKeyValue}"
    }
  ],
  "disabled": false
}

JavaScript コードを次に示します。

module.exports = async function (context, req, toDoItem) {
    context.log('JavaScript queue trigger function processed work item');
    if (!toDoItem)
    {
        context.log("ToDo item not found");
    }
    else
    {
        context.log("Found ToDo item, Description=" + toDoItem.Description);
    }
};

HTTP トリガー、ルートデータからの ID の検索

次の例は、単一のドキュメントを取得する JavaScript 関数を示しています。関数は、ルートデータを使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションから ToDoItem ドキュメントを取得するために使用されます。

モデル v4
モデル v3

function.json ファイルを次に示します。

{
  "bindings": [
    {
      "authLevel": "anonymous",
      "name": "req",
      "type": "httpTrigger",
      "direction": "in",
      "methods": [
        "get",
        "post"
      ],
      "route":"todoitems/{partitionKeyValue}/{id}"
    },
    {
      "name": "$return",
      "type": "http",
      "direction": "out"
    },
    {
      "type": "cosmosDB",
      "name": "toDoItem",
      "databaseName": "ToDoItems",
      "collectionName": "Items",
      "connectionStringSetting": "CosmosDBConnection",
      "direction": "in",
      "Id": "{id}",
      "PartitionKey": "{partitionKeyValue}"
    }
  ],
  "disabled": false
}

JavaScript コードを次に示します。

module.exports = async function (context, req, toDoItem) {
    context.log('JavaScript queue trigger function processed work item');
    if (!toDoItem)
    {
        context.log("ToDo item not found");
    }
    else
    {
        context.log("Found ToDo item, Description=" + toDoItem.Description);
    }
};

キュートリガー、SqlQuery を使用した複数のドキュメントの取得

次の例は、SQL クエリで指定されている複数のドキュメントを、キュートリガーを使用してクエリパラメーターをカスタマイズすることで取得する JavaScript 関数を示しています。

モデル v4
モデル v3

function.json ファイルのバインディングデータを次に示します。

{
    "name": "documents",
    "type": "cosmosDB",
    "direction": "in",
    "databaseName": "MyDb",
    "collectionName": "MyCollection",
    "sqlQuery": "SELECT * from c where c.departmentId = {departmentId}",
    "connectionStringSetting": "CosmosDBConnection"
}

これらのプロパティについては、「構成」セクションを参照してください。

JavaScript コードを次に示します。

module.exports = async function (context, input) {
  var documents = context.bindings.documents;
  for (const document of documents) {
    // operate on each document
  }
};

キュートリガー、JSON からの ID の検索
HTTP トリガー、クエリ文字列からの ID の検索
HTTP トリガー、ルートデータからの ID の検索
キュートリガー、SqlQuery を使用した複数のドキュメントの取得

キュートリガー、JSON からの ID の検索

次の例では、1 つのAzure Cosmos DB ドキュメントを読み取って更新する方法を示します。ドキュメントの一意識別子は、キューメッセージの JSON 値によって提供されます。

Azure Cosmos DB入力バインドは、関数の構成ファイル (function.json) にあるバインドの一覧に最初に表示されます。

{
  "name": "InputDocumentIn",
  "type": "cosmosDB",
  "databaseName": "MyDatabase",
  "collectionName": "MyCollection",
  "id": "{queueTrigger_payload_property}",
  "partitionKey": "{queueTrigger_payload_property}",
  "connectionStringSetting": "CosmosDBConnection",
  "direction": "in"
},
{
  "name": "InputDocumentOut",
  "type": "cosmosDB",
  "databaseName": "MyDatabase",
  "collectionName": "MyCollection",
  "createIfNotExists": false,
  "partitionKey": "{queueTrigger_payload_property}",
  "connectionStringSetting": "CosmosDBConnection",
  "direction": "out"
}

run.ps1 ファイルには、受信ドキュメントを読み取り、変更を出力する PowerShell コードが含まれます。

param($QueueItem, $InputDocumentIn, $TriggerMetadata)

$Document = $InputDocumentIn 
$Document.text = 'This was updated!'

Push-OutputBinding -Name InputDocumentOut -Value $Document

HTTP トリガー、クエリ文字列からの ID の検索

次の例では、Web API から 1 つのAzure Cosmos DB ドキュメントを読み取って更新する方法を示します。ドキュメントの一意識別子は、バインドの "Id": "{Query.Id}" プロパティで定義されているように、HTTP 要求の querystring パラメーターを通じて提供されます。

Azure Cosmos DB入力バインドは、関数の構成ファイル (function.json) にあるバインドの一覧に最初に表示されます。

{ 
  "bindings": [ 
    { 
      "type": "cosmosDB", 
      "name": "ToDoItem", 
      "databaseName": "ToDoItems", 
      "collectionName": "Items", 
      "connectionStringSetting": "CosmosDBConnection", 
      "direction": "in", 
      "Id": "{Query.id}", 
      "PartitionKey": "{Query.partitionKeyValue}" 
    },
    { 
      "authLevel": "anonymous", 
      "name": "Request", 
      "type": "httpTrigger", 
      "direction": "in", 
      "methods": [ 
        "get", 
        "post" 
      ] 
    }, 
    { 
      "name": "Response", 
      "type": "http", 
      "direction": "out" 
    },
  ], 
  "disabled": false 
}

run.ps1 ファイルには、受信ドキュメントを読み取り、変更を出力する PowerShell コードが含まれます。

using namespace System.Net

param($Request, $ToDoItem, $TriggerMetadata)

Write-Host 'PowerShell HTTP trigger function processed a request'

if (-not $ToDoItem) { 
    Write-Host 'ToDo item not found'

    Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{ 
        StatusCode = [HttpStatusCode]::NotFound 
        Body = $ToDoItem.Description 
    })

} else {

    Write-Host "Found ToDo item, Description=$($ToDoItem.Description)"

    Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{ 
        StatusCode = [HttpStatusCode]::OK 
        Body = $ToDoItem.Description 
    }) 
}

HTTP トリガー、ルートデータからの ID の検索

次の例では、Web API から 1 つのAzure Cosmos DB ドキュメントを読み取って更新する方法を示します。ドキュメントの一意識別子は、route パラメーターを通じて提供されます。ルートパラメーターは、HTTP 要求バインディングの route プロパティで定義され、Azure Cosmos DB "Id": "{Id}" バインドプロパティで参照されます。

Azure Cosmos DB入力バインドは、関数の構成ファイル (function.json) にあるバインドの一覧に最初に表示されます。

{ 
  "bindings": [ 
    { 
      "type": "cosmosDB", 
      "name": "ToDoItem", 
      "databaseName": "ToDoItems", 
      "collectionName": "Items", 
      "connectionStringSetting": "CosmosDBConnection", 
      "direction": "in", 
      "Id": "{id}", 
      "PartitionKey": "{partitionKeyValue}" 
    },
    { 
      "authLevel": "anonymous", 
      "name": "Request", 
      "type": "httpTrigger", 
      "direction": "in", 
      "methods": [ 
        "get", 
        "post" 
      ], 
      "route": "todoitems/{partitionKeyValue}/{id}" 
    }, 
    { 
      "name": "Response", 
      "type": "http", 
      "direction": "out" 
    }
  ], 
  "disabled": false 
}

run.ps1 ファイルには、受信ドキュメントを読み取り、変更を出力する PowerShell コードが含まれます。

using namespace System.Net

param($Request, $ToDoItem, $TriggerMetadata)

Write-Host 'PowerShell HTTP trigger function processed a request'

if (-not $ToDoItem) { 
    Write-Host 'ToDo item not found'

    Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{ 
        StatusCode = [HttpStatusCode]::NotFound 
        Body = $ToDoItem.Description 
    })

} else { 
    Write-Host "Found ToDo item, Description=$($ToDoItem.Description)"

    Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{ 
        StatusCode = [HttpStatusCode]::OK 
        Body = $ToDoItem.Description 
    }) 
}

キュートリガー、SqlQuery を使用した複数のドキュメントの取得

次の例では、複数のAzure Cosmos DBドキュメントを読み取る方法を示します。関数の構成ファイル (function.json) によって、sqlQuery を含むバインドプロパティが定義されます。 sqlQuery プロパティに指定された SQL ステートメントによって、関数に提供されるドキュメントのセットが選択されます。

{ 
  "name": "Documents", 
  "type": "cosmosDB", 
  "direction": "in", 
  "databaseName": "MyDb", 
  "collectionName": "MyCollection", 
  "sqlQuery": "SELECT * from c where c.departmentId = {departmentId}", 
  "connectionStringSetting": "CosmosDBConnection" 
}

run1.ps1 ファイルには、受信ドキュメントを読み取る PowerShell コードが含まれます。

param($QueueItem, $Documents, $TriggerMetadata)

foreach ($Document in $Documents) { 
    # operate on each document 
}

このセクションには、次の例が含まれています。各例では、さまざまなソースから ID 値を指定して単一のドキュメントを読み取ります。

キュートリガー、JSON からの ID の検索
HTTP トリガー、クエリ文字列からの ID の検索
HTTP トリガー、ルートデータからの ID の検索
キュートリガー、SqlQuery を使用した複数のドキュメントの取得

例は、v1 または v2 Python プログラミングモデルのどちらを使用するかによって異なります。

Cosmos DB の SDK-Type バインドの使用 (プレビュー)

この例では、SDK 型を使用して、Cosmos DB 入力バインディングによって提供される基になる CosmosClient オブジェクトに直接アクセスします。

この関数は、すべてのデータベースをループし、その ID をログに記録します。

import logging
import azure.functions as func
import azurefunctions.extensions.bindings.cosmosdb as cosmos

app = func.FunctionApp(http_auth_level=func.AuthLevel.FUNCTION)

@app.route(route="cosmos")
@app.cosmos_db_input(arg_name="client",
                     connection="CosmosDBConnection",
                     database_name=None,
                     container_name=None)
def get_docs(req: func.HttpRequest, client: cosmos.CosmosClient):
    databases = client.list_databases()
    for db in databases:
        logging.info(f"Found database with ID: {db.get('id')}")

    return "ok"

他の SDK の種類の使用例については、ContainerProxy および DatabaseProxy サンプルを参照してください。関数アプリに SDK 型のバインドを含める方法の詳細なチュートリアルについては、Python CosmosDB 用 SDK バインドのサンプルに従ってください。

他の SDK 型バインドがサポートされているものも含め、詳細については、 SDK の型バインドに関するページを参照してください。

キュートリガー、JSON からの ID の検索

次の例は、Azure Cosmos DB入力バインドを示しています。この関数は、1 つのドキュメントを読み取って、そのドキュメントのテキスト値を更新します。

import logging
import azure.functions as func

app = func.FunctionApp()

@app.queue_trigger(arg_name="msg", 
                   queue_name="outqueue", 
                   connection="AzureWebJobsStorage")
@app.cosmos_db_input(arg_name="documents", 
                     database_name="MyDatabase",
                     collection_name="MyCollection",
                     id="{msg.payload_property}",
                     partition_key="{msg.payload_property}",
                     connection_string_setting="MyAccount_COSMOSDB")
@app.cosmos_db_output(arg_name="outputDocument", 
                      database_name="MyDatabase",
                      collection_name="MyCollection",
                      connection_string_setting="MyAccount_COSMOSDB")
def test_function(msg: func.QueueMessage,
                  inputDocument: func.DocumentList, 
                  outputDocument: func.Out[func.Document]):
     doc = inputDocument[0]
     doc["text"] = "This was updated!"
     outputDocument.set(doc)
     print(f"Updated document.")

function.json ファイルのバインディングデータを次に示します。

{
    "name": "documents",
    "type": "cosmosDB",
    "databaseName": "MyDatabase",
    "collectionName": "MyCollection",
    "id" : "{queueTrigger_payload_property}",
    "partitionKey": "{queueTrigger_payload_property}",
    "connectionStringSetting": "MyAccount_COSMOSDB",
    "direction": "in"
},
{
    "name": "$return",
    "type": "cosmosDB",
    "databaseName": "MyDatabase",
    "collectionName": "MyCollection",
    "createIfNotExists": false,
    "partitionKey": "{queueTrigger_payload_property}",
    "connectionStringSetting": "MyAccount_COSMOSDB",
    "direction": "out"
}

これらのプロパティについては、「構成」セクションを参照してください。

Pythonコードを次に示します。

import azure.functions as func

def main(queuemsg: func.QueueMessage, documents: func.DocumentList) -> func.Document:
    if documents:
        document = documents[0]
        document['text'] = 'This was updated!'
        return document

HTTP トリガー、クエリ文字列からの ID の検索

次の例は、単一のドキュメントを取得する関数を示しています。関数は、クエリ文字列を使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションから ToDoItem ドキュメントを取得するために使用されます。

現時点では、v2 に対応するサンプルはありません。

function.json ファイルを次に示します。

{
  "bindings": [
    {
      "authLevel": "anonymous",
      "name": "req",
      "type": "httpTrigger",
      "direction": "in",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "name": "$return",
      "type": "http",
      "direction": "out"
    },
    {
      "type": "cosmosDB",
      "name": "todoitems",
      "databaseName": "ToDoItems",
      "collectionName": "Items",
      "connectionStringSetting": "CosmosDBConnection",
      "direction": "in",
      "Id": "{Query.id}",
      "PartitionKey": "{Query.partitionKeyValue}"
    }
  ],
  "scriptFile": "__init__.py"
}

Pythonコードを次に示します。

import logging
import azure.functions as func

def main(req: func.HttpRequest, todoitems: func.DocumentList) -> str:
    if not todoitems:
        logging.warning("ToDo item not found")
    else:
        logging.info("Found ToDo item, Description=%s",
                     todoitems[0]['description'])

    return 'OK'

HTTP トリガー、ルートデータからの ID の検索

次の例は、単一のドキュメントを取得する関数を示しています。関数は、ルートデータを使用して検索のための ID とパーティションキー値を指定する HTTP 要求によってトリガーされます。その ID とパーティションキー値は、指定されたデータベースとコレクションから ToDoItem ドキュメントを取得するために使用されます。

現時点では、v2 に対応するサンプルはありません。

function.json ファイルを次に示します。

{
  "bindings": [
    {
      "authLevel": "anonymous",
      "name": "req",
      "type": "httpTrigger",
      "direction": "in",
      "methods": [
        "get",
        "post"
      ],
      "route":"todoitems/{partitionKeyValue}/{id}"
    },
    {
      "name": "$return",
      "type": "http",
      "direction": "out"
    },
    {
      "type": "cosmosDB",
      "name": "todoitems",
      "databaseName": "ToDoItems",
      "collectionName": "Items",
      "connection": "CosmosDBConnection",
      "direction": "in",
      "Id": "{id}",
      "PartitionKey": "{partitionKeyValue}"
    }
  ],
  "disabled": false,
  "scriptFile": "__init__.py"
}

Pythonコードを次に示します。

import logging
import azure.functions as func

def main(req: func.HttpRequest, todoitems: func.DocumentList) -> str:
    if not todoitems:
        logging.warning("ToDo item not found")
    else:
        logging.info("Found ToDo item, Description=%s",
                     todoitems[0]['description'])
    return 'OK'

キュートリガー、SqlQuery を使用した複数のドキュメントの取得

次の例は、バインドを使用するAzure Cosmos DB入力バインドPython関数を示しています。この関数は、SQL クエリで指定されている複数のドキュメントを、キュートリガーを使用してクエリパラメーターをカスタマイズすることで取得します。

現時点では、v2 に対応するサンプルはありません。

function.json ファイルのバインディングデータを次に示します。

{
    "name": "documents",
    "type": "cosmosDB",
    "direction": "in",
    "databaseName": "MyDb",
    "collectionName": "MyCollection",
    "sqlQuery": "SELECT * from c where c.departmentId = {departmentId}",
    "connectionStringSetting": "CosmosDBConnection"
}

属性

インプロセスと分離ワーカープロセスの C# ライブラリの両方で、属性を使って関数を定義します。 C# スクリプトでは、C# スクリプトガイドで説明されているように、代わりに function.json 構成ファイルを使用します。

属性のプロパティ	説明
接続	クエリ対象のAzure Cosmos DB アカウントに接続する方法を指定するアプリ設定または設定コレクションの名前。詳細については、「接続」を参照してください。
DatabaseName	監視対象のコンテナーを含むAzure Cosmos DB データベースの名前。
ContainerName	監視対象のコンテナーの名前。
PartitionKey	参照用のパーティションキー値を指定します。バインディングパラメーターを含めることもできます。パーティション分割されたコンテナーの検索に必要です。
身分証明書	取得するドキュメントの ID。このプロパティは、バインド式をサポートしています。 `Id` と `SqlQuery` プロパティの両方は設定しないでください。いずれも設定しなかった場合は、コンテナー全体が取得されます。
SqlQuery の	複数のドキュメントを取得するために使用するAzure Cosmos DB SQL クエリ。このプロパティは、次の例のように実行時のバインドをサポートします。`SELECT * FROM c where c.departmentId = {departmentId}` `Id` と `SqlQuery` プロパティの両方は設定しないでください。いずれも設定しなかった場合は、コンテナー全体が取得されます。
PreferredLocations	(省略可能)Azure Cosmos DB サービス内の geo レプリケートされたデータベースアカウントの優先する場所 (リージョン) を定義します。複数の値はコンマで区切る必要があります。たとえば、`East US,South Central US,North Europe` のようにします。

属性のプロパティ	説明
ConnectionStringSetting	監視対象のAzure Cosmos DB アカウントに接続する方法を指定するアプリ設定または設定コレクションの名前。詳細については、「接続」を参照してください。
DatabaseName	監視対象のコレクションを含むAzure Cosmos DB データベースの名前。
CollectionName	監視されているコレクションの名前。
PartitionKey	参照用のパーティションキー値を指定します。バインディングパラメーターを含めることもできます。パーティション分割されたコレクションの参照で必須です。
身分証明書	取得するドキュメントの ID。このプロパティは、バインド式をサポートしています。 `Id` と `SqlQuery` プロパティの両方は設定しないでください。いずれも設定しない場合は、コレクション全体が取得されます。
SqlQuery の	複数のドキュメントを取得するために使用するAzure Cosmos DB SQL クエリ。このプロパティは、次の例のように実行時のバインドをサポートします。`SELECT * FROM c where c.departmentId = {departmentId}` `Id` と `SqlQuery` プロパティの両方は設定しないでください。いずれも設定しない場合は、コレクション全体が取得されます。
PreferredLocations	(省略可能)Azure Cosmos DB サービス内の geo レプリケートされたデータベースアカウントの優先する場所 (リージョン) を定義します。複数の値はコンマで区切る必要があります。たとえば、"East US,South Central US,North Europe" などです。

属性のプロパティ	説明
接続	クエリ対象のAzure Cosmos DB アカウントに接続する方法を指定するアプリ設定または設定コレクションの名前。詳細については、「接続」を参照してください。
DatabaseName	監視対象のコンテナーを含むAzure Cosmos DB データベースの名前。
ContainerName	監視対象のコンテナーの名前。
PartitionKey	参照用のパーティションキー値を指定します。バインディングパラメーターを含めることもできます。パーティション分割されたコンテナーの検索に必要です。
身分証明書	取得するドキュメントの ID。このプロパティは、バインド式をサポートしています。 `Id` と `SqlQuery` プロパティの両方は設定しないでください。いずれも設定しなかった場合は、コンテナー全体が取得されます。
SqlQuery の	複数のドキュメントを取得するために使用するAzure Cosmos DB SQL クエリ。このプロパティは、次の例のように実行時のバインドをサポートします。`SELECT * FROM c where c.departmentId = {departmentId}` `Id` と `SqlQuery` プロパティの両方は設定しないでください。いずれも設定しなかった場合は、コンテナー全体が取得されます。
PreferredLocations	(省略可能)Azure Cosmos DB サービス内の geo レプリケートされたデータベースアカウントの優先する場所 (リージョン) を定義します。複数の値はコンマで区切る必要があります。たとえば、`East US,South Central US,North Europe` のようにします。

属性のプロパティ	説明
ConnectionStringSetting	監視対象のAzure Cosmos DB アカウントに接続する方法を指定するアプリ設定または設定コレクションの名前。詳細については、「接続」を参照してください。
DatabaseName	監視対象のコレクションを含むAzure Cosmos DB データベースの名前。
CollectionName	監視されているコレクションの名前。
PartitionKey	参照用のパーティションキー値を指定します。バインディングパラメーターを含めることもできます。パーティション分割されたコレクションの参照で必須です。
身分証明書	取得するドキュメントの ID。このプロパティは、バインド式をサポートしています。 `Id` と `SqlQuery` プロパティの両方は設定しないでください。いずれも設定しない場合は、コレクション全体が取得されます。
SqlQuery の	複数のドキュメントを取得するために使用するAzure Cosmos DB SQL クエリ。このプロパティは、次の例のように実行時のバインドをサポートします。`SELECT * FROM c where c.departmentId = {departmentId}` `Id` と `SqlQuery` プロパティの両方は設定しないでください。いずれも設定しない場合は、コレクション全体が取得されます。
PreferredLocations	(省略可能)Azure Cosmos DB サービス内の geo レプリケートされたデータベースアカウントの優先する場所 (リージョン) を定義します。複数の値はコンマで区切る必要があります。たとえば、"East US,South Central US,North Europe" などです。

デコレータ

Python v2 プログラミングモデルにのみ適用されます。

Python v2 関数は、cosmos_db_input デコレーターを使用して定義されます。これは、拡張機能のバージョンに応じて、これらのプロパティをサポートします。

拡張機能 4.x 以降
Functions 2.x 以上

プロパティ	説明
`arg_name`	変更されるドキュメントの一覧を表す、関数コードで使用する変数の名前。
`database_name`	監視対象のコレクションを含むAzure Cosmos DB データベースの名前。
`container_name`	監視対象のAzure Cosmos DB コレクションの名前。
`connection`	監視対象のAzure Cosmos DBの接続文字列。
`partition_key`	監視対象のAzure Cosmos DBのパーティションキー。
`id`	取得するドキュメントの ID。

プロパティ	説明
`arg_name`	変更されるドキュメントの一覧を表す、関数コードで使用する変数の名前。
`database_name`	監視対象のコレクションを含むAzure Cosmos DB データベースの名前。
`collection_name`	監視対象のAzure Cosmos DB コレクションの名前。
`connection_string_setting`	監視対象のAzure Cosmos DBの接続文字列。
`partition_key`	監視対象のAzure Cosmos DBのパーティションキー。
`id`	取得するドキュメントの ID。

function.json を使用して定義Python関数については、「Configuration」セクションを参照してください。

注釈

Java関数ランタイムライブラリから、Azure Cosmos DBから読み取るパラメーターに対して @CosmosDBInput 注釈を使用します。この注釈では、次のプロパティがサポートされます。

構成

Python v1 プログラミングモデルにのみ適用されます。

モデル v4
モデル v3

次の表では、options メソッドに渡される input.cosmosDB() オブジェクトに対して設定できるプロパティについて説明します。 type、direction、name の各プロパティは v4 モデルには適用されません。

次の表では、function.json ファイルで設定するバインド構成のプロパティについて説明します。これらのプロパティは、拡張機能バージョンによって異なります。

拡張機能 4.x 以降
Functions 2.x 以上

function.json のプロパティ	説明
タイプ	`cosmosDB` に設定する必要があります。
方向	`in` に設定する必要があります。
名前	変更されるドキュメントの一覧を表す、関数コードで使用する変数の名前。
接続	監視対象のAzure Cosmos DB アカウントに接続する方法を指定するアプリ設定または設定コンテナーの名前。詳細については、「接続」を参照してください。
databaseName	監視対象のコンテナーを含むAzure Cosmos DB データベースの名前。
containerName	監視対象のコンテナーの名前。
partitionKey	参照用のパーティションキー値を指定します。バインディングパラメーターを含めることもできます。パーティション分割されたコンテナーの検索に必要です。
ID	取得するドキュメントの ID。このプロパティは、バインド式をサポートしています。 `id` と `sqlQuery` プロパティの両方は設定しないでください。いずれも設定しなかった場合は、コンテナー全体が取得されます。
sqlQuery	複数のドキュメントを取得するために使用するAzure Cosmos DB SQL クエリ。このプロパティは、次の例のように実行時のバインドをサポートします。`SELECT * FROM c where c.departmentId = {departmentId}` `id` と `sqlQuery` プロパティの両方は設定しないでください。いずれも設定しなかった場合は、コンテナー全体が取得されます。
preferredLocations	(省略可能)Azure Cosmos DB サービス内の geo レプリケートされたデータベースアカウントの優先する場所 (リージョン) を定義します。複数の値はコンマで区切る必要があります。たとえば、`East US,South Central US,North Europe` のようにします。

function.json のプロパティ	説明
タイプ	`cosmosDBTrigger` に設定する必要があります。
方向	`in` に設定する必要があります。
名前	変更されるドキュメントの一覧を表す、関数コードで使用する変数の名前。
connectionStringSetting	監視対象のAzure Cosmos DB アカウントに接続する方法を指定するアプリ設定または設定コレクションの名前。詳細については、「接続」を参照してください。
databaseName	監視対象のコレクションを含むAzure Cosmos DB データベースの名前。
collectionName	監視されているコレクションの名前。
partitionKey	参照用のパーティションキー値を指定します。バインディングパラメーターを含めることもできます。パーティション分割されたコレクションの参照で必須です。
ID	取得するドキュメントの ID。このプロパティは、バインド式をサポートしています。 `id` と `sqlQuery` プロパティの両方は設定しないでください。いずれも設定しない場合は、コレクション全体が取得されます。
sqlQuery	複数のドキュメントを取得するために使用するAzure Cosmos DB SQL クエリ。このプロパティは、次の例のように実行時のバインドをサポートします。`SELECT * FROM c where c.departmentId = {departmentId}` `id` と `sqlQuery` プロパティの両方は設定しないでください。いずれも設定しない場合は、コレクション全体が取得されます。
preferredLocations	(省略可能)Azure Cosmos DB サービス内の geo レプリケートされたデータベースアカウントの優先する場所 (リージョン) を定義します。複数の値はコンマで区切る必要があります。たとえば、`East US,South Central US,North Europe` のようにします。

完全な例については、セクションの例を参照してください。

使用法

関数が正常に終了すると、入力ドキュメントへの変更がすべて自動的に保持されます。

Cosmos DB 入力バインドでサポートされるパラメーターの型は、Functions ランタイムのバージョン、拡張機能パッケージのバージョン、使用される C# のモダリティによって異なります。

関数で 1 つのドキュメントを処理するとき、Cosmos DB 入力バインドは次の型にバインドできます。

タイプ	説明
JSON シリアル化可能な型	Functions はドキュメントの JSON データを単純な従来の CLR オブジェクト (POCO) 型に逆シリアル化しようとします。

関数で 1 つのクエリから得た複数のドキュメントを処理するとき、Cosmos DB 入力バインドは次の型にバインドできます。

タイプ	説明
`IEnumerable<T>` (`T` は JSON シリアル化可能な型)	クエリによって返されるエンティティの列挙型。各エントリは 1 つのドキュメントを表します。
CosmosClient¹	Cosmos DB アカウントに接続されているクライアント。
データベース¹	Cosmos DB データベースに接続されているクライアント。
コンテナー¹	Cosmos DB コンテナーに接続されているクライアント。

¹ これらの型を使用するには、Microsoft.Azure を参照する必要があります。Functions.Worker.Extensions.CosmosDB 4.4.0 以降および SDK 型バインドのcommon 依存関係。

Java functions ランタイムライブラリから、@CosmosDBInput 注釈はAzure Cosmos DBデータを関数に公開します。この注釈は、Optional<T> を使用して、ネイティブ Java型、POJO、または null 許容値と共に使用できます。

モデル v4
モデル v3

context.extraInputs.get() を使用してドキュメントにアクセスします。

関数の終了時にドキュメントへの更新が自動的に行われることはありません。関数でドキュメントを更新するには、出力バインドを使用します。詳細については、「PowerShell の例」を参照してください。

データは、DocumentList パラメーターを介して関数から使用できるようになります。ドキュメントに加えられた変更は、自動的には保存されません。関数では、Azure Cosmos の PYTHON SDK 型バインドもサポートされています。これにより、基になる SDK の種類を使用してデータを操作できます。

重要

Pythonの CosmosDB SDK の種類のサポートはプレビュー段階であり、Python v2 プログラミングモデルでのみサポートされています。詳細については、「Python の SDK 型」を参照してください。

接続

connectionおよびleaseConnectionプロパティはアプリケーション設定内のキーに設定されており、Functionsランタイムが拡張機能で使うAzure Cosmos DBアカウントエンドポイントに接続するために使う値を返します。これらのプロパティ設定の価値は、接続の種類によって異なります:

マネージドアイデンティティ接続: connection プロパティは複数の設定で共有される一つの <CONNECTION_NAME_PREFIX> であり、それらが共にアカウントへのアイデンティティベースの接続を定義します。詳細については、「同一性接続の定義」を参照してください。
Key Vault参照:connectionプロパティ設定は、接続文字列が中央管理されている場所への参照Azure Key Vaultを返します。詳細については、「Key Vault connectionsの定義」をご覧ください。
App Configuration reference:connectionプロパティ設定は接続文字列またはKey Vault参照を返すAzure App Configuration参照を返します。詳細については、接続記事のAzure App Configurationをご覧ください。
Connection string:connectionプロパティ設定は実際のアカウント接続文字列を返します。接続文字列には共有の秘密鍵が含まれているため、可能であれば管理型アイデンティティ接続の使用を検討すべきです。詳細については、「接続の定義」を参照してください。

バインディング接続について詳しく知りたい方は、Azure Functionsの「Manage connection in Connection」をご覧ください。接続文字列を取得するには、Azure Cosmos DBアカウントにアクセスし、Keysを選択し、PRIMARY CONNECTION STRINGまたはSECONDARY CONNECTION STRINGの値をコピーしてください。これらの接続文字列には共有の秘密鍵が含まれており、安全に保たなければなりません。

拡張の初期バージョンでは、接続プロパティは connectionStringSetting と leaseConnectionStringSettingと呼ばれていました。

次のステップ

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-07-22

Azure Functions 2.x 以降のAzure Cosmos DB入力バインド

例

キュー トリガー、JSON からの ID の検索

HTTP トリガー、クエリ文字列からの ID の検索 - String パラメーター

HTTP トリガー、クエリ文字列からの ID の検索 - POJO パラメーター

HTTP トリガー、ルート データからの ID の検索

HTTP トリガー、SqlQuery を使用したルート データからの ID の検索

HTTP トリガー、ルート データからの複数のドキュメントの取得、SqlQuery を使用

キュー トリガー、JSON からの ID の検索

HTTP トリガー、クエリ文字列からの ID の検索

HTTP トリガー、ルート データからの ID の検索

キュー トリガー、SqlQuery を使用した複数のドキュメントの取得

キュー トリガー、JSON からの ID の検索

HTTP トリガー、クエリ文字列からの ID の検索

HTTP トリガー、ルート データからの ID の検索

キュー トリガー、SqlQuery を使用した複数のドキュメントの取得

キュー トリガー、JSON からの ID の検索

HTTP トリガー、クエリ文字列からの ID の検索

HTTP トリガー、ルート データからの ID の検索

キュー トリガー、SqlQuery を使用した複数のドキュメントの取得

Cosmos DB の SDK-Type バインドの使用 (プレビュー)

キュー トリガー、JSON からの ID の検索

HTTP トリガー、クエリ文字列からの ID の検索

HTTP トリガー、ルート データからの ID の検索

キュー トリガー、SqlQuery を使用した複数のドキュメントの取得

属性

デコレータ

注釈

構成

使用法

接続

次のステップ

フィードバック

その他のリソース

キュートリガー、JSON からの ID の検索

HTTP トリガー、ルートデータからの ID の検索

HTTP トリガー、SqlQuery を使用したルートデータからの ID の検索

HTTP トリガー、ルートデータからの複数のドキュメントの取得、SqlQuery を使用

キュートリガー、JSON からの ID の検索

HTTP トリガー、ルートデータからの ID の検索

キュートリガー、SqlQuery を使用した複数のドキュメントの取得

キュートリガー、JSON からの ID の検索

HTTP トリガー、ルートデータからの ID の検索

キュートリガー、SqlQuery を使用した複数のドキュメントの取得

キュートリガー、JSON からの ID の検索

HTTP トリガー、ルートデータからの ID の検索

キュートリガー、SqlQuery を使用した複数のドキュメントの取得

キュートリガー、JSON からの ID の検索

HTTP トリガー、ルートデータからの ID の検索

キュートリガー、SqlQuery を使用した複数のドキュメントの取得