다음을 통해 공유


@azure/core-rest-pipeline package

클래스

RestError

실패한 파이프라인 요청에 대한 사용자 지정 오류 유형입니다.

인터페이스

AddPipelineOptions

파이프라인에 정책을 추가할 때의 옵션입니다. 다른 정책에 대한 종속성을 표현하는 데 사용됩니다.

Agent

NodeJS의 http.Agent호환되는 인터페이스입니다. 런타임 버전에 따라 다를 수 있으므로 실제 인터페이스를 공개적으로 다시 내보내지 않으려고 합니다.

AuthorizeRequestOnChallengeOptions

authorizeRequestOnChallenge 콜백으로 전송되는 옵션

AuthorizeRequestOptions

authorizeRequest 콜백으로 전송된 옵션

AuxiliaryAuthenticationHeaderPolicyOptions

auxiliaryAuthenticationHeaderPolicy를 구성하는 옵션

BearerTokenAuthenticationPolicyOptions

bearerTokenAuthenticationPolicy를 구성하는 옵션

BodyPart

다중 파트 요청의 요청 본문 부분입니다.

ChallengeCallbacks

연속 액세스 평가 문제 처리를 재정의하는 옵션입니다.

CreateFileFromStreamOptions

스트림이 전달될 때 createFile에 대한 추가 옵션입니다.

CreateFileOptions

파일에 대한 메타데이터를 지정하는 createFile에 전달되는 옵션입니다.

DefaultRetryPolicyOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.

ExponentialRetryPolicyOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.

HttpClient

파이프라인을 대신하여 HTTP 요청을 만드는 클라이언트에 필요한 인터페이스입니다.

HttpHeaders

요청/응답에 대한 HTTP 헤더 집합을 나타냅니다. 헤더 이름은 대/소문자를 구분하지 않는 것으로 처리됩니다.

InternalPipelineOptions

SDK 클라이언트에 대한 HTTP 파이프라인의 내부 옵션을 구성하는 데 사용되는 옵션을 정의합니다.

KeyObject

NodeJS의 tls.KeyObject호환되는 인터페이스입니다. 런타임 버전에 따라 다를 수 있으므로 실제 인터페이스를 공개적으로 다시 내보내지 않으려고 합니다.

LogPolicyOptions

logPolicy를 구성하는 옵션입니다.

MultipartRequestBody

여러 부분으로 구성된 요청 본문입니다.

Pipeline

URL에 대한 HTTP 요청을 만들기 위한 파이프라인을 나타냅니다. 파이프라인에는 서버에 대한 요청 전후에 각 요청 조작을 관리하는 여러 정책이 있을 수 있습니다.

PipelineOptions

SDK 클라이언트에 대한 HTTP 파이프라인을 구성하는 데 사용되는 옵션을 정의합니다.

PipelinePolicy

파이프라인 정책은 파이프라인을 통과할 때 요청을 조작합니다. 개념적으로 요청을 받기 전에 수정할 수 있는 미들웨어와 수신 시 응답입니다.

PipelineRequest

파이프라인에서 이루어지는 요청에 대한 메타데이터입니다.

PipelineRequestOptions

요청을 초기화하는 설정입니다. 부분과 거의 동일하지만 URL은 필수입니다.

PipelineResponse

파이프라인에서 받은 응답에 대한 메타데이터입니다.

PipelineRetryOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.

ProxySettings

나가는 요청에 대한 프록시를 구성하는 옵션입니다(Node.js만 해당).

PxfObject

NodeJS의 tls.PxfObject호환되는 인터페이스입니다. 런타임 버전에 따라 다를 수 있으므로 실제 인터페이스를 공개적으로 다시 내보내지 않으려고 합니다.

RedirectPolicyOptions

리디렉션 응답을 처리하는 방법에 대한 옵션입니다.

RestErrorOptions

RestError에서 지원하는 옵션입니다.

RetryInformation

재시도 정책의 현재 진행률에 대한 재시도 전략에 제공된 정보입니다.

RetryModifiers

재시도 정책의 동작을 수정할 수 있는 속성입니다.

RetryPolicyOptions

retryPolicy 대한 옵션

RetryStrategy

재시도 전략은 재시도 여부와 재시도 방법을 정의하기 위한 것입니다.

SystemErrorRetryPolicyOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.

TelemetryOptions

일반적인 원격 분석 및 추적 정보를 구성하는 데 사용되는 옵션을 정의합니다.

ThrottlingRetryPolicyOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.

TlsSettings

TLS 인증을 위한 인증서를 나타냅니다.

TracingPolicyOptions

추적 정책을 구성하는 옵션입니다.

UserAgentPolicyOptions

나가는 요청에 사용자 에이전트 세부 정보를 추가하는 옵션입니다.

형식 별칭

FormDataMap

브라우저 양식에서처럼 양식 데이터를 제공하는 간단한 개체입니다.

FormDataValue

각 양식 데이터 항목은 문자열, Blob 또는 파일일 수 있습니다. 이름을 가진 파일을 전달하지만 File 클래스에 액세스할 수 없는 경우 createFile 도우미를 사용하여 파일을 만들 수 있습니다.

HttpMethods

요청할 때 사용할 지원되는 HTTP 메서드입니다.

PipelinePhase

정책은 단계적으로 실행됩니다. 실행 순서는 다음과 같습니다.

  1. 직렬화 단계
  2. 단계가 아닌 정책
  3. 역직렬화 단계
  4. 다시 시도 단계
  5. 서명 단계
RawHttpHeaders

단순 JSON 개체로 표현되는 HttpHeaders 컬렉션입니다.

RawHttpHeadersInput

단순 JSON 개체로 표현되는 입력에 대한 HttpHeaders 컬렉션입니다.

RequestBodyType

요청에서 지원되는 본문 유형입니다. NodeJS.ReadableStream 및 () => NodeJS.ReadableStream은 노드 전용입니다. Blob, ReadableStream 및 () => ReadableStream은 브라우저에만 해당합니다.

SendRequest

파이프라인 요청을 만들고 응답을 수신하기 위한 간단한 인터페이스입니다.

TransferProgressEvent

업로드 또는 다운로드 진행률에 대한 응답으로 발생합니다.

함수

agentPolicy(Agent)

http.agent를 설정하는 파이프라인 정책을 가져옵니다.

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

x-ms-authorization-auxiliary 헤더에 대한 외부 토큰에 대한 정책입니다. 이 헤더는 서로 다른 테넌트에 있는 리소스에 대한 인증 요청을 처리해야 할 수 있는 테넌트 간 애플리케이션을 만들 때 사용됩니다. 이 기능의 작동 방식에 대한 ARM 문서 확인할 수 있습니다.

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

TokenCredential 구현에서 토큰을 요청한 다음, 요청의 권한 부여 헤더에 전달자 토큰으로 적용할 수 있는 정책입니다.

createDefaultHttpClient()

현재 환경에 대한 올바른 HttpClient를 만듭니다.

createEmptyPipeline()

완전히 빈 파이프라인을 만듭니다. 사용자 지정 테스트 또는 만들기에 유용합니다.

createFile(Uint8Array, string, CreateFileOptions)

파일 인터페이스를 구현하는 개체를 만듭니다. 이 개체는 RequestBodyType.formData에 전달될 예정이며 다른 상황에서는 예상대로 작동하지 않습니다.

이 함수는 전역 File 개체를 사용할 수 없는 환경에서 RequestBodyType.formData에서 사용할 File 개체를 만듭니다.

createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)

파일 인터페이스를 구현하는 개체를 만듭니다. 이 개체는 RequestBodyType.formData에 전달될 예정이며 다른 상황에서는 예상대로 작동하지 않습니다.

이 함수를 사용하여 다음을 수행합니다.

  • 전역 File 개체를 사용할 수 없는 환경에서 RequestBodyType.formData에서 사용할 File 개체를 만듭니다.
  • 스트림을 메모리로 읽지 않고 읽을 수 있는 스트림에서 파일과 유사한 개체를 만듭니다.
createHttpHeaders(RawHttpHeadersInput)

HttpHeaders 인터페이스를 충족하는 개체를 만듭니다.

createPipelineFromOptions(InternalPipelineOptions)

사용자 지정 가능한 정책의 기본 집합을 사용하여 새 파이프라인을 만듭니다.

createPipelineRequest(PipelineRequestOptions)

