다음을 통해 공유


Azure Functions에 대한 Azure Service Bus 출력 바인딩

Azure Service Bus 출력 바인딩을 사용하여 큐 또는 토픽 메시지를 보냅니다.

설정 및 구성 세부 정보에 대한 자세한 내용은 개요를 참조하세요.

Important

이 문서에서는 탭을 사용하여 여러 버전의 Node.js 프로그래밍 모델을 지원합니다. v4 모델은 일반적으로 사용 가능하며 JavaScript 및 TypeScript 개발자를 위해 보다 유연하고 직관적인 환경을 제공하도록 설계되었습니다. v4 모델의 작동 방식에 대한 자세한 내용은 Azure Functions Node.js 개발자 가이드를 참조하세요. v3과 v4의 차이점에 대해 자세히 알아보려면 마이그레이션 가이드를 참조하세요.

Azure Functions는 Python에 대해 두 가지 프로그래밍 모델을 지원합니다. 바인딩을 정의하는 방법은 선택한 프로그래밍 모델에 따라 달라집니다.

Python v2 프로그래밍 모델을 사용하면 Python 함수 코드에서 직접 데코레이터를 사용하여 바인딩을 정의할 수 있습니다. 자세한 내용은 Python 개발자 가이드참조하세요.

이 문서에서는 두 프로그래밍 모델을 모두 지원합니다.

예시

C# 함수는 다음 C# 모드 중 하나를 사용하여 만들 수 있습니다.

  • 격리된 작업자 모델: 런타임에서 격리된 작업자 프로세스에서 실행되는 컴파일된 C# 함수입니다. LTS 및 비 LTS 버전 .NET 및 .NET Framework에서 실행되는 C# 함수를 지원하려면 격리된 작업자 프로세스가 필요합니다. 격리된 작업자 프로세스 함수에 대한 확장은 Microsoft.Azure.Functions.Worker.Extensions.* 네임스페이스를 사용합니다.
  • In Process 모델: Functions 런타임과 동일한 프로세스에서 실행되는 컴파일된 C# 함수입니다. 이 모델의 변형에서는 주로 C# 포털 편집에 지원되는 C# 스크립팅을 사용하여 Functions를 실행할 수 있습니다. In Process 함수에 대한 확장은 Microsoft.Azure.WebJobs.Extensions.* 네임스페이스를 사용합니다.

이 코드는 다음을 정의하고 초기화합니다.ILogger

private readonly ILogger<ServiceBusReceivedMessageFunctions> _logger;

public ServiceBusReceivedMessageFunctions(ILogger<ServiceBusReceivedMessageFunctions> logger)
{
    _logger = logger;
}

이 예제에서는 메시지를 수신하고 두 번째 큐에 쓰는 C# 함수를 보여 줍니다.

[Function(nameof(ServiceBusReceivedMessageFunction))]
[ServiceBusOutput("outputQueue", Connection = "ServiceBusConnection")]
public string ServiceBusReceivedMessageFunction(
    [ServiceBusTrigger("queue", Connection = "ServiceBusConnection")] ServiceBusReceivedMessage message)
{
    _logger.LogInformation("Message ID: {id}", message.MessageId);
    _logger.LogInformation("Message Body: {body}", message.Body);
    _logger.LogInformation("Message Content-Type: {contentType}", message.ContentType);

    var outputMessage = $"Output message created at {DateTime.Now}";
    return outputMessage;
}

 


이 예제에서는 개체와 함께 HTTP 트리거를 OutputType 사용하여 HTTP 응답을 보내고 출력 메시지를 작성합니다.

[Function("HttpSendMsg")]
public async Task<OutputType> Run([HttpTrigger(AuthorizationLevel.Function, "get", "post")] HttpRequestData req, FunctionContext context)
{
   _logger.LogInformation($"C# HTTP trigger function processed a request for {context.InvocationId}.");

   HttpResponseData response = req.CreateResponse(HttpStatusCode.OK);
   await response.WriteStringAsync("HTTP response: Message sent");

   return new OutputType()
   {
       OutputEvent = "MyMessage",
       HttpResponse = response
   };
}

이 코드는 다음에 대한 Service Bus 출력 바인딩 정의를 포함하는 여러 출력 형식OutputType을 정의합니다.OutputEvent

 public class OutputType
{
   [ServiceBusOutput("TopicOrQueueName", Connection = "ServiceBusConnection")]
   public string OutputEvent { get; set; }

   public HttpResponseData HttpResponse { get; set; }
}

다음 예제에서는 HTTP 요청에 의해 트리거될 때 Service Bus 큐 myqueue 에 메시지를 보내는 Java 함수를 보여 줍니다.

