@azure/core-http package

클래스

AccessTokenRefresher	현재 새 토큰을 기다리지 않는 경우 새 토큰을 요청하여 core-http 토큰 인증 정책을 돕습니다.
ApiKeyCredentials	API 키를 사용하여 서비스에 인증합니다.
BaseRequestPolicy	모든 요청 정책이 파생되는 기본 클래스입니다.
BasicAuthenticationCredentials	사용자 이름 및 암호로 인증하는 간단한 <xref:ServiceClientCredential> 입니다.
DefaultHttpClient	를 사용하는 HTTP 클라이언트입니다 node-fetch.
ExpiringAccessTokenCache	만료OnTimestamp가 통과된 후 캐시된 AccessToken을 지우는 AccessTokenCache 구현을 제공합니다.
HttpHeaders	HTTP 헤더 키/값 쌍의 컬렉션입니다.
RequestPolicyOptions	RequestPolicy를 만들 때 사용할 수 있는 선택적 속성입니다.
RestError	서비스 엔드포인트에 대한 HTTP 요청으로 인한 오류입니다.
Serializer	원시 응답 개체를 최종 셰이프에 매핑하는 데 사용됩니다. JSON에 내장되지 않는 날짜 및 기타 인코딩된 형식을 압축하고 압축 해제하는 데 도움이 됩니다. 또한 헤더에서 값을 끌어와 기본값 및 상수를 삽입할 수 있습니다.
ServiceClient	ServiceClient는 서비스 요청을 보내고 응답을 받습니다.
TopicCredentials	Azure Event Grid 사용되는 TopicCredentials 개체입니다.
URLBuilder	URL 만들기, 수정 및 구문 분석을 처리하는 클래스입니다.
URLQuery	URLBuilder의 쿼리 부분을 처리하는 클래스입니다.
WebResource	새 WebResource 개체를 만듭니다. 이 클래스는 라이브러리/구현에 구애받지 않고 요청을 시작하는 데 필요한 속성을 래핑하여 REST 호출에 대한 추상화를 제공합니다.

인터페이스

