Azure Functions の Azure SQL 入力バインド (プレビュー)

関数が実行されると、Azure SQL 入力バインドによりデータベースからデータが取得され、関数の入力パラメーターに渡されます。

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

Azure SQL 入力バインドのその他のサンプルは、GitHub リポジトリで入手できます。

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

次の例では ToDoItem クラスとそれに対応するデータベース テーブルを参照します。

namespace AzureSQL.ToDo {
    public class ToDoItem {
        public Guid Id { get; set; }
        public int? order { get; set; }
        public string title { get; set; }
        public string url { get; set; }
        public bool? completed { get; set; }
    }
}
CREATE TABLE dbo.ToDo (
    Id uniqueidentifier primary key,
    [order] int null,
    title nvarchar(200) not null,
    [url] nvarchar(200) not null,
    completed bit not null
);

HTTP トリガー、クエリ文字列からの ID による行の取得

次の例は、単一のレコードを取得する C# 関数を示しています。 この関数は、クエリ文字列を使用して ID を指定する HTTP 要求によってトリガーされます。 その ID は、指定されたクエリを使用して ToDoItem レコードを取得するために使用されます。

Note

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

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

namespace AzureSQLSamples
{
    public static class GetToDoItem
    {
        [FunctionName("GetToDoItem")]
        public static IActionResult Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "gettodoitem")]
            HttpRequest req,
            [Sql("select [Id], [order], [title], [url], [completed] from dbo.ToDo where Id = @Id",
                CommandType = System.Data.CommandType.Text,
                Parameters = "@Id={Query.id}",
                ConnectionStringSetting = "SqlConnectionString")]
            IEnumerable<ToDoItem> toDoItem)
        {
            return new OkObjectResult(toDoItem.FirstOrDefault());
        }
    }
}

HTTP トリガー、ルート パラメーターからの複数の行の取得

次の例は、クエリによって返されるドキュメントを取得する C# 関数を示しています。 この関数は、ルート データを使用してクエリ パラメーターの値を指定する HTTP 要求によってトリガーされます。 このパラメーターは、指定されたクエリ内の ToDoItem レコードをフィルター処理するために使用されます。

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

namespace AzureSQLSamples
{
    public static class GetToDoItems
    {
        [FunctionName("GetToDoItems")]
        public static IActionResult Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "gettodoitems/{priority}")]
            HttpRequest req,
            [Sql("select [Id], [order], [title], [url], [completed] from dbo.ToDo where [Priority] > @Priority",
                CommandType = System.Data.CommandType.Text,
                Parameters = "@Priority={priority}",
                ConnectionStringSetting = "SqlConnectionString")]
            IEnumerable<ToDoItem> toDoItems)
        {
            return new OkObjectResult(toDoItems);
        }
    }
}

HTTP トリガー、行の削除

次の例は、HTTP 要求クエリ パラメーターからの入力を使用してストアド プロシージャを実行する C# 関数を示しています。

ストアド プロシージャ dbo.DeleteToDo は、SQL データベースに作成する必要があります。 この例では、ストアド プロシージャは、パラメーターの値に応じて 1 つのレコードまたはすべてのレコードを削除します。

CREATE PROCEDURE [dbo].[DeleteToDo]
    @Id nvarchar(100)
AS
    DECLARE @UID UNIQUEIDENTIFIER = TRY_CAST(@ID AS uniqueidentifier)
    IF @UId IS NOT NULL AND @Id != ''
    BEGIN
        DELETE FROM dbo.ToDo WHERE Id = @UID
    END
    ELSE
    BEGIN
        DELETE FROM dbo.ToDo WHERE @ID = ''
    END

    SELECT Id, [order], title, url, completed FROM dbo.ToDo
GO
using System;
using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;

