다음을 통해 공유


@azure/ms-rest-js package

클래스

ApiKeyCredentials

API 키를 사용하여 서비스에 인증합니다.

AzureIdentityCredentialAdapter

이 클래스는 인증을 위해 ServiceClientCredentials 자격 증명 제품군을 수락하는 레거시 Azure SDK와 함께 사용하기 위해 라이브러리에서 @azure/identity 사용할 <xref:TokenCredential> 수 있는 간단한 확장을 제공합니다.

BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials

API 키를 사용하여 서비스에 인증합니다.

HttpHeaders

HTTP 헤더 키/값 쌍의 컬렉션입니다.

RequestPolicyOptions

RequestPolicy를 만들 때 사용할 수 있는 선택적 속성입니다.

RestError
Serializer
ServiceClient
TokenCredentials

토큰 문자열과 작성 체계를 사용하여 인증하는 자격 증명 개체입니다.

TopicCredentials

API 키를 사용하여 서비스에 인증합니다.

URLBuilder

URL 만들기, 수정 및 구문 분석을 처리하는 클래스입니다.

URLQuery

URLBuilder의 쿼리 부분을 처리하는 클래스입니다.

WebResource

새 WebResource 개체를 만듭니다.

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

인터페이스

AbortSignalLike

"중단" 이벤트가 발생할 때 요청을 중단하도록 허용합니다. 브라우저 기본 제공 AbortSignal 및 일반 폴리필과 호환됩니다.

AgentSettings

HTTP 및 HTTPS 에이전트(Node.js만 해당)

ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes

특정 방식으로 작업 응답을 역직렬화해야 함을 나타내는 콘텐츠 형식입니다.

DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient

HttpRequests를 보내고 약속된 HttpResponses를 받을 수 있는 인터페이스입니다.

HttpHeader

HttpHeaders 컬렉션 내의 개별 헤더입니다.

HttpHeadersLike

HTTP 헤더 키/값 쌍의 컬렉션입니다.

HttpOperationResponse

http 요청 및 응답에 대한 래퍼 개체입니다. 역직렬화된 개체는 응답 본문을 JSON 또는 XML로 받으면 속성에 저장 parsedBody 됩니다.

HttpPipelineLogger

HttpPipeline에 추가할 수 있는 로거입니다. 이렇게 하면 각 RequestPolicy가 디버깅 목적으로 사용할 수 있는 메시지를 기록할 수 있습니다.

HttpResponse

항상 존재하는 HTTP 응답의 속성입니다.

MapperConstraints
OperationArguments

작업의 단일 호출에 적용되는 속성의 컬렉션입니다.

OperationParameter

모든 Operation 매개 변수가 확장하는 공통 인터페이스입니다.

OperationQueryParameter

작업의 HTTP 요청에 쿼리 매개 변수로 추가될 작업에 대한 매개 변수입니다.

OperationResponse

단일 상태 코드에 대한 작업 요청에서 반환할 수 있는 OperationResponse입니다.

OperationSpec

작업을 정의하는 사양입니다.

OperationURLParameter

작업의 요청 URL로 대체될 작업에 대한 매개 변수입니다.

ParameterValue

RequestPrepareOptions의 경로 또는 쿼리 매개 변수에 대해 제공되는 매개 변수 값입니다.

PolymorphicDiscriminator
ProxySettings

HTTP 프록시 설정(Node.js만 해당)

RedirectOptions

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

RequestOptionsBase

모든 작업에 사용할 options 개체의 기본 구조를 설명합니다.

RequestPolicy
RequestPolicyOptionsLike

RequestPolicy를 만들 때 사용할 수 있는 선택적 속성입니다.

RequestPrepareOptions
RestResponse

REST 호출에 대한 평면화된 응답입니다. 기본 HttpOperationResponse 및 parsedBody, parsedHeaders 등의 병합된 속성을 포함합니다.

SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions

클라이언트를 만드는 동안 제공할 옵션입니다.

SimpleMapperType
TokenResponse

TokenResponse는 에서 @azure/ms-rest-nodeauth 정의되며 불필요한 종속성을 추가하지 않도록 여기에 복사됩니다.

UrlParameterValue
WebResourceLike

REST 호출에 대한 추상화입니다.

형식 별칭

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders

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

RequestPolicyFactory

제공된 nextPolicy를 사용하는 요청당 새 RequestPolicy를 만듭니다.

TelemetryInfo
TransferProgressEvent

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

열거형

HttpPipelineLogLevel

HttpPipelineLogger와 함께 사용할 수 있는 다양한 수준의 로그입니다.

QueryCollectionFormat

쿼리 매개 변수 값에 대해 값 배열을 조인하는 데 사용할 형식입니다.

함수

agentPolicy(AgentSettings)
applyMixins(any, any[])

sourceCtors의 프로토타입에 대한 속성을 targetCtor의 프로토타입에 적용합니다.

delay<T>(number, T)

t 밀리초 후 약속을 확인하는 setTimeout에 대한 래퍼입니다.

deserializationPolicy(DeserializationContentTypes)

HTTP 파이프라인을 통과할 때 HTTP 요청 본문을 직렬화하는 새 serialization RequestPolicyCreator를 만듭니다.

deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)

URI를 인코딩합니다.

executePromisesSequentially(any[], any)

약속의 배열을 순차적으로 실행합니다. 이 메서드의 영감은 다음과 같습니다 https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. 약속에 멋진 블로그!

exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()

생성된 UUID

getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)

지정된 문자열이 ISO 8601 형식인지 여부를 나타냅니다.

isValidUuid(string)

지정된 uuid를 문자열로 유효성을 검사합니다.

logPolicy(any)
promiseToCallback(Promise<any>)

