@azure/ms-rest-js package

Reference

Třídy

ApiKeyCredentials	Ověřuje se ve službě pomocí klíče rozhraní API.
AzureIdentityCredentialAdapter	Tato třída poskytuje jednoduché rozšíření pro použití <xref:TokenCredential> z `@azure/identity` knihovny na použití se staršími sadami AZURE SDK, které pro ověřování přijímají řadu přihlašovacích údajů ServiceClientCredentials .
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials	Ověřuje se ve službě pomocí klíče rozhraní API.
HttpHeaders	Kolekce párů klíč/hodnota hlavičky HTTP.
RequestPolicyOptions	Volitelné vlastnosti, které lze použít při vytváření Zásady požadavku.
RestError
Serializer
ServiceClient
TokenCredentials	Objekt přihlašovacích údajů, který k ověření používá řetězec tokenu a schéma vytváření.
TopicCredentials	Ověřuje se ve službě pomocí klíče rozhraní API.
URLBuilder	Třída, která se stará o vytváření, úpravy a parsování adres URL.
URLQuery	Třída, která zpracovává část dotazu URLBuilder.
WebResource	Vytvoří nový objekt WebResource. Tato třída poskytuje abstrakci volání REST tím, že je nezávislá na knihovně nebo implementaci a zabalení potřebných vlastností k zahájení požadavku.

Rozhraní

AbortSignalLike	Umožňuje přerušení požadavku při spuštění události "abort". Kompatibilní s integrovaným prohlížečem AbortSignal a běžnými polyfilly.
AgentSettings	Agenti HTTP a HTTPS (jenom Node.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes	Typy obsahu, které budou indikovat, že odpověď na operaci by měla být deserializována určitým způsobem.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient	Rozhraní, které může odesílat httpRequests a přijímat slíbené HttpResponses.
HttpHeader	Jednotlivá hlavička v kolekci HttpHeaders.
HttpHeadersLike	Kolekce párů klíč/hodnota hlavičky HTTP.
HttpOperationResponse	Objekt Wrapper pro požadavek HTTP a odpověď. Deserializovaný objekt je uložen ve `parsedBody` vlastnosti při přijetí textu odpovědi ve formátu JSON nebo XML.
HttpPipelineLogger	Protokolovací nástroj, který lze přidat do HttpPipeline. To umožňuje každé politice requestpolicy protokolovat zprávy, které se dají použít pro účely ladění.
HttpResponse	Vlastnosti odpovědi HTTP, která bude vždy k dispozici.
MapperConstraints
OperationArguments	Kolekce vlastností, které platí pro jedno vyvolání operace.
OperationParameter	Společné rozhraní, které rozšiřuje všechny parametry operace.
OperationQueryParameter	Parametr pro operaci, který se přidá jako parametr dotazu do požadavku HTTP operace.
OperationResponse	OperaceResponse, která může být vrácena z požadavku operace pro jeden stavový kód.
OperationSpec	Specifikace, která definuje operaci.
OperationURLParameter	Parametr pro operaci, který bude nahrazen adresou URL požadavku operace.
ParameterValue	Hodnota parametru zadaná pro parametry cesty nebo dotazu v části RequestPrepareOptions
PolymorphicDiscriminator
ProxySettings	Nastavení proxy serveru HTTP (jenom Node.js)
RedirectOptions	Možnosti zpracování odpovědí přesměrování
RequestOptionsBase	Popisuje základní strukturu objektu options, který se použije v každé operaci.
RequestPolicy
RequestPolicyOptionsLike	Volitelné vlastnosti, které lze použít při vytváření Zásady požadavku.
RequestPrepareOptions
RestResponse	Zploštělé odpovědi na volání REST. Obsahuje základní httpOperationResponse a sloučené vlastnosti parsedBody, parsedHeaders atd.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions	Možnosti, které se mají poskytnout při vytváření klienta.
SimpleMapperType
TokenResponse	TokenResponse je definován v `@azure/ms-rest-nodeauth` a zkopíruje se sem, aby se nepřidá zbytečná závislost.
UrlParameterValue
WebResourceLike	Abstrakce volání REST.

Aliasy typu

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders	Kolekce HttpHeaders reprezentovaná jako jednoduchý objekt JSON.
RequestPolicyFactory	Vytvoří novou zásadu RequestPolicy pro každou žádost, která používá zadanou zásadu nextPolicy.
TelemetryInfo
TransferProgressEvent	Aktivované v reakci na průběh nahrávání nebo stahování.

Výčty

HttpPipelineLogLevel	Různé úrovně protokolů, které lze použít s HttpPipelineLogger.
QueryCollectionFormat	Formát, který se použije ke spojení pole hodnot pro hodnotu parametru dotazu.

Funkce

agentPolicy(AgentSettings)
applyMixins(any, any[])	Použije vlastnosti prototypu sourceCtors na prototyp targetCtoru.
delay<T>(number, T)	Obálka pro setTimeout, která vyřeší příslib po t milisekundách.
deserializationPolicy(DeserializationContentTypes)	Vytvořte novou serializaci RequestPolicyCreator, která bude serializovat těla požadavků HTTP, jak procházejí kanálem HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)	Kóduje identifikátor URI.
executePromisesSequentially(any[], any)	Provede postupně pole slibů. Inspirace touto metodou je zde: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Úžasný blog o slibech!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined \| OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()	Vygenerované UUID
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)	Určuje, jestli je daný řetězec ve formátu ISO 8601.
isValidUuid(string)	Ověří zadaný uuid jako řetězec.
logPolicy(any)
promiseToCallback(Promise<any>)	Převede příslib na zpětné volání.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Převede příslib na zpětné volání služby.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)	Vrátí odstraněnou verzi požadavku HTTP, která neobsahuje hlavičku Authorization.
stripResponse(HttpOperationResponse)	Vrátí odstraněnou verzi odpovědi HTTP, která obsahuje pouze tělo, hlavičky a stav.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Podrobnosti funkce