AbortSignalLike	"중단" 이벤트가 발생할 때 요청을 중단하도록 허용합니다. 브라우저 기본 제공 AbortSignal 및 일반 폴리필과 호환됩니다.
AccessToken	만료 시간이 있는 액세스 토큰을 나타냅니다.
AccessTokenCache	TokenCredential에서 반환된 AccessToken에 대한 캐시를 제공합니다.
ApiKeyCredentialOptions	ApiKeyCredentials 인스턴스를 만드는 동안 제공할 옵션에 대해 설명합니다.
BaseMapper	매퍼의 기본 정의입니다. XML 및 일반 JavaScript 개체에 사용할 수 있습니다.
CompositeMapper	다른 매퍼로 구성된 매퍼입니다.
CompositeMapperType	다른 매퍼를 기반으로 개체의 속성 집합을 매핑하는 방법을 설명하는 매퍼를 빌드하는 데 도움이 됩니다. , 및 additionalProperties속성 중 하나만 있어야 classNamemodelProperties 합니다.
DeserializationContentTypes	특정 방식으로 작업 응답을 역직렬화해야 함을 나타내는 콘텐츠 형식입니다.
DeserializationOptions	API 응답 역직렬화를 구성하는 옵션입니다.
DictionaryMapper	키/값 쌍으로 사용되는 일반 JavaScript 개체를 설명하는 매퍼입니다.
DictionaryMapperType	매핑된 값의 사전을 구문 분석하는 방법을 설명하는 매퍼를 빌드하는 데 도움이 됩니다.
EnumMapper	열거형 값을 설명하는 매퍼입니다.
EnumMapperType	열거형 값을 구문 분석하는 방법을 설명하는 매퍼를 빌드하는 데 도움이 됩니다.
GetTokenOptions	TokenCredential.getToken에 대한 옵션을 정의합니다.
HttpClient	HttpRequests를 보내고 약속된 HttpResponses를 받을 수 있는 인터페이스입니다.
HttpHeader	HttpHeaders 컬렉션 내의 개별 헤더입니다.
HttpHeadersLike	HTTP 헤더 키/값 쌍의 컬렉션입니다.
HttpOperationResponse	http 요청 및 응답에 대한 래퍼 개체입니다. 역직렬화된 개체는 응답 본문을 JSON 또는 XML로 받으면 속성에 저장 parsedBody 됩니다.
HttpPipelineLogger	HttpPipeline에 추가할 수 있는 로거입니다. 이렇게 하면 각 RequestPolicy가 디버깅 목적으로 사용할 수 있는 메시지를 기록할 수 있습니다.
HttpResponse	항상 존재하는 HTTP 응답의 속성입니다.
InternalPipelineOptions	SDK 클라이언트에 대한 HTTP 파이프라인의 내부 옵션을 구성하는 데 사용되는 옵션을 정의합니다.
KeepAliveOptions	향후 요청에 대해 HTTP 연결을 유지 관리하는 방법에 대한 옵션입니다.
LogPolicyOptions	logPolicy에 전달할 옵션입니다. 기본적으로 헤더 집합 목록만 기록되지만 구성할 수 있습니다. 요청 및 응답 본문은 기록되지 않습니다.
MapperConstraints	정수 범위 및 문자열 정규식과 같은 다양한 값 제약 조건에 대한 설명입니다.
OperationArguments	작업의 단일 호출에 적용되는 속성의 컬렉션입니다.
OperationOptions	모든 작업에 대한 기본 옵션 형식입니다.
OperationParameter	모든 Operation 매개 변수가 확장되는 공통 인터페이스입니다.
OperationQueryParameter	작업의 HTTP 요청에 쿼리 매개 변수로 추가될 작업에 대한 매개 변수입니다.
OperationRequestOptions	SDK 작업에서 수행한 HTTP 요청의 처리를 구성할 수 있는 옵션입니다.
OperationResponse	단일 상태 코드에 대한 작업 요청에서 반환할 수 있는 OperationResponse입니다.
OperationSpec	요청 정보를 올바르게 로 직렬화하고 응답 정보를 ServiceClient에서 반환할 수 있는 개체 페이로드로 역직렬화하는 방법을 포함하여 HTTP를 통해 특정 서비스 작업을 수행하는 방법을 정의하는 사양입니다.
OperationURLParameter	작업의 요청 URL로 대체될 작업에 대한 매개 변수입니다.
ParameterValue	RequestPrepareOptions의 경로 또는 쿼리 매개 변수에 제공된 매개 변수 값입니다.
PipelineOptions	SDK 클라이언트에 대한 HTTP 파이프라인을 구성하는 데 사용되는 옵션을 정의합니다.
PolymorphicDiscriminator	차별된 형식 공용 구조체를 명확하게 구분하는 데 사용됩니다. 예를 들어 응답에 셰이프가 많을 수 있지만 'kind' 필드(또는 이와 유사)도 포함된 경우 해당 필드를 사용하여 올바른 형식에 대한 응답을 역직렬화하는 방법을 결정할 수 있습니다.
ProxySettings	나가는 요청에 대한 프록시를 구성하는 옵션입니다(Node.js 전용).
RedirectOptions	리디렉션 응답을 처리하는 방법에 대한 옵션입니다.
RequestOptionsBase	모든 작업에 사용할 options 개체의 기본 구조를 설명합니다.
RequestPolicy	요청 정책의 기본 구조입니다.
RequestPolicyOptionsLike	RequestPolicy를 만들 때 사용할 수 있는 선택적 속성입니다.
RequestPrepareOptions	나가는 HTTP 요청을 준비하는 옵션입니다.
RestResponse	REST 호출에 대한 평면화된 응답입니다. 기본 HttpOperationResponse와 , parsedHeaders등의 병합된 속성을 parsedBody포함합니다.
RetryOptions	실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.
SequenceMapper	배열을 설명하는 매퍼입니다.
SequenceMapperType	매핑된 값 시퀀스를 구문 분석하는 방법을 설명하는 매퍼를 빌드하는 데 도움이 됩니다.
SerializerOptions	xml 파서 및 작성기의 동작을 제어하는 옵션입니다.
ServiceCallback
ServiceClientCredentials	나가는 요청에 서명할 메서드(예: 헤더 설정)를 사용하여 개체 또는 클래스 signRequest 를 Authorization 나타냅니다.
ServiceClientOptions	클라이언트를 만드는 동안 제공할 옵션입니다.
SimpleMapperType	간단한 매퍼의 형식입니다.
TokenCredential	인증 토큰을 제공할 수 있는 자격 증명을 나타냅니다.
TracingPolicyOptions	추적 정책을 사용자 지정하는 옵션입니다.
UrlParameterValue	URL 매개 변수 값을 나타내는 인터페이스입니다.
UserAgentOptions	나가는 요청에 사용자 에이전트 세부 정보를 추가하는 옵션입니다.
WebResourceLike	원격 서버에 대한 HTTP 요청에 대한 설명입니다.

