@azure/storage-queue package

클래스

AccountSASPermissions	NODE.JS 런타임에서만 사용할 수 있습니다. AccountSAS에서 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString으로 직렬화되고 AccountSASSignatureValues 개체의 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한의 순서는 특정하며 이 클래스는 정확성을 보장합니다.
AccountSASResourceTypes	NODE.JS 런타임에서만 사용할 수 있습니다. AccountSAS에서 액세스할 수 있는 리소스를 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 리소스 종류에 대한 액세스 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 직렬화되고 AccountSASSignatureValues 개체의 리소스 필드로 설정되어야 합니다. 이 클래스 없이 리소스 문자열을 생성할 수 있지만 리소스의 순서는 특정하며 이 클래스는 정확성을 보장합니다.
AccountSASServices	NODE.JS 런타임에서만 사용할 수 있습니다. AccountSAS에서 액세스할 수 있는 서비스를 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 서비스에 대한 액세스 권한을 부여합니다. 모든 값이 설정되면 toString으로 직렬화되고 AccountSASSignatureValues 개체의 서비스 필드로 설정되어야 합니다. 이 클래스 없이 서비스 문자열을 생성할 수 있지만 서비스의 순서는 특정하며 이 클래스는 정확성을 보장합니다.
AnonymousCredential	AnonymousCredential은 AnonymousCredentialPolicy 개체를 만드는 데 사용되는 credentialPolicyCreator 멤버를 제공합니다. AnonymousCredentialPolicy는 공용 리소스를 읽거나 SAS(공유 액세스 서명)와 함께 사용하기 위해 HTTP(S) 요청에 사용됩니다.
AnonymousCredentialPolicy	AnonymousCredentialPolicy는 공용 리소스를 읽거나 SAS(공유 액세스 서명)와 함께 사용하기 위해 HTTP(S) 요청에 사용됩니다.
BaseRequestPolicy	모든 요청 정책이 파생되는 기본 클래스입니다.
Credential	자격 증명은 Azure Storage HTTP 요청 서명에 대한 추상 클래스입니다. 이 클래스는 CredentialPolicy를 생성하는 credentialPolicyCreator 팩터리를 호스트합니다.
CredentialPolicy	보내기 전에 HTTP(S) 요청에 서명하는 데 사용되는 자격 증명 정책입니다. 이 클래스는 추상 클래스입니다.
Pipeline	HTTP 요청 정책을 포함하는 Pipeline 클래스입니다. newPipeline을 호출하여 기본 파이프라인을 만들 수 있습니다. 또는 Pipeline 생성자가 고유한 정책을 사용하여 파이프라인을 만들 수 있습니다. 사용자 지정된 파이프라인을 구현하기 전에 newPipeline 및 제공된 정책을 참조하세요.
QueueClient	QueueClient는 해당 메시지를 조작할 수 있는 Azure Storage 큐의 메시지에 대한 URL을 나타냅니다.
QueueSASPermissions	NODE.JS 런타임에서만 사용할 수 있습니다. ServiceSAS가 큐에 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 직렬화되고 QueueSASSignatureValues 개체의 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한의 순서는 특정하며 이 클래스는 정확성을 보장합니다.
QueueServiceClient	QueueServiceClient는 큐를 조작할 수 있는 Azure Storage 큐 서비스에 대한 URL을 나타냅니다.
RestError	실패한 파이프라인 요청에 대한 사용자 지정 오류 유형입니다.
SASQueryParameters	Azure Storage SAS의 쿼리 매개 변수를 구성하는 구성 요소를 나타냅니다. 이 형식은 사용자가 직접 생성하지 않습니다. AccountSASSignatureValues 및 QueueSASSignatureValues 형식에서만 생성됩니다. 생성되면 로 인코딩하고 URL에 toString() 직접 추가할 수 있습니다(기존 쿼리 매개 변수가 있는 경우 이러한 쿼리 매개 변수를 추가하는 적절한 수단에 영향을 줄 수 있는 경우 주의해야 합니다). 참고: 이 클래스의 인스턴스는 변경할 수 없습니다.
StorageBrowserPolicy	StorageBrowserPolicy는 다음을 포함하여 Node.js 브라우저 런타임 간의 차이를 처리합니다. 브라우저는 'IF_MODIFIED_SINCE'과 같은 조건부 헤더를 추가하여 GET/HEAD 요청을 캐시합니다. StorageBrowserPolicy는 GET/HEAD 요청 URL에 타임스탬프 쿼리를 추가하여 브라우저 캐시를 방지하는 데 사용되는 정책입니다. 보안을 위해 쿠키 헤더 제거 콘텐츠 길이 헤더를 제거하여 브라우저 경고 방지
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory는 StorageBrowserPolicy 개체를 생성하는 데 도움이 되는 팩터리 클래스입니다.
StorageRetryPolicy	지수 재시도 및 선형 재시도를 구현하여 정책을 다시 시도합니다.
StorageRetryPolicyFactory	StorageRetryPolicyFactory는 StorageRetryPolicy 개체를 생성하는 데 도움이 되는 팩터리 클래스입니다.
StorageSharedKeyCredential	NODE.JS 런타임에서만 사용할 수 있습니다. Azure Storage 서비스의 계정 키 권한 부여를 위한 StorageSharedKeyCredential입니다.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy는 공유 키를 사용하여 HTTP 요청에 서명하는 데 사용되는 정책입니다.