Promise를 콜백으로 변환합니다.

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Promise를 서비스 콜백으로 변환합니다.

proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)

권한 부여 헤더를 포함하지 않는 Http 요청의 제거된 버전을 반환합니다.

stripResponse(HttpOperationResponse)

본문, 헤더 및 상태만 포함하는 Http 응답의 제거된 버전을 반환합니다.

systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

함수 세부 정보

agentPolicy(AgentSettings)

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

매개 변수

agentSettings
AgentSettings

반환

applyMixins(any, any[])

sourceCtors의 프로토타입에 대한 속성을 targetCtor의 프로토타입에 적용합니다.

function applyMixins(targetCtor: any, sourceCtors: any[])

매개 변수

targetCtor

any

속성을 적용해야 하는 대상 개체입니다.

sourceCtors

any[]

속성을 가져와야 하는 원본 개체의 배열입니다.

delay<T>(number, T)

t 밀리초 후 약속을 확인하는 setTimeout에 대한 래퍼입니다.

function delay<T>(t: number, value?: T): Promise<T>

매개 변수

t

number

지연될 시간(밀리초)입니다.

value

T

시간 초과 후 확인할 값(밀리초)입니다.

반환

Promise<T>

해결된 약속

deserializationPolicy(DeserializationContentTypes)

HTTP 파이프라인을 통과할 때 HTTP 요청 본문을 직렬화하는 새 serialization RequestPolicyCreator를 만듭니다.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

매개 변수

deserializationContentTypes
DeserializationContentTypes

반환

deserializeResponseBody(string[], string[], HttpOperationResponse)

function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse): Promise<HttpOperationResponse>

매개 변수

jsonContentTypes

string[]

xmlContentTypes

string[]

반환

encodeUri(string)

URI를 인코딩합니다.

function encodeUri(uri: string): string

매개 변수

uri

string

인코딩할 URI입니다.

반환

string

인코딩된 URI입니다.

executePromisesSequentially(any[], any)

약속의 배열을 순차적으로 실행합니다. 이 메서드의 영감은 다음과 같습니다 https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. 약속에 멋진 블로그!

function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>

매개 변수

promiseFactories

any[]

promise 팩터리 배열(promise를 반환하는 함수)

kickstart

any

프라미스 체인을 킥스타트하는 데 사용되는 첫 번째 약속에 대한 입력입니다. 제공되지 않으면 프라미스 체인이 정의되지 않은 상태로 시작됩니다.

반환

Promise<any>

해결되거나 거부된 약속 체인

exponentialRetryPolicy(number, number, number, number)

function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

매개 변수

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

반환

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

매개 변수

responseSpec

undefined | OperationResponse

반환

generateClientRequestIdPolicy(string)

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

매개 변수

requestIdHeaderName

string

반환

generateUuid()

생성된 UUID

function generateUuid(): string

반환

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

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

매개 변수

proxyUrl

string

반환

ProxySettings | undefined

getDefaultUserAgentValue()

function getDefaultUserAgentValue(): string

반환

string

isDuration(string)

지정된 문자열이 ISO 8601 형식인지 여부를 나타냅니다.

function isDuration(value: string): boolean

매개 변수

value

string

ISO 8601 기간 형식에 대해 유효성을 검사할 값입니다.

반환

boolean

true 유효하면 이고, false 그렇지 않으면 입니다.

isValidUuid(string)

지정된 uuid를 문자열로 유효성을 검사합니다.

function isValidUuid(uuid: string): boolean

매개 변수

uuid

string

유효성을 검사해야 하는 문자열인 uuid

반환

boolean

True이면 uuid가 유효합니다. false이면 이고, 그렇지 않으면 입니다.

logPolicy(any)

function logPolicy(logger?: any): RequestPolicyFactory

매개 변수

logger

any

반환

promiseToCallback(Promise<any>)

경고

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

generated code should instead depend on responseToBody

Promise를 콜백으로 변환합니다.

function promiseToCallback(promise: Promise<any>): Function

매개 변수

promise

Promise<any>

콜백으로 변환할 약속

반환

Function

콜백을 사용하는 함수(cb: 함수): void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Promise를 서비스 콜백으로 변환합니다.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): Function

매개 변수

promise

Promise<HttpOperationResponse>

서비스 콜백으로 변환할 HttpOperationResponse 약속

반환

Function

서비스 콜백을 사용하는 함수(cb: ServiceCallback): void

proxyPolicy(ProxySettings)

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

매개 변수

proxySettings
ProxySettings

반환

redirectPolicy(number)

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

매개 변수

maximumRetries

number

반환

serializeObject(any)

function serializeObject(toSerialize: any): any

매개 변수

toSerialize

any

반환

any

signingPolicy(ServiceClientCredentials)

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

매개 변수

authenticationProvider
ServiceClientCredentials

반환

stripRequest(WebResourceLike)

권한 부여 헤더를 포함하지 않는 Http 요청의 제거된 버전을 반환합니다.

function stripRequest(request: WebResourceLike): WebResourceLike

매개 변수

request
WebResourceLike

Http Request 개체

반환

제거된 버전의 Http 요청입니다.

stripResponse(HttpOperationResponse)

본문, 헤더 및 상태만 포함하는 Http 응답의 제거된 버전을 반환합니다.

function stripResponse(response: HttpOperationResponse): any

매개 변수

response
HttpOperationResponse

Http 응답

반환

any

Http 응답의 제거된 버전입니다.

systemErrorRetryPolicy(number, number, number, number)

function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

매개 변수

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

반환

throttlingRetryPolicy(number)

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

매개 변수

maxRetries

number

반환

userAgentPolicy(TelemetryInfo)

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

매개 변수

userAgentData
TelemetryInfo

반환