QueueService 클래스

큐 리소스를 관리하는 기본 클래스입니다.

큐 서비스는 메시지를 저장합니다. 큐에는 무제한의 메시지가 포함될 수 있으며, 각 메시지의 크기는 최대 64KB가 될 수 있습니다. 메시지는 일반적으로 큐 끝에 추가되고 큐의 앞에서 검색되지만 FIFO(선입 선출) 동작이 보장되지는 않습니다.

:type ~azure.storage.common.TokenCredential

상속

StorageClient

QueueService

생성자

QueueService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None, token_credential=None)

매개 변수

account_name

str

기본값: None

스토리지 계정 이름입니다. 계정 키로 서명된 요청을 인증하고 스토리지 엔드포인트를 생성하는 데 사용됩니다. 연결 문자열 지정되지 않는 한 필요합니다.

account_key

str

기본값: None

스토리지 계정 키입니다. 공유 키 인증에 사용됩니다.

sas_token

str

기본값: None

계정 키 대신 요청을 인증하는 데 사용할 공유 액세스 서명 토큰입니다. 계정 키와 sas 토큰이 모두 지정된 경우 계정 키를 사용하여 서명합니다.

is_emulated

bool

기본값: False

에뮬레이터를 사용할지 여부입니다. 기본값은 False입니다. 지정된 경우 는 연결 문자열 및 요청 세션 외에 다른 모든 매개 변수를 재정의합니다.

protocol

str

기본값: https

요청에 사용할 프로토콜입니다. 기본값은 https입니다.

endpoint_suffix

str

기본값: core.windows.net

URL의 호스트 기본 구성 요소에서 계정 이름을 뺀 값입니다. 기본값은 Azure(core.windows.net)입니다. 중국 클라우드(core.chinacloudapi.cn)를 사용하도록 재정의합니다.

request_session

<xref:requests.Session>

기본값: None

http 요청에 사용할 세션 개체입니다.

connection_string

str

기본값: None

지정된 경우 요청 세션 외에 다른 모든 매개 변수를 재정의합니다. 연결 문자열 형식은 를 참조하세요http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/.

socket_timeout

int

기본값: None

지정된 경우 기본 소켓 시간 제한을 재정의합니다. 지정된 시간 제한(초)입니다. 기본값은 _constants.py DEFAULT_SOCKET_TIMEOUT 참조하세요.

token_credential

기본값: None

HTTPS 요청을 인증하는 데 사용되는 토큰 자격 증명입니다. 토큰 값은 만료 전에 업데이트해야 합니다.

변수

encode_function

<xref:function>(<xref:data>)

큐 메시지를 인코딩하는 데 사용되는 함수입니다. put_message API에 전달된 데이터를 매개 변수로 사용하여 인코딩된 메시지를 반환합니다. 기본적으로 텍스트 및 xml 인코딩을 수행하지만 바이트 및 기타 인코딩을 사용할 수 있습니다. 예를 들어 base64는 다양한 언어로 여러 Azure Storage 라이브러리를 개발하는 데 더 적합할 수 있습니다. QueueMessageFormat 에 대한 xml, base64 및 인코딩 메서드 없음 및 이진 해당 메서드를 참조하세요.

decode_function

<xref:function>(<xref:data>)

메시지를 인코딩하는 데 사용되는 함수입니다. get_messages 반환된 데이터를 매개 변수로 사용하고 API를 peek_messages 디코딩된 메시지를 반환합니다. 기본적으로 텍스트 및 xml 디코딩을 반환하지만 바이트 및 기타 디코딩을 사용할 수 있습니다. 예를 들어 base64는 다양한 언어로 여러 Azure Storage 라이브러리를 개발하는 데 더 적합할 수 있습니다. QueueMessageFormat xml, base64 및 디코딩 메서드 없음 및 이진 등가물에 대한 를 참조하세요.

key_encryption_key

object

