Visual Studio Code를 사용하여 Azure SQL Database에 Azure Functions 연결

아티클
04/25/2024

Azure Functions를 사용하면 자체 통합 코드를 작성하지 않고도 함수에 Azure 서비스 및 기타 리소스를 연결할 수 있습니다. 입력과 출력을 모두 나타내는 이러한 바인딩은 함수 정의 내에서 선언됩니다. 바인딩의 데이터는 함수에 매개 변수로 제공됩니다. 트리거는 특수한 형식의 입력 바인딩입니다. 함수에는 하나의 트리거만 있지만, 여러 개의 입력 및 출력 바인딩이 있을 수 있습니다. 자세한 내용은 Azure Functions 트리거 및 바인딩 개념을 참조하세요.

이 문서에서는 Visual Studio Code를 사용하여 이전의 빠른 시작 문서에서 만든 함수에 Azure SQL Database를 연결하는 방법을 보여줍니다. 이 함수에 추가하는 출력 바인딩은 HTTP 요청의 데이터를 Azure SQL Database의 테이블에 씁니다.

시작하기 전에 빠른 시작: Visual Studio Code를 사용하여 Azure에서 C# 함수 만들기를 완료해야 합니다. 해당 문서의 끝에서 리소스를 이미 정리한 경우, 해당 단계를 다시 수행하여 Azure에서 함수 앱 및 관련 리소스를 다시 만듭니다.

시작하기 전에 빠른 시작: Visual Studio Code를 사용하여 Azure에서 JavaScript 함수 만들기를 완료해야 합니다. 해당 문서의 끝에서 리소스를 이미 정리한 경우, 해당 단계를 다시 수행하여 Azure에서 함수 앱 및 관련 리소스를 다시 만듭니다.

시작하기 전에 빠른 시작: Visual Studio Code를 사용하여 Azure에서 Python 함수 만들기를 완료해야 합니다. 해당 문서의 끝에서 리소스를 이미 정리한 경우, 해당 단계를 다시 수행하여 Azure에서 함수 앱 및 관련 리소스를 다시 만듭니다.

Azure Functions에 대한 Azure SQL 바인딩 및 트리거의 설정에 관한 자세한 내용은 Azure Functions 설명서에서 확인할 수 있습니다.

Azure SQL Database 만들기

Azure SQL Database 만들기 빠른 시작에 따라 서버리스 Azure SQL 데이터베이스를 만듭니다. 데이터베이스는 비어 있거나 샘플 데이터 세트 AdventureWorksLT에서 만들 수 있습니다.

프롬프트에서 다음 정보를 제공합니다.

프롬프트	선택 사항
리소스 그룹	이전 문서에서 함수 앱을 만든 리소스 그룹을 선택합니다.
데이터베이스 이름	`mySampleDatabase`를 입력합니다.
서버 이름	서버의 고유 이름을 입력합니다. 서버 이름은 구독 내에서 고유한 것이 아니라 Azure의 모든 서버에 대해 전역적으로 고유해야 하므로 사용할 정확한 서버 이름을 제공할 수 없습니다.
인증 방법	SQL Server 인증을 선택합니다.
서버 관리자 로그인	`azureuser`를 입력합니다.
암호	복잡성 요구 사항을 충족하는 암호를 입력합니다.
Azure 서비스 및 리소스가 이 서버에 액세스할 수 있도록 허용	예를 선택합니다.

생성이 완료되면 Azure Portal의 데이터베이스 블레이드로 이동하고 설정 아래에서 연결 문자열을 선택합니다. SQL 인증을 위해 ADO.NET 연결 문자열을 복사합니다. 나중에 사용할 수 있도록 임시 문서에 연결 문자열을 붙여넣습니다.
HTTP 요청에서 데이터를 저장할 테이블을 만듭니다. Azure Portal에서 데이터베이스 블레이드로 이동하여 쿼리 편집기를 선택합니다. 다음 쿼리를 입력하여 dbo.ToDo라는 테이블을 만듭니다.
```
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
);
```
서버의 방화벽 설정을 확인하여 Azure 함수가 Azure SQL Database에 액세스할 수 있는지 확인합니다. Azure Portal에서 서버 블레이드로 이동하고 보안 아래에서 네트워킹을 선택합니다. Azure 서비스 및 리소스가 이 서버에 액세스할 수 있도록 허용에 대한 예외를 확인해야 합니다.

함수 앱 설정 업데이트