지정된 옵션을 사용하여 새 파이프라인 요청을 만듭니다. 이 메서드는 기본값을 쉽게 설정할 수 있도록 하고 필수는 아닙니다.

decompressResponsePolicy()

Accept-Encoding 헤더 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding 따라 응답 압축 해제를 사용하도록 설정하는 정책

defaultRetryPolicy(DefaultRetryPolicyOptions)

다음 세 가지 전략에 따라 다시 시도되는 정책입니다.

  • 서버가 Retry-After 헤더를 사용하여 429 응답을 보내는 경우
  • 기본 전송 계층에 오류가 있는 경우(예: DNS 조회 실패)
  • 또는 나가는 요청이 실패하면 기하급수적으로 증가하는 지연으로 다시 시도합니다.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)

기하급수적으로 증가하는 지연을 도입하는 동안 요청을 다시 시도하려는 정책입니다.

formDataPolicy()

요청의 FormData를 본문으로 인코딩하는 정책입니다.

getDefaultProxySettings(string)

이 메서드는 ProxyPolicy에서 사용할 프록시 URL을 ProxySettings 변환합니다. 인수가 지정되지 않은 경우 HTTPS_PROXY 또는 HTTP_PROXY환경 변수에서 프록시 URL을 구문 분석하려고 시도합니다.

isRestError(unknown)

RestError용 Typeguard

logPolicy(LogPolicyOptions)

모든 요청 및 응답을 기록하는 정책입니다.

multipartPolicy()

다중 파트 요청에 대한 파이프라인 정책

ndJsonPolicy()

ndJsonPolicy는 모든 요청에 대한 활성 유지 설정을 제어하는 데 사용되는 정책입니다.

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

모든 요청에 프록시 설정을 적용할 수 있는 정책입니다. 정적 설정을 전달하지 않으면 HTTPS_PROXY 또는 HTTP_PROXY 환경 변수에서 검색됩니다.

redirectPolicy(RedirectPolicyOptions)

서버 쪽 리디렉션을 지원하기 위해 서버의 위치 헤더를 따르는 정책입니다. 브라우저에서 이 정책은 사용되지 않습니다.

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy는 특정 조건이 충족될 때 재시도 요청을 사용하도록 설정하는 일반적인 정책입니다.

setClientRequestIdPolicy(string)

각 PipelineRequest는 만들 때 고유한 ID를 가져옵니다. 이 정책은 HTTP 헤더를 통해 해당 고유 ID를 전달하여 더 나은 원격 분석 및 추적을 가능하게 합니다.

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

서버 자체에서 다시 시도 가능한 오류 코드 대신 기본 전송 계층(예: DNS 조회 실패)의 오류를 처리하려는 재시도 정책입니다.

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

서버가 Retry-After 헤더를 사용하여 429 응답을 보낼 때 다시 시도되는 정책입니다.

자세한 내용은 https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors 참조하세요.

tlsPolicy(TlsSettings)

인증을 위해 HttpClient 에이전트에 클라이언트 인증서를 추가하는 파이프라인 정책을 가져옵니다.

tracingPolicy(TracingPolicyOptions)

부모에 SpanOptions가 있는 파이프라인에서 수행한 각 요청에 대해 OpenTelemetry Spans를 만드는 간단한 정책입니다. 부모 범위가 없는 요청은 기록되지 않습니다.

userAgentPolicy(UserAgentPolicyOptions)

라이브러리 버전을 반영하도록 User-Agent 헤더(또는 해당)를 설정하는 정책입니다.

함수 세부 정보

agentPolicy(Agent)

http.agent를 설정하는 파이프라인 정책을 가져옵니다.

function agentPolicy(agent?: Agent): PipelinePolicy

매개 변수

agent
Agent

반환

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

x-ms-authorization-auxiliary 헤더에 대한 외부 토큰에 대한 정책입니다. 이 헤더는 서로 다른 테넌트에 있는 리소스에 대한 인증 요청을 처리해야 할 수 있는 테넌트 간 애플리케이션을 만들 때 사용됩니다. 이 기능의 작동 방식에 대한 ARM 문서 확인할 수 있습니다.

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

매개 변수

반환

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

TokenCredential 구현에서 토큰을 요청한 다음, 요청의 권한 부여 헤더에 전달자 토큰으로 적용할 수 있는 정책입니다.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