형식 별칭

Authenticator	챌린지를 수신하고 문자열 토큰으로 프라미스를 해결하는 함수입니다.
CommonRequestInfo	를 호출할 때 사용되는 문자열 URL입니다 fetch().
CommonRequestInit	나가는 HTTP 요청에 대한 정보를 포함하는 개체입니다.
CommonResponse	들어오는 HTTP 응답에 대한 정보를 포함하는 개체입니다.
HttpMethods	지원되는 HTTP 메서드 목록입니다.
HttpRequestBody	가능한 HTTP 요청 본문 유형
Mapper	매퍼는 라이브러리에 사용되는 데이터 모델의 정의입니다. 이러한 데이터 모델은 응답 또는 매개 변수의 작업 또는 클라이언트 정의에 속합니다.
MapperType	매퍼의 형식입니다. 알려진 매퍼를 포함합니다.
ParameterPath	지정된 개체 데이터 원본의 특정 속성에 액세스하는 방법을 설명하는 경로입니다. 단일 속성 이름, 중첩된 속성 이름을 나타내는 배열 또는 복잡한 개체 값의 경우 경로가 있는 여러 명명된 속성 집합일 수 있습니다.
ProxyOptions	나중에 사용할 ProxySettings의 별칭입니다.
RawHttpHeaders	단순 JSON 개체로 표현되는 HttpHeaders 컬렉션입니다.
RequestPolicyFactory	제공된 nextPolicy를 사용하는 요청당 새 RequestPolicy를 만듭니다.
TelemetryInfo	원격 분석 정보입니다. User-Agent 문자열 내에 포함할 키/값 쌍입니다.
TransferProgressEvent	업로드 또는 다운로드 진행률에 대한 응답으로 발생합니다.

열거형

HttpPipelineLogLevel	HttpPipelineLogger와 함께 사용할 수 있는 다양한 수준의 로그입니다.
QueryCollectionFormat	쿼리 매개 변수 값에 대해 값 배열을 함께 조인하는 데 사용할 형식입니다.
RetryMode	재시도 모드 유형에 대해 설명합니다. 현재 지수만 지원합니다.

함수

