Udostępnij za pośrednictwem

@azure/ms-rest-js package

  • Odwołanie

Klasy

ApiKeyCredentials

Uwierzytelnia się w usłudze przy użyciu klucza interfejsu API.
AzureIdentityCredentialAdapter

Ta klasa udostępnia proste rozszerzenie do używania <xref:TokenCredential> z biblioteki @azure/identity do użycia ze starszymi zestawami SDK platformy Azure, które akceptują ServiceClientCredentials rodziny poświadczeń na potrzeby uwierzytelniania.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials

Uwierzytelnia się w usłudze przy użyciu klucza interfejsu API.
HttpHeaders

Kolekcja par klucz/wartość nagłówka HTTP.
RequestPolicyOptions

Opcjonalne właściwości, które mogą być używane podczas tworzenia obiektu RequestPolicy.
RestError
Serializer
ServiceClient
TokenCredentials

Obiekt poświadczeń, który używa ciągu tokenu i schematu autoryzacji do uwierzytelniania.
TopicCredentials

Uwierzytelnia się w usłudze przy użyciu klucza interfejsu API.
URLBuilder

Klasa, która obsługuje tworzenie, modyfikowanie i analizowanie adresów URL.
URLQuery

Klasa, która obsługuje część zapytania urlBuilder.
WebResource

Tworzy nowy obiekt WebResource.

Ta klasa zapewnia abstrakcję wywołania REST przez bycie biblioteką / implementacją niezależne od implementacji i zawijanie niezbędnych właściwości do zainicjowania żądania.

Interfejsy

AbortSignalLike

Umożliwia przerwanie żądania po wyzwoleniu zdarzenia "przerwania". Zgodność z wbudowanym elementem AbortSignal i typowymi polifillami w przeglądarce.
AgentSettings

Agenci HTTP i HTTPS (tylkoNode.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes

Typy zawartości, które będą wskazywać, że odpowiedź operacji powinna zostać zdeserializowana w określony sposób.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient

Interfejs, który może wysyłać żądania HttpRequests i odbierać obiecane odpowiedzi HttpResponses.
HttpHeader

Pojedynczy nagłówek w kolekcji HttpHeaders.
HttpHeadersLike

Kolekcja par klucz/wartość nagłówka HTTP.
HttpOperationResponse

Obiekt otoki dla żądania http i odpowiedzi. Deserializowany obiekt jest przechowywany we właściwości parsedBody, gdy treść odpowiedzi zostanie odebrana w formacie JSON lub XML.
HttpPipelineLogger

Rejestrator, który można dodać do interfejsu HttpPipeline. Dzięki temu każda zasada RequestPolicy umożliwia rejestrowanie komunikatów, które mogą być używane do celów debugowania.
HttpResponse

Właściwości odpowiedzi HTTP, które będą zawsze obecne.
MapperConstraints
OperationArguments

Kolekcja właściwości, które mają zastosowanie do pojedynczego wywołania operacji.
OperationParameter

Wspólny interfejs, który rozszerza wszystkie parametry operacji.
OperationQueryParameter

Parametr operacji, która zostanie dodana jako parametr zapytania do żądania HTTP operacji.
OperationResponse

Element OperationResponse, który można zwrócić z żądania operacji dla pojedynczego kodu stanu.
OperationSpec

Specyfikacja definiująca operację.
OperationURLParameter

Parametr operacji, która zostanie zastąpiona adresem URL żądania operacji.
ParameterValue

Wartość parametru podana dla parametrów ścieżki lub zapytania w poleceniu RequestPrepareOptions
PolymorphicDiscriminator
ProxySettings

Ustawienia serwera proxy HTTP (tylkoNode.js)
RedirectOptions

Opcje obsługi odpowiedzi przekierowania.
RequestOptionsBase

Opisuje podstawową strukturę obiektu options, który będzie używany w każdej operacji.
RequestPolicy
RequestPolicyOptionsLike

Opcjonalne właściwości, które mogą być używane podczas tworzenia obiektu RequestPolicy.
RequestPrepareOptions
RestResponse

Spłaszczona odpowiedź na wywołanie REST. Zawiera podstawowe właściwości HttpOperationResponse, a także scalone właściwości parsedBody, parsedHeaders itp.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions

Opcje, które należy udostępnić podczas tworzenia klienta.
SimpleMapperType
TokenResponse

TokenResponse jest zdefiniowany w @azure/ms-rest-nodeauth i jest kopiowany tutaj, aby nie dodawać niepotrzebnej zależności.
UrlParameterValue
WebResourceLike

Abstrakcja wywołania REST.

Aliasy typu

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders

Kolekcja HttpHeaders reprezentowana jako prosty obiekt JSON.
RequestPolicyFactory

Tworzy nowy element RequestPolicy dla każdego żądania, który używa podanej następnej zasady.
TelemetryInfo
TransferProgressEvent

Wyzwolony w odpowiedzi na postęp przekazywania lub pobierania.

Wyliczenia

HttpPipelineLogLevel

Różne poziomy dzienników, których można używać z protokołem HttpPipelineLogger.
QueryCollectionFormat

Format, który będzie używany do łączenia tablicy wartości razem dla wartości parametru zapytania.

Funkcje

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

Stosuje właściwości prototypu obiektów sourceCtors do prototypu obiektu targetCtor
delay<T>(number, T)

Otoka setTimeout, która rozwiązuje obietnicę po milisekundach.
deserializationPolicy(DeserializationContentTypes)

Utwórz nową serializacji RequestPolicyCreator, który zserializuje treść żądań HTTP podczas przekazywania potoku HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)