인터페이스

AccessPolicy	액세스 정책
AccountSASSignatureValues	NODE.JS 런타임에서만 사용할 수 있습니다. AccountSASSignatureValues는 Azure Storage 계정에 대한 SAS(공유 액세스 서명)를 생성하는 데 사용됩니다. 여기에 있는 모든 값이 적절하게 설정되면 generateSASQueryParameters()를 호출하여 실제로 큐 URL에 적용할 수 있는 SAS의 표현을 가져옵니다. 참고: 이 클래스와 SASQueryParameters 는 모두 존재합니다. 전자는 변경 가능하고 논리적 표현이지만 후자는 변경할 수 없으며 실제 REST 요청을 생성하는 데 사용되므로 존재합니다. SAS에 대한 자세한 개념 정보는 필수 매개 변수를 포함하여 매개 변수에 대한 설명을 참조하세요 https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas .
CommonOptions	모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.
CorsRule	CORS는 특정 도메인에서 실행되는 웹 애플리케이션이 다른 도메인의 자원에 액세스할 수 있도록 하는 HTTP 기능입니다. 웹 브라우저는 웹 페이지가 다른 도메인에서 API를 호출하지 못하도록 하는 동일한 원본 정책이라고 하는 보안 제한을 구현합니다. CORS는 한 도메인(원본 도메인)이 다른 도메인에서 API를 호출하도록 허용하는 안전한 방법을 제공합니다.
DequeuedMessageItem	큐에서 메시지 가져오기를 호출할 때 QueueMessageList 배열에 반환된 개체입니다.
EnqueuedMessage	큐에 메시지 배치를 호출할 때 QueueMessageList 배열에 반환된 개체입니다.
GeoReplication	보조 스토리지 서비스에 대한 Geo-Replication 정보
HttpHeaders	HTTP 헤더 키/값 쌍의 컬렉션입니다.
HttpOperationResponse	core-v1(core-http)과 호환되는 Http 응답입니다.
HttpResponse	시작된 요청에 대한 참조를 포함하는 HTTP 응답의 표현입니다.
IHttpClient	core-http 요청 정책에 대한 호환되는 인터페이스
ListQueuesSegmentResponse	큐 서비스에서 목록 큐를 호출할 때 반환되는 개체입니다.
Logging	Azure Analytics 로깅 설정.
MessageIdDeleteHeaders	MessageId_delete 작업에 대한 헤더를 정의합니다.
MessageIdUpdateHeaders	MessageId_update 작업에 대한 헤더를 정의합니다.
MessagesClearHeaders	Messages_clear 작업에 대한 헤더를 정의합니다.
MessagesDequeueHeaders	Messages_dequeue 작업에 대한 헤더를 정의합니다.
MessagesDequeueOptionalParams	선택적 매개 변수입니다.
MessagesEnqueueHeaders	Messages_enqueue 작업에 대한 헤더를 정의합니다.
MessagesEnqueueOptionalParams	선택적 매개 변수입니다.
MessagesPeekHeaders	Messages_peek 작업에 대한 헤더를 정의합니다.
MessagesPeekOptionalParams	선택적 매개 변수입니다.
Metadata	키-값 문자열 쌍의 컬렉션입니다.
Metrics	메트릭을 나타내는 인터페이스입니다.
PeekedMessageItem	큐에서 메시지 피킹을 호출할 때 QueueMessageList 배열에 반환된 개체입니다.
PipelineLike	HTTP 요청 정책을 포함하는 Pipeline 클래스에 대한 인터페이스입니다. newPipeline을 호출하여 기본 파이프라인을 만들 수 있습니다. 또는 Pipeline 생성자가 고유한 정책을 사용하여 파이프라인을 만들 수 있습니다. 사용자 지정된 파이프라인을 구현하기 전에 newPipeline 및 제공된 정책을 참조하세요.
PipelineOptions	파이프라인 생성자에 대한 옵션 인터페이스입니다.
QueueClearMessagesOptions	clearMessages 작업을 구성하는 옵션
QueueCreateHeaders	Queue_create 작업에 대한 헤더를 정의합니다.
QueueCreateIfNotExistsResponse	createIfNotExists 작업에 대한 응답 데이터를 포함합니다.
QueueCreateOptions	만들기 작업을 구성하는 옵션
QueueDeleteHeaders	Queue_delete 작업에 대한 헤더를 정의합니다.
QueueDeleteIfExistsResponse	deleteIfExists 작업에 대한 응답 데이터를 포함합니다.
QueueDeleteMessageOptions	deleteMessage 작업을 구성하는 옵션
QueueDeleteOptions	삭제 작업을 구성하는 옵션
QueueExistsOptions	기존 작업을 구성하는 옵션
QueueGenerateSasUrlOptions	generateSasUrl 작업을 구성하는 옵션입니다.
QueueGetAccessPolicyHeaders	Queue_getAccessPolicy 작업에 대한 헤더를 정의합니다.
QueueGetAccessPolicyOptions	getAccessPolicy 작업을 구성하는 옵션
QueueGetPropertiesHeaders	Queue_getProperties 작업에 대한 헤더를 정의합니다.
QueueGetPropertiesOptions	getProperties 작업을 구성하는 옵션
QueueItem	Azure Storage 큐.
QueuePeekMessagesOptions	peekMessages 작업을 구성하는 옵션
QueueReceiveMessageOptions	receiveMessages 작업을 구성하는 옵션
QueueSASSignatureValues	NODE.JS 런타임에서만 사용할 수 있습니다. QueueSASSignatureValues는 큐에 대한 큐 서비스 SAS 토큰을 생성하는 데 사용됩니다.
QueueSendMessageOptions	sendMessage 작업을 구성하는 옵션
QueueServiceProperties	스토리지 서비스 속성입니다.
QueueServiceStatistics	스토리지 서비스에 대한 통계입니다.
QueueSetAccessPolicyHeaders	Queue_setAccessPolicy 작업에 대한 헤더를 정의합니다.
QueueSetAccessPolicyOptions	setAccessPolicy 작업을 구성하는 옵션
QueueSetMetadataHeaders	Queue_setMetadata 작업에 대한 헤더를 정의합니다.
QueueSetMetadataOptions	setMetadata 작업을 구성하는 옵션
QueueUpdateMessageOptions	updateMessage 작업을 구성하는 옵션
RequestPolicyFactory	core-http의 RequestPolicyFactory와의 호환성을 위한 인터페이스
RequestPolicyOptions	RequestPolicy와의 호환성을 위한 인터페이스
ResponseLike	간단한 _response 속성이 있는 개체입니다.
ResponseWithBody	본문과 헤더가 이미 알려진 형식으로 구문 분석된 _response 속성이 있는 개체입니다.
ResponseWithHeaders	헤더가 이미 형식화된 개체로 구문 분석된 _response 속성이 있는 개체입니다.
RetentionPolicy	보존 정책
SasIPRange	SAS에 허용되는 IP 범위입니다.
ServiceClientOptions	ServiceClientOptions의 @azure/core-http 하위 집합
ServiceGenerateAccountSasUrlOptions	generateAccountSasUrl 작업을 구성하는 옵션입니다.
ServiceGetPropertiesHeaders	Service_getProperties 작업에 대한 헤더를 정의합니다.
ServiceGetPropertiesOptions	getProperties 작업을 구성하는 옵션
ServiceGetStatisticsHeaders	Service_getStatistics 작업에 대한 헤더를 정의합니다.
ServiceGetStatisticsOptions	getStatistics 작업을 구성하는 옵션
ServiceListQueuesOptions	listQueues 작업을 구성하는 옵션
ServiceListQueuesSegmentHeaders	Service_listQueuesSegment 작업에 대한 헤더를 정의합니다.
ServiceSetPropertiesHeaders	Service_setProperties 작업에 대한 헤더를 정의합니다.
ServiceSetPropertiesOptions	setProperties 작업을 구성하는 옵션
SignedIdentifier	서명된 식별자입니다.
SignedIdentifierModel	서명된 식별자
StoragePipelineOptions	newPipeline 함수에 대한 옵션 인터페이스입니다.
StorageRetryOptions	Storage Blob 다시 시도 옵션 인터페이스.
WebResource	원격 서버에 대한 HTTP 요청에 대한 설명입니다.