namespace AzureSQL.ToDo
{
    public static class DeleteToDo
    {
        // delete all items or a specific item from querystring
        // returns remaining items
        // uses input binding with a stored procedure DeleteToDo to delete items and return remaining items
        [FunctionName("DeleteToDo")]
        public static IActionResult Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "delete", Route = "DeleteFunction")] HttpRequest req,
            ILogger log,
            [Sql("DeleteToDo", CommandType = System.Data.CommandType.StoredProcedure, 
                Parameters = "@Id={Query.id}", ConnectionStringSetting = "SqlConnectionString")] 
                IEnumerable<ToDoItem> toDoItems)
        {
            return new OkObjectResult(toDoItems);
        }
    }
}

注意

現在のプレビューでは、Azure SQL バインドは、C# クラス ライブラリ関数JavaScript 関数、および Python 関数でのみサポートされています。

Azure SQL 入力バインドのその他のサンプルは、GitHub リポジトリで入手できます。

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

この例では、次のデータベース テーブルを参照します。

CREATE TABLE dbo.ToDo (
    Id uniqueidentifier primary key,
    [order] int null,
    title nvarchar(200) not null,
    [url] nvarchar(200) not null,
    completed bit not null
);

HTTP トリガー、複数の行の取得

次の例は、function.json ファイル内の SQL 入力バインドと、クエリから読み取って結果を HTTP 応答で返す JavaScript 関数を示しています。

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

{
    "authLevel": "anonymous",
    "type": "httpTrigger",
    "direction": "in",
    "name": "req",
    "methods": [
        "get"
    ]
},
{
    "type": "http",
    "direction": "out",
    "name": "res"
},
{
    "name": "todoItems",
    "type": "sql",
    "direction": "in",
    "commandText": "select [Id], [order], [title], [url], [completed] from dbo.ToDo",
    "commandType": "Text",
    "connectionStringSetting": "SqlConnectionString"
}

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

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

module.exports = async function (context, req, todoItems) {
    context.log('JavaScript HTTP trigger and SQL input binding function processed a request.');

    context.res = {
        // status: 200, /* Defaults to 200 */
        mimetype: "application/json",
        body: todoItems
    };
}

HTTP トリガー、クエリ文字列からの ID による行の取得

次の例は、クエリ文字列のパラメーターによってフィルター処理されたクエリから読み取り、HTTP 応答で行を返す JavaScript 関数の SQL 入力バインドを示しています。

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

{
    "authLevel": "anonymous",
    "type": "httpTrigger",
    "direction": "in",
    "name": "req",
    "methods": [
        "get"
    ]
},
{
    "type": "http",
    "direction": "out",
    "name": "res"
},
{
    "name": "todoItem",
    "type": "sql",
    "direction": "in",
    "commandText": "select [Id], [order], [title], [url], [completed] from dbo.ToDo where Id = @Id",
    "commandType": "Text",
    "parameters": "@Id = {Query.id}",
    "connectionStringSetting": "SqlConnectionString"
}

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

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

module.exports = async function (context, req, todoItem) {
    context.log('JavaScript HTTP trigger and SQL input binding function processed a request.');

    context.res = {
        // status: 200, /* Defaults to 200 */
        mimetype: "application/json",
        body: todoItem
    };
}

HTTP トリガー、行の削除

次の例は、function.json ファイル内の SQL 入力バインドと、HTTP 要求クエリ パラメーターからの入力を使用してストアド プロシージャを実行する JavaScript 関数を示しています。

ストアド プロシージャ dbo.DeleteToDo は、データベースに作成する必要があります。 この例では、ストアド プロシージャは、パラメーターの値に応じて 1 つのレコードまたはすべてのレコードを削除します。

CREATE PROCEDURE [dbo].[DeleteToDo]
    @Id nvarchar(100)
AS
    DECLARE @UID UNIQUEIDENTIFIER = TRY_CAST(@ID AS uniqueidentifier)
    IF @UId IS NOT NULL AND @Id != ''
    BEGIN
        DELETE FROM dbo.ToDo WHERE Id = @UID
    END
    ELSE
    BEGIN
        DELETE FROM dbo.ToDo WHERE @ID = ''
    END

    SELECT Id, [order], title, url, completed FROM dbo.ToDo