applyMixins(unknown, any[])	sourceCtors의 프로토타입에 있는 속성을 targetCtor의 프로토타입에 적용합니다.
bearerTokenAuthenticationPolicy(TokenCredential, string | string[])	요청 Authorization 의 헤더에 전달자 토큰을 적용하는 RequestPolicy에 대한 새 팩터리를 만듭니다.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	지정된 옵션을 기반으로 HTTP 파이프라인을 만듭니다.
delay(number, DelayOptions)	timeInMs 밀리초 후에 프라미스를 확인하는 setTimeout에 대한 래퍼입니다.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	HTTP 파이프라인을 통과할 때 HTTP 요청 본문을 직렬화하는 새 serialization RequestPolicyCreator를 만듭니다.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	JSON 또는 XML로 구문 분석할 특정 콘텐츠 형식 집합이 지정된 경우 는 HTTP 응답을 사용하여 요청의 OperationSpec에 정의된 결과 개체를 생성합니다.
disableResponseDecompressionPolicy()	인스턴스를 만드는 데 사용할 수 있는 요청 정책 팩터리를 반환합니다 <xref:DisableResponseDecompressionPolicy>.
encodeUri(string)	URI를 인코딩합니다.
executePromisesSequentially(any[], unknown)	약속의 배열을 순차적으로 실행합니다. 이 메서드의 영감은 다음과 같습니다 https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. 약속에 멋진 블로그!
exponentialRetryPolicy(number, number, number)	최대 재시도 시간 간격이 지정된 동안 구성된 만큼 요청을 여러 번 다시 시도하는 정책으로, 각 재시도는 마지막 시간보다 더 오래 대기합니다.
flattenResponse(HttpOperationResponse, undefined | OperationResponse)	HttpOperationResponse를 정규화된 HTTP 응답 개체(RestResponse)로 구문 분석합니다.
generateClientRequestIdPolicy(string)	나가는 요청에 고유한 요청 ID를 할당하는 정책을 만듭니다.
generateUuid()	생성된 UUID
getDefaultProxySettings(string)	프록시 서버의 지정된 URL을 로 ProxySettings 변환하거나 전달되지 않은 경우 현재 환경에서 검색 ProxySettings 을 시도합니다.
getDefaultUserAgentValue()	사용자 에이전트를 생성하는 기본 방법입니다. 이 패키지의 정적 정보와 런타임에서 사용할 수 있는 시스템 정보를 사용합니다.
isDuration(string)	지정된 문자열이 ISO 8601 형식인지 여부를 나타냅니다.
isTokenCredential(unknown)	개체를 테스트하여 TokenCredential을 구현하는지 여부를 확인합니다.
isValidUuid(string)	지정된 uuid를 문자열로 유효성을 검사합니다.
keepAlivePolicy(KeepAliveOptions)	향후 요청에서 HTTP 연결이 유지 관리되는지 여부를 제어하는 정책을 만듭니다.
logPolicy(LogPolicyOptions)	나가는 요청 및 들어오는 응답에 대한 정보를 기록하는 정책을 만듭니다.
operationOptionsToRequestOptionsBase<T>(T)	OperationOptions를 RequestOptionsBase로 변환합니다.
parseXML(string, SerializerOptions)	지정된 XML 문자열을 JSON으로 변환
promiseToCallback(Promise<any>)	Promise를 콜백으로 변환합니다.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Promise를 서비스 콜백으로 변환합니다.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	모든 요청에 프록시 설정을 적용할 수 있는 정책입니다. 정적 설정을 전달하지 않으면 HTTPS_PROXY 또는 HTTP_PROXY 환경 변수에서 검색됩니다.
redirectPolicy(number)	"location" 헤더와 300~307 사이의 상태 코드를 사용하여 응답이 도착하는 경우 요청을 새 대상으로 반복하는 리디렉션 정책을 만듭니다.
serializeObject(unknown)	이진 정보를 포함할 수 있는 개체를 일반 개체, 배열 또는 문자열로 직렬화하는 유틸리티 함수입니다.
signingPolicy(ServiceClientCredentials)	제공 authenticationProvider된 의 signRequest 메서드를 호출하여 나가는 요청에 서명하는 정책을 만듭니다.
stringifyXML(unknown, SerializerOptions)	지정된 JSON 개체를 XML 문자열로 변환
stripRequest(WebResourceLike)	권한 부여 헤더를 포함하지 않는 Http 요청의 제거된 버전을 반환합니다.
stripResponse(HttpOperationResponse)	본문, 헤더 및 상태만 포함하는 제거된 버전의 Http Response를 반환합니다.
systemErrorRetryPolicy(number, number, number, number)	"ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" 또는 "ENOENT" 코드로 식별되는 시스템 오류가 있을 때 다시 시도되는 정책입니다.
throttlingRetryPolicy()	응답이 제한 이유로 인해 요청이 실패했음을 나타내는 경우 요청을 다시 보내는 정책을 만듭니다. 예를 들어 응답에 헤더가 Retry-After 포함된 경우 해당 헤더의 값에 따라 요청을 다시 전송합니다. 자세한 내용은 , 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
tracingPolicy(TracingPolicyOptions)	나가는 요청을 추적 범위로 래핑하는 정책을 만듭니다.
userAgentPolicy(TelemetryInfo)	지정된 TelemetryInfo를 기반으로 나가는 요청에 사용자 에이전트 헤더를 추가하는 정책을 반환합니다.

함수 세부 정보

applyMixins(unknown, any[])

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

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

매개 변수

targetCtorParam

unknown

sourceCtors

any[]

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

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

요청 Authorization 의 헤더에 전달자 토큰을 적용하는 RequestPolicy에 대한 새 팩터리를 만듭니다.

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

매개 변수

credential

TokenCredential

전달자 토큰을 제공할 수 있는 TokenCredential 구현입니다.

scopes

string | string[]

전달자 토큰이 적용되는 범위입니다.

반환

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

지정된 옵션을 기반으로 HTTP 파이프라인을 만듭니다.

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

매개 변수

pipelineOptions

InternalPipelineOptions

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

authPolicyFactory

RequestPolicyFactory

서명 요청에 사용할 선택적 인증 정책 팩터리입니다.

반환

ServiceClientOptions

새 ServiceClient를 만들기 위해 전달할 수 있는 옵션 집합입니다.

delay(number, DelayOptions)

timeInMs 밀리초 후에 프라미스를 확인하는 setTimeout에 대한 래퍼입니다.

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

매개 변수

timeInMs

number

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

options

DelayOptions

지연 옵션 - 현재 중단 옵션

반환

Promise<void>

timeInMs 이후에 해결되는 Promise

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

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

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

매개 변수