매개 변수

반환

createDefaultHttpClient()

현재 환경에 대한 올바른 HttpClient를 만듭니다.

function createDefaultHttpClient(): HttpClient

반환

createEmptyPipeline()

완전히 빈 파이프라인을 만듭니다. 사용자 지정 테스트 또는 만들기에 유용합니다.

function createEmptyPipeline(): Pipeline

반환

createFile(Uint8Array, string, CreateFileOptions)

파일 인터페이스를 구현하는 개체를 만듭니다. 이 개체는 RequestBodyType.formData에 전달될 예정이며 다른 상황에서는 예상대로 작동하지 않습니다.

이 함수는 전역 File 개체를 사용할 수 없는 환경에서 RequestBodyType.formData에서 사용할 File 개체를 만듭니다.

function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File

매개 변수

content

Uint8Array

파일의 내용을 메모리의 Uint8Array로 지정합니다.

name

string

파일의 이름입니다.

options
CreateFileOptions

파일에 대한 선택적 메타데이터(예: 파일 이름, 파일 크기, MIME 형식)입니다.

반환

File

createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)

파일 인터페이스를 구현하는 개체를 만듭니다. 이 개체는 RequestBodyType.formData에 전달될 예정이며 다른 상황에서는 예상대로 작동하지 않습니다.

이 함수를 사용하여 다음을 수행합니다.

  • 전역 File 개체를 사용할 수 없는 환경에서 RequestBodyType.formData에서 사용할 File 개체를 만듭니다.
  • 스트림을 메모리로 읽지 않고 읽을 수 있는 스트림에서 파일과 유사한 개체를 만듭니다.
function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File

매개 변수

stream

() => ReadableStream<Uint8Array> | ReadableStream

스트림을 반환하는 콜백으로 파일의 콘텐츠입니다. createFile을 사용하여 만든 File 개체가 요청의 양식 데이터 맵에 전달되면 스트림은 메모리로 읽혀지지 않고 요청이 이루어지면 스트리밍됩니다. 재시도 시 스트림을 다시 읽어야 하므로 가능하면 이 콜백은 새 스트림을 반환해야 합니다.

name

string

파일의 이름입니다.

options
CreateFileFromStreamOptions

파일에 대한 선택적 메타데이터(예: 파일 이름, 파일 크기, MIME 형식)입니다.

반환

File

createHttpHeaders(RawHttpHeadersInput)

HttpHeaders 인터페이스를 충족하는 개체를 만듭니다.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

매개 변수

rawHeaders
RawHttpHeadersInput

초기 헤더를 나타내는 간단한 개체

반환

createPipelineFromOptions(InternalPipelineOptions)

사용자 지정 가능한 정책의 기본 집합을 사용하여 새 파이프라인을 만듭니다.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

매개 변수

options
InternalPipelineOptions

사용자 지정 파이프라인을 구성하는 옵션입니다.

반환

createPipelineRequest(PipelineRequestOptions)

지정된 옵션을 사용하여 새 파이프라인 요청을 만듭니다. 이 메서드는 기본값을 쉽게 설정할 수 있도록 하고 필수는 아닙니다.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

매개 변수

options
PipelineRequestOptions

요청을 만드는 옵션입니다.

반환

decompressResponsePolicy()

Accept-Encoding 헤더 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding 따라 응답 압축 해제를 사용하도록 설정하는 정책

function decompressResponsePolicy(): PipelinePolicy

반환

defaultRetryPolicy(DefaultRetryPolicyOptions)

다음 세 가지 전략에 따라 다시 시도되는 정책입니다.

  • 서버가 Retry-After 헤더를 사용하여 429 응답을 보내는 경우
  • 기본 전송 계층에 오류가 있는 경우(예: DNS 조회 실패)
  • 또는 나가는 요청이 실패하면 기하급수적으로 증가하는 지연으로 다시 시도합니다.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

매개 변수

반환

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

기하급수적으로 증가하는 지연을 도입하는 동안 요청을 다시 시도하려는 정책입니다.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

매개 변수

options
ExponentialRetryPolicyOptions

재시도 논리를 구성하는 옵션입니다.

반환

formDataPolicy()

요청의 FormData를 본문으로 인코딩하는 정책입니다.

function formDataPolicy(): PipelinePolicy