사용자가 선택적으로 제공하는 키 암호화 키입니다. 제공된 경우 는 지원되는 메서드에서 암호화/암호 해독하는 데 사용됩니다. 암호 해독이 필요한 메서드의 경우 key_encryption_key 또는 확인자를 제공해야 합니다. 둘 다 제공된 경우 해결 프로그램 우선 순위가 적용됩니다. 암호화가 필요한 API에 대해 다음 메서드를 구현해야 합니다. wrap_key(키)–사용자가 선택한 알고리즘을 사용하여 지정된 키(바이트)를 래핑합니다. 암호화된 키를 바이트로 반환합니다. get_key_wrap_algorithm()–지정된 대칭 키를 래핑하는 데 사용되는 알고리즘을 반환합니다. get_kid()–이 key-encryption-key에 대한 문자열 키 ID를 반환합니다. 암호 해독이 필요한 API에 대해 다음 메서드를 구현해야 합니다. unwrap_key(키, 알고리즘)-문자열 지정 알고리즘을 사용하여 지정된 대칭 키의 래핑되지 않은 형식을 반환합니다. get_kid()–이 key-encryption-key에 대한 문자열 키 ID를 반환합니다.

key_resolver_function

kid) (<xref:function>

사용자가 선택적으로 제공하는 키를 resolve 함수입니다. 제공된 경우 는 지원되는 메서드에서 암호를 해독하는 데 사용됩니다. 암호 해독이 필요한 메서드의 경우 key_encryption_key 또는 확인자를 제공해야 합니다. 둘 다 제공된 경우 해결 프로그램 우선 순위가 적용됩니다. 키 문자열을 사용하여 위에서 정의한 인터페이스를 구현하는 키 암호화 키를 반환합니다.

require_encryption

bool

모든 메시지가 큐에 성공적으로 업로드되고 큐에서 다운로드되고 성공적으로 읽은 모든 메시지가 서버에 있는 동안 암호화/암호화되도록 설정할 수 있는 플래그입니다. 이 플래그를 설정하면 암호화/암호 해독에 필요한 모든 매개 변수를 제공해야 합니다. key_encryption_key 및 확인자에서 위의 주석을 참조하세요.

메서드

clear_messages	지정된 큐에서 모든 메시지를 삭제합니다.
create_queue	지정된 계정 아래에 큐를 만듭니다.
delete_message	지정된 메시지를 삭제합니다. 일반적으로 클라이언트가 get_messages 작업으로 메시지를 검색한 후 클라이언트는 메시지를 처리하고 삭제해야 합니다. 메시지를 삭제하려면 id 및 pop_receipt 두 개의 데이터 항목이 있어야 합니다. ID는 이전 get_messages 작업에서 반환됩니다. pop_receipt 가장 최근 get_messages 또는 update_message 작업에서 반환됩니다. delete_message 작업이 성공하려면 요청에 지정된 pop_receipt 또는 update_message 작업에서 get_messages 반환된 pop_receipt 일치해야 합니다.
delete_queue	지정된 큐와 해당 큐에 포함된 모든 메시지를 삭제합니다. 큐가 성공적으로 삭제되면 즉시 삭제로 표시되고 클라이언트가 더 이상 액세스할 수 없습니다. 이 큐는 나중에 가비지 수집 과정에서 큐 서비스에서 제거됩니다. 큐 삭제를 완료하는 데 40초 이상 걸릴 수 있습니다. 삭제되는 동안 큐에 대해 작업을 시도하면 이 <xref:azure.storage.queue.queueservice.AzureConflictHttpError> throw됩니다.
exists	큐가 있는지 여부를 나타내는 부울을 반환합니다.
extract_date_and_request_id
generate_account_shared_access_signature	큐 서비스에 대한 공유 액세스 서명을 생성합니다. 반환된 서명을 QueueService의 sas_token 매개 변수와 함께 사용합니다.
generate_queue_shared_access_signature	큐에 대한 공유 액세스 서명을 생성합니다. 반환된 서명을 QueueService의 sas_token 매개 변수와 함께 사용합니다.
get_messages	큐 앞부분에서 하나 이상의 메시지를 검색합니다. 큐에서 메시지를 검색할 때 응답에는 메시지를 삭제하는 데 필요한 메시지 콘텐츠와 pop_receipt 값이 포함됩니다. 메시지는 큐에서 자동으로 삭제되지 않지만 검색된 후에는 visibility_timeout 매개 변수에 지정된 시간 간격 동안 다른 클라이언트에 표시되지 않습니다. 키-암호화 키 또는 확인자 필드가 로컬 서비스 개체에 설정된 경우 메시지가 반환되기 전에 암호가 해독됩니다.
get_queue_acl	공유 액세스 서명과 함께 사용할 수 있는 큐에 지정된 저장된 액세스 정책에 대한 세부 정보를 반환합니다.
get_queue_metadata	지정된 큐에서 사용자 정의 메타데이터 및 큐 속성을 검색합니다. 메타데이터는 큐에 이름-값 쌍으로 연결됩니다.
get_queue_service_properties	로깅, 분석 및 CORS 규칙을 포함하여 스토리지 계정의 큐 서비스의 속성을 가져옵니다.
get_queue_service_stats	큐 서비스에 대한 복제와 관련된 통계를 검색합니다. 스토리지 계정에 대해 읽기 액세스 지역 중복 복제를 사용하도록 설정한 경우에만 사용할 수 있습니다. 지리적 중복 복제를 사용하여 Azure 저장소는 데이터를 두 위치에서 영구 유지 관리합니다. 두 위치 모두에서 Azure 저장소는 데이터에 대한 여러 정상 복제를 지속적으로 유지 관리합니다. 데이터를 읽거나 만들거나 업데이트하거나 삭제하는 위치는 주 저장소 계정 위치입니다. 기본 위치는 Azure Management Azure 클래식 포털(예: 미국 중북부)을 통해 계정을 만들 때 선택한 지역에 있습니다. 데이터가 복제되는 위치는 보조 위치입니다. 보조 위치는 기본 위치에 따라 자동으로 결정되며, 기본 위치와 동일한 지역에 있는 보조 데이터 센터입니다. 저장소 계정에 대해 읽기 액세스 지리적 중복 복제가 설정되어 있는 경우, 보조 위치에서 읽기 전용 액세스가 가능합니다.
list_queues	큐를 나열하는 생성기를 반환합니다. 생성기는 서비스에서 반환된 연속 토큰을 느리게 따르고 모든 큐가 반환되거나 num_results 도달하면 중지됩니다. num_results 지정되고 계정에 해당 큐 수보다 많은 경우 생성기는 완료되면 채워진 next_marker 필드를 갖게 됩니다. 이 표식은 더 많은 결과가 필요한 경우 새 생성기를 만드는 데 사용할 수 있습니다.
peek_messages	큐 앞부분에서 하나 이상의 메시지를 검색하지만 메시지의 표시 유형을 변경하지는 않습니다. 표시되는 메시지만 검색할 수 있습니다. get_messages 호출을 사용하여 메시지를 처음으로 검색하면 dequeue_count 속성이 1로 설정됩니다. 삭제되지 않고 이후에 다시 검색되면 dequeue_count 속성이 증가합니다. 클라이언트는 이 값을 사용해서 메시지가 검색된 횟수를 확인할 수 있습니다. peek_messages 호출은 DequeueCount 값을 증가시키지 않지만 클라이언트가 읽을 수 있도록 이 값을 반환합니다. 키-암호화 키 또는 확인자 필드가 로컬 서비스 개체에 설정된 경우 메시지가 반환되기 전에 암호가 해독됩니다.
put_message	메시지 큐의 뒷면에 새 메시지를 추가합니다. 표시 유형 시간 제한은 메시지가 표시되지 않는 시간을 지정합니다. 제한 시간이 만료된 뒤에는 메시지가 표시됩니다. 표시 제한 시간을 지정하지 않으면 기본값 0이 사용됩니다. 메시지 TL(Time to Live)은 메시지가 큐에 남아 있는 기간을 지정합니다. 메시지는 TTL(time-to-live) 기간이 만료되었을 때 큐에서 삭제됩니다. 키 암호화 키 필드가 로컬 서비스 개체에 설정된 경우 이 메서드는 업로드하기 전에 콘텐츠를 암호화합니다.
set_proxy	HTTP CONNECT 터널링에 대한 프록시 서버 호스트 및 포트를 설정합니다.
set_queue_acl	공유 액세스 서명에 사용할 수 있는 큐에 대한 저장된 액세스 정책을 설정합니다. 큐에 대한 권한을 설정하면 기존 권한이 바뀝니다. 큐의 권한을 업데이트하려면 를 호출 get_queue_acl 하여 큐와 연결된 모든 액세스 정책을 가져오고, 변경하려는 액세스 정책을 수정한 다음, 전체 데이터 집합으로 이 함수를 호출하여 업데이트를 수행합니다. 큐에서 저장된 액세스 정책을 설정할 경우 적용되는 데 최대 30초까지 걸릴 수 있습니다. 이 간격 동안 저장된 액세스 정책과 연결된 공유 액세스 서명은 액세스 정책이 활성화될 때까지 을 throw <xref:azure.storage.queue.queueservice.AzureHttpError> 합니다.
set_queue_metadata	지정된 큐에서 사용자 정의 메타데이터를 설정합니다. 메타데이터는 큐에 이름-값 쌍으로 연결됩니다.
set_queue_service_properties	Azure 스토리지 분석 포함하여 스토리지 계정의 큐 서비스의 속성을 설정합니다. 요소(예: 로깅)가 None으로 남아 있으면 해당 기능에 대한 서비스의 기존 설정이 유지됩니다. Azure 스토리지 분석 대한 자세한 내용은 를 참조하세요https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx.
update_message	메시지의 표시 유형 시간 제한을 업데이트. 또한 이 작업을 사용해서 메시지의 콘텐츠를 업데이트할 수도 있습니다. 이 작업을 사용하여 큐 메시지의 투명도를 지속적으로 확장할 수 있습니다. 이 기능은 작업자 역할이 큐 메시지를 "임대"하려는 경우에 유용할 수 있습니다. 예를 들어 작업자 역할이 get_messages 호출하고 메시지를 처리하는 데 더 많은 시간이 필요하다는 것을 인식하는 경우 처리될 때까지 메시지의 보이지 않는 기능을 지속적으로 확장할 수 있습니다. 처리 중에 작업자 역할이 실패할 경우에는 결과적으로 메시지가 다시 표시되며, 다른 작업자 역할이 이를 처리할 수 있습니다. 키 암호화 키 필드가 로컬 서비스 개체에 설정된 경우 이 메서드는 업로드하기 전에 콘텐츠를 암호화합니다.

clear_messages

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

clear_messages(queue_name, timeout=None)

매개 변수

queue_name

str

필수

메시지를 지울 큐의 이름입니다.

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

create_queue

지정된 계정 아래에 큐를 만듭니다.

create_queue(queue_name, metadata=None, fail_on_exist=False, timeout=None)

매개 변수

queue_name

str

필수

만들 큐의 이름입니다. 큐 이름은 3~63자여야 하며 소문자, 숫자 및 대시(-) 문자만 포함할 수 있습니다. 큐의 첫 번째 문자와 마지막 문자는 영숫자여야 합니다. 대시(-) 문자가 첫 번째 또는 마지막 문자가 될 수 없습니다. 큐 이름에 연속해서 대시 문자를 사용할 수 없습니다.

metadata

dict(str, str)

기본값: None

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

fail_on_exist

bool

기본값: False

큐가 이미 있는 경우 예외를 throw할지 여부를 지정합니다.

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

반환

큐가 만들어졌는지 여부를 나타내는 부울입니다. fail_on_exist True로 설정된 경우 false를 반환하는 대신 throw됩니다.

반환 형식

bool

delete_message

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

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

delete_message(queue_name, message_id, pop_receipt, timeout=None)

매개 변수

queue_name

str

필수

메시지를 삭제할 큐의 이름입니다.

message_id

str

필수

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

pop_receipt

str

필수

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

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

delete_queue

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

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

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

delete_queue(queue_name, fail_not_exist=False, timeout=None)

매개 변수

queue_name

str

필수

삭제할 큐의 이름입니다.

fail_not_exist

bool

기본값: False

큐가 없는 경우 예외를 throw할지 여부를 지정합니다.

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

반환

큐가 삭제되었는지 여부를 나타내는 부울입니다. fail_not_exist True로 설정된 경우 false를 반환하는 대신 throw됩니다.

반환 형식

bool

exists

큐가 있는지 여부를 나타내는 부울을 반환합니다.

exists(queue_name, timeout=None)

매개 변수

queue_name

str

필수

존재할 검사 큐의 이름입니다.

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

반환

큐가 있는지 여부를 나타내는 부울입니다.

반환 형식

bool

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

매개 변수

retry_context

필수

generate_account_shared_access_signature

큐 서비스에 대한 공유 액세스 서명을 생성합니다. 반환된 서명을 QueueService의 sas_token 매개 변수와 함께 사용합니다.

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

매개 변수

resource_types

<xref:ResourceTypes>

필수

계정 SAS를 사용하여 액세스할 수 있는 리소스 종류를 지정합니다.

permission

<xref:AccountPermissions>

필수

공유 액세스 서명과 연결된 권한입니다. 사용자는 이러한 권한으로 허용된 작업만 수행할 수 있도록 제한됩니다. 이 필드를 포함하는 저장된 액세스 정책을 참조하는 ID가 지정되지 않는 한 필요합니다. 이 필드는 연결된 저장된 액세스 정책에 지정된 경우 생략되어야 합니다.

expiry

datetime 또는 str

필수

공유 액세스 서명이 유효하지 않은 시간입니다. 이 필드를 포함하는 저장된 액세스 정책을 참조하는 ID가 지정되지 않는 한 필요합니다. 이 필드는 연결된 저장된 액세스 정책에 지정된 경우 생략되어야 합니다. Azure는 항상 값을 UTC로 변환합니다. 날짜가 표준 시간대 정보 없이 전달되는 경우 UTC로 간주됩니다.

start

datetime 또는 str

기본값: None

공유 액세스 서명이 유효한 시간입니다. 생략되는 경우 이 호출의 시작 시간은 저장소 서비스가 요청을 받는 시간으로 간주됩니다. Azure는 항상 값을 UTC로 변환합니다. 날짜가 표준 시간대 정보 없이 전달되는 경우 UTC로 간주됩니다.

ip

str

기본값: None

요청을 수락할 IP 주소 또는 IP 주소 범위를 지정합니다. 요청이 시작된 IP 주소가 SAS 토큰에 지정된 IP 주소 또는 주소 범위와 일치하지 않으면 요청이 인증되지 않습니다. 예를 들어 SAS에서 sip=168.1.5.65 또는 sip=168.1.5.60-168.1.5.70을 지정하면 요청이 해당 IP 주소로 제한됩니다.

protocol

str

기본값: None

요청이 허용되는 프로토콜을 지정합니다. 기본값은 https,http입니다. 가능한 값은 Protocol를 참조하십시오.

반환

공유 액세스 서명(sas) 토큰입니다.

반환 형식

str

generate_queue_shared_access_signature

큐에 대한 공유 액세스 서명을 생성합니다. 반환된 서명을 QueueService의 sas_token 매개 변수와 함께 사용합니다.

generate_queue_shared_access_signature(queue_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None)

매개 변수

queue_name

str

필수

SAS 토큰을 만들 큐의 이름입니다.

permission

QueuePermissions

기본값: None

공유 액세스 서명과 연결된 권한입니다. 사용자는 이러한 권한으로 허용된 작업만 수행할 수 있도록 제한됩니다. 이 필드를 포함하는 저장된 액세스 정책을 참조하는 ID가 지정되지 않는 한 필요합니다. 이 필드는 연결된 저장된 액세스 정책에 지정된 경우 생략되어야 합니다.

expiry

datetime 또는 str

기본값: None

공유 액세스 서명이 유효하지 않은 시간입니다. 이 필드를 포함하는 저장된 액세스 정책을 참조하는 ID가 지정되지 않는 한 필요합니다. 이 필드는 연결된 저장된 액세스 정책에 지정된 경우 생략되어야 합니다. Azure는 항상 값을 UTC로 변환합니다. 날짜가 표준 시간대 정보 없이 전달되는 경우 UTC로 간주됩니다.

start

datetime 또는 str

기본값: None

공유 액세스 서명이 유효한 시간입니다. 생략되는 경우 이 호출의 시작 시간은 저장소 서비스가 요청을 받는 시간으로 간주됩니다. Azure는 항상 값을 UTC로 변환합니다. 날짜가 표준 시간대 정보 없이 전달되는 경우 UTC로 간주됩니다.

id

str

기본값: None

저장된 액세스 정책과 상관 관계가 있는 최대 64자 길이의 고유 값입니다. 저장된 액세스 정책을 만들려면 를 사용합니다 set_queue_acl.

ip

str

기본값: None

요청을 수락할 IP 주소 또는 IP 주소 범위를 지정합니다. 요청이 시작된 IP 주소가 SAS 토큰에 지정된 IP 주소 또는 주소 범위와 일치하지 않으면 요청이 인증되지 않습니다. 예를 들어 SAS에서 sip='168.1.5.65' 또는 sip='168.1.5.60-168.1.5.70'을 지정하면 요청이 해당 IP 주소로 제한됩니다.

protocol

str

기본값: None

요청이 허용되는 프로토콜을 지정합니다. 기본값은 https,http입니다. 가능한 값은 Protocol를 참조하십시오.

반환

공유 액세스 서명(sas) 토큰입니다.

반환 형식

str

get_messages

큐 앞부분에서 하나 이상의 메시지를 검색합니다.

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

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

get_messages(queue_name, num_messages=None, visibility_timeout=None, timeout=None)

매개 변수

queue_name

str

필수

메시지를 가져올 큐의 이름입니다.

num_messages

int

기본값: None

최대 32까지 큐에서 검색할 메시지 수를 지정하는 0이 아닌 정수 값입니다. 표시 가능한 수가 더 적으면 해당 표시 가능한 메시지가 반환됩니다. 기본적으로 이 작업으로는 메시지에서 단일 메시지가 검색됩니다.

visibility_timeout

int

기본값: None

서버 시간을 기준으로 새로운 표시 제한 시간 값(초)을 지정합니다. 새 값은 1초보다 크거나 같아야 하며 7일보다 클 수 없습니다. 메시지의 표시 제한 시간은 만료 시간보다 큰 값으로 설정할 수 있습니다.

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

반환

QueueMessage 전달된 정보를 나타내는 개체입니다.

반환 형식

list(QueueMessage)

get_queue_acl

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

get_queue_acl(queue_name, timeout=None)

매개 변수

queue_name

str

필수

기존 큐의 이름입니다.

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

반환

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

반환 형식

dict(str, AccessPolicy)

get_queue_metadata

지정된 큐에서 사용자 정의 메타데이터 및 큐 속성을 검색합니다. 메타데이터는 큐에 이름-값 쌍으로 연결됩니다.

get_queue_metadata(queue_name, timeout=None)

매개 변수

queue_name

str

필수

기존 큐의 이름입니다.

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

반환

큐의 메시지 수를 예측하는 dict의 approximate_message_count int 속성이 있는 큐 메타데이터를 나타내는 사전입니다.

반환 형식

dict(str, str)

get_queue_service_properties

로깅, 분석 및 CORS 규칙을 포함하여 스토리지 계정의 큐 서비스의 속성을 가져옵니다.

get_queue_service_properties(timeout=None)

매개 변수

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

반환

큐 서비스 속성입니다.

반환 형식

ServiceProperties

get_queue_service_stats

큐 서비스에 대한 복제와 관련된 통계를 검색합니다. 스토리지 계정에 대해 읽기 액세스 지역 중복 복제를 사용하도록 설정한 경우에만 사용할 수 있습니다.

지리적 중복 복제를 사용하여 Azure 저장소는 데이터를 두 위치에서 영구 유지 관리합니다. 두 위치 모두에서 Azure 저장소는 데이터에 대한 여러 정상 복제를 지속적으로 유지 관리합니다. 데이터를 읽거나 만들거나 업데이트하거나 삭제하는 위치는 주 저장소 계정 위치입니다. 기본 위치는 Azure Management Azure 클래식 포털(예: 미국 중북부)을 통해 계정을 만들 때 선택한 지역에 있습니다. 데이터가 복제되는 위치는 보조 위치입니다. 보조 위치는 기본 위치에 따라 자동으로 결정되며, 기본 위치와 동일한 지역에 있는 보조 데이터 센터입니다. 저장소 계정에 대해 읽기 액세스 지리적 중복 복제가 설정되어 있는 경우, 보조 위치에서 읽기 전용 액세스가 가능합니다.

get_queue_service_stats(timeout=None)

매개 변수

timeout

int

기본값: None

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

반환

큐 서비스 통계입니다.

반환 형식

ServiceStats

list_queues

큐를 나열하는 생성기를 반환합니다. 생성기는 서비스에서 반환된 연속 토큰을 느리게 따르고 모든 큐가 반환되거나 num_results 도달하면 중지됩니다.

num_results 지정되고 계정에 해당 큐 수보다 많은 경우 생성기는 완료되면 채워진 next_marker 필드를 갖게 됩니다. 이 표식은 더 많은 결과가 필요한 경우 새 생성기를 만드는 데 사용할 수 있습니다.

list_queues(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)

매개 변수

prefix

str

기본값: None

이름이 지정된 접두사로 시작하는 큐만 반환하도록 결과를 필터링합니다.

num_results

int

기본값: None

반환할 최대 큐 수입니다.

include_metadata

bool

기본값: False

컨테이너 메타데이터가 응답에 반환되도록 지정합니다.

marker

str

기본값: None

불투명 연속 토큰입니다. 이 값은 num_results 지정되고 생성기가 결과 열거를 완료한 경우 이전 생성기 개체의 next_marker 필드에서 검색할 수 있습니다. 지정된 경우 이 생성기는 이전 생성기가 중지된 지점에서 결과를 반환하기 시작합니다.

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다. 이 함수는 서비스에 대해 여러 번 호출할 수 있습니다. 이 경우 지정된 시간 제한 값이 각 개별 호출에 적용됩니다.

peek_messages

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

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

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

peek_messages(queue_name, num_messages=None, timeout=None)

매개 변수

queue_name

str

필수

메시지를 피킹할 큐의 이름입니다.

num_messages

int

기본값: None

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

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

반환

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

반환 형식

list(QueueMessage)

put_message

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

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

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

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

put_message(queue_name, content, visibility_timeout=None, time_to_live=None, timeout=None)

매개 변수

queue_name

str

필수

메시지를 넣을 큐의 이름입니다.

content

<xref:obj>

필수

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

visibility_timeout

int

기본값: None

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

time_to_live

int

기본값: None

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

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

반환

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

반환 형식

QueueMessage

set_proxy

HTTP CONNECT 터널링에 대한 프록시 서버 호스트 및 포트를 설정합니다.

set_proxy(host, port, user=None, password=None)

매개 변수

host

str

필수

프록시의 주소입니다. 예: '192.168.0.100'

port

int

필수

프록시의 포트입니다. 예: 6000

user

str

기본값: None

프록시 권한 부여를 위한 사용자입니다.

password

str

기본값: None

프록시 권한 부여에 대한 암호입니다.

set_queue_acl

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

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

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

set_queue_acl(queue_name, signed_identifiers=None, timeout=None)

매개 변수

queue_name

str

필수

기존 큐의 이름입니다.

signed_identifiers

dict(str, AccessPolicy)

기본값: None

큐와 연결할 액세스 정책 사전입니다. 사전에는 최대 5개의 요소가 포함될 수 있습니다. 빈 사전은 서비스에 설정된 액세스 정책을 지웁히게 됩니다.

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

set_queue_metadata

지정된 큐에서 사용자 정의 메타데이터를 설정합니다. 메타데이터는 큐에 이름-값 쌍으로 연결됩니다.

set_queue_metadata(queue_name, metadata=None, timeout=None)

매개 변수

queue_name

str

필수

기존 큐의 이름입니다.

metadata

dict

기본값: None

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

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

set_queue_service_properties

Azure 스토리지 분석 포함하여 스토리지 계정의 큐 서비스의 속성을 설정합니다. 요소(예: 로깅)가 None으로 남아 있으면 해당 기능에 대한 서비스의 기존 설정이 유지됩니다. Azure 스토리지 분석 대한 자세한 내용은 를 참조하세요https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx.

set_queue_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

매개 변수

logging

<xref:Logging>

기본값: None

로깅 설정은 요청 로그를 제공합니다.

hour_metrics

<xref:Metrics>

기본값: None

시간 메트릭 설정은 큐에 대한 시간별 집계에서 API별로 그룹화된 요청 통계의 요약을 제공합니다.

minute_metrics

<xref:Metrics>

기본값: None

분 메트릭 설정은 큐에 대한 각 분에 대한 요청 통계를 제공합니다.

cors

list(CorsRule)

기본값: None

목록에 최대 5개의 CorsRule 요소를 포함할 수 있습니다. 빈 목록을 지정하면 모든 CORS 규칙이 삭제되고 서비스에 대해 CORS가 비활성화됩니다. CORS 규칙 및 평가 논리에 대한 자세한 내용은 https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx을 참조하십시오.

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

update_message

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

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

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

update_message(queue_name, message_id, pop_receipt, visibility_timeout, content=None, timeout=None)

매개 변수

queue_name

str

필수

업데이트할 메시지를 포함하는 큐의 이름입니다.

message_id

str

필수

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

pop_receipt

str

필수

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

visibility_timeout

int

필수

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

content

<xref:obj>

기본값: None

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

timeout

int

기본값: None

초 단위로 표현된 서버 시간 제한입니다.

반환

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

반환 형식

list(QueueMessage)

특성

protocol

request_session

socket_timeout