agentPolicy(AgentSettings)

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parametry

agentSettings: AgentSettings

Návraty

RequestPolicyFactory

applyMixins(any, any[])

Použije vlastnosti prototypu sourceCtors na prototyp targetCtoru.

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

Parametry

targetCtor: any

Cílový objekt, na který je třeba použít vlastnosti.

sourceCtors: any[]

Pole zdrojových objektů, ze kterých je třeba převést vlastnosti.

delay<T>(number, T)

Obálka pro setTimeout, která vyřeší příslib po t milisekundách.

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

Parametry

t: number

Počet milisekund, které se mají zpozdit.

value: T

Hodnota, se kterou se má přeložit po vypršení časového limitu t milisekund.

Návraty

Promise<T>

Vyřešený slib

deserializationPolicy(DeserializationContentTypes)

Vytvořte novou serializaci RequestPolicyCreator, která bude serializovat těla požadavků HTTP, jak procházejí kanálem HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parametry

deserializationContentTypes: DeserializationContentTypes

Návraty

RequestPolicyFactory

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

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

Parametry

jsonContentTypes: string[]

xmlContentTypes: string[]

response: HttpOperationResponse

Návraty

Promise<HttpOperationResponse>

encodeUri(string)

Kóduje identifikátor URI.

function encodeUri(uri: string): string

Parametry

uri: string

Identifikátor URI, který se má zakódovat.

Návraty

string

Kódovaný identifikátor URI.

executePromisesSequentially(any[], any)

Provede postupně pole slibů. Inspirace touto metodou je zde: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Úžasný blog o slibech!

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

Parametry

promiseFactories: any[]

Pole objektů pro vytváření slibů (funkce, která vrací příslib)

kickstart: any

