다음을 통해 공유


QueueReceiveMessageOptions interface

<xref:QueueClient.receiveMessages> 작업을 구성하는 옵션

Extends

속성

abortSignal

요청을 중단하는 데 사용할 수 있는 신호입니다.

customHeaders

는 요청을 보내기 전에 적용됩니다.

numberOfMessages

선택적. 큐에서 검색할 메시지 수를 최대 32개까지 지정하는 0이 아닌 정수 값입니다. 표시되는 메시지가 적으면 표시되는 메시지가 반환됩니다. 기본적으로 이 작업을 사용하여 큐에서 단일 메시지를 검색합니다.

onDownloadProgress

다운로드 진행 시 발생하는 콜백입니다.

onUploadProgress

업로드 진행률에 따라 발생하는 콜백입니다.

requestId

스토리지 분석 로깅을 사용하도록 설정할 때 분석 로그에 기록되는 1KB 문자 제한으로 클라이언트에서 생성된 불투명 값을 제공합니다.

serializerOptions

XML 구문 분석/빌드 동작을 재정의하는 옵션입니다.

shouldDeserialize

HttpOperationResponse를 역직렬화해야 하는지 여부입니다. 정의되지 않은 경우 HttpOperationResponse를 역직렬화해야 합니다.

timeout

요청이 자동으로 종료되기 전에 걸릴 수 있는 시간(밀리초)입니다. 요청이 종료되면 AbortError throw됩니다.

timeoutInSeconds

시간 제한 매개 변수는 초 단위로 표시됩니다. 자세한 내용은 큐 서비스 작업에 대한 시간 제한 설정 참조하세요.

tracingContext

추적: 범위를 만들 때 사용되는 컨텍스트입니다.

tracingOptions

추적을 사용할 때 생성되는 범위를 구성하는 옵션입니다.

visibilityTimeout

선택적. 서버 시간을 기준으로 새 표시 시간 제한 값(초)을 지정합니다. 기본값은 30초입니다. 지정된 값은 1초보다 크거나 같아야 하며, 버전 2011-08-18 이전의 REST 프로토콜 버전에서 7일보다 크거나 2시간 이상일 수 없습니다. 메시지의 표시 시간 제한은 만료 시간보다 나중에 값으로 설정할 수 있습니다.

속성 세부 정보

abortSignal

요청을 중단하는 데 사용할 수 있는 신호입니다.

abortSignal?: AbortSignalLike

속성 값

AbortSignalLike

customHeaders

는 요청을 보내기 전에 적용됩니다.

customHeaders?: [key: string]: string

속성 값

[key: string]: string

numberOfMessages

선택적. 큐에서 검색할 메시지 수를 최대 32개까지 지정하는 0이 아닌 정수 값입니다. 표시되는 메시지가 적으면 표시되는 메시지가 반환됩니다. 기본적으로 이 작업을 사용하여 큐에서 단일 메시지를 검색합니다.

numberOfMessages?: number

속성 값

number

onDownloadProgress

다운로드 진행 시 발생하는 콜백입니다.

onDownloadProgress?: (progress: TransferProgressEvent) => void

속성 값

(progress: TransferProgressEvent) => void

onUploadProgress

업로드 진행률에 따라 발생하는 콜백입니다.

onUploadProgress?: (progress: TransferProgressEvent) => void

속성 값

(progress: TransferProgressEvent) => void

requestId

스토리지 분석 로깅을 사용하도록 설정할 때 분석 로그에 기록되는 1KB 문자 제한으로 클라이언트에서 생성된 불투명 값을 제공합니다.

requestId?: string

속성 값

string

serializerOptions

XML 구문 분석/빌드 동작을 재정의하는 옵션입니다.

serializerOptions?: SerializerOptions

속성 값

SerializerOptions

shouldDeserialize

HttpOperationResponse를 역직렬화해야 하는지 여부입니다. 정의되지 않은 경우 HttpOperationResponse를 역직렬화해야 합니다.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

속성 값

boolean | (response: HttpOperationResponse) => boolean

timeout

요청이 자동으로 종료되기 전에 걸릴 수 있는 시간(밀리초)입니다. 요청이 종료되면 AbortError throw됩니다.

timeout?: number

속성 값

number

timeoutInSeconds

시간 제한 매개 변수는 초 단위로 표시됩니다. 자세한 내용은 큐 서비스 작업에 대한 시간 제한 설정 참조하세요.

timeoutInSeconds?: number

속성 값

number

tracingContext

추적: 범위를 만들 때 사용되는 컨텍스트입니다.

tracingContext?: Context

속성 값

Context

tracingOptions

추적을 사용할 때 생성되는 범위를 구성하는 옵션입니다.

tracingOptions?: OperationTracingOptions

속성 값

OperationTracingOptions

visibilityTimeout

선택적. 서버 시간을 기준으로 새 표시 시간 제한 값(초)을 지정합니다. 기본값은 30초입니다. 지정된 값은 1초보다 크거나 같아야 하며, 버전 2011-08-18 이전의 REST 프로토콜 버전에서 7일보다 크거나 2시간 이상일 수 없습니다. 메시지의 표시 시간 제한은 만료 시간보다 나중에 값으로 설정할 수 있습니다.

visibilityTimeout?: number

속성 값

number