형식 별칭

CredentialPolicyCreator	제공된 nextPolicy를 사용하는 새 CredentialPolicy를 만드는 팩터리 함수입니다.
GeoReplicationStatusType	GeoReplicationStatusType에 대한 값을 정의합니다.
HttpRequestBody	요청에서 지원되는 본문 유형입니다. NodeJS.ReadableStream 및 () => NodeJS.ReadableStream은 노드 전용입니다. Blob, ReadableStream 및 () => ReadableStream은 브라우저 전용입니다.
ListQueuesIncludeType	ListQueuesIncludeType에 대한 값을 정의합니다. 가능한 값은 '메타데이터'입니다.
MessageIdDeleteResponse	삭제 작업에 대한 응답 데이터를 포함합니다.
MessageIdUpdateResponse	업데이트 작업에 대한 응답 데이터를 포함합니다.
MessagesClearResponse	지우기 작업에 대한 응답 데이터를 포함합니다.
QueueClearMessagesResponse	clearMessages 작업에 대한 응답 데이터를 포함합니다.
QueueCreateResponse	만들기 작업에 대한 응답 데이터를 포함합니다.
QueueDeleteMessageResponse	deleteMessage 작업에 대한 응답 데이터를 포함합니다.
QueueDeleteResponse	삭제 작업에 대한 응답 데이터를 포함합니다.
QueueGetAccessPolicyResponse	getAccessPolicy 작업에 대한 응답 데이터를 포함합니다.
QueueGetPropertiesResponse	getProperties 작업에 대한 응답 데이터를 포함합니다.
QueuePeekMessagesResponse	peekMessages 작업에 대한 응답 데이터를 포함합니다.
QueueReceiveMessageResponse	receiveMessages 작업에 대한 응답 데이터를 포함합니다.
QueueSendMessageResponse	sendMessage 작업에 대한 응답 데이터를 포함합니다.
QueueSetAccessPolicyResponse	setAccessPolicy 작업에 대한 응답 데이터를 포함합니다.
QueueSetMetadataResponse	setMetadata 작업에 대한 응답 데이터를 포함합니다.
QueueUpdateMessageResponse	updateMessage 작업에 대한 응답 데이터를 포함합니다.
ReceivedMessageItem	receiveMessages를 호출할 receivedMessageItems 때 배열에 반환된 개체입니다. 참조: QueueReceiveMessageResponse
ServiceGetPropertiesResponse	getProperties 작업에 대한 응답 데이터를 포함합니다.
ServiceGetStatisticsResponse	getStatistics 작업에 대한 응답 데이터를 포함합니다.
ServiceListQueuesSegmentResponse	listQueuesSegment 작업에 대한 응답 데이터를 포함합니다.
ServiceSetPropertiesResponse	setProperties 작업에 대한 응답 데이터를 포함합니다.
WithResponse	알려진 _response 속성이 있는 작업 결과를 나타내는 형식입니다.