Koduje identyfikator URI.
executePromisesSequentially(any[], any)

Wykonuje tablicę obietnic sekwencyjnie. Inspiracją tej metody jest tutaj: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Niesamowity blog na temat obietnic!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()

Wygenerowany identyfikator UUID
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)

Wskazuje, czy dany ciąg ma format ISO 8601.
isValidUuid(string)

Sprawdza poprawność podanego identyfikatora uuid jako ciągu
logPolicy(any)
promiseToCallback(Promise<any>)

Konwertuje obietnicę na wywołanie zwrotne.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Konwertuje obietnicę na wywołanie zwrotne usługi.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)

Zwraca rozłożoną wersję żądania HTTP, która nie zawiera nagłówka Autoryzacja.
stripResponse(HttpOperationResponse)

Zwraca rozłożoną wersję odpowiedzi HTTP, która zawiera tylko treść, nagłówki i stan.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Szczegóły funkcji

agentPolicy(AgentSettings) 

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parametry

agentSettings
AgentSettings

Zwraca

RequestPolicyFactory

applyMixins(any, any[])

Stosuje właściwości prototypu obiektów sourceCtors do prototypu obiektu targetCtor

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

Parametry

targetCtor

any

Obiekt docelowy, na którym należy zastosować właściwości.

sourceCtors

any[]

Tablica obiektów źródłowych, z których należy pobrać właściwości.

delay<T>(number, T)

Otoka setTimeout, która rozwiązuje obietnicę po milisekundach.

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

Parametry

t

number

Liczba milisekund, które mają być opóźnione.

value

T

Wartość, która ma zostać rozpoznana po przekroczeniu limitu czasu t milisekund.

Zwraca

Promise<T>

Rozwiązana obietnica

deserializationPolicy(DeserializationContentTypes)

Utwórz nową serializacji RequestPolicyCreator, który zserializuje treść żądań HTTP podczas przekazywania potoku HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parametry

deserializationContentTypes
DeserializationContentTypes

Zwraca

RequestPolicyFactory

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

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

Parametry

jsonContentTypes

string[]

xmlContentTypes

string[]

response
HttpOperationResponse

Zwraca

Promise<HttpOperationResponse>

encodeUri(string)

Koduje identyfikator URI.

function encodeUri(uri: string): string

Parametry

uri

string

Identyfikator URI do zakodowania.

Zwraca

string

Zakodowany identyfikator URI.

executePromisesSequentially(any[], any)

Wykonuje tablicę obietnic sekwencyjnie. Inspiracją tej metody jest tutaj: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Niesamowity blog na temat obietnic!

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

Parametry

promiseFactories

any[]

