@azure/ms-rest-js package

Klassen

ApiKeyCredentials	Authentifiziert sich mit einem API-Schlüssel bei einem Dienst.
AzureIdentityCredentialAdapter	Diese Klasse bietet eine einfache Erweiterung, um <xref:TokenCredential> aus @azure/identity Bibliothek für die Verwendung mit älteren Azure-SDKs zu verwenden, die ServiceClientCredentials Familie von Anmeldeinformationen für die Authentifizierung akzeptieren.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials	Authentifiziert sich mit einem API-Schlüssel bei einem Dienst.
HttpHeaders	Eine Sammlung von HTTP-Headerschlüssel-Wert-Paaren.
RequestPolicyOptions	Optionale Eigenschaften, die beim Erstellen einer RequestPolicy verwendet werden können.
RestError
Serializer
ServiceClient
TokenCredentials	Ein Anmeldeinformationsobjekt, das eine Tokenzeichenfolge und ein Autorisierungsschema zur Authentifizierung verwendet.
TopicCredentials	Authentifiziert sich mit einem API-Schlüssel bei einem Dienst.
URLBuilder	Eine Klasse, die das Erstellen, Ändern und Analysieren von URLs behandelt.
URLQuery	Eine Klasse, die den Abfrageteil eines URLBuilders behandelt.
WebResource	Erstellt ein neues WebResource -Objekt. Diese Klasse stellt eine Abstraktion über einen REST-Aufruf bereit, indem sie bibliotheks-/implementierungsagnostisch sind und die erforderlichen Eigenschaften umschließen, um eine Anforderung zu initiieren.

Schnittstellen

AbortSignalLike	Ermöglicht das Abbrechen der Anforderung beim Auslösen des "abort"-Ereignisses. Kompatibel mit dem browser integrierten AbortSignal und gängigen Polyfills.
AgentSettings	HTTP- und HTTPS-Agents ( nurNode.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes	Die Inhaltstypen, die angeben, dass eine Vorgangsantwort auf eine bestimmte Weise deserialisiert werden soll.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient	Eine Schnittstelle, die HttpRequests senden und versprochene HttpResponses empfangen kann.
HttpHeader	Ein einzelner Header in einer HttpHeaders-Auflistung.
HttpHeadersLike	Eine Sammlung von HTTP-Headerschlüssel-Wert-Paaren.
HttpOperationResponse	Wrapperobjekt für HTTP-Anforderung und -Antwort. Das deserialisierte Objekt wird in der eigenschaft parsedBody gespeichert, wenn der Antworttext in JSON oder XML empfangen wird.
HttpPipelineLogger	Ein Logger, der einer HttpPipeline hinzugefügt werden kann. Dadurch kann jede RequestPolicy Nachrichten protokollieren, die für Debuggingzwecke verwendet werden können.
HttpResponse	Die Eigenschaften für eine HTTP-Antwort, die immer vorhanden ist.
MapperConstraints
OperationArguments	Eine Auflistung von Eigenschaften, die auf einen einzelnen Aufruf eines Vorgangs angewendet werden.
OperationParameter	Eine allgemeine Schnittstelle, die alle Operation-Parameter erweitern.
OperationQueryParameter	Ein Parameter für einen Vorgang, der als Abfrageparameter zur HTTP-Anforderung des Vorgangs hinzugefügt wird.
OperationResponse	Eine OperationResponse, die von einer Vorgangsanforderung für einen einzelnen Statuscode zurückgegeben werden kann.
OperationSpec	Eine Spezifikation, die einen Vorgang definiert.
OperationURLParameter	Ein Parameter für einen Vorgang, der in die Anforderungs-URL des Vorgangs ersetzt wird.
ParameterValue	Der parameterwert, der für Pfad- oder Abfrageparameter in RequestPrepareOptions bereitgestellt wird
PolymorphicDiscriminator
ProxySettings	HTTP-Proxyeinstellungen ( nurNode.js)
RedirectOptions	Optionen für die Behandlung von Umleitungsantworten.
RequestOptionsBase	Beschreibt die Basisstruktur des Optionsobjekts, das in jedem Vorgang verwendet wird.
RequestPolicy
RequestPolicyOptionsLike	Optionale Eigenschaften, die beim Erstellen einer RequestPolicy verwendet werden können.
RequestPrepareOptions
RestResponse	Die flache Antwort auf einen REST-Aufruf. Enthält die zugrunde liegenden HttpOperationResponse sowie die zusammengeführten Eigenschaften des parsedBody, parsedHeaders usw.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions	Optionen, die beim Erstellen des Clients bereitgestellt werden sollen.
SimpleMapperType
TokenResponse	TokenResponse wird in @azure/ms-rest-nodeauth definiert und hier kopiert, um keine unnötige Abhängigkeit hinzuzufügen.
UrlParameterValue
WebResourceLike	Eine Abstraktion über einen REST-Aufruf.

Typaliase

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders	Eine HttpHeaders-Auflistung, die als einfaches JSON-Objekt dargestellt wird.
RequestPolicyFactory	Erstellt eine neue RequestPolicy pro Anforderung, die die bereitgestellte nextPolicy verwendet.
TelemetryInfo
TransferProgressEvent	Wird als Reaktion auf den Upload- oder Downloadfortschritt ausgelöst.

Enumerationen

HttpPipelineLogLevel	Die verschiedenen Ebenen von Protokollen, die mit httpPipelineLogger verwendet werden können.
QueryCollectionFormat	Das Format, das verwendet wird, um ein Array von Werten für einen Abfrageparameterwert zu verbinden.

Functions

agentPolicy(AgentSettings)
applyMixins(any, any[])	Wendet die Eigenschaften für den Prototyp von sourceCtors auf den Prototyp von targetCtor an.
delay<T>(number, T)	Ein Wrapper für setTimeout, der eine Zusage nach t Millisekunden aufgelöst.
deserializationPolicy(DeserializationContentTypes)	Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die http-Anforderungstexte serialisiert, während sie über die HTTP-Pipeline übergeben werden.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)	Codiert einen URI.
executePromisesSequentially(any[], any)	Führt ein Array von Zusagen sequenziell aus. Inspiration dieser Methode ist hier: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Ein fantastischer Blog zu Zusagen!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()	Generierte UUID
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)	Gibt an, ob die angegebene Zeichenfolge im ISO 8601-Format vorliegt.
isValidUuid(string)	Überprüft die angegebene uuid als Zeichenfolge.
logPolicy(any)
promiseToCallback(Promise<any>)	Konvertiert eine Zusage in einen Rückruf.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Konvertiert eine Zusage in einen Dienstrückruf.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)	Gibt eine strippede Version der HTTP-Anforderung zurück, die nicht den Autorisierungsheader enthält.
stripResponse(HttpOperationResponse)	Gibt eine gestreifte Version der Http-Antwort zurück, die nur Textkörper, Header und den Status enthält.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Details zur Funktion

