Share via

@azure/ms-rest-js package

  • Referens

Klasser

ApiKeyCredentials

Autentiserar till en tjänst med hjälp av en API-nyckel.
AzureIdentityCredentialAdapter

Den här klassen ger ett enkelt tillägg som du kan använda <xref:TokenCredential> från @azure/identity biblioteket för att använda med äldre Azure-SDK:er som accepterar ServiceClientCredentials-serien med autentiseringsuppgifter för autentisering.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials

Autentiserar till en tjänst med hjälp av en API-nyckel.
HttpHeaders

En samling http-huvudnyckel/värde-par.
RequestPolicyOptions

Valfria egenskaper som kan användas när du skapar en RequestPolicy.
RestError
Serializer
ServiceClient
TokenCredentials

Ett autentiseringsobjekt som använder en tokensträng och ett redigeringsschema för att autentisera.
TopicCredentials

Autentiserar till en tjänst med hjälp av en API-nyckel.
URLBuilder

En klass som hanterar skapande, ändring och parsning av URL:er.
URLQuery

En klass som hanterar frågedelen i en URLBuilder.
WebResource

Skapar ett nytt WebResource-objekt.

Den här klassen ger en abstraktion över ett REST-anrop genom att vara biblioteks-/implementeringsagnostisk och omsluta nödvändiga egenskaper för att initiera en begäran.

Gränssnitt

AbortSignalLike

Tillåter att begäran avbryts vid avfyrning av "abort"-händelsen. Kompatibel med webbläsarens inbyggda AbortSignal och vanliga polyfiller.
AgentSettings

HTTP- och HTTPS-agenter (endast Node.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes

De innehållstyper som anger att ett åtgärdssvar ska deserialiseras på ett visst sätt.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient

Ett gränssnitt som kan skicka HttpRequests och ta emot utlovade HttpResponses.
HttpHeader

En enskild rubrik i en HttpHeaders-samling.
HttpHeadersLike

En samling http-huvudnyckel/värde-par.
HttpOperationResponse

Wrapper-objekt för http-begäran och svar. Deserialiserat objekt lagras i parsedBody egenskapen när svarstexten tas emot i JSON eller XML.
HttpPipelineLogger

En logger som kan läggas till i en HttpPipeline. Detta gör att varje RequestPolicy kan logga meddelanden som kan användas för felsökning.
HttpResponse

Egenskaperna för ett HTTP-svar som alltid kommer att finnas.
MapperConstraints
OperationArguments

En samling egenskaper som gäller för ett enda anrop av en åtgärd.
OperationParameter

Ett vanligt gränssnitt som alla åtgärdsparameter utökar.
OperationQueryParameter

En parameter för en åtgärd som ska läggas till som en frågeparameter i åtgärdens HTTP-begäran.
OperationResponse

En OperationResponse som kan returneras från en åtgärdsbegäran för en enda statuskod.
OperationSpec

En specifikation som definierar en åtgärd.
OperationURLParameter

En parameter för en åtgärd som ska ersättas med åtgärdens url för begäran.
ParameterValue

Parametervärdet som anges för sökvägs- eller frågeparametrar i RequestPrepareOptions
PolymorphicDiscriminator
ProxySettings

HTTP-proxyinställningar (endast Node.js)
RedirectOptions

Alternativ för hur omdirigeringssvar hanteras.
RequestOptionsBase

Beskriver basstrukturen för alternativobjektet som ska användas i varje åtgärd.
RequestPolicy
RequestPolicyOptionsLike

Valfria egenskaper som kan användas när du skapar en RequestPolicy.
RequestPrepareOptions
RestResponse

Det utplattade svaret på ett REST-anrop. Innehåller den underliggande HttpOperationResponse samt de sammanfogade egenskaperna för parsedBody, parsedHeaders osv.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions

Alternativ som ska anges när klienten skapas.
SimpleMapperType
TokenResponse

TokenResponse definieras i @azure/ms-rest-nodeauth och kopieras här för att inte lägga till ett onödigt beroende.
UrlParameterValue
WebResourceLike

En abstraktion över ett REST-anrop.

Typalias

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders

En HttpHeaders-samling som representeras som ett enkelt JSON-objekt.
RequestPolicyFactory

Skapar en ny RequestPolicy per begäran som använder den angivna nextPolicy.
TelemetryInfo
TransferProgressEvent

Utlöstes som svar på överförings- eller nedladdningsstatus.

Uppräkningar

HttpPipelineLogLevel

De olika nivåerna av loggar som kan användas med HttpPipelineLogger.
QueryCollectionFormat

Det format som ska användas för att koppla samman en matris med värden för ett frågeparametervärde.

Funktioner

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

Tillämpar egenskaperna på prototypen av sourceCtors på prototypen av targetCtor
delay<T>(number, T)

En omslutning för setTimeout som löser ett löfte efter t millisekunder.
deserializationPolicy(DeserializationContentTypes)

Skapa en ny serialisering RequestPolicyCreator som serialiserade HTTP-begärandeorgan när de passerar genom HTTP-pipelinen.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)

Kodar en URI.
executePromisesSequentially(any[], any)

Kör en matris med löften sekventiellt. Inspirationen till den här metoden finns här: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. En fantastisk blogg om löften!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()

Genererad UUID
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)

Anger om den angivna strängen är i ISO 8601-format.
isValidUuid(string)

Validerar angiven uuid som en sträng
logPolicy(any)
promiseToCallback(Promise<any>)

Konverterar ett löfte till ett återanrop.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Konverterar ett löfte till ett tjänståteranrop.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)