이전 빠른 시작 문서에서는 Azure에서 함수 앱을 만들었습니다. 이 문서에서는 방금 만든 Azure SQL Database에 데이터를 작성하도록 앱을 업데이트합니다. Azure SQL Database에 연결하려면 연결 문자열을 앱 설정에 추가해야 합니다. 그런 다음, 새 설정을 local.settings.json 파일에 다운로드하여 로컬로 실행할 때 Azure SQL Database에 연결할 수 있습니다.

이전에 만든 임시 문서에서 연결 문자열을 편집합니다. Password 값을 Azure SQL Database를 만들 때 사용한 암호로 바꿉니다. 업데이트된 연결 문자열을 복사합니다.
Ctrl/Cmd+shift+P를 눌러 명령 팔레트를 연 다음, Azure Functions: Add New Setting... 명령을 검색하여 실행합니다.

이전 문서에서 만든 함수 앱을 선택합니다. 프롬프트에서 다음 정보를 제공합니다.

프롬프트	선택 사항
새 앱 설정 이름 입력	`SqlConnectionString`.
"SqlConnectionString"에 대한 값 입력	방금 복사한 Azure SQL Database의 연결 문자열을 붙여넣습니다.

그러면 Azure의 함수 앱에 연결 SqlConnectionString이라는 애플리케이션 설정이 만들어집니다. 이제 이 설정을 local.settings.json 파일에 다운로드할 수 있습니다.

Ctrl/Cmd+shift+P를 다시 눌러 명령 팔레트를 연 다음, Azure Functions: Download Remote Settings... 명령을 검색하여 실행합니다.
이전 문서에서 만든 함수 앱을 선택합니다. 모두 예를 선택하여 기존 로컬 설정을 덮어씁니다.

그러면 새 연결 문자열 설정을 포함하여 모든 설정이 Azure에서 로컬 프로젝트로 다운로드됩니다. 다운로드한 설정의 대부분은 로컬로 실행할 때 사용되지 않습니다.

바인딩 확장 등록

Azure SQL 출력 바인딩을 사용하므로 프로젝트를 실행하기 전에 해당 바인딩 확장이 설치되어 있어야 합니다.

HTTP 및 타이머 트리거를 제외하고 바인딩은 확장 패키지로 구현됩니다. 터미널 창에서 다음 dotnet add package 명령을 실행하여 프로젝트에 Azure SQL 확장 패키지를 추가합니다.

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

프로젝트가 미리 정의된 확장 패키지 세트를 자동으로 설치하는 확장 번들을 사용하도록 구성되었습니다.

확장 번들 사용은 프로젝트의 루트에 있는 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
  }
}

:::

이제 Azure SQL 출력 바인딩을 프로젝트에 추가할 수 있습니다.

출력 바인딩 추가

Functions에서 각 바인딩 형식의 direction, type 및 고유한 name을 function.json 파일에 정의해야 합니다. 이러한 특성을 정의하는 방법은 함수 앱의 언어에 따라 달라집니다.

HttpExample.cs 프로젝트 파일을 열고 데이터베이스에 기록되는 개체를 정의하는 다음 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; }
    }
}

C# 클래스 라이브러리 프로젝트에서 바인딩은 함수 메서드의 바인딩 특성으로 정의됩니다. 그런 다음, 함수에 필요한 function.json 파일이 이러한 특성을 기반으로 자동으로 생성됩니다.

HttpExample.cs 프로젝트 파일을 열고 HTTP 응답과 SQL 출력 모두에 대해 함수에서 출력할 결합된 개체를 정의하는 다음 출력 형식 클래스를 추가합니다.

public static class OutputType
{
    [SqlOutput("dbo.ToDo", connectionStringSetting: "SqlConnectionString")]
    public ToDoItem ToDoItem { get; set; }
    public HttpResponseData HttpResponse { get; set; }
}

파일 맨 위에 Microsoft.Azure.Functions.Worker.Extensions.Sql 라이브러리에 using 문을 추가합니다.

using Microsoft.Azure.Functions.Worker.Extensions.Sql;

바인딩 특성은 코드에서 직접 정의됩니다. Azure SQL 출력 구성에서는 Azure SQL 출력 바인딩에 필요한 필드를 설명합니다.

이 MultiResponse 시나리오의 경우 함수에 extraOutputs 출력 바인딩을 추가해야 합니다.

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

바인딩 구성에 다음 속성을 추가합니다.

const sendToSql = output.sql({
  commandText: 'dbo.ToDo',
  connectionStringSetting: 'SqlConnectionString',
});

바인딩 특성은 function_app.py 파일에서 직접 정의됩니다. generic_output_binding 데코레이터를 사용하여 Azure SQL 출력 바인딩을 추가합니다.