열거형

SASProtocol	생성된 SAS에 대한 프로토콜입니다.
StorageQueueAudience	Storage에 대해 알려진 클라우드 대상 그룹을 정의합니다.
StorageRetryPolicyType	RetryPolicy 형식입니다.

함수

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	NODE.JS 런타임에서만 사용할 수 있습니다. 실제 REST 요청을 만드는 데 필요한 모든 SAS 쿼리 매개 변수를 포함하는 SASQueryParameters 개체를 생성합니다. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas을 참조하십시오.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)	NODE.JS 런타임에서만 사용할 수 있습니다. SASQueryParameters의 인스턴스를 만듭니다. SAS를 만드는 데 필요한 설정만 허용합니다. 선택적 설정의 경우 권한, startsOn 및 식별자와 같은 해당 속성을 직접 설정하세요. 경고: 식별자가 제공되지 않으면 권한 및 expiresOn이 필요합니다. 이 생성자를 사용하여 초기화한 경우 식별자에 값을 할당하거나 expiresOn & 권한을 수동으로 할당해야 합니다.
getQueueServiceAccountAudience(string)	큐 서비스에 대한 스토리지 계정에 대한 OAuth 대상 그룹을 가져옵니다.
isPipelineLike(unknown)	지정된 인수가 파이프라인 계약을 충족하는지 여부를 결정하는 도우미
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	자격 증명이 제공된 새 Pipeline 개체를 만듭니다.

