@azure/core-rest-pipeline package

참조

클래스

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

인터페이스

AddPipelineOptions	파이프라인에 정책을 추가할 때의 옵션입니다. 다른 정책에 대한 종속성을 표현하는 데 사용됩니다.
Agent	NodeJS의 와 호환되는 인터페이스입니다 `http.Agent`. 런타임 버전에 따라 다를 수 있으므로 실제 인터페이스를 공개적으로 다시 내보내지 않으려고 합니다.
AuthorizeRequestOnChallengeOptions	authorizeRequestOnChallenge 콜백으로 전송되는 옵션
AuthorizeRequestOptions	authorizeRequest 콜백으로 전송되는 옵션
AuxiliaryAuthenticationHeaderPolicyOptions	auxiliaryAuthenticationHeaderPolicy를 구성하는 옵션
BearerTokenAuthenticationPolicyOptions	bearerTokenAuthenticationPolicy를 구성하는 옵션
ChallengeCallbacks	연속 액세스 평가 챌린지 처리를 재정의하는 옵션입니다.
DefaultRetryPolicyOptions	실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.
ExponentialRetryPolicyOptions	실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.
HttpClient	파이프라인을 대신하여 HTTP 요청을 만드는 클라이언트에 필요한 인터페이스입니다.
HttpHeaders	요청/응답에 대한 HTTP 헤더 집합을 나타냅니다. 헤더 이름은 대/소문자를 구분하지 않는 것으로 처리됩니다.
InternalPipelineOptions	SDK 클라이언트에 대한 HTTP 파이프라인의 내부 옵션을 구성하는 데 사용되는 옵션을 정의합니다.
KeyObject	NodeJS의 와 호환되는 인터페이스입니다 `tls.KeyObject`. 런타임 버전에 따라 다를 수 있으므로 실제 인터페이스를 공개적으로 다시 내보내지 않으려고 합니다.
LogPolicyOptions	logPolicy를 구성하는 옵션입니다.
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일 수 있습니다.
HttpMethods	요청할 때 사용할 지원되는 HTTP 메서드입니다.
PipelinePhase	정책은 단계적으로 실행됩니다. 실행 순서는 다음과 같습니다. 직렬화 단계 단계에 있지 않은 정책 역직렬화 단계 다시 시도 단계 서명 단계
RawHttpHeaders	단순 JSON 개체로 표현되는 HttpHeaders 컬렉션입니다.
RawHttpHeadersInput	간단한 JSON 개체로 표현되는 입력에 대한 HttpHeaders 컬렉션입니다.
RequestBodyType	요청에서 지원되는 본문 유형입니다. NodeJS.ReadableStream 및 () => NodeJS.ReadableStream은 노드 전용입니다. Blob, ReadableStream 및 () => ReadableStream은 브라우저 전용입니다.
SendRequest	파이프라인 요청을 만들고 응답을 수신하기 위한 간단한 인터페이스입니다.
TransferProgressEvent	업로드 또는 다운로드 진행률에 대한 응답으로 발생합니다.

함수

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	헤더에 대한 외부 토큰에 `x-ms-authorization-auxiliary` 대한 정책입니다. 이 헤더는 서로 다른 테넌트에서 리소스에 대한 인증 요청을 처리해야 할 수 있는 테넌트 간 애플리케이션을 만들 때 사용됩니다. 이 기능의 작동 방식에 대한 개요에 대한 ARM 문서를 볼 수 있습니다.
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	TokenCredential 구현에서 토큰을 요청한 다음 요청의 Authorization 헤더에 전달자 토큰으로 적용할 수 있는 정책입니다.
createDefaultHttpClient()	현재 환경에 대한 올바른 HttpClient를 만듭니다.
createEmptyPipeline()	완전히 빈 파이프라인을 만듭니다. 사용자 지정 테스트 또는 만들기에 유용합니다.
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` 변환합니다. 인수가 지정되지 않으면 환경 변수 또는 `HTTP_PROXY`에서 프록시 URL을 구문 분석하려고 시도합니다`HTTPS_PROXY`.
isRestError(unknown)	RestError용 Typeguard
logPolicy(LogPolicyOptions)	모든 요청 및 응답을 기록하는 정책입니다.
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://docs.microsoft.com/en-us/azure/azure-subscription-service-limits 및 를 https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits참조하세요.https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tlsPolicy(TlsSettings)	인증을 위해 HttpClient 에이전트에 클라이언트 인증서를 추가하는 파이프라인 정책을 가져옵니다.
tracingPolicy(TracingPolicyOptions)	부모가 있는 SpanOptions가 있는 파이프라인에서 수행한 각 요청에 대해 OpenTelemetry Spans를 만드는 간단한 정책입니다. 부모 Span 없이 이루어진 요청은 기록되지 않습니다.
userAgentPolicy(UserAgentPolicyOptions)	라이브러리 버전을 반영하도록 User-Agent 헤더(또는 이에 해당)를 설정하는 정책입니다.

함수 세부 정보

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

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

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

다음을 통해 공유

@azure/core-rest-pipeline package

클래스

인터페이스

형식 별칭

함수

함수 세부 정보

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

매개 변수

반환

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

매개 변수

반환

createDefaultHttpClient()

반환

createEmptyPipeline()

반환

createHttpHeaders(RawHttpHeadersInput)

매개 변수

반환

createPipelineFromOptions(InternalPipelineOptions)

매개 변수

반환

createPipelineRequest(PipelineRequestOptions)

매개 변수

반환

decompressResponsePolicy()

반환

defaultRetryPolicy(DefaultRetryPolicyOptions)

매개 변수

반환

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

매개 변수

반환

formDataPolicy()

반환

getDefaultProxySettings(string)

매개 변수

반환

isRestError(unknown)

매개 변수

반환

logPolicy(LogPolicyOptions)

매개 변수

반환

ndJsonPolicy()

반환

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

매개 변수

반환

redirectPolicy(RedirectPolicyOptions)

매개 변수

반환

retryPolicy(RetryStrategy[], RetryPolicyOptions)

매개 변수

반환

setClientRequestIdPolicy(string)

매개 변수

반환

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

매개 변수

반환

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

매개 변수

반환

tlsPolicy(TlsSettings)

매개 변수

반환

tracingPolicy(TracingPolicyOptions)

매개 변수

반환

userAgentPolicy(UserAgentPolicyOptions)

매개 변수

반환

추가 리소스