queue 패키지

패키지

aio

클래스

AccessPolicy

집합에서 사용하는 액세스 정책 클래스 및 액세스 정책 메서드를 가져옵니다.

저장된 액세스 정책은 연관된 공유 액세스 서명에 대한 시작 시간, 만료 시간 및 권한을 지정할 수 있습니다. 리소스에 대한 액세스를 제어하는 방법에 따라 저장된 액세스 정책 내에서 이러한 매개 변수를 모두 지정하고 공유 액세스 서명의 URL에서 생략할 수 있습니다. 언제든지 연결된 서명의 동작을 수정하고 서명을 해제할 수 있습니다. 또는 저장된 액세스 정책 내에서 하나 이상의 액세스 정책 매개 변수를 지정하고 URL에 나머지를 지정할 수 있습니다. 마지막으로 URL에 모든 매개 변수를 지정할 수 있습니다. 이 경우 저장된 액세스 정책을 사용하여 서명을 취소할 수 있지만 해당 동작을 수정할 수는 없습니다.

공유 액세스 서명과 저장된 액세스 정책 모두 서명을 인증하는 데 필요한 모든 필드를 포함해야 합니다. 필수 필드가 하나라도 누락될 경우 요청에 실패합니다. 마찬가지로 필드가 공유 액세스 서명 URL 및 저장된 액세스 정책에서 모두 지정될 경우 요청은 상태 코드 400(잘못된 요청)의 오류가 발생합니다.

AccountSasPermissions

ResourceTypes generate_account_sas 함수 및 set_*_acl 사용되는 AccessPolicies에 사용할 클래스입니다. 리소스 액세스 권한을 부여하는 데 사용할 수 있는 두 가지 유형의 SAS가 있습니다. 하나는 특정 리소스(리소스별)에 대한 액세스 권한을 부여하는 것입니다. 또 다른 방법은 특정 계정에 대한 전체 서비스에 대한 액세스 권한을 부여하고 여기에 있는 퍼마에 따라 특정 작업을 허용하는 것입니다.

BinaryBase64DecodePolicy

기본 64로 인코딩된 메시지를 바이트로 디코딩하는 메시지 디코딩 정책입니다.

base64로 인코딩된 메시지를 바이트로 디코딩합니다. 입력 콘텐츠가 유효한 base 64가 아닌 경우 DecodeError가 발생합니다.

BinaryBase64EncodePolicy

이진 메시지에 대한 기본 64 메시지 인코딩 정책입니다.

이진 메시지를 base 64로 인코딩합니다. 입력 내용이 바이트가 아닌 경우 TypeError가 발생합니다.

CorsRule

CORS는 특정 도메인에서 실행되는 웹 애플리케이션이 다른 도메인의 자원에 액세스할 수 있도록 하는 HTTP 기능입니다. 웹 브라우저는 웹 페이지에서 다른 도메인의 API를 호출하는 것을 방지하는 동일 원본 정책이라는 보안 제한을 구현합니다. CORS는 한 도메인(원본 도메인)에서 다른 도메인의 API를 호출할 수 있도록 하는 안전한 방법을 제공합니다.

Azure로 보내려면 모든 필수 매개 변수를 채워야 합니다.

ExponentialRetry

지수 재시도.

지수 재시도 개체를 생성합니다. initial_backoff 첫 번째 재시도에 사용됩니다. 후속 재시도는 initial_backoff + increment_power^retry_count 초 후에 다시 시도됩니다.

LinearRetry

선형 재시도.

선형 재시도 개체를 생성합니다.

LocationMode

요청을 보내야 하는 위치를 지정합니다. 이 모드는 보조 읽기 액세스를 허용하는 RA-GRS 계정에만 적용됩니다. 다른 모든 계정 유형은 PRIMARY를 사용해야 합니다.

Metrics

API별로 시간 또는 분 집계로 그룹화된 요청 통계의 요약입니다.

Azure로 보내려면 모든 필수 매개 변수를 채워야 합니다.

QueueAnalyticsLogging

Azure Analytics 로깅 설정.

Azure로 보내려면 모든 필수 매개 변수를 채워야 합니다.

QueueClient

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

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