Vstup do prvního slibu, který slouží k nastartu řetězu příslibů. Pokud není zadaný, řetězec příslibů začíná nedefinovaným.

Návraty

Promise<any>

Řetěz vyřešených nebo odmítnutých slibů

exponentialRetryPolicy(number, number, number, number)

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

Parametry

retryCount: number

retryInterval: number

minRetryInterval: number

maxRetryInterval: number

Návraty

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

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

Parametry

_response: HttpOperationResponse

responseSpec: undefined | OperationResponse

Návraty

RestResponse

generateClientRequestIdPolicy(string)

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parametry

requestIdHeaderName: string

Návraty

RequestPolicyFactory

generateUuid()

Vygenerované UUID

function generateUuid(): string

Návraty

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

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

Parametry

proxyUrl: string

Návraty

ProxySettings | undefined

getDefaultUserAgentValue()

function getDefaultUserAgentValue(): string

Návraty

string

isDuration(string)

Určuje, jestli je daný řetězec ve formátu ISO 8601.

function isDuration(value: string): boolean

Parametry

value: string

Hodnota, která má být ověřena pro formát doby trvání ISO 8601.

Návraty

boolean

true pokud je platný, false v opačném případě.

isValidUuid(string)

Ověří zadaný uuid jako řetězec.

function isValidUuid(uuid: string): boolean

Parametry

uuid: string

Uuid jako řetězec, který je potřeba ověřit

Návraty

boolean

True, pokud je uuid platný; v opačném případě false.

logPolicy(any)

function logPolicy(logger?: any): RequestPolicyFactory

Parametry

logger: any

Návraty

RequestPolicyFactory

promiseToCallback(Promise<any>)

Upozornění

Toto rozhraní API je teď zastaralé.

generated code should instead depend on responseToBody

Převede příslib na zpětné volání.

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

Parametry

promise: Promise<any>

Příslib, který se má převést na zpětné volání

Návraty

Function

Funkce, která přebírá zpětné volání (cb: Function): void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Převede příslib na zpětné volání služby.

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

Parametry

promise: Promise<HttpOperationResponse>

Příslib httpOperationResponse, který se má převést na zpětné volání služby

Návraty

Function

Funkce, která přebírá zpětné volání služby (cb: ServiceCallback): void

proxyPolicy(ProxySettings)

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parametry

proxySettings: ProxySettings

Návraty

RequestPolicyFactory

redirectPolicy(number)

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parametry

maximumRetries: number

Návraty

RequestPolicyFactory

serializeObject(any)

function serializeObject(toSerialize: any): any

Parametry

toSerialize: any

Návraty

any

signingPolicy(ServiceClientCredentials)

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametry

authenticationProvider: ServiceClientCredentials

Návraty

RequestPolicyFactory

stripRequest(WebResourceLike)

Vrátí odstraněnou verzi požadavku HTTP, která neobsahuje hlavičku Authorization.

function stripRequest(request: WebResourceLike): WebResourceLike

Parametry

request: WebResourceLike

Objekt požadavku HTTP

Návraty

WebResourceLike

Odstraněná verze požadavku HTTP.

stripResponse(HttpOperationResponse)

Vrátí odstraněnou verzi odpovědi HTTP, která obsahuje pouze tělo, hlavičky a stav.

function stripResponse(response: HttpOperationResponse): any

Parametry

response: HttpOperationResponse

Odpověď HTTP

Návraty

any

Odstraněná verze odpovědi HTTP.

systemErrorRetryPolicy(number, number, number, number)

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

Parametry

retryCount: number

retryInterval: number

minRetryInterval: number

maxRetryInterval: number

Návraty

RequestPolicyFactory

throttlingRetryPolicy(number)

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parametry

maxRetries: number

Návraty

RequestPolicyFactory

userAgentPolicy(TelemetryInfo)

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametry

userAgentData: TelemetryInfo

Návraty

RequestPolicyFactory