@azure/core-https package

클래스

DefaultHttpsClient

Node의 "https" 모듈을 사용하여 HTTPS 요청을 보내는 HttpsClient 구현입니다.

RestError

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

인터페이스

AddPipelineOptions

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

BearerTokenAuthenticationPolicyOptions

bearerTokenAuthenticationPolicy를 구성하는 옵션

ExponentialRetryPolicyOptions

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

HttpHeaders

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

HttpsClient

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

InternalPipelineOptions

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

LogPolicyOptions

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

Pipeline

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

PipelineOptions

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

PipelinePolicy

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

PipelineRequest

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

PipelineRequestOptions

요청을 초기화하는 설정입니다. Partial<PipelineRequest>와 거의 동일하지만 url은 필수입니다.

PipelineResponse

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

ProxySettings

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

RedirectPolicyOptions

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

RestErrorOptions

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

SystemErrorRetryPolicyOptions

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

TracingPolicyOptions

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

UserAgentPolicyOptions

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

형식 별칭

FormDataMap

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

FormDataValue

각 양식 데이터 항목은 문자열 또는 (브라우저에서) Blob일 수 있습니다.

HttpMethods

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

PipelinePhase

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

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

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

RequestBodyType

요청에서 지원되는 본문 유형입니다. NodeJS.ReadableStream은 노드 전용입니다. Blob은 브라우저 전용입니다.

SendRequest

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

TransferProgressEvent

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

함수

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

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

createEmptyPipeline()

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

createHttpHeaders(RawHttpHeaders)

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

createPipelineFromOptions(InternalPipelineOptions)

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

createPipelineRequest(PipelineRequestOptions)

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

decompressResponsePolicy()

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

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

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

formDataPolicy()

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

getDefaultProxySettings(string)

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

logPolicy(LogPolicyOptions)

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

ndJsonPolicy()

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

proxyPolicy(ProxySettings)

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

redirectPolicy(RedirectPolicyOptions)

서버 쪽 리디렉션을 지원하기 위해 서버의 위치 헤더를 따르는 정책입니다.

setClientRequestIdPolicy(string)

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

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

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

throttlingRetryPolicy()

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

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

tracingPolicy(TracingPolicyOptions)

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

userAgentPolicy(UserAgentPolicyOptions)

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

변수

bearerTokenAuthenticationPolicyName

bearerTokenAuthenticationPolicy의 프로그래밍 식별자입니다.

decompressResponsePolicyName

decompressResponsePolicy의 프로그래밍 식별자입니다.

expontentialRetryPolicyName

지수적 재시도정책(ExponentialRetryPolicy)의 프로그램 식별자입니다.

formDataPolicyName

formDataPolicy의 프로그래밍 식별자입니다.

logPolicyName

logPolicy의 프로그램적 식별자입니다.

ndJsonPolicyName

ndJsonPolicy의 프로그래밍 식별자입니다.

proxyPolicyName

proxyPolicy의 프로그램적 식별자입니다.

redirectPolicyName

리디렉션Policy의 프로그램적 식별자입니다.

setClientRequestIdPolicyName

setClientRequestIdPolicy의 프로그래밍 식별자입니다.

systemErrorRetryPolicyName

systemErrorRetryPolicy의 프로그래밍 식별자입니다.

throttlingRetryPolicyName

throttlingRetryPolicy의 프로그래밍 식별자입니다.

tracingPolicyName

트레이싱 정책의 프로그램적 식별자입니다.

userAgentPolicyName

userAgentPolicy의 프로그래밍 식별자입니다.

함수 세부 정보

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

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

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

매개 변수

반환

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

반환

createHttpHeaders(RawHttpHeaders)

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

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

매개 변수

rawHeaders
RawHttpHeaders

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

반환

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

반환

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

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

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

매개 변수

options
ExponentialRetryPolicyOptions

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

반환

formDataPolicy()

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

function formDataPolicy(): PipelinePolicy

반환

getDefaultProxySettings(string)

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

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

매개 변수

proxyUrl

string

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

반환

ProxySettings | undefined

logPolicy(LogPolicyOptions)

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

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

매개 변수

options
LogPolicyOptions

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

반환

ndJsonPolicy()

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

function ndJsonPolicy(): PipelinePolicy

반환

proxyPolicy(ProxySettings)

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

function proxyPolicy(proxySettings?: ProxySettings): PipelinePolicy

매개 변수

proxySettings
ProxySettings

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

반환

redirectPolicy(RedirectPolicyOptions)

서버 쪽 리디렉션을 지원하기 위해 서버의 위치 헤더를 따르는 정책입니다.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

매개 변수

options
RedirectPolicyOptions

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

반환

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()

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

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

function throttlingRetryPolicy(): PipelinePolicy

반환

tracingPolicy(TracingPolicyOptions)

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

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

매개 변수

options
TracingPolicyOptions

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

반환

userAgentPolicy(UserAgentPolicyOptions)

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

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

매개 변수

options
UserAgentPolicyOptions

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

반환

Variable Details

bearerTokenAuthenticationPolicyName

bearerTokenAuthenticationPolicy의 프로그래밍 식별자입니다.

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

형식

"bearerTokenAuthenticationPolicy"

decompressResponsePolicyName

decompressResponsePolicy의 프로그래밍 식별자입니다.

decompressResponsePolicyName: "decompressResponsePolicy"

형식

"decompressResponsePolicy"

expontentialRetryPolicyName

지수적 재시도정책(ExponentialRetryPolicy)의 프로그램 식별자입니다.

expontentialRetryPolicyName: "exponentialRetryPolicy"

형식

"exponentialRetryPolicy"

formDataPolicyName

formDataPolicy의 프로그래밍 식별자입니다.

formDataPolicyName: "formDataPolicy"

형식

"formDataPolicy"

logPolicyName

logPolicy의 프로그램적 식별자입니다.

logPolicyName: "logPolicy"

형식

"logPolicy"

ndJsonPolicyName

ndJsonPolicy의 프로그래밍 식별자입니다.

ndJsonPolicyName: "ndJsonPolicy"

형식

"ndJsonPolicy"

proxyPolicyName

proxyPolicy의 프로그램적 식별자입니다.

proxyPolicyName: "proxyPolicy"

형식

"proxyPolicy"

redirectPolicyName

리디렉션Policy의 프로그램적 식별자입니다.

redirectPolicyName: "redirectPolicy"

형식

"redirectPolicy"

setClientRequestIdPolicyName

setClientRequestIdPolicy의 프로그래밍 식별자입니다.

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

형식

"setClientRequestIdPolicy"

systemErrorRetryPolicyName

systemErrorRetryPolicy의 프로그래밍 식별자입니다.

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

형식

"systemErrorRetryPolicy"

throttlingRetryPolicyName

throttlingRetryPolicy의 프로그래밍 식별자입니다.

throttlingRetryPolicyName: "throttlingRetryPolicy"

형식

"throttlingRetryPolicy"

tracingPolicyName

트레이싱 정책의 프로그램적 식별자입니다.

tracingPolicyName: "tracingPolicy"

형식

"tracingPolicy"

userAgentPolicyName

userAgentPolicy의 프로그래밍 식별자입니다.

userAgentPolicyName: "userAgentPolicy"

형식

"userAgentPolicy"