Visual Studio Code를 사용하여 Azure Functions를 Azure Cosmos DB에 연결
아티클
2024. 04. 29.
Azure Functions를 사용하면 자체 통합 코드를 작성하지 않고도 함수에 Azure 서비스 및 기타 리소스를 연결할 수 있습니다. 입력과 출력을 모두 나타내는 이러한 바인딩은 함수 정의 내에서 선언됩니다. 바인딩의 데이터는 함수에 매개 변수로 제공됩니다. 트리거는 특수한 형식의 입력 바인딩입니다. 함수에는 하나의 트리거만 있지만, 여러 개의 입력 및 출력 바인딩이 있을 수 있습니다. 자세한 내용은 Azure Functions 트리거 및 바인딩 개념을 참조하세요.
이 문서에서는 Visual Studio Code를 사용하여 Azure Cosmos DB를 이전 빠른 시작 문서에서 만든 함수에 연결하는 방법을 보여 줍니다. 이 함수에 추가되는 출력 바인딩은 HTTP 요청의 데이터를 Azure Cosmos DB 컨테이너에 저장된 JSON 문서에 씁니다.
이전 빠른 시작 문서에서는 Azure에서 함수 앱을 만들었습니다. 이 문서에서는 방금 만든 Azure Cosmos DB 컨테이너에 JSON 문서를 작성하도록 앱을 업데이트합니다. Azure Cosmos DB 계정에 연결하려면 연결 문자열을 앱 설정에 추가해야 합니다. 그런 다음, 새 설정을 local.settings.json 파일에 다운로드하여 로컬로 실행할 때 Azure Cosmos DB 계정에 연결할 수 있습니다.
Visual Studio Code에서 새 Azure Cosmos DB 계정을 마우스 오른쪽 단추로 클릭(macOS의 경우 Ctrl 선택)하고 연결 문자열 복사를 선택합니다.
F1 키를 눌러 명령 팔레트를 연 다음, Azure Functions: Add New Setting... 명령을 검색하여 실행합니다.
이전 문서에서 만든 함수 앱을 선택합니다. 프롬프트에서 다음 정보를 제공합니다.
프롬프트
선택
새 앱 설정 이름 입력
CosmosDbConnectionSetting.
"CosmosDbConnectionSetting"에 대한 값 입력
복사한 Azure Cosmos DB 계정의 연결 문자열을 붙여넣습니다. 대안으로 Microsoft Entra ID를 구성할 수도 있습니다.
그러면 Azure의 함수 앱에 연결 CosmosDbConnectionSetting이라는 애플리케이션 설정이 만들어집니다. 이제 이 설정을 local.settings.json 파일에 다운로드할 수 있습니다.
F1 키를 다시 눌러 명령 팔레트를 연 다음, Azure Functions: Download Remote Settings... 명령을 검색하여 실행합니다.
이전 문서에서 만든 함수 앱을 선택합니다. 모두 예를 선택하여 기존 로컬 설정을 덮어씁니다.
그러면 새 연결 문자열 설정을 포함하여 모든 설정이 Azure에서 로컬 프로젝트로 다운로드됩니다. 다운로드한 설정의 대부분은 로컬로 실행할 때 사용되지 않습니다.
바인딩 확장 등록
Azure Cosmos DB 출력 바인딩을 사용하므로 프로젝트를 실행하기 전에 해당 바인딩 확장이 설치되어 있어야 합니다.
HTTP 및 타이머 트리거를 제외하고는 바인딩이 확장 패키지로 구현됩니다. 터미널 창에서 다음 dotnet add package 명령을 실행하여 프로젝트에 Azure Cosmos DB 확장 패키지를 추가합니다.
이 코드에서 arg_name은(는) 코드에서 참조되는 바인딩 매개 변수를 식별하고, database_name 및 container_name은(는) 바인딩이 쓰는 데이터베이스 및 컬렉션 이름이며 connection은(는) local.settings.json 파일의 CosmosDbConnectionSetting 설정에 있는 Azure Cosmos DB 계정에 대한 연결 문자열을 포함하는 애플리케이션 설정의 이름입니다.
출력 바인딩을 사용하는 코드 추가
기존 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 출력 바인딩 개체를 사용하는 코드를 추가하여 명명된 출력 바인딩 함수 sendToCosmosDb에 JSON 문서를 보냅니다. 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 매개 변수를 함수 정의에 추가하고 if name: 문 아래에 outputDocument.set()를 추가합니다.
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 도구와 통합되어 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를 중지합니다.
JSON 문서가 만들어졌는지 확인
Azure Portal에서 Azure Cosmos DB 계정으로 돌아가서 데이터 탐색기를 선택합니다.
데이터베이스와 컨테이너를 펼치고, 항목을 선택하여 컨테이너에 만든 문서를 나열합니다.
출력 바인딩에서 새 JSON 문서가 만들어졌는지 확인합니다.
업데이트된 앱 다시 배포 및 확인
Visual Studio Code에서 F1 키를 눌러 명령 팔레트를 엽니다. 명령 팔레트에서 Azure Functions: Deploy to function app...을 검색하여 선택합니다.
처음 문서에서 만든 함수 앱을 선택합니다. 동일한 앱에 프로젝트를 다시 배포하므로 배포를 선택하여 파일 덮어쓰기에 대한 경고를 해제합니다.
배포가 완료되면 지금 함수 실행... 기능을 사용하여 Azure에서 함수를 트리거할 수 있습니다.