deserializationContentTypes

DeserializationContentTypes

parsingOptions

SerializerOptions

반환

RequestPolicyFactory

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

JSON 또는 XML로 구문 분석할 특정 콘텐츠 형식 집합이 지정된 경우 는 HTTP 응답을 사용하여 요청의 OperationSpec에 정의된 결과 개체를 생성합니다.

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

매개 변수

jsonContentTypes

string[]

본문을 JSON으로 구문 분석하기 위한 응답 콘텐츠 형식입니다.

xmlContentTypes

string[]

본문을 XML로 구문 분석하기 위한 응답 콘텐츠 형식입니다.

response

HttpOperationResponse

파이프라인의 HTTP 응답입니다.

options

SerializerOptions

직렬 변환기에 대한 옵션이며, 주로 필요한 경우 XML 파서 구성을 위한 옵션입니다.

반환

Promise<HttpOperationResponse>

ServiceClient에서 반환할 수 있는 구문 분석된 HttpOperationResponse 개체입니다.

disableResponseDecompressionPolicy()

인스턴스를 만드는 데 사용할 수 있는 요청 정책 팩터리를 반환합니다 <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

반환

RequestPolicyFactory

encodeUri(string)

URI를 인코딩합니다.

function encodeUri(uri: string): string

매개 변수

uri

string

인코딩할 URI입니다.

반환

string

인코딩된 URI입니다.

executePromisesSequentially(any[], unknown)

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

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

매개 변수

promiseFactories

any[]

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

kickstart

unknown

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

반환

Promise<any>

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

exponentialRetryPolicy(number, number, number)

최대 재시도 시간 간격이 지정된 동안 구성된 만큼 요청을 여러 번 다시 시도하는 정책으로, 각 재시도는 마지막 시간보다 더 오래 대기합니다.

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

매개 변수

retryCount

number

최대 다시 시도 횟수:

retryInterval

number

재시도 사이의 기본 시간입니다.

maxRetryInterval

number

재시도 사이에 대기할 최대 시간입니다.

반환

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

HttpOperationResponse를 정규화된 HTTP 응답 개체(RestResponse)로 구문 분석합니다.

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

매개 변수

_response

HttpOperationResponse

http 응답에 대한 래퍼 개체입니다.

responseSpec

undefined | OperationResponse

응답 속성을 구문 분석하는 방법에 대한 매퍼입니다.

반환

RestResponse

• 정규화된 응답 개체입니다.

generateClientRequestIdPolicy(string)

나가는 요청에 고유한 요청 ID를 할당하는 정책을 만듭니다.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

매개 변수

requestIdHeaderName

string

요청에 고유 ID를 할당할 때 사용할 헤더의 이름입니다.

반환

RequestPolicyFactory

generateUuid()

생성된 UUID

function generateUuid(): string

반환

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

프록시 서버의 지정된 URL을 로 ProxySettings 변환하거나 전달되지 않은 경우 현재 환경에서 검색 ProxySettings 을 시도합니다.

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

매개 변수

proxyUrl

string

프록시의 URL

반환

ProxySettings | undefined

기본 프록시 설정 또는 정의되지 않은 설정입니다.

getDefaultUserAgentValue()

사용자 에이전트를 생성하는 기본 방법입니다. 이 패키지의 정적 정보와 런타임에서 사용할 수 있는 시스템 정보를 사용합니다.

function getDefaultUserAgentValue(): string

반환

string

isDuration(string)

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

function isDuration(value: string): boolean

매개 변수

value

string

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

반환

boolean

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

isTokenCredential(unknown)

개체를 테스트하여 TokenCredential을 구현하는지 여부를 확인합니다.

function isTokenCredential(credential: unknown): credential

매개 변수

credential

unknown

테스트할 가정된 TokenCredential입니다.

반환

credential

isValidUuid(string)

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

function isValidUuid(uuid: string): boolean

매개 변수

uuid

string

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

반환

boolean

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

keepAlivePolicy(KeepAliveOptions)

향후 요청에서 HTTP 연결이 유지 관리되는지 여부를 제어하는 정책을 만듭니다.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

매개 변수

keepAliveOptions

KeepAliveOptions

활성 옵션을 유지합니다. 기본적으로 HTTP 연결은 향후 요청에 대해 유지 관리됩니다.

반환

RequestPolicyFactory

의 인스턴스 <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

나가는 요청 및 들어오는 응답에 대한 정보를 기록하는 정책을 만듭니다.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

매개 변수

loggingOptions