함수 세부 정보

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

NODE.JS 런타임에서만 사용할 수 있습니다.

실제 REST 요청을 만드는 데 필요한 모든 SAS 쿼리 매개 변수를 포함하는 SASQueryParameters 개체를 생성합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas을 참조하십시오.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

매개 변수

accountSASSignatureValues

AccountSASSignatureValues

계정의 SAS 서명 값

sharedKeyCredential

StorageSharedKeyCredential

공유 키 자격 증명.

반환

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

NODE.JS 런타임에서만 사용할 수 있습니다.

SASQueryParameters의 인스턴스를 만듭니다.

SAS를 만드는 데 필요한 설정만 허용합니다. 선택적 설정의 경우 권한, startsOn 및 식별자와 같은 해당 속성을 직접 설정하세요.

경고: 식별자가 제공되지 않으면 권한 및 expiresOn이 필요합니다. 이 생성자를 사용하여 초기화한 경우 식별자에 값을 할당하거나 expiresOn & 권한을 수동으로 할당해야 합니다.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

매개 변수

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

반환

SASQueryParameters

getQueueServiceAccountAudience(string)

큐 서비스에 대한 스토리지 계정에 대한 OAuth 대상 그룹을 가져옵니다.

function getQueueServiceAccountAudience(storageAccountName: string): string

매개 변수

storageAccountName

string

반환

string

isPipelineLike(unknown)

지정된 인수가 파이프라인 계약을 충족하는지 여부를 결정하는 도우미

function isPipelineLike(pipeline: unknown): pipeline

매개 변수

pipeline

unknown

파이프라인일 수 있는 인수

반환

pipeline

인수가 파이프라인 계약을 충족하는 경우 true입니다.

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

자격 증명이 제공된 새 Pipeline 개체를 만듭니다.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

매개 변수

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential, StorageSharedKeyCredential 또는 패키지의 @azure/identity 자격 증명과 같이 서비스에 대한 요청을 인증합니다. TokenCredential 인터페이스를 구현하는 개체를 제공할 수도 있습니다. 지정하지 않으면 AnonymousCredential이 사용됩니다.

pipelineOptions

StoragePipelineOptions

선택 사항입니다. 옵션입니다.

반환

Pipeline

새 Pipeline 개체입니다.