agentPolicy(AgentSettings)

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parameter

agentSettings

AgentSettings

Gibt zurück

RequestPolicyFactory

applyMixins(any, any[])

Wendet die Eigenschaften für den Prototyp von sourceCtors auf den Prototyp von targetCtor an.

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

Parameter

targetCtor

any

Das Zielobjekt, auf das die Eigenschaften angewendet werden müssen.

sourceCtors

any[]

Ein Array von Quellobjekten, aus denen die Eigenschaften entnommen werden müssen.

delay<T>(number, T)

Ein Wrapper für setTimeout, der eine Zusage nach t Millisekunden aufgelöst.

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

Parameter

t

number

Die Anzahl der zu verzögernden Millisekunden.

value

T

Der Wert, der nach einem Timeout von t Millisekunden aufgelöst werden soll.

Gibt zurück

Promise<T>

Gelöste Zusage

deserializationPolicy(DeserializationContentTypes)

Erstellen Sie eine neue Serialisierung RequestPolicyCreator, die http-Anforderungstexte serialisiert, während sie über die HTTP-Pipeline übergeben werden.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parameter

deserializationContentTypes

DeserializationContentTypes

Gibt zurück

RequestPolicyFactory

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

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

Parameter

jsonContentTypes

string[]

xmlContentTypes

string[]

response

HttpOperationResponse

Gibt zurück

Promise<HttpOperationResponse>

encodeUri(string)

Codiert einen URI.

function encodeUri(uri: string): string

Parameter

uri

string

Der zu codierenden URI.

Gibt zurück

string

Der codierte URI.

executePromisesSequentially(any[], any)