@app.generic_output_binding(arg_name="toDoItems", type="sql", CommandText="dbo.ToDo", ConnectionStringSetting="SqlConnectionString"
    data_type=DataType.STRING)

이 코드에서 arg_name은 코드에서 참조되는 바인딩 매개 변수를 식별하고, type은 출력 바인딩이 SQL 출력 바인딩임을 나타내고, CommandText는 바인딩이 기록되는 테이블이고, ConnectionStringSetting은 Azure SQL 연결 문자열을 포함하는 애플리케이션 설정의 이름입니다. 연결 문자열은 local.settings.json 파일의 SqlConnectionString 설정에 있습니다.

출력 바인딩을 사용하는 코드 추가

기존 Run 메서드를 다음 코드로 바꿉니다.

[Function("HttpExample")]
public static OutputType 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 SQL output binding.
    return new OutputType()
    {
         ToDoItem = new ToDoItem
        {
            id = System.Guid.NewGuid().ToString(),
            title = message,
            completed = false,
            url = ""
        },
        HttpResponse = response
    };
}

context에서 extraInputs 출력 바인딩 개체를 사용하는 코드를 추가하여 명명된 출력 바인딩 함수 sendToSql에 JSON 문서를 보냅니다. return 문 앞에 이 코드를 추가합니다.

const data = JSON.stringify([
  {
    // create a random ID
    Id: crypto.randomUUID(),
    title: name,
    completed: false,
    url: '',
  },
]);

// Output to Database
context.extraOutputs.set(sendToSql, data);

crypto 모듈을 활용하려면 파일 맨 위에 다음 줄을 추가합니다.

const crypto = require("crypto");

이 시점에서 함수는 다음과 같이 표시됩니다.

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

const sendToSql = output.sql({
  commandText: 'dbo.ToDo',
  connectionStringSetting: 'SqlConnectionString',
});

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  extraOutputs: [sendToSql],
  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' };
      }

      // Stringified array of objects to be inserted into the database
      const data = JSON.stringify([
        {
          // create a random ID
          Id: crypto.randomUUID(),
          title: name,
          completed: false,
          url: '',
        },
      ]);

      // Output to Database
      context.extraOutputs.set(sendToSql, data);

      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' };
    }
  },
});

다음 코드와 일치하도록 HttpExample\function_app.py를 업데이트합니다. toDoItems 매개 변수를 함수 정의에 추가하고 if name: 문 아래에 toDoItems.set()를 추가합니다.

import azure.functions as func
import logging
from azure.functions.decorators.core import DataType
import uuid

app = func.FunctionApp()

@app.function_name(name="HttpTrigger1")
@app.route(route="hello", auth_level=func.AuthLevel.ANONYMOUS)
@app.generic_output_binding(arg_name="toDoItems", type="sql", CommandText="dbo.ToDo", ConnectionStringSetting="SqlConnectionString",data_type=DataType.STRING)
def test_function(req: func.HttpRequest, toDoItems: func.Out[func.SqlRow]) -> func.HttpResponse:
     logging.info('Python HTTP trigger function processed a request.')
     name = req.get_json().get('name')
     if not name:
        try:
            req_body = req.get_json()
        except ValueError:
            pass
        else:
            name = req_body.get('name')

     if name:
        toDoItems.set(func.SqlRow({"Id": str(uuid.uuid4()), "title": name, "completed": False, "url": ""}))
        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
                )

로컬에서 함수 실행

Visual Studio Code는 Azure Functions Core 도구와 통합되어 Azure에 게시하기 전에 로컬 개발 컴퓨터에서 이 프로젝트를 실행할 수 있습니다. 로컬에 Core Tools가 아직 설치되어 있지 않은 경우 프로젝트를 처음 실행할 때 이를 설치하라는 메시지가 표시됩니다.

함수를 호출하려면 F5를 눌러 함수 앱 프로젝트를 시작합니다. 터미널 패널에 핵심 도구의 출력이 표시됩니다. 터미널 패널에서 앱이 시작됩니다. 로컬에서 실행 중인 HTTP 트리거 함수의 URL 엔드포인트를 볼 수 있습니다.

Core Tools가 아직 설치되어 있지 않은 경우 메시지가 표시되면 설치를 선택하여 Core Tools를 설치합니다.
Windows에서 실행하는 데 문제가 있는 경우 Visual Studio Code의 기본 터미널이 WSL Bash로 설정되어 있지 않은지 확인합니다.
Core Tools가 실행 중인 상태에서 Azure: Functions 영역으로 이동합니다. Functions에서 로컬 프로젝트>Functions를 확장합니다. HttpExample 함수를 마우스 오른쪽 단추로 클릭(Windows)하거나 Ctrl -을 클릭(macOS)하고 지금 함수 실행...을 선택합니다.
요청 본문 입력에서 Enter를 눌러 요청 메시지를 함수로 보냅니다.
함수가 로컬로 실행되고 응답을 반환하는 경우 Visual Studio Code에서 알림이 발생합니다. 함수 실행에 대한 정보는 터미널 패널에 표시됩니다.
Ctrl + C를 눌러 Core Tools를 중지하고 디버거 연결을 끊습니다.