GO
{
    "authLevel": "anonymous",
    "type": "httpTrigger",
    "direction": "in",
    "name": "req",
    "methods": [
        "get"
    ]
},
{
    "type": "http",
    "direction": "out",
    "name": "res"
},
{
    "name": "todoItems",
    "type": "sql",
    "direction": "in",
    "commandText": "DeleteToDo",
    "commandType": "StoredProcedure",
    "parameters": "@Id = {Query.id}",
    "connectionStringSetting": "SqlConnectionString"
}

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

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

module.exports = async function (context, req, todoItems) {
    context.log('JavaScript HTTP trigger and SQL input binding function processed a request.');

    context.res = {
        // status: 200, /* Defaults to 200 */
        mimetype: "application/json",
        body: todoItems
    };
}

Azure SQL 入力バインドのその他のサンプルは、GitHub リポジトリで入手できます。

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

この例では、次のデータベース テーブルを参照します。

CREATE TABLE dbo.ToDo (
    Id uniqueidentifier primary key,
    [order] int null,
    title nvarchar(200) not null,
    [url] nvarchar(200) not null,
    completed bit not null
);

HTTP トリガー、複数の行の取得

次の例は、function.json ファイル内の SQL 入力バインドと、クエリから読み取って結果を HTTP 応答で返す Python 関数を示しています。

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

{
    "authLevel": "anonymous",
    "type": "httpTrigger",
    "direction": "in",
    "name": "req",
    "methods": [
        "get"
    ]
},
{
    "type": "http",
    "direction": "out",
    "name": "$return"
},
{
    "name": "todoItems",
    "type": "sql",
    "direction": "in",
    "commandText": "select [Id], [order], [title], [url], [completed] from dbo.ToDo",
    "commandType": "Text",
    "connectionStringSetting": "SqlConnectionString"
}

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

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

import azure.functions as func
import json

def main(req: func.HttpRequest, todoItems: func.SqlRowList) -> func.HttpResponse:
    rows = list(map(lambda r: json.loads(r.to_json()), todoItems))

    return func.HttpResponse(
        json.dumps(rows),
        status_code=200,
        mimetype="application/json"
    ) 

HTTP トリガー、クエリ文字列からの ID による行の取得

次の例は、クエリ文字列のパラメーターでフィルター処理されたクエリから読み取り、HTTP 応答で行を返す Python 関数の SQL 入力バインドを示しています。

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

{
    "authLevel": "anonymous",
    "type": "httpTrigger",
    "direction": "in",
    "name": "req",
    "methods": [
        "get"
    ]
},
{
    "type": "http",
    "direction": "out",
    "name": "$return"
},
{
    "name": "todoItem",
    "type": "sql",
    "direction": "in",
    "commandText": "select [Id], [order], [title], [url], [completed] from dbo.ToDo where Id = @Id",
    "commandType": "Text",
    "parameters": "@Id = {Query.id}",
    "connectionStringSetting": "SqlConnectionString"
}

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

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

import azure.functions as func
import json

def main(req: func.HttpRequest, todoItem: func.SqlRowList) -> func.HttpResponse:
    rows = list(map(lambda r: json.loads(r.to_json()), todoItem))

    return func.HttpResponse(
        json.dumps(rows),
        status_code=200,
        mimetype="application/json"
    ) 

HTTP トリガー、行の削除

次の例は、function.json ファイル内の SQL 入力バインドと、HTTP 要求クエリ パラメーターからの入力を使用してストアド プロシージャを実行する Python 関数を示しています。

ストアド プロシージャ dbo.DeleteToDo は、データベースに作成する必要があります。 この例では、ストアド プロシージャは、パラメーターの値に応じて 1 つのレコードまたはすべてのレコードを削除します。

CREATE PROCEDURE [dbo].[DeleteToDo]
    @Id nvarchar(100)