QueueMessage

큐 메시지를 나타냅니다.

QueueProperties

큐 속성입니다.

QueueSasPermissions

함수 및 와 함께 generate_queue_sas 사용되는 AccessPolicies에 사용할 set_queue_access_policyQueueSasPermissions 클래스입니다.

QueueServiceClient

계정 수준에서 큐 서비스와 상호 작용할 클라이언트입니다.

이 클라이언트는 계정 속성뿐만 아니라 계정 내에서 큐를 검색 및 구성하고 큐를 만들고 삭제하는 작업을 제공합니다. 특정 큐와 관련된 작업의 경우 함수를 사용하여 이 엔터티에 대한 클라이언트를 get_queue_client 검색할 수 있습니다.

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

ResourceTypes

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

RetentionPolicy

연결된 데이터를 유지할 기간을 결정하는 보존 정책입니다.

Azure로 보내려면 모든 필수 매개 변수를 채워야 합니다.

TextBase64DecodePolicy

기본 64로 인코딩된 메시지를 텍스트로 디코딩하는 메시지 디코딩 정책입니다.

base64로 인코딩된 메시지를 텍스트(유니코드)로 디코딩합니다. 입력 콘텐츠가 유효한 base 64가 아닌 경우 DecodeError가 발생합니다. 메시지 데이터는 UTF-8을 지원해야 합니다.

TextBase64EncodePolicy

문자 메시지에 대한 기본 64 메시지 인코딩 정책입니다.

텍스트(유니코드) 메시지를 base 64로 인코딩합니다. 입력 내용이 텍스트가 아니면 TypeError가 발생합니다. 입력 텍스트는 UTF-8을 지원해야 합니다.

열거형

StorageErrorCode

함수

generate_account_sas

큐 서비스에 대한 공유 액세스 서명을 생성합니다.

반환된 서명을 모든 Queue Service의 자격 증명 매개 변수와 함께 사용합니다.

generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str, start: datetime | str | None = None, ip: str | None = None, **kwargs: Any) -> str

매개 변수

account_name
str
필수

공유 액세스 서명을 생성하는 데 사용되는 스토리지 계정 이름입니다.

account_key
str
필수

공유 액세스 서명을 생성하기 위해 공유 키 또는 액세스 키라고도 하는 계정 키입니다.

resource_types
ResourceTypes
필수

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

permission
AccountSasPermissions 또는 str
필수

공유 액세스 서명과 연결된 권한입니다. 사용자는 이러한 권한으로 허용된 작업만 수행할 수 있도록 제한됩니다.

expiry
datetime 또는 str
필수

공유 액세스 서명이 유효하지 않은 시간입니다. 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

요청이 허용되는 프로토콜을 지정합니다. 기본값은 https입니다.

반환

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

반환 형식

str

generate_queue_sas

큐에 대한 공유 액세스 서명을 생성합니다.

반환된 서명을 모든 Queue Service의 자격 증명 매개 변수와 함께 사용합니다.

generate_queue_sas(account_name: str, queue_name: str, account_key: str, permission: QueueSasPermissions | str | None = None, expiry: datetime | str | None = None, start: datetime | str | None = None, policy_id: str | None = None, ip: str | None = None, **kwargs: Any) -> str

매개 변수

account_name
str
필수

공유 액세스 서명을 생성하는 데 사용되는 스토리지 계정 이름입니다.

queue_name
str
필수

큐의 이름입니다.

account_key
str
필수

공유 액세스 서명을 생성하기 위해 공유 키 또는 액세스 키라고도 하는 계정 키입니다.

permission
QueueSasPermissions 또는 str
기본값: None

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

expiry
datetime 또는 str
기본값: None

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

start
datetime 또는 str
기본값: None

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

policy_id
str
기본값: None

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

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

요청이 허용되는 프로토콜을 지정합니다. 기본값은 https입니다.

반환

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

반환 형식

str

예제

sas 토큰을 생성합니다.


   from azure.storage.queue import generate_queue_sas
   sas_token = generate_queue_sas(
       queue.account_name,
       queue.queue_name,
       queue.credential.account_key,
       policy_id='my-access-policy-id'
   )