다음을 통해 공유

QueueClient 클래스

  • 참조

특정 큐와 상호 작용하는 클라이언트입니다.

추가 선택적 구성을 보려면 여기를 클릭하세요.

상속
azure.storage.queue._shared.base_client.StorageAccountHostsMixin
QueueClient
azure.storage.queue._encryption.StorageEncryptionMixin
QueueClient

생성자

QueueClient(account_url: str, queue_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

매개 변수

account_url
str
필수

스토리지 계정에 대한 URL입니다. 큐에 대한 전체 URI가 지정된 클라이언트를 만들려면 classmethod를 from_queue_url 사용합니다.

queue_name
str
필수

큐의 이름입니다.

credential
기본값: None

인증할 자격 증명입니다. 계정 URL에 이미 SAS 토큰이 있는 경우 선택 사항입니다. 값은 SAS 토큰 문자열, azure.core.credentials에서 AzureSasCredential 또는 AzureNamedKeyCredential의 instance, 계정 공유 액세스 키 또는 azure.identity에서 TokenCredentials 클래스의 instance 수 있습니다. 리소스 URI에 이미 SAS 토큰이 포함된 경우 명시적 자격 증명을 위해 무시됩니다.

  • 충돌하는 SAS 토큰이 ValueError를 발생시키는 AzureSasCredential의 경우를 제외하고. AzureNamedKeyCredential의 instance 사용하는 경우 "name"은 스토리지 계정 이름이고 "키"는 스토리지 계정 키여야 합니다.
api_version
str

요청에 사용할 Storage API 버전입니다. 기본값은 현재 SDK와 호환되는 최신 서비스 버전입니다. 이전 버전으로 설정하면 기능 호환성이 저하될 수 있습니다.

secondary_hostname
str

보조 엔드포인트의 호스트 이름입니다.

message_encode_policy

보내는 메시지에 사용할 인코딩 정책입니다. 기본값은 메시지를 인코딩하지 않는 것입니다. 다른 옵션으로는 , BinaryBase64EncodePolicy 또는 없음이 있습니다TextBase64EncodePolicy.

message_decode_policy

들어오는 메시지에 사용할 디코딩 정책입니다. 기본값은 메시지를 디코딩하지 않는 것입니다. 다른 옵션으로는 , BinaryBase64DecodePolicy 또는 없음이 있습니다TextBase64DecodePolicy.

audience
str

Azure Active Directory 인증에 대한 토큰을 요청할 때 사용할 대상 그룹입니다. 자격 증명이 TokenCredential 형식인 경우에만 효과가 있습니다. 값은 (기본값) 또는 https://.queue.core.windows.net 수 https://storage.azure.com/ 있습니다.

예제

URL 및 자격 증명을 사용하여 큐 클라이언트를 만듭니다.


   token_auth_queue = QueueClient.from_queue_url(
       queue_url=queue.url,
       credential=sas_token
   )

메서드

clear_messages

지정된 큐에서 모든 메시지를 삭제합니다.
close

이 메서드는 클라이언트에서 연 소켓을 닫는 것입니다. 컨텍스트 관리자와 함께 를 사용할 때는 사용할 필요가 없습니다.
create_queue

스토리지 계정에 새 큐를 만듭니다.

이름이 같은 큐가 이미 있는 경우 ResourceExistsError로 인해 작업이 실패합니다.
delete_message

지정된 메시지를 삭제합니다.

일반적으로 클라이언트가 수신 메시지 작업을 사용하여 메시지를 검색한 후 클라이언트는 메시지를 처리하고 삭제해야 합니다. 메시지를 삭제하려면 메시지 개체 자체 또는 두 개의 데이터 항목(id 및 pop_receipt)이 있어야 합니다. ID는 이전 receive_messages 작업에서 반환됩니다. pop_receipt 가장 최근 receive_messages 또는 update_message 작업에서 반환됩니다. delete_message 작업이 성공하려면 요청에 지정된 pop_receipt 또는 update_message 작업에서 receive_messages 반환된 pop_receipt 일치해야 합니다.
delete_queue

지정된 큐와 해당 큐에 포함된 모든 메시지를 삭제합니다.

큐가 성공적으로 삭제되면 즉시 삭제로 표시되고 클라이언트가 더 이상 액세스할 수 없습니다. 이 큐는 나중에 가비지 수집 과정에서 큐 서비스에서 제거됩니다.

큐 삭제를 완료하는 데 40초 이상 걸릴 수 있습니다. 삭제되는 동안 큐에 대해 작업을 시도하면 이 <xref:azure.storage.queue.HttpResponseError> throw됩니다.
from_connection_string

연결 문자열에서 QueueClient를 만듭니다.
from_queue_url

특정 큐와 상호 작용하는 클라이언트입니다.
get_queue_access_policy

공유 액세스 서명과 함께 사용할 수 있는 큐에 지정된 저장된 액세스 정책에 대한 세부 정보를 반환합니다.
get_queue_properties

지정된 큐에 대한 모든 사용자 정의 메타데이터를 반환합니다.

반환된 데이터에는 큐의 메시지 목록이 포함되지 않습니다.
peek_messages

큐의 전면에서 하나 이상의 메시지를 검색하지만 메시지의 표시 유형을 변경하지는 않습니다.

표시되는 메시지만 검색할 수 있습니다. 에 대한 호출을 사용하여 메시지를 처음으로 검색하면 receive_messages해당 dequeue_count 속성이 1로 설정됩니다. 삭제되지 않고 이후에 다시 검색되면 dequeue_count 속성이 증가합니다. 클라이언트는 이 값을 사용해서 메시지가 검색된 횟수를 확인할 수 있습니다. peek_messages 호출은 dequeue_count 값을 증가시키지 않지만 클라이언트가 읽을 이 값을 반환합니다.

키 암호화 키 또는 확인자 필드가 로컬 서비스 개체에 설정된 경우 메시지가 반환되기 전에 암호가 해독됩니다.
receive_message

큐의 맨 앞에서 하나의 메시지를 제거합니다.

큐에서 메시지를 검색하면 응답에는 메시지 콘텐츠와 메시지를 삭제하는 데 필요한 pop_receipt 값이 포함됩니다. 메시지는 큐에서 자동으로 삭제되지 않지만 검색된 후에는 visibility_timeout 매개 변수로 지정된 시간 간격 동안 다른 클라이언트에 표시되지 않습니다.

키 암호화 키 또는 확인자 필드가 로컬 서비스 개체에 설정된 경우 메시지가 반환되기 전에 암호 해독됩니다.
receive_messages

큐의 맨 앞에서 하나 이상의 메시지를 제거합니다.

큐에서 메시지를 검색하면 응답에는 메시지 콘텐츠와 메시지를 삭제하는 데 필요한 pop_receipt 값이 포함됩니다. 메시지는 큐에서 자동으로 삭제되지 않지만 검색된 후에는 visibility_timeout 매개 변수로 지정된 시간 간격 동안 다른 클라이언트에 표시되지 않습니다. 반복기는 큐가 비어 있거나 max_messages 도달할 때까지(max_messages 설정된 경우) 메시지를 지속적으로 가져옵니다.

키 암호화 키 또는 확인자 필드가 로컬 서비스 개체에 설정된 경우 메시지가 반환되기 전에 암호가 해독됩니다.
send_message

메시지 큐의 뒷면에 새 메시지를 추가합니다.

표시 시간 제한은 메시지가 보이지 않는 시간을 지정합니다. 제한 시간이 만료된 뒤에는 메시지가 표시됩니다. 표시 제한 시간을 지정하지 않으면 기본값 0이 사용됩니다.

메시지 TL(Time to Live)은 메시지가 큐에 남아 있는 기간을 지정합니다. 메시지는 TTL(time-to-live) 기간이 만료되었을 때 큐에서 삭제됩니다.

키 암호화 키 필드가 로컬 서비스 개체에 설정된 경우 이 메서드는 업로드하기 전에 콘텐츠를 암호화합니다.
set_queue_access_policy

공유 액세스 서명에 사용할 수 있는 큐에 대한 저장된 액세스 정책을 설정합니다.

큐에 대한 권한을 설정하면 기존 권한이 바뀝니다. 큐의 권한을 업데이트하려면 를 호출 get_queue_access_policy 하여 큐와 연결된 모든 액세스 정책을 가져오고, 변경하려는 액세스 정책을 수정한 다음, 전체 데이터 집합으로 이 함수를 호출하여 업데이트를 수행합니다.

큐에서 저장된 액세스 정책을 설정할 경우 적용되는 데 최대 30초까지 걸릴 수 있습니다. 이 간격 동안 저장된 액세스 정책과 연결된 공유 액세스 서명은 액세스 정책이 활성화될 때까지 을 throw <xref:azure.storage.queue.HttpResponseError> 합니다.
set_queue_metadata

지정된 큐에서 사용자 정의 메타데이터를 설정합니다.

메타데이터는 큐에 이름-값 쌍으로 연결됩니다.
update_message

메시지의 표시 유형 시간 제한을 업데이트. 또한 이 작업을 사용해서 메시지의 콘텐츠를 업데이트할 수도 있습니다.

이 작업을 사용하여 큐 메시지의 투명도를 지속적으로 확장할 수 있습니다. 이 기능은 작업자 역할이 큐 메시지를 "임대"하려는 경우에 유용할 수 있습니다. 예를 들어 작업자 역할이 을 호출 receive_messages 하고 메시지를 처리하는 데 더 많은 시간이 필요하다는 것을 인식하는 경우 처리될 때까지 메시지의 보이지 않는 기능을 지속적으로 확장할 수 있습니다. 처리 중에 작업자 역할이 실패할 경우에는 결과적으로 메시지가 다시 표시되며, 다른 작업자 역할이 이를 처리할 수 있습니다.

키 암호화 키 필드가 로컬 서비스 개체에 설정된 경우 이 메서드는 업로드하기 전에 콘텐츠를 암호화합니다.

clear_messages

지정된 큐에서 모든 메시지를 삭제합니다.

clear_messages(**kwargs: Any) -> None

매개 변수

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

예제

모든 메시지를 지웁니다.


   queue.clear_messages()

close

이 메서드는 클라이언트에서 연 소켓을 닫는 것입니다. 컨텍스트 관리자와 함께 를 사용할 때는 사용할 필요가 없습니다.

close()

create_queue

스토리지 계정에 새 큐를 만듭니다.

이름이 같은 큐가 이미 있는 경우 ResourceExistsError로 인해 작업이 실패합니다.

create_queue(*, metadata: Dict[str, str] | None = None, **kwargs: Any) -> None

매개 변수

metadata
Dict[str,str]

큐와 메타데이터로 연결할 이름-값 쌍을 포함하는 받아쓰기입니다. 메타데이터를 만들 때는 이름에서 대/소문자를 구분하지만 설정하거나 읽을 때에는 대/소문자를 구분하지 않습니다.

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

반환

none 또는 cls(response)의 결과

반환 형식

None

예외

StorageErrorException

예제

큐를 만듭니다.


   queue.create_queue()

delete_message

지정된 메시지를 삭제합니다.

일반적으로 클라이언트가 수신 메시지 작업을 사용하여 메시지를 검색한 후 클라이언트는 메시지를 처리하고 삭제해야 합니다. 메시지를 삭제하려면 메시지 개체 자체 또는 두 개의 데이터 항목(id 및 pop_receipt)이 있어야 합니다. ID는 이전 receive_messages 작업에서 반환됩니다. pop_receipt 가장 최근 receive_messages 또는 update_message 작업에서 반환됩니다. delete_message 작업이 성공하려면 요청에 지정된 pop_receipt 또는 update_message 작업에서 receive_messages 반환된 pop_receipt 일치해야 합니다.

delete_message(message: str | QueueMessage, pop_receipt: str | None = None, **kwargs: Any) -> None

매개 변수

message
str 또는 QueueMessage
필수

삭제할 메시지를 식별하는 메시지 개체 또는 ID입니다.

pop_receipt
str
필수

또는 update_message에 대한 이전 호출 receive_messages 에서 반환된 유효한 팝 영수증 값입니다.

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

예제

메시지를 삭제합니다.


   # Get the message at the front of the queue
   msg = next(queue.receive_messages())

   # Delete the specified message
   queue.delete_message(msg)

delete_queue

지정된 큐와 해당 큐에 포함된 모든 메시지를 삭제합니다.

큐가 성공적으로 삭제되면 즉시 삭제로 표시되고 클라이언트가 더 이상 액세스할 수 없습니다. 이 큐는 나중에 가비지 수집 과정에서 큐 서비스에서 제거됩니다.

큐 삭제를 완료하는 데 40초 이상 걸릴 수 있습니다. 삭제되는 동안 큐에 대해 작업을 시도하면 이 <xref:azure.storage.queue.HttpResponseError> throw됩니다.

delete_queue(**kwargs: Any) -> None

매개 변수

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

반환 형식

None

예제

큐를 삭제합니다.


   queue.delete_queue()

from_connection_string

연결 문자열에서 QueueClient를 만듭니다.

from_connection_string(conn_str: str, queue_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

매개 변수

conn_str
str
필수

Azure Storage 계정에 대한 연결 문자열.

queue_name
str
필수

큐 이름입니다.

credential
기본값: None

인증할 자격 증명입니다. 계정 URL에 이미 SAS 토큰이 있거나 연결 문자열 공유 액세스 키 값이 이미 있는 경우 선택 사항입니다. 값은 SAS 토큰 문자열, azure.core.credentials에서 AzureSasCredential 또는 AzureNamedKeyCredential의 instance, 계정 공유 액세스 키 또는 azure.identity에서 TokenCredentials 클래스의 instance 수 있습니다. 여기에 제공된 자격 증명이 연결 문자열 자격 증명보다 우선합니다. AzureNamedKeyCredential의 instance 사용하는 경우 "name"은 스토리지 계정 이름이고 "키"는 스토리지 계정 키여야 합니다.

audience
str

Azure Active Directory 인증에 대한 토큰을 요청할 때 사용할 대상 그룹입니다. 자격 증명이 TokenCredential 형식인 경우에만 효과가 있습니다. 값은 (기본값) 또는 https://.queue.core.windows.net 수 https://storage.azure.com/ 있습니다.

반환

큐 클라이언트입니다.

반환 형식

QueueClient

예제

연결 문자열 큐 클라이언트를 만듭니다.


   from azure.storage.queue import QueueClient
   queue = QueueClient.from_connection_string(self.connection_string, "myqueue1")

from_queue_url

특정 큐와 상호 작용하는 클라이언트입니다.

from_queue_url(queue_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

매개 변수

queue_url
str
필수

사용되는 경우 SAS 토큰을 포함하여 큐에 대한 전체 URI입니다.

credential
기본값: None

인증할 자격 증명입니다. 계정 URL에 이미 SAS 토큰이 있는 경우 선택 사항입니다. 값은 SAS 토큰 문자열, azure.core.credentials의 AzureSasCredential 또는 AzureNamedKeyCredential의 instance, 계정 공유 액세스 키 또는 azure.identity에서 TokenCredentials 클래스의 instance 수 있습니다. 리소스 URI에 이미 SAS 토큰이 포함된 경우 명시적 자격 증명을 위해 무시됩니다.

  • 충돌하는 SAS 토큰이 ValueError를 발생시키는 AzureSasCredential의 경우를 제외하고 AzureNamedKeyCredential의 instance 사용하는 경우 "name"은 스토리지 계정 이름이고 "키"는 스토리지 계정 키여야 합니다.
audience
str

Azure Active Directory 인증에 대한 토큰을 요청할 때 사용할 대상 그룹입니다. 자격 증명이 TokenCredential 형식인 경우에만 효과가 있습니다. 값은 (기본값) 또는 https://.queue.core.windows.net 수 https://storage.azure.com/ 있습니다.

반환

큐 클라이언트입니다.

반환 형식

QueueClient

get_queue_access_policy

공유 액세스 서명과 함께 사용할 수 있는 큐에 지정된 저장된 액세스 정책에 대한 세부 정보를 반환합니다.

get_queue_access_policy(**kwargs: Any) -> Dict[str, AccessPolicy]

매개 변수

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

반환

큐와 연결된 액세스 정책의 사전입니다.

반환 형식

Dict[str, AccessPolicy]

get_queue_properties

지정된 큐에 대한 모든 사용자 정의 메타데이터를 반환합니다.

반환된 데이터에는 큐의 메시지 목록이 포함되지 않습니다.

get_queue_properties(**kwargs: Any) -> QueueProperties

매개 변수

timeout
int

시간 초과 매개 변수는 초 단위로 표현됩니다.

반환

큐에 대한 사용자 정의 메타데이터입니다.

반환 형식

QueueProperties

예제

큐의 속성을 가져옵니다.


   properties = queue.get_queue_properties().metadata

peek_messages

큐의 전면에서 하나 이상의 메시지를 검색하지만 메시지의 표시 유형을 변경하지는 않습니다.

표시되는 메시지만 검색할 수 있습니다. 에 대한 호출을 사용하여 메시지를 처음으로 검색하면 receive_messages해당 dequeue_count 속성이 1로 설정됩니다. 삭제되지 않고 이후에 다시 검색되면 dequeue_count 속성이 증가합니다. 클라이언트는 이 값을 사용해서 메시지가 검색된 횟수를 확인할 수 있습니다. peek_messages 호출은 dequeue_count 값을 증가시키지 않지만 클라이언트가 읽을 이 값을 반환합니다.

키 암호화 키 또는 확인자 필드가 로컬 서비스 개체에 설정된 경우 메시지가 반환되기 전에 암호가 해독됩니다.

peek_messages(max_messages: int | None = None, **kwargs: Any) -> List[QueueMessage]

매개 변수

max_messages
int
필수

최대 32까지 큐에서 미리 보려는 메시지 수를 지정하는 0이 아닌 정수 값입니다. 기본적으로 이 작업으로는 메시지에서 단일 메시지를 미리 봅니다.

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

반환

QueueMessage 개체의 목록입니다. 피킹이 메시지를 표시하지 않고 이미 표시된 메시지만 검색할 수 있으므로 next_visible_on 및 pop_receipt 채워지지 않습니다.

반환 형식

list(QueueMessage)

예제

메시지를 Peek.


   # Peek at one message at the front of the queue
   msg = queue.peek_messages()

   # Peek at the last 5 messages
   messages = queue.peek_messages(max_messages=5)

   # Print the last 5 messages
   for message in messages:
       print(message.content)

receive_message

큐의 맨 앞에서 하나의 메시지를 제거합니다.

큐에서 메시지를 검색하면 응답에는 메시지 콘텐츠와 메시지를 삭제하는 데 필요한 pop_receipt 값이 포함됩니다. 메시지는 큐에서 자동으로 삭제되지 않지만 검색된 후에는 visibility_timeout 매개 변수로 지정된 시간 간격 동안 다른 클라이언트에 표시되지 않습니다.

키 암호화 키 또는 확인자 필드가 로컬 서비스 개체에 설정된 경우 메시지가 반환되기 전에 암호 해독됩니다.

receive_message(*, visibility_timeout: int | None = None, **kwargs: Any) -> QueueMessage | None

매개 변수

visibility_timeout
int

지정하지 않으면 기본값은 30입니다. 서버 시간을 기준으로 새로운 표시 제한 시간 값(초)을 지정합니다. 값은 1보다 크거나 같아야 하며 7일보다 클 수 없습니다. 메시지의 가시성 제한 시간은 만료 시간보다 큰 값으로 설정할 수 없습니다. visibility_timeout time to Live 값보다 작은 값으로 설정해야 합니다.

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

반환

큐가 비어 있으면 큐 또는 없음에서 메시지를 반환합니다.

반환 형식

QueueMessage,
None

예제

큐에서 하나의 메시지를 받습니다.


   # Pop two messages from the front of the queue
   message1 = queue.receive_message()
   message2 = queue.receive_message()
   # We should see message 3 if we peek
   message3 = queue.peek_messages()[0]

   if not message1 or not message2 or not message3:
       raise ValueError("One of the messages are None.")

   print(message1.content)
   print(message2.content)
   print(message3.content)

receive_messages

큐의 맨 앞에서 하나 이상의 메시지를 제거합니다.

큐에서 메시지를 검색하면 응답에는 메시지 콘텐츠와 메시지를 삭제하는 데 필요한 pop_receipt 값이 포함됩니다. 메시지는 큐에서 자동으로 삭제되지 않지만 검색된 후에는 visibility_timeout 매개 변수로 지정된 시간 간격 동안 다른 클라이언트에 표시되지 않습니다. 반복기는 큐가 비어 있거나 max_messages 도달할 때까지(max_messages 설정된 경우) 메시지를 지속적으로 가져옵니다.

키 암호화 키 또는 확인자 필드가 로컬 서비스 개체에 설정된 경우 메시지가 반환되기 전에 암호가 해독됩니다.

receive_messages(*, messages_per_page: int | None = None, visibility_timeout: int | None = None, max_messages: int | None = None, **kwargs: Any) -> ItemPaged[QueueMessage]

매개 변수

visibility_timeout
int

지정하지 않으면 기본값은 30입니다. 서버 시간을 기준으로 새로운 표시 제한 시간 값(초)을 지정합니다. 값은 1보다 크거나 같아야 하며 7일보다 클 수 없습니다. 메시지의 가시성 제한 시간은 만료 시간보다 큰 값으로 설정할 수 없습니다. visibility_timeout time to Live 값보다 작은 값으로 설정해야 합니다.

max_messages
int

큐에서 검색할 최대 메시지 수를 지정하는 정수입니다.

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

반환

dict와 유사한 Message 개체의 메시지 반복기를 반환합니다.

반환 형식

ItemPaged[QueueMessage]

예제

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


   # Receive messages one-by-one
   messages = queue.receive_messages()
   for msg in messages:
       print(msg.content)

   # Receive messages by batch
   messages = queue.receive_messages(messages_per_page=5)
   for msg_batch in messages.by_page():
       for msg in msg_batch:
           print(msg.content)
           queue.delete_message(msg)

send_message

메시지 큐의 뒷면에 새 메시지를 추가합니다.

표시 시간 제한은 메시지가 보이지 않는 시간을 지정합니다. 제한 시간이 만료된 뒤에는 메시지가 표시됩니다. 표시 제한 시간을 지정하지 않으면 기본값 0이 사용됩니다.

메시지 TL(Time to Live)은 메시지가 큐에 남아 있는 기간을 지정합니다. 메시지는 TTL(time-to-live) 기간이 만료되었을 때 큐에서 삭제됩니다.

키 암호화 키 필드가 로컬 서비스 개체에 설정된 경우 이 메서드는 업로드하기 전에 콘텐츠를 암호화합니다.

send_message(content: object | None, *, visibility_timeout: int | None = None, time_to_live: int | None = None, **kwargs: Any) -> QueueMessage

매개 변수

content
Optional[object]
필수

메시지 콘텐츠입니다. 허용되는 형식은 서비스에서 설정된 encode_function 따라 결정됩니다. 기본값은 str입니다. 인코딩된 메시지의 크기는 최대 64KB입니다.

visibility_timeout
int

지정되지 않은 경우 기본값은 0입니다. 서버 시간을 기준으로 새로운 표시 제한 시간 값(초)을 지정합니다. 값은 0보다 크거나 같아야 하며 7일보다 클 수 없습니다. 메시지의 가시성 제한 시간은 만료 시간보다 큰 값으로 설정할 수 없습니다. visibility_timeout time to Live 값보다 작은 값으로 설정해야 합니다.

time_to_live
int

메시지에 대한 TTL(time-to-live) 간격(초)을 지정합니다. Time to Live는 무한대에 대해 양수 또는 -1일 수 있습니다. 이 매개 변수를 생략한 경우 기본 TTL(time-to-live)은 7일입니다.

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

반환

QueueMessage 개체입니다. 이 개체는 서비스에서 반환되지 않지만 콘텐츠로 채워집니다.

반환 형식

QueueMessage

예제

메시지를 보냅니다.


   queue.send_message("message1")
   queue.send_message("message2", visibility_timeout=30)  # wait 30s before becoming visible
   queue.send_message("message3")
   queue.send_message("message4")
   queue.send_message("message5")

set_queue_access_policy

공유 액세스 서명에 사용할 수 있는 큐에 대한 저장된 액세스 정책을 설정합니다.

큐에 대한 권한을 설정하면 기존 권한이 바뀝니다. 큐의 권한을 업데이트하려면 를 호출 get_queue_access_policy 하여 큐와 연결된 모든 액세스 정책을 가져오고, 변경하려는 액세스 정책을 수정한 다음, 전체 데이터 집합으로 이 함수를 호출하여 업데이트를 수행합니다.

큐에서 저장된 액세스 정책을 설정할 경우 적용되는 데 최대 30초까지 걸릴 수 있습니다. 이 간격 동안 저장된 액세스 정책과 연결된 공유 액세스 서명은 액세스 정책이 활성화될 때까지 을 throw <xref:azure.storage.queue.HttpResponseError> 합니다.

set_queue_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> None

매개 변수

signed_identifiers
Dict[str, AccessPolicy]
필수

큐와 연결할 SignedIdentifier 액세스 정책입니다. 여기에는 최대 5개의 요소가 포함될 수 있습니다. 빈 받아쓰기를 사용하면 서비스에 설정된 액세스 정책이 지워지게 됩니다.

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

예제

큐에서 액세스 정책을 설정합니다.


   # Create an access policy
   from azure.storage.queue import AccessPolicy, QueueSasPermissions
   access_policy = AccessPolicy()
   access_policy.start = datetime.utcnow() - timedelta(hours=1)
   access_policy.expiry = datetime.utcnow() + timedelta(hours=1)
   access_policy.permission = QueueSasPermissions(read=True)
   identifiers = {'my-access-policy-id': access_policy}

   # Set the access policy
   queue.set_queue_access_policy(identifiers)

set_queue_metadata

지정된 큐에서 사용자 정의 메타데이터를 설정합니다.

메타데이터는 큐에 이름-값 쌍으로 연결됩니다.

set_queue_metadata(metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, Any]

매개 변수

metadata
Optional[Dict[str, str]]
필수

큐와 메타데이터로 연결할 이름-값 쌍을 포함하는 받아쓰기입니다.

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

반환

응답 헤더의 사전입니다.

반환 형식

Dict[str, Any]

예제

큐에서 메타데이터를 설정합니다.


   metadata = {'foo': 'val1', 'bar': 'val2', 'baz': 'val3'}
   queue.set_queue_metadata(metadata=metadata)

update_message

메시지의 표시 유형 시간 제한을 업데이트. 또한 이 작업을 사용해서 메시지의 콘텐츠를 업데이트할 수도 있습니다.

이 작업을 사용하여 큐 메시지의 투명도를 지속적으로 확장할 수 있습니다. 이 기능은 작업자 역할이 큐 메시지를 "임대"하려는 경우에 유용할 수 있습니다. 예를 들어 작업자 역할이 을 호출 receive_messages 하고 메시지를 처리하는 데 더 많은 시간이 필요하다는 것을 인식하는 경우 처리될 때까지 메시지의 보이지 않는 기능을 지속적으로 확장할 수 있습니다. 처리 중에 작업자 역할이 실패할 경우에는 결과적으로 메시지가 다시 표시되며, 다른 작업자 역할이 이를 처리할 수 있습니다.

키 암호화 키 필드가 로컬 서비스 개체에 설정된 경우 이 메서드는 업로드하기 전에 콘텐츠를 암호화합니다.

update_message(message: str | QueueMessage, pop_receipt: str | None = None, content: object | None = None, *, visibility_timeout: int | None = None, **kwargs: Any) -> QueueMessage

매개 변수

message
str 또는 QueueMessage
필수

업데이트할 메시지를 식별하는 메시지 개체 또는 ID입니다.

pop_receipt
str
필수

receive_messages 또는 update_message 작업에 대한 이전 호출로부터 반환된 유효한 PopReceipt 값입니다.

content
Optional[object]
필수

메시지 콘텐츠입니다. 허용되는 형식은 서비스에 설정된 encode_function 따라 결정됩니다. 기본값은 str입니다.

visibility_timeout
int

서버 시간을 기준으로 새로운 표시 제한 시간 값(초)을 지정합니다. 새 값은 0 이상이어야 하며 7일을 초과할 수 없습니다. 메시지의 가시성 제한 시간은 만료 시간보다 큰 값으로 설정할 수 없습니다. 메시지는 삭제 또는 만료되기 전까지 업데이트할 수 있습니다. 업데이트할 메시지를 식별하는 메시지 개체 또는 메시지 ID입니다.

timeout
int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

반환

QueueMessage 개체입니다. 편의를 위해 이 개체는 서비스에서 반환되지는 않지만 콘텐츠로 채워집니다.

반환 형식

QueueMessage

예제

메시지를 업데이트합니다.


   # Send a message
   queue.send_message("update me")

   # Receive the message
   messages = queue.receive_messages()

   # Update the message
   list_result = next(messages)
   message = queue.update_message(
       list_result.id,
       pop_receipt=list_result.pop_receipt,
       visibility_timeout=0,
       content="updated")

특성

api_version

요청에 사용되는 Storage API의 버전입니다.

반환 형식

str

location_mode

클라이언트가 현재 사용 중인 위치 모드입니다.

기본적으로 "기본"입니다. 옵션에는 "기본" 및 "보조"가 포함됩니다.

반환 형식

str

primary_endpoint

전체 기본 엔드포인트 URL입니다.

반환 형식

str

primary_hostname

기본 엔드포인트의 호스트 이름입니다.

반환 형식

str

secondary_endpoint

구성된 경우 전체 보조 엔드포인트 URL입니다.

사용할 수 없는 경우 ValueError가 발생합니다. 보조 호스트 이름을 명시적으로 지정하려면 인스턴스화에 선택적 secondary_hostname 키워드(keyword) 인수를 사용합니다.

반환 형식

str

예외

ValueError

secondary_hostname

보조 엔드포인트의 호스트 이름입니다.

사용할 수 없는 경우 없음이 됩니다. 보조 호스트 이름을 명시적으로 지정하려면 인스턴스화에 선택적 secondary_hostname 키워드(keyword) 인수를 사용합니다.

반환 형식

Optional[str]

url

사용되는 경우 SAS 토큰을 포함하여 이 엔터티에 대한 전체 엔드포인트 URL입니다.

이는 기본 엔드포인트이거나 현재 location_mode에 따라 보조 엔드포인트일 수 있습니다. :returns: 사용되는 경우 SAS 토큰을 포함하여 이 엔터티에 대한 전체 엔드포인트 URL입니다. :rtype: str