WebResource class

패키지:

@azure/core-http

새 WebResource 개체를 만듭니다.

이 클래스는 라이브러리/구현에 구애받지 않고 요청을 시작하는 데 필요한 속성을 래핑하여 REST 호출에 대한 추상화를 제공합니다.

생성자

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

속성

abortSignal	중단 컨트롤러의 신호입니다. 네트워크 요청을 보내고 응답을 기다리는 작업을 모두 중단하는 데 사용할 수 있습니다.
body	요청 본문입니다.
decompressResponse	Accept-Encoding 헤더에 따라 응답을 압축 해제할지 여부(노드 인출에만 해당)
formData	요청 본문을 빌드하는 데 사용되는 양식 데이터입니다.
headers	HTTP 헤더.
keepAlive	요청 전체에서 HTTP 연결을 활성 상태로 유지할지 여부입니다.
method	사용할 HTTP 메서드입니다.
onDownloadProgress	다운로드 진행 시 발생하는 콜백입니다.
onUploadProgress	업로드 진행률에 따라 발생하는 콜백입니다.
operationResponseGetter	지정된 OperationSpec 및 HttpOperationResponse 조합에 대한 적절한 OperationResponse를 반환하는 함수입니다. 정의되지 않은 경우 간단한 상태 코드 조회가 사용됩니다.
operationSpec	HTTP 요청의 사양입니다.
proxySettings	필요한 경우 사용할 프록시입니다.
query	URL에 추가된 쿼리입니다.
requestId	나가는 요청의 고유 식별자입니다.
shouldDeserialize	HttpOperationResponse를 역직렬화해야 하는지 여부입니다. 정의되지 않은 경우 HttpOperationResponse를 역직렬화해야 합니다.
spanOptions	추적: 추적을 사용할 때 범위를 만드는 데 사용되는 옵션입니다.
streamResponseBody	HttpOperationResponse의 본문을 스트림으로 처리해야 하는지 여부입니다.
streamResponseStatusCodes	해당 HttpOperationResponse 본문을 스트림으로 처리해야 하는 상태 코드 목록입니다.
timeout	요청을 중단하기 전에 대기하는 시간(밀리초)입니다.
tracingContext	추적: 범위를 만들 때 사용되는 컨텍스트입니다.
url	나가는 요청의 URL입니다.
withCredentials	브라우저에서 교차 사이트 대상으로 요청할 때 자격 증명(쿠키, 권한 부여 헤더 또는 TLS 클라이언트 인증서를 통해)을 보낼지 여부입니다.

메서드

clone()	이 WebResource HTTP 요청 개체를 복제합니다.
prepare(RequestPrepareOptions)	요청을 준비합니다.
validateRequestProperties()	메서드, URL, 헤더["Content-Type"], 헤더["accept-language"]와 같은 필수 속성이 정의되어 있는지 확인합니다. 위에서 언급한 속성 중 하나가 정의되지 않은 경우 오류가 발생합니다.

생성자 세부 정보

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

매개 변수

url

string

method

HttpMethods

body

unknown

query

{[key: string]: any}

headers

{[key: string]: any} | HttpHeadersLike

streamResponseBody

boolean

withCredentials

boolean

abortSignal

AbortSignalLike

timeout

number

onUploadProgress

(progress: TransferProgressEvent) => void

onDownloadProgress

(progress: TransferProgressEvent) => void

proxySettings

ProxySettings

keepAlive

boolean

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

속성 세부 정보

abortSignal

중단 컨트롤러의 신호입니다. 네트워크 요청을 보내고 응답을 기다리는 작업을 모두 중단하는 데 사용할 수 있습니다.

abortSignal?: AbortSignalLike

속성 값

AbortSignalLike

body

요청 본문입니다.

body?: any

속성 값

any

decompressResponse

Accept-Encoding 헤더에 따라 응답을 압축 해제할지 여부(노드 인출에만 해당)

decompressResponse?: boolean

속성 값

boolean

formData

요청 본문을 빌드하는 데 사용되는 양식 데이터입니다.

formData?: any

속성 값

any

headers

HTTP 헤더.

headers: HttpHeadersLike

속성 값

HttpHeadersLike

keepAlive

요청 전체에서 HTTP 연결을 활성 상태로 유지할지 여부입니다.

keepAlive?: boolean

속성 값

boolean

method

사용할 HTTP 메서드입니다.

method: HttpMethods

속성 값

HttpMethods

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

속성 값

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

속성 값

(progress: TransferProgressEvent) => void

operationResponseGetter

지정된 OperationSpec 및 HttpOperationResponse 조합에 대한 적절한 OperationResponse를 반환하는 함수입니다. 정의되지 않은 경우 간단한 상태 코드 조회가 사용됩니다.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

속성 값

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

HTTP 요청의 사양입니다.

operationSpec?: OperationSpec

속성 값

OperationSpec

proxySettings

필요한 경우 사용할 프록시입니다.

proxySettings?: ProxySettings

속성 값

ProxySettings

query

URL에 추가된 쿼리입니다.

query?: {[key: string]: any}

속성 값

{[key: string]: any}

requestId

나가는 요청의 고유 식별자입니다.

requestId: string

속성 값

string

shouldDeserialize

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

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

속성 값

boolean | (response: HttpOperationResponse) => boolean

spanOptions

추적: 추적을 사용할 때 범위를 만드는 데 사용되는 옵션입니다.

spanOptions?: SpanOptions

속성 값

@azure/core-tracing.SpanOptions

streamResponseBody

경고

이 API는 이제 사용되지 않습니다.

Use streamResponseStatusCodes property instead.

HttpOperationResponse의 본문을 스트림으로 처리해야 하는지 여부입니다.

streamResponseBody?: boolean

속성 값

boolean

streamResponseStatusCodes

해당 HttpOperationResponse 본문을 스트림으로 처리해야 하는 상태 코드 목록입니다.

streamResponseStatusCodes?: Set<number>

속성 값

Set<number>

timeout

요청을 중단하기 전에 대기하는 시간(밀리초)입니다.

timeout: number

속성 값

number

tracingContext

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

tracingContext?: Context

속성 값

@azure/core-tracing.Context

url

나가는 요청의 URL입니다.

url: string

속성 값

string

withCredentials

브라우저에서 교차 사이트 대상으로 요청할 때 자격 증명(쿠키, 권한 부여 헤더 또는 TLS 클라이언트 인증서를 통해)을 보낼지 여부입니다.

withCredentials: boolean

속성 값

boolean

메서드 세부 정보

clone()

이 WebResource HTTP 요청 개체를 복제합니다.

function clone(): WebResource

반환

WebResource

이 WebResource HTTP 요청 개체의 복제본입니다.

prepare(RequestPrepareOptions)

요청을 준비합니다.

function prepare(options: RequestPrepareOptions): WebResource

매개 변수

options

RequestPrepareOptions

요청을 준비하기 위한 옵션입니다.

반환

WebResource

요청 파이프라인에 제공해야 하는 준비된 WebResource(HTTP Request) 개체를 반환합니다.

validateRequestProperties()

메서드, URL, 헤더["Content-Type"], 헤더["accept-language"]와 같은 필수 속성이 정의되어 있는지 확인합니다. 위에서 언급한 속성 중 하나가 정의되지 않은 경우 오류가 발생합니다.

function validateRequestProperties()