ServiceBusReceiver 클래스

메시지를 중단합니다.

이 메시지는 큐로 반환되고 다시 받을 수 있습니다.

abandon_message(message: ServiceBusReceivedMessage) -> None

매개 변수

반환 형식

예외

예제

받은 메시지를 중단합니다.

       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           servicebus_receiver.abandon_message(message)

close() -> None

예외

메시지를 완료합니다.

그러면 큐에서 메시지가 제거됩니다.

complete_message(message: ServiceBusReceivedMessage) -> None

매개 변수

반환 형식

예외

예제

받은 메시지를 완료합니다.

       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           servicebus_receiver.complete_message(message)

메시지를 배달 못 한 편지 큐로 이동합니다.

배달 못한 편지 큐는 올바르게 처리하지 못했거나 추가 검사 또는 처리가 필요한 메시지를 저장하는 데 사용할 수 있는 하위 큐입니다. 만료된 메시지를 배달 못 한 편지 큐로 보내도록 큐를 구성할 수도 있습니다.

dead_letter_message(message: ServiceBusReceivedMessage, reason: str | None = None, error_description: str | None = None) -> None

매개 변수

반환 형식

예외

예제

배달 못한 편지 받은 메시지입니다.

       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           servicebus_receiver.dead_letter_message(message)

메시지를 연기합니다.

이 메시지는 큐에 남아 있지만 수신하려면 시퀀스 번호로 특별히 요청해야 합니다.

defer_message(message: ServiceBusReceivedMessage) -> None

매개 변수

반환 형식

예외

예제

받은 메시지를 연기합니다.

       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           servicebus_receiver.defer_message(message)

next()

예외

큐에서 현재 보류 중인 메시지를 찾습니다.

피킹된 메시지는 큐에서 제거되지 않으며 잠겨 있지 않습니다. 그들은 완료, 지연 또는 배달 못한 편지 수 없습니다.

peek_messages(max_message_count: int = 1, *, sequence_number: int = 0, timeout: float | None = None, **kwargs: Any) -> List[ServiceBusReceivedMessage]

매개 변수

반환

~azure.servicebus.ServiceBusReceivedMessage 목록입니다.

반환 형식

예외

예제

큐에서 보류 중인 메시지를 확인합니다.

   with servicebus_receiver:
       messages = servicebus_receiver.peek_messages()
       for message in messages:
           print(str(message))

이전에 지연된 메시지를 받습니다.

분할된 엔터티에서 지연된 메시지를 수신하는 경우 제공된 모든 시퀀스 번호는 동일한 파티션의 메시지여야 합니다.

receive_deferred_messages(sequence_numbers: int | List[int], *, timeout: float | None = None, **kwargs: Any) -> List[ServiceBusReceivedMessage]

매개 변수

반환

요청된 ~azure.servicebus.ServiceBusReceivedMessage 인스턴스의 목록입니다.

반환 형식

예외

예제

ServiceBus에서 지연된 메시지를 받습니다.

   with servicebus_receiver:
       deferred_sequenced_numbers = []
       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           deferred_sequenced_numbers.append(message.sequence_number)
           print(str(message))
           servicebus_receiver.defer_message(message)

       received_deferred_msg = servicebus_receiver.receive_deferred_messages(
           sequence_numbers=deferred_sequenced_numbers
       )

       for msg in received_deferred_msg:
           servicebus_receiver.complete_message(msg)

한 번에 메시지 일괄 처리를 수신합니다.

이 방법은 여러 메시지를 동시에 처리하거나 임시 수신을 단일 호출로 수행하려는 경우에 최적입니다.

단일 일괄 처리에서 검색된 메시지 수는 수신기에 대해 prefetch_count 설정되었는지 여부에 따라 달라집니다. 수신기에 대해 prefetch_count 설정되지 않은 경우 수신기는 서비스에 대한 요청 내에서 max_message_count(제공된 경우) 메시지를 캐시하려고 시도합니다.

이 호출은 지정된 일괄 처리 크기보다 빠르게 반환하는 우선 순위를 지정하므로 하나 이상의 메시지가 수신되고 지정된 일괄 처리 크기에 관계없이 들어오는 메시지의 간격이 있는 즉시 반환됩니다.

receive_messages(max_message_count: int | None = 1, max_wait_time: float | None = None) -> List[ServiceBusReceivedMessage]

매개 변수

반환

받은 메시지 목록입니다. 사용할 수 있는 메시지가 없으면 빈 목록이 됩니다.

반환 형식

예외

예제

ServiceBus에서 메시지를 받습니다.

   with servicebus_receiver:
       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           print(str(message))
           servicebus_receiver.complete_message(message)

메시지 잠금을 갱신합니다.

이렇게 하면 메시지에 대한 잠금이 유지되어 다시 처리할 큐에 반환되지 않도록 합니다.

메시지를 완료(또는 그렇지 않으면 해결)하려면 잠금을 유지 관리해야 하며 이미 만료될 수 없습니다. 만료된 잠금을 갱신할 수 없습니다.

RECEIVE_AND_DELETE 모드를 통해 받은 메시지는 잠겨 있지 않으므로 갱신할 수 없습니다. 이 작업은 세션이 아닌 메시지에만 사용할 수 있습니다.

renew_message_lock(message: ServiceBusReceivedMessage, *, timeout: float | None = None, **kwargs: Any) -> datetime

매개 변수

반환

잠금이 만료되도록 설정된 utc datetime입니다.

반환 형식

예외

예제

받은 메시지에 대한 잠금을 갱신합니다.

       messages = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages:
           servicebus_receiver.renew_message_lock(message)

수신기 instance 연결된 ServiceBusReceiver client_identifier 가져옵니다.

반환 형식

수신기와 연결된 ServiceBusSession 개체를 가져옵니다. 세션은 세션 사용 엔터티에서만 사용할 수 있으며 세션이 아닌 수신기에서 호출된 경우 None을 반환합니다.

반환 형식

예제

수신기에서 세션 가져오기

       with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id) as receiver:
           session = receiver.session