LogPolicyOptions

로깅 옵션.

반환

RequestPolicyFactory

의 인스턴스 <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

OperationOptions를 RequestOptionsBase로 변환합니다.

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

매개 변수

opts

T

RequestOptionsBase로 변환할 OperationOptions 개체

반환

RequestOptionsBase

parseXML(string, SerializerOptions)

지정된 XML 문자열을 JSON으로 변환

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

매개 변수

str

string

JSON으로 구문 분석할 XML 콘텐츠가 포함된 문자열

opts

SerializerOptions

지정된 xml 문자열의 구문 분석을 제어하는 옵션

반환

Promise<any>

promiseToCallback(Promise<any>)

경고

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

generated code should instead depend on responseToBody

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

function promiseToCallback(promise: Promise<any>): (cb: Function) => void

매개 변수

promise

Promise<any>

콜백으로 변환할 약속

반환

(cb: Function) => void

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

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

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

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void

매개 변수

promise

Promise<HttpOperationResponse>

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

반환

(cb: ServiceCallback<T>) => void

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

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

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

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

매개 변수

proxySettings

ProxySettings

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

options

{ customNoProxyList?: string[] }

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

반환

RequestPolicyFactory

redirectPolicy(number)

"location" 헤더와 300~307 사이의 상태 코드를 사용하여 응답이 도착하는 경우 요청을 새 대상으로 반복하는 리디렉션 정책을 만듭니다.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

매개 변수

maximumRetries

number

따라야 할 최대 리디렉션 수입니다.

반환

RequestPolicyFactory

의 인스턴스 <xref:RedirectPolicy>

serializeObject(unknown)

이진 정보를 포함할 수 있는 개체를 일반 개체, 배열 또는 문자열로 직렬화하는 유틸리티 함수입니다.

function serializeObject(toSerialize: unknown): any

매개 변수

toSerialize

unknown

반환

any

signingPolicy(ServiceClientCredentials)

제공 authenticationProvider된 의 signRequest 메서드를 호출하여 나가는 요청에 서명하는 정책을 만듭니다.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

매개 변수

authenticationProvider

ServiceClientCredentials

인증 공급자입니다.

반환

RequestPolicyFactory

<xref:SigningPolicy>인스턴스

stringifyXML(unknown, SerializerOptions)

지정된 JSON 개체를 XML 문자열로 변환

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

매개 변수

obj

unknown

XML 문자열로 변환할 JSON 개체

opts

SerializerOptions

지정된 JSON 개체의 구문 분석을 제어하는 옵션

반환

string

stripRequest(WebResourceLike)

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

function stripRequest(request: WebResourceLike): WebResourceLike

매개 변수

request

WebResourceLike

Http Request 개체

반환

WebResourceLike

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

stripResponse(HttpOperationResponse)

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

function stripResponse(response: HttpOperationResponse): any

매개 변수

response

HttpOperationResponse

Http 응답

반환

any

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

systemErrorRetryPolicy(number, number, number, number)

"ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" 또는 "ENOENT" 코드로 식별되는 시스템 오류가 있을 때 다시 시도되는 정책입니다.

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

매개 변수

retryCount

number

최대 다시 시도 횟수:

retryInterval

number

클라이언트 재시도 간격(밀리초)입니다.

minRetryInterval

number

최소 재시도 간격(밀리초)입니다.

maxRetryInterval

number

최대 재시도 간격(밀리초)입니다.

반환

RequestPolicyFactory

의 인스턴스 <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

응답이 제한 이유로 인해 요청이 실패했음을 나타내는 경우 요청을 다시 보내는 정책을 만듭니다. 예를 들어 응답에 헤더가 Retry-After 포함된 경우 해당 헤더의 값에 따라 요청을 다시 전송합니다.

자세한 내용은 , 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

function throttlingRetryPolicy(): RequestPolicyFactory

반환

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

나가는 요청을 추적 범위로 래핑하는 정책을 만듭니다.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

매개 변수

tracingOptions

TracingPolicyOptions

추적 옵션.

반환

RequestPolicyFactory

<xref:TracingPolicy> 클래스의 인스턴스입니다.

userAgentPolicy(TelemetryInfo)

지정된 TelemetryInfo를 기반으로 나가는 요청에 사용자 에이전트 헤더를 추가하는 정책을 반환합니다.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

매개 변수

userAgentData

TelemetryInfo

원격 분석 정보입니다.

반환

RequestPolicyFactory

새 <xref:UserAgentPolicy>입니다.