@FunctionName("httpToServiceBusQueue")
@ServiceBusQueueOutput(name = "message", queueName = "myqueue", connection = "AzureServiceBusConnection")
public String pushToQueue(
  @HttpTrigger(name = "request", methods = {HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS)
  final String message,
  @HttpOutput(name = "response") final OutputBinding<T> result ) {
      result.setValue(message + " has been sent.");
      return message;
 }

Java 함수 런타임 라이브러리에서 값이 Service Bus 큐에 기록되는 함수 매개 변수에 주석을 사용합니다@QueueOutput. 매개 변수 형식은 계획 POJO(이전 Java 개체)의 네이티브 Java 형식이어야 합니다OutputBinding<T>T.

Java 함수는 Service Bus 토픽에 쓸 수도 있습니다. 다음 예제에서는 주석을 @ServiceBusTopicOutput 사용하여 출력 바인딩에 대한 구성을 설명합니다.

@FunctionName("sbtopicsend")
    public HttpResponseMessage run(
            @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request,
            @ServiceBusTopicOutput(name = "message", topicName = "mytopicname", subscriptionName = "mysubscription", connection = "ServiceBusConnection") OutputBinding<String> message,
            final ExecutionContext context) {

        String name = request.getBody().orElse("Azure Functions");

        message.setValue(name);
        return request.createResponseBuilder(HttpStatus.OK).body("Hello, " + name).build();

    }

다음 예에서는 5분마다 큐 메시지를 보내는 타이머 트리거 TypeScript 함수를 보여 줍니다.

import { app, InvocationContext, output, Timer } from '@azure/functions';

export async function timerTrigger1(myTimer: Timer, context: InvocationContext): Promise<string> {
    const timeStamp = new Date().toISOString();
    return `Message created at: ${timeStamp}`;
}

app.timer('timerTrigger1', {
    schedule: '0 */5 * * * *',
    return: output.serviceBusQueue({
        queueName: 'testqueue',
        connection: 'MyServiceBusConnection',
    }),
    handler: timerTrigger1,
});

여러 메시지를 출력하려면 단일 개체 대신 배열을 반환합니다. 예시:

const timeStamp = new Date().toISOString();
const message = `Message created at: ${timeStamp}`;
return [`1: ${message}`, `2: ${message}`];

다음 예에서는 5분마다 큐 메시지를 보내는 타이머 트리거 JavaScript 함수를 보여 줍니다.

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

const serviceBusOutput = output.serviceBusQueue({
    queueName: 'testqueue',
    connection: 'MyServiceBusConnection',
});

app.timer('timerTrigger1', {
    schedule: '0 */5 * * * *',
    return: serviceBusOutput,
    handler: (myTimer, context) => {
        const timeStamp = new Date().toISOString();
        return `Message created at: ${timeStamp}`;
    },
});

여러 메시지를 출력하려면 단일 개체 대신 배열을 반환합니다. 예시:

const timeStamp = new Date().toISOString();
const message = `Message created at: ${timeStamp}`;
return [`1: ${message}`, `2: ${message}`];

다음 예제에서는 바인딩을 사용하는 function.json 파일과 PowerShell 함수의 Service Bus 출력 바인딩을 보여줍니다.

function.json 파일의 바인딩 데이터는 다음과 같습니다.

{
  "bindings": [
    {
      "type": "serviceBus",
      "direction": "out",
      "connection": "AzureServiceBusConnectionString",
      "name": "outputSbMsg",
      "queueName": "outqueue",
      "topicName": "outtopic"
    }
  ]
}

함수의 출력으로 메시지를 만드는 PowerShell은 다음과 같습니다.

param($QueueItem, $TriggerMetadata) 

Push-OutputBinding -Name outputSbMsg -Value @{ 
    name = $QueueItem.name 
    employeeId = $QueueItem.employeeId 
    address = $QueueItem.address 
} 

다음 예제에서는 Python에서 Service Bus 큐에 쓰는 방법을 보여 줍니다. 이 예제는 v1 또는 v2 Python 프로그래밍 모델을 사용하는지 여부에 따라 달라집니다.

import logging
import azure.functions as func

app = func.FunctionApp()

@app.route(route="put_message")
@app.service_bus_topic_output(arg_name="message",
                              connection="<CONNECTION_SETTING>",
                              topic_name="<TOPIC_NAME>")
def main(req: func.HttpRequest, message: func.Out[str]) -> func.HttpResponse:
    input_msg = req.params.get('message')
    message.set(input_msg)
    return 'OK'

특성

In Process격리된 작업자 프로세스 C# 라이브러리는 모두 특성을 사용하여 출력 바인딩을 정의합니다. 대신 C# 스크립트는 C# 스크립팅 가이드에 설명된 대로 function.json 구성 파일을 사용합니다.

C# 클래스 라이브러리에서 ServiceBusOutputAttribute를 사용하여 출력에 의해 작성된 큐 또는 항목을 정의합니다.

다음 표에서는 특성을 사용하여 설정할 수 있는 특성에 대해 설명합니다.

속성 설명
EntityType 엔터티 형식을 큐에 메시지를 보내는 경우 Queue로 설정하거나 항목에 메시지를 보내는 경우 Topic으로 설정합니다.
QueueOrTopicName 메시지를 보낼 항목 또는 큐의 이름입니다. EntityType을 사용하여 대상 형식을 설정합니다.
Connection Service Bus에 연결하는 방법을 지정하는 앱 설정 또는 설정 컬렉션의 이름입니다. 연결을 참조하세요.

데코레이터

Python v2 프로그래밍 모델에만 적용됩니다.

데코레이터를 사용하여 정의된 Python v2 함수의 경우 다음 속성은 service_bus_topic_output다음과 같습니다.

속성 설명
arg_name 함수 코드에서 큐 또는 토픽 메시지를 나타내는 변수의 이름입니다.
queue_name 큐 이름. 토픽이 아닌 큐 메시지를 보내는 경우에만 설정합니다.
topic_name 항목의 이름입니다. 큐가 아닌 토픽 메시지를 보내는 경우에만 설정합니다.
connection Service Bus에 연결하는 방법을 지정하는 앱 설정 또는 설정 컬렉션의 이름입니다. 연결을 참조하세요.

function.json 사용하여 정의된 Python 함수는 구성 섹션을 참조하세요.

주석

ServiceBusQueueOutput 주석과 ServiceBusTopicOutput 주석을 사용하여 메시지를 함수 출력으로 작성할 수 있습니다. 이러한 주석으로 데코레이팅된 매개 변수는 메시지 형식에 해당하는 형식인 OutputBinding<T> 위치 T 로 선언해야 합니다.

로컬에서 개발하는 경우 Values 컬렉션의 local.settings.json 파일에 애플리케이션 설정을 추가합니다.

구성

Python v1 프로그래밍 모델에만 적용됩니다.

다음 표에서는 output.serviceBusQueue() 메서드에 전달된 options 개체에 설정할 수 있는 속성에 대해 설명합니다.

속성 설명
queueName 큐 이름.
connection Service Bus에 연결하는 방법을 지정하는 앱 설정 또는 설정 컬렉션의 이름입니다. 연결을 참조하세요.

다음 표에서는 output.serviceBusTopic() 메서드에 전달된 options 개체에 설정할 수 있는 속성에 대해 설명합니다.

속성 설명
topicName 항목의 이름입니다.
connection Service Bus에 연결하는 방법을 지정하는 앱 설정 또는 설정 컬렉션의 이름입니다. 연결을 참조하세요.

로컬에서 개발하는 경우 Values 컬렉션의 local.settings.json 파일에 애플리케이션 설정을 추가합니다.

다음 표에서는 function.json 파일 및 ServiceBus 특성에 설정된 바인딩 구성 속성을 설명합니다.

function.json 속성 설명
type serviceBus로 설정해야 합니다. 이 속성은 사용자가 Azure Portal에서 트리거를 만들 때 자동으로 설정됩니다.
direction out로 설정해야 합니다. 이 속성은 사용자가 Azure Portal에서 트리거를 만들 때 자동으로 설정됩니다.
이름 함수 코드에서 큐 또는 토픽 메시지를 나타내는 변수의 이름입니다. "$return"으로 설정하여 함수 반환 값을 참조합니다.
queueName 큐 이름. 토픽이 아닌 큐 메시지를 보내는 경우에만 설정합니다.
topicName 항목의 이름입니다. 큐가 아닌 토픽 메시지를 보내는 경우에만 설정합니다.
connection Service Bus에 연결하는 방법을 지정하는 앱 설정 또는 설정 컬렉션의 이름입니다. 연결을 참조하세요.
accessRights(v1만 해당) 연결 문자열에 대한 액세스 권한입니다. 사용 가능한 값은 managelisten입니다. 기본값은 manage이며, connection관리 권한이 있음을 의미합니다. 관리 권한이 없는 연결 문자열 사용하는 경우 "수신 대기"로 설정합니다accessRights. 그렇지 않으면 함수 런타임은 관리 권한이 필요한 작업 시도를 실패할 수 있습니다. Azure Functions 버전 2.x 이상에서는 최신 버전의 Service Bus SDK가 관리 작업을 지원하지 않으므로 이 속성을 사용할 수 없습니다.

로컬에서 개발하는 경우 Values 컬렉션의 local.settings.json 파일에 애플리케이션 설정을 추가합니다.

전체 예제는 예제 섹션을 참조하세요.

사용

모든 C# 형식 및 확장 버전은 다음과 같은 출력 매개 변수 형식을 지원합니다.

Type 설명
System.String 작성할 메시지가 간단한 텍스트일 때 사용합니다. 함수가 종료될 때 매개 변수 값이 null이면 Functions는 메시지를 만들지 않습니다.
byte[] 이진 데이터 메시지를 작성하는 데 사용합니다. 함수가 종료될 때 매개 변수 값이 null이면 Functions는 메시지를 만들지 않습니다.
Object 메시지에 JSON이 포함된 경우 Functions는 개체를 JSON 메시지 페이로드로 직렬화합니다. 함수가 종료될 때 매개 변수 값이 null이면 Functions는 null 개체와 메시지를 만듭니다.

메시징 관련 매개 변수 형식은 추가 메시지 메타데이터를 포함하며 JSON serialization과 호환되지 않습니다. 따라서 격리된 모델의 출력 바인딩과 함께 사용할 ServiceBusMesage 수 없습니다. 출력 바인딩에서 지원하는 특정 형식은 Functions 런타임 버전, 확장 패키지 버전 및 사용된 C# 형식에 따라 다릅니다.

함수가 단일 메시지를 작성하도록 하려는 경우 Service Bus 출력 바인딩은 다음 형식에 바인딩될 수 있습니다.

Type 설명
string 문자열 메시지입니다. 메시지가 간단한 텍스트일 때 사용합니다.
byte[] 메시지의 바이트입니다.
JSON 직렬화 가능 형식 메시지를 나타내는 개체입니다. Functions는 POCO(Plain Old CLR Object) 형식을 JSON 데이터로 직렬화하려고 시도합니다.

함수가 여러 메시지를 쓰도록 하려는 경우 Service Bus 출력 바인딩을 다음 형식에 바인딩할 수 있습니다.

Type 설명
T[] 여기서 T는 단일 메시지 유형 중 하나입니다. 여러 메시지를 포함하는 배열입니다. 각 항목은 하나의 메시지를 나타냅니다.

다른 출력 시나리오의 경우 Azure.Messaging.ServiceBus다른 형식과 함께 ServiceBusClient를 직접 만들고 사용합니다. 종속성 주입을 사용하여 Azure SDK에서 클라이언트 형식을 만드는 예제는 Azure 클라이언트 등록을 참조하세요.

Azure Functions 1.x에서 런타임은 큐가 존재하지 accessRights 않고 설정한 경우 큐를 manage만듭니다. Azure Functions 버전 2.x 이상에서는 큐 또는 항목이 이미 있어야 합니다. 존재하지 않는 큐 또는 항목을 지정하면 함수가 실패합니다.

값을 직접 반환하거나 context.extraOutputs.set()를 사용하여 출력 메시지에 액세스합니다.

Service Bus에 대한 출력은 function.json 파일에서 바인딩의 이름 매개 변수로 지정된 이름과 일치하는 인수를 전달하는 cmdlet을 통해 Push-OutputBinding 사용할 수 있습니다.

전체 예제는 예제 섹션을 참조하세요.

연결

connection 속성은 앱이 Service Bus에 연결해야 하는 방법을 지정하는 환경 구성에 대한 참조입니다. 다음을 지정할 수 있습니다.

  • 연결 문자열이 포함된 애플리케이션 설정의 이름
  • 함께 ID 기반 연결을 정의하는 여러 애플리케이션 설정에 대한 공유 접두사의 이름입니다.

구성된 값이 단일 설정에 대해 정확히 일치하고 다른 설정에 대해 접두사가 일치하는 경우 정확한 일치가 사용됩니다.

Connection string

연결 문자열 가져오려면 관리 자격 증명 가져오기에 표시된 단계를 따릅니다. 연결 문자열 특정 큐 또는 토픽에 국한되지 않고 Service Bus 네임스페이스에 대한 것이어야 합니다.

이 연결 문자열은 바인딩 구성의 connection 속성에 지정된 값과 일치하는 이름으로 애플리케이션 설정에 저장해야 합니다.

앱 설정 이름이 "AzureWebJobs"로 시작하는 경우 이름의 나머지만 지정할 수 있습니다. 예를 들어 "MyServiceBus"로 설정한 connection 경우 Functions 런타임은 "AzureWebJobsMyServiceBus"라는 앱 설정을 찾습니다. 비워 두 connection 면 Functions 런타임은 "AzureWebJobsServiceBus"라는 앱 설정에서 기본 Service Bus 연결 문자열 사용합니다.

ID 기반 연결

버전 5.x 이상을 사용하는 경우 비밀과 함께 연결 문자열 사용하는 대신 앱에서 Microsoft Entra ID사용하도록 할 수 있습니다. 이렇게 하려면 트리거 및 바인딩 구성의 connection 속성에 매핑되는 공통 접두사 아래에 설정을 정의합니다.

이 모드에서 확장에는 다음 속성이 필요합니다.

속성 환경 변수 템플릿 설명 예제 값
정규화된 네임스페이스 <CONNECTION_NAME_PREFIX>__fullyQualifiedNamespace 정규화된 Service Bus 네임스페이스입니다. <service_bus_namespace>.servicebus.windows.net

연결을 사용자 지정하기 위해 추가 속성을 설정할 수 있습니다. ID 기반 연결의 공통 속성을 참조하세요.

참고 항목

Azure App Configuration 또는 Key Vault를 사용하여 관리 ID 연결에 대한 설정을 제공하는 경우 설정 이름은 올바르게 확인되도록 __ 대신 : 또는 /와 같은 유효한 키 구분 기호를 사용해야 합니다.

예들 들어 <CONNECTION_NAME_PREFIX>:fullyQualifiedNamespace입니다.

Azure Functions 서비스에서 호스트되는 경우 ID 기반 연결에 관리 ID가 사용됩니다. 사용자가 할당한 ID는 credentialclientID 속성을 사용하여 지정할 수 있지만 기본적으로 시스템 할당 ID가 사용됩니다. 리소스 ID를 사용하여 사용자가 할당한 ID를 구성하는 것은 지원되지 않습니다. 로컬 개발과 같은 다른 컨텍스트에서 실행할 때 사용자 지정할 수 있지만 대신 개발자 ID가 사용됩니다. ID 기반 연결을 사용하여 로컬 개발을 참조하세요.

ID에 권한 부여

사용되는 모든 ID에는 의도한 작업을 수행할 수 있는 권한이 있어야 합니다. 대부분 Azure 서비스의 경우 이는 해당 권한을 제공하는 기본 제공 또는 사용자 지정 역할을 사용하여 Azure RBAC에서 역할을 할당해야 함을 의미합니다.

Important

일부 사용 권한은 모든 컨텍스트에 필요하지 않은 대상 서비스에 의해 노출될 수 있습니다. 가능한 경우 최소 권한 원칙을 준수하여 ID에 필요한 권한만 부여하세요. 예를 들어 앱이 데이터 원본에서 읽을 수만 있으면 되는 경우 읽기 권한만 있는 역할을 사용합니다. 읽기 작업에 대한 과도한 권한이 될 수 있으므로 해당 서비스에 쓰기도 허용하는 역할을 할당하는 것은 부적절합니다. 마찬가지로 역할 할당이 읽어야 하는 리소스에 대해서만 범위가 할당되도록 할 수 있습니다.

런타임에 항목 및 큐에 대한 액세스를 제공하는 역할 할당을 만들어야 합니다. 소유자와 같은 관리 역할로는 충분하지 않습니다. 다음 표는 정상적인 작동에서 Service Bus 확장을 사용할 때 권장되는 기본 제공 역할을 보여 줍니다. 작성하는 코드에 따라 애플리케이션에 추가 권한이 필요할 수 있습니다.

바인딩 유형 기본 제공 역할 예
Trigger1 Azure Service Bus 데이터 수신기, Azure Service Bus 데이터 소유자
출력 바인딩 Azure Service Bus 데이터 보내는 사람

1 Service Bus 항목에서 트리거하려면 역할 할당에 Service Bus 구독 리소스에 대한 유효 범위가 있어야 합니다. 항목만 포함하면 오류가 발생합니다. Azure Portal과 같은 일부 클라이언트는 Service Bus 구독 리소스를 역할 할당 범위로 노출하지 않습니다. 이러한 경우 Azure CLI를 대신 사용할 수 있습니다. 자세한 내용은 Azure Service Bus용 Azure 기본 제공 역할을 참조하세요.

예외 및 반환 코드

바인딩 참조
Service Bus Service Bus 오류 코드
Service Bus Service Bus 제한

다음 단계