로컬에서 함수 실행

이전 문서에서와 같이 F5를 눌러 함수 앱 프로젝트와 Core Tools를 시작합니다.
Core Tools가 실행 중인 상태에서 Azure: Functions 영역으로 이동합니다. Functions에서 로컬 프로젝트>Functions를 확장합니다. HttpExample 함수를 마우스 오른쪽 단추로 클릭(Mac에서는 Ctrl 클릭)하고 지금 함수 실행...을 선택합니다.
요청 본문 입력에서 { "name": "Azure" }의 요청 메시지 본문 값이 표시됩니다. Enter를 눌러 이 요청 메시지를 함수로 보냅니다.
응답이 반환된 후 Ctrl + C를 눌러 Core Tools를 중지합니다.

정보가 데이터베이스에 기록되었는지 확인

Azure Portal에서 Azure SQL Database로 돌아가 쿼리 편집기를 선택합니다.
데이터베이스에 연결하고 왼쪽의 개체 탐색기에서 테이블 노드를 확장합니다. dbo.ToDo 테이블을 마우스 오른쪽 단추로 클릭하고 상위 1000개의 행 선택을 선택합니다.
출력 바인딩을 통해 새 정보가 데이터베이스에 기록되었는지 확인합니다.

업데이트된 앱 다시 배포 및 확인

Visual Studio Code에서 F1을 눌러 명령 팔레트를 엽니다. 명령 팔레트에서 Azure Functions: Deploy to function app...을 검색하여 선택합니다.
처음 문서에서 만든 함수 앱을 선택합니다. 동일한 앱에 프로젝트를 다시 배포하므로 배포를 선택하여 파일 덮어쓰기에 대한 경고를 해제합니다.
배포가 완료되면 지금 함수 실행... 기능을 사용하여 Azure에서 함수를 트리거할 수 있습니다.
Azure SQL Database에 작성된 데이터를 확인하여 출력 바인딩에서 새 JSON 문서를 다시 생성하는지 확인합니다.

리소스 정리

Azure에서 리소스는 함수 앱, 함수, 스토리지 계정 등을 참조합니다. 리소스는 리소스 그룹으로 그룹화되며 그룹을 삭제하면 그룹의 모든 항목을 삭제할 수 있습니다.

이러한 빠른 시작을 완료하기 위해 리소스를 만들었습니다. 계정 상태 및 서비스 가격 책정에 따라 이러한 리소스에 대한 요금이 청구될 수 있습니다. 리소스가 더 이상 필요하지 않게 되면 다음과 같이 삭제합니다.

Visual Studio Code에서 F1을 눌러 명령 팔레트를 엽니다. 명령 팔레트에서 Azure: Open in portal을 검색하여 선택합니다.
함수 앱을 선택하고 Enter를 누릅니다. 함수 앱 페이지가 Azure Portal에서 열립니다.
개요 탭에서 리소스 그룹 옆에 있는 명명된 링크를 선택합니다.
리소스 그룹 페이지에서 포함된 리소스 목록을 검토하고 삭제하려는 항목인지 확인합니다.
리소스 그룹 삭제를 선택하고 지시를 따릅니다.

삭제는 몇 분 정도 소요됩니다. 완료되면 알림이 잠시 표시됩니다. 또한 페이지 위쪽의 종 모양 아이콘을 선택하여 알림을 확인할 수도 있습니다.

다음 단계

데이터를 Azure SQL Database에 쓰도록 HTTP 트리거 함수를 업데이트했습니다. 이제 Visual Studio Code를 사용하여 함수 개발에 대해 자세히 알아봅니다.

다음을 통해 공유

Visual Studio Code를 사용하여 Azure SQL Database에 Azure Functions 연결

Azure SQL Database 만들기

함수 앱 설정 업데이트

바인딩 확장 등록

출력 바인딩 추가

출력 바인딩을 사용하는 코드 추가

로컬에서 함수 실행

로컬에서 함수 실행

정보가 데이터베이스에 기록되었는지 확인

업데이트된 앱 다시 배포 및 확인

리소스 정리

다음 단계

피드백

추가 리소스