Führt ein Array von Zusagen sequenziell aus. Inspiration dieser Methode ist hier: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Ein fantastischer Blog zu Zusagen!

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

Parameter

promiseFactories

any[]

Ein Array von Zusagefabriken(Eine Funktion, die eine Zusage zurückgibt)

kickstart

any

Eingabe für die erste Zusage, die verwendet wird, um die Zusagekette zu starten. Wenn nicht angegeben, beginnt die Zusagekette mit undefiniert.

Gibt zurück

Promise<any>

Eine Kette aufgelöster oder abgelehnter Zusagen

exponentialRetryPolicy(number, number, number, number)

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

Parameter

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Gibt zurück

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

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

Parameter

_response

HttpOperationResponse

responseSpec

undefined | OperationResponse

Gibt zurück

RestResponse

generateClientRequestIdPolicy(string)

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parameter

requestIdHeaderName

string

Gibt zurück

RequestPolicyFactory

generateUuid()

Generierte UUID

function generateUuid(): string

Gibt zurück

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

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

Parameter

proxyUrl

string

Gibt zurück

ProxySettings | undefined

getDefaultUserAgentValue()

function getDefaultUserAgentValue(): string

Gibt zurück

string

isDuration(string)

Gibt an, ob die angegebene Zeichenfolge im ISO 8601-Format vorliegt.

function isDuration(value: string): boolean

Parameter

value

string

Der wert, der für das ISO 8601-Dauerformat überprüft werden soll.

Gibt zurück

boolean

andernfalls truefalse.

isValidUuid(string)

Überprüft die angegebene uuid als Zeichenfolge.

function isValidUuid(uuid: string): boolean

Parameter

uuid

string

Die uuid als Zeichenfolge, die überprüft werden muss

Gibt zurück

boolean

True, wenn die uuid gültig ist; andernfalls "false".

logPolicy(any)

function logPolicy(logger?: any): RequestPolicyFactory

Parameter

logger

any

Gibt zurück

RequestPolicyFactory

promiseToCallback(Promise<any>)

Warnung

Diese API ist nun veraltet.

generated code should instead depend on responseToBody

Konvertiert eine Zusage in einen Rückruf.

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

Parameter

promise

Promise<any>

Die zu konvertierende Zusage in einen Rückruf

Gibt zurück

Function

Eine Funktion, die den Rückruf verwendet (cb: Function): void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Konvertiert eine Zusage in einen Dienstrückruf.

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

Parameter

promise

Promise<HttpOperationResponse>

Die Zusage von HttpOperationResponse, die in einen Dienstrückruf konvertiert werden soll

Gibt zurück

Function

Eine Funktion, die den Dienstrückruf verwendet (cb: ServiceCallback): void

proxyPolicy(ProxySettings)

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parameter

proxySettings

ProxySettings

Gibt zurück

RequestPolicyFactory

redirectPolicy(number)

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parameter

maximumRetries

number

Gibt zurück

RequestPolicyFactory

serializeObject(any)

function serializeObject(toSerialize: any): any

Parameter

toSerialize

any

Gibt zurück

any

signingPolicy(ServiceClientCredentials)

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parameter

authenticationProvider

ServiceClientCredentials

Gibt zurück

RequestPolicyFactory

stripRequest(WebResourceLike)

Gibt eine strippede Version der HTTP-Anforderung zurück, die nicht den Autorisierungsheader enthält.

function stripRequest(request: WebResourceLike): WebResourceLike

Parameter

request

WebResourceLike

Das Http-Anforderungsobjekt

Gibt zurück

WebResourceLike

Die entfernte Version der Http-Anforderung.

stripResponse(HttpOperationResponse)

Gibt eine gestreifte Version der Http-Antwort zurück, die nur Textkörper, Header und den Status enthält.

function stripResponse(response: HttpOperationResponse): any

Parameter

response

HttpOperationResponse

Die HTTP-Antwort

Gibt zurück

any

Die entfernte Version der Http-Antwort.

systemErrorRetryPolicy(number, number, number, number)

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

Parameter

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Gibt zurück

RequestPolicyFactory

throttlingRetryPolicy(number)

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parameter

maxRetries

number

Gibt zurück

RequestPolicyFactory

userAgentPolicy(TelemetryInfo)

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parameter

userAgentData

TelemetryInfo

Gibt zurück

RequestPolicyFactory