AS
    DECLARE @UID UNIQUEIDENTIFIER = TRY_CAST(@ID AS uniqueidentifier)
    IF @UId IS NOT NULL AND @Id != ''
    BEGIN
        DELETE FROM dbo.ToDo WHERE Id = @UID
    END
    ELSE
    BEGIN
        DELETE FROM dbo.ToDo WHERE @ID = ''
    END

    SELECT Id, [order], title, url, completed FROM dbo.ToDo
GO
{
    "authLevel": "anonymous",
    "type": "httpTrigger",
    "direction": "in",
    "name": "req",
    "methods": [
        "get"
    ]
},
{
    "type": "http",
    "direction": "out",
    "name": "$return"
},
{
    "name": "todoItems",
    "type": "sql",
    "direction": "in",
    "commandText": "DeleteToDo",
    "commandType": "StoredProcedure",
    "parameters": "@Id = {Query.id}",
    "connectionStringSetting": "SqlConnectionString"
}

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

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

import azure.functions as func
import json

def main(req: func.HttpRequest, todoItems: func.SqlRowList) -> func.HttpResponse:
    rows = list(map(lambda r: json.loads(r.to_json()), todoItems))

    return func.HttpResponse(
        json.dumps(rows),
        status_code=200,
        mimetype="application/json"
    ) 

属性

C# クラス ライブラリでは、次のプロパティがある Sql 属性を使用します。

属性のプロパティ 説明
CommandText 必須。 バインドによって実行される Transact-SQL クエリ コマンドまたはストアド プロシージャの名前。
ConnectionStringSetting 必須。 クエリまたはストアド プロシージャの実行対象となるデータベースの接続文字列を含むアプリ設定の名前。 この値は実際の接続文字列ではなく、代わりに環境変数名に解決される必要があります。
CommandType 必須。 CommandType 値。これは、クエリの場合はテキストで、ストアド プロシージャの場合は StoredProcedure です。
パラメーター 省略可能。 実行時に 1 つの文字列としてコマンドに渡される 0 個以上のパラメーター値。 @param1=param1,@param2=param2 という形式に従う必要があります。 パラメーター名とパラメーター値のどちらにも、コンマ (,) または等号 (=) を含めることはできません。

構成

次の表は、function.json ファイルで設定したバインド構成のプロパティを説明しています。

function.json のプロパティ 説明
type 必須。 sql に設定する必要があります。
direction 必須。 in に設定する必要があります。
name 必須。 関数コード内のクエリ結果を表す変数の名前。
commandText 必須。 バインドによって実行される Transact-SQL クエリ コマンドまたはストアド プロシージャの名前。
connectionStringSetting 必須。 クエリまたはストアド プロシージャの実行対象となるデータベースの接続文字列を含むアプリ設定の名前。 この値は実際の接続文字列ではなく、代わりに環境変数名に解決される必要があります。 接続文字列値の省略可能なキーワードは、SQL バインドの接続を調整するために使用できます
commandType 必須。 CommandType 値。これは、クエリの場合はテキストで、ストアド プロシージャの場合は StoredProcedure です。
parameters 省略可能。 実行時に 1 つの文字列としてコマンドに渡される 0 個以上のパラメーター値。 @param1=param1,@param2=param2 という形式に従う必要があります。 パラメーター名とパラメーター値のどちらにも、コンマ (,) または等号 (=) を含めることはできません。

ローカルで開発する場合は、 コレクション内の local.settings.json ファイルにアプリケーション設定を追加します。

使用

この属性のコンストラクターは、SQL コマンド テキスト、コマンドの種類、パラメーター、接続文字列設定名を受け取ります。 コマンドは、コマンドの種類 System.Data.CommandType.Text を指定した Transact-SQL (T-SQL) クエリ、またはコマンドの種類 System.Data.CommandType.StoredProcedure を指定したストアド プロシージャ名にすることができます。 接続文字列設定名は、Azure SQL または SQL Server インスタンスへの接続の接続文字列が含まれるアプリケーション設定 (ローカル開発の場合は local.settings.json の) に合致します。

次の手順