Returnerar en borttagen version av Http-begäran som inte innehåller auktoriseringshuvudet.
stripResponse(HttpOperationResponse)

Returnerar en borttagen version av Http-svaret som endast innehåller brödtext, rubriker och status.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Funktionsinformation

agentPolicy(AgentSettings) 

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parametrar

agentSettings
AgentSettings

Returer

RequestPolicyFactory

applyMixins(any, any[])

Tillämpar egenskaperna på prototypen av sourceCtors på prototypen av targetCtor

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

Parametrar

targetCtor

any

Målobjektet som egenskaperna måste tillämpas på.

sourceCtors

any[]

En matris med källobjekt som egenskaperna måste hämtas från.

delay<T>(number, T)

En omslutning för setTimeout som löser ett löfte efter t millisekunder.

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

Parametrar

t

number

Antalet millisekunder som ska fördröjas.

value

T

Värdet som ska matchas med efter en timeout på t millisekunder.

Returer

Promise<T>

Löst löfte

deserializationPolicy(DeserializationContentTypes)

Skapa en ny serialisering RequestPolicyCreator som serialiserade HTTP-begärandeorgan när de passerar genom HTTP-pipelinen.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parametrar

deserializationContentTypes
DeserializationContentTypes

Returer

RequestPolicyFactory

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

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

Parametrar

jsonContentTypes

string[]

xmlContentTypes

string[]

response
HttpOperationResponse

Returer

Promise<HttpOperationResponse>

encodeUri(string)

Kodar en URI.

function encodeUri(uri: string): string

Parametrar

uri

string

Den URI som ska kodas.

Returer

string

Den kodade URI:n.

executePromisesSequentially(any[], any)

Kör en matris med löften sekventiellt. Inspirationen till den här metoden finns här: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. En fantastisk blogg om löften!

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

Parametrar

promiseFactories

any[]

En matris med löftesfabriker (en funktion som returnerar ett löfte)

kickstart

any

Indata till det första löftet som används för att kickstarta löfteskedjan. Om den inte tillhandahålls börjar löfteskedjan med odefinierad.

Returer

Promise<any>

En kedja av lösta eller avvisade löften

exponentialRetryPolicy(number, number, number, number) 

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

Parametrar

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Returer

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse) 

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

Parametrar

_response
HttpOperationResponse
responseSpec

undefined | OperationResponse

Returer

RestResponse

generateClientRequestIdPolicy(string) 

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parametrar

requestIdHeaderName

string

Returer

RequestPolicyFactory

generateUuid()

Genererad UUID

function generateUuid(): string

Returer

string

RFC4122 v4 UUID.

getDefaultProxySettings(string) 

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

Parametrar

proxyUrl

string

Returer

ProxySettings | undefined

getDefaultUserAgentValue() 

function getDefaultUserAgentValue(): string

Returer

string

isDuration(string)

Anger om den angivna strängen är i ISO 8601-format.

function isDuration(value: string): boolean

Parametrar

value

string

Värdet som ska valideras för ISO 8601-varaktighetsformatet.

Returer

boolean

true om det är giltigt, false annars.

isValidUuid(string)

Validerar angiven uuid som en sträng

function isValidUuid(uuid: string): boolean

Parametrar

uuid

string

Uuid som en sträng som måste verifieras

Returer

boolean

Sant om uuid är giltigt; annars falskt.

logPolicy(any) 

function logPolicy(logger?: any): RequestPolicyFactory

Parametrar

logger

any

Returer

RequestPolicyFactory

promiseToCallback(Promise<any>)

Varning

Det här API:et är nu inaktuellt.

generated code should instead depend on responseToBody

Konverterar ett löfte till ett återanrop.

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

Parametrar

promise

Promise<any>

Löftet som ska konverteras till ett återanrop

Returer

Function

En funktion som tar återanropet (cb: Function): void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Konverterar ett löfte till ett tjänståteranrop.

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

Parametrar

promise

Promise<HttpOperationResponse>

Löftet om att HttpOperationResponse ska konverteras till ett återanrop till tjänsten

Returer

Function

En funktion som tar tillbaka tjänstens återanrop (cb: ServiceCallback): void

proxyPolicy(ProxySettings) 

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parametrar

proxySettings
ProxySettings

Returer

RequestPolicyFactory

redirectPolicy(number) 

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parametrar

maximumRetries

number

Returer

RequestPolicyFactory

serializeObject(any) 

function serializeObject(toSerialize: any): any

Parametrar

toSerialize

any

Returer

any

signingPolicy(ServiceClientCredentials) 

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametrar

authenticationProvider
ServiceClientCredentials

Returer

RequestPolicyFactory

stripRequest(WebResourceLike)

Returnerar en borttagen version av Http-begäran som inte innehåller auktoriseringshuvudet.

function stripRequest(request: WebResourceLike): WebResourceLike

Parametrar

request
WebResourceLike

Http-begärandeobjektet

Returer

WebResourceLike

Den borttagna versionen av Http-begäran.

stripResponse(HttpOperationResponse)

Returnerar en borttagen version av Http-svaret som endast innehåller brödtext, rubriker och status.

function stripResponse(response: HttpOperationResponse): any

Parametrar

response
HttpOperationResponse

Http-svaret

Returer

any

Den borttagna versionen av Http-svar.

systemErrorRetryPolicy(number, number, number, number) 

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

Parametrar

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Returer

RequestPolicyFactory

throttlingRetryPolicy(number) 

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parametrar

maxRetries

number

Returer

RequestPolicyFactory

userAgentPolicy(TelemetryInfo) 

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametrar

userAgentData
TelemetryInfo

Returer

RequestPolicyFactory