Tablica fabryk obietnic (funkcja zwracająca obietnicę)

kickstart

any

Dane wejściowe do pierwszej obietnicy, która jest używana do rozpoczęcia łańcucha obietnic. Jeśli nie zostanie podany, łańcuch obietnic zaczyna się od niezdefiniowanego.

Zwraca

Promise<any>

Łańcuch rozwiązanych lub odrzuconych obietnic

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

Zwraca

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse) 

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

Parametry

_response
HttpOperationResponse
responseSpec

undefined | OperationResponse

Zwraca

RestResponse

generateClientRequestIdPolicy(string) 

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parametry

requestIdHeaderName

string

Zwraca

RequestPolicyFactory

generateUuid()

Wygenerowany identyfikator UUID

function generateUuid(): string

Zwraca

string

RFC4122 identyfikator UUID w wersji 4.

getDefaultProxySettings(string) 

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

Parametry

proxyUrl

string

Zwraca

ProxySettings | undefined

getDefaultUserAgentValue() 

function getDefaultUserAgentValue(): string

Zwraca

string

isDuration(string)

Wskazuje, czy dany ciąg ma format ISO 8601.

function isDuration(value: string): boolean

Parametry

value

string

Wartość, która ma zostać zweryfikowana dla formatu czasu trwania ISO 8601.

Zwraca

boolean

true, jeśli jest prawidłowa, false w przeciwnym razie.

isValidUuid(string)

Sprawdza poprawność podanego identyfikatora uuid jako ciągu

function isValidUuid(uuid: string): boolean

Parametry

uuid

string

Identyfikator uuid jako ciąg, który musi zostać zweryfikowany

Zwraca

boolean

Prawda, jeśli identyfikator uuid jest prawidłowy; w przeciwnym razie wartość false.

logPolicy(any) 

function logPolicy(logger?: any): RequestPolicyFactory

Parametry

logger

any

Zwraca

RequestPolicyFactory

promiseToCallback(Promise<any>)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

generated code should instead depend on responseToBody

Konwertuje obietnicę na wywołanie zwrotne.

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

Parametry

promise

Promise<any>

Obietnica, która ma zostać przekonwertowana na wywołanie zwrotne

Zwraca

Function

Funkcja, która pobiera wywołanie zwrotne (cb: Funkcja): void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Konwertuje obietnicę na wywołanie zwrotne usługi.

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

Parametry

promise

Promise<HttpOperationResponse>

Obietnica httpOperationResponse, która ma zostać przekonwertowana na wywołanie zwrotne usługi

Zwraca

Function

Funkcja, która pobiera wywołanie zwrotne usługi (cb: ServiceCallback): void

proxyPolicy(ProxySettings) 

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parametry

proxySettings
ProxySettings

Zwraca

RequestPolicyFactory

redirectPolicy(number) 

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parametry

maximumRetries

number

Zwraca

RequestPolicyFactory

serializeObject(any) 

function serializeObject(toSerialize: any): any

Parametry

toSerialize

any

Zwraca

any

signingPolicy(ServiceClientCredentials) 

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametry

authenticationProvider
ServiceClientCredentials

Zwraca

RequestPolicyFactory

stripRequest(WebResourceLike)

Zwraca rozłożoną wersję żądania HTTP, która nie zawiera nagłówka Autoryzacja.

function stripRequest(request: WebResourceLike): WebResourceLike

Parametry

request
WebResourceLike

Obiekt Żądania HTTP

Zwraca

WebResourceLike

Rozbierana wersja żądania HTTP.

stripResponse(HttpOperationResponse)

Zwraca rozłożoną wersję odpowiedzi HTTP, która zawiera tylko treść, nagłówki i stan.

function stripResponse(response: HttpOperationResponse): any

Parametry

response
HttpOperationResponse

Odpowiedź HTTP

Zwraca

any

Rozbierana wersja odpowiedzi 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

Zwraca

RequestPolicyFactory

throttlingRetryPolicy(number) 

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parametry

maxRetries

number

Zwraca

RequestPolicyFactory

userAgentPolicy(TelemetryInfo) 

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametry

userAgentData
TelemetryInfo

Zwraca

RequestPolicyFactory