반환

getDefaultProxySettings(string)

경고

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

  • Internally this method is no longer necessary when setting proxy information.

이 메서드는 ProxyPolicy에서 사용할 프록시 URL을 ProxySettings 변환합니다. 인수가 지정되지 않은 경우 HTTPS_PROXY 또는 HTTP_PROXY환경 변수에서 프록시 URL을 구문 분석하려고 시도합니다.

function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined

매개 변수

proxyUrl

string

사용할 프록시의 URL입니다. 인증 정보를 포함할 수 있습니다.

반환

ProxySettings | undefined

isRestError(unknown)

RestError용 Typeguard

function isRestError(e: unknown): e

매개 변수

e

unknown

캐치 절에 의해 잡힌 무언가.

반환

e

logPolicy(LogPolicyOptions)

모든 요청 및 응답을 기록하는 정책입니다.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

매개 변수

options
LogPolicyOptions

logPolicy를 구성하는 옵션입니다.

반환

multipartPolicy()

다중 파트 요청에 대한 파이프라인 정책

function multipartPolicy(): PipelinePolicy

반환

ndJsonPolicy()

ndJsonPolicy는 모든 요청에 대한 활성 유지 설정을 제어하는 데 사용되는 정책입니다.

function ndJsonPolicy(): PipelinePolicy

반환

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

모든 요청에 프록시 설정을 적용할 수 있는 정책입니다. 정적 설정을 전달하지 않으면 HTTPS_PROXY 또는 HTTP_PROXY 환경 변수에서 검색됩니다.

function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicy

매개 변수

proxySettings
ProxySettings

각 요청에 사용할 ProxySettings입니다.

options

{ customNoProxyList?: string[] }

추가 설정(예: 사용자 지정 NO_PROXY 패턴)

반환

redirectPolicy(RedirectPolicyOptions)

서버 쪽 리디렉션을 지원하기 위해 서버의 위치 헤더를 따르는 정책입니다. 브라우저에서 이 정책은 사용되지 않습니다.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

매개 변수

options
RedirectPolicyOptions

정책 동작을 제어하는 옵션입니다.

반환

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy는 특정 조건이 충족될 때 재시도 요청을 사용하도록 설정하는 일반적인 정책입니다.

function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy

매개 변수

strategies

RetryStrategy[]

반환

setClientRequestIdPolicy(string)

각 PipelineRequest는 만들 때 고유한 ID를 가져옵니다. 이 정책은 HTTP 헤더를 통해 해당 고유 ID를 전달하여 더 나은 원격 분석 및 추적을 가능하게 합니다.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

매개 변수

requestIdHeaderName

string

요청 ID를 전달할 헤더의 이름입니다.

반환

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

서버 자체에서 다시 시도 가능한 오류 코드 대신 기본 전송 계층(예: DNS 조회 실패)의 오류를 처리하려는 재시도 정책입니다.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

매개 변수

options
SystemErrorRetryPolicyOptions

정책을 사용자 지정하는 옵션입니다.

반환

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

서버가 Retry-After 헤더를 사용하여 429 응답을 보낼 때 다시 시도되는 정책입니다.

자세한 내용은 https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors 참조하세요.

function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

매개 변수

options
ThrottlingRetryPolicyOptions

재시도 논리를 구성하는 옵션입니다.

반환

tlsPolicy(TlsSettings)

인증을 위해 HttpClient 에이전트에 클라이언트 인증서를 추가하는 파이프라인 정책을 가져옵니다.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

매개 변수

tlsSettings
TlsSettings

반환

tracingPolicy(TracingPolicyOptions)

부모에 SpanOptions가 있는 파이프라인에서 수행한 각 요청에 대해 OpenTelemetry Spans를 만드는 간단한 정책입니다. 부모 범위가 없는 요청은 기록되지 않습니다.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

매개 변수

options
TracingPolicyOptions

추적 정책에 의해 기록된 원격 분석을 구성하는 옵션입니다.

반환

userAgentPolicy(UserAgentPolicyOptions)

라이브러리 버전을 반영하도록 User-Agent 헤더(또는 해당)를 설정하는 정책입니다.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

매개 변수

options
UserAgentPolicyOptions

사용자 에이전트 값을 사용자 지정하는 옵션입니다.

반환