@azure/core-http package

Klasy

AccessTokenRefresher	Pomaga zasadom uwierzytelniania tokenu core-http żądać nowego tokenu, jeśli nie czekamy na nowy token.
ApiKeyCredentials	Uwierzytelnia się w usłudze przy użyciu klucza interfejsu API.
BaseRequestPolicy	Klasa bazowa, z której pochodzą wszystkie zasady żądań.
BasicAuthenticationCredentials	Proste <xref:ServiceClientCredential> uwierzytelnianie przy użyciu nazwy użytkownika i hasła.
DefaultHttpClient	Klient HTTP, który używa programu node-fetch.
ExpiringAccessTokenCache	Zapewnia implementację accessTokenCache , która czyści buforowane identyfikatory AccessToken po przekazaniu elementu expiresOnTimestamp.
HttpHeaders	Kolekcja par klucz/wartość nagłówka HTTP.
RequestPolicyOptions	Opcjonalne właściwości, których można użyć podczas tworzenia obiektu RequestPolicy.
RestError	Błąd wynikający z żądania HTTP do punktu końcowego usługi.
Serializer	Służy do mapowania nieprzetworzonych obiektów odpowiedzi na końcowe kształty. Ułatwia pakowanie i rozpakowywanie dat oraz innych zakodowanych typów, które nie są wewnętrzne w formacie JSON. Umożliwia również ściąganie wartości z nagłówków, a także wstawianie wartości domyślnych i stałych.
ServiceClient	Klasa ServiceClient wysyła żądania obsługi i odbiera odpowiedzi.
TopicCredentials	Obiekt TopicCredentials używany do Azure Event Grid.
URLBuilder	Klasa, która obsługuje tworzenie, modyfikowanie i analizowanie adresów URL.
URLQuery	Klasa, która obsługuje część zapytania elementu URLBuilder.
WebResource	Tworzy nowy obiekt WebResource. Ta klasa zapewnia abstrakcję wywołania REST przez bycie biblioteką / implementacją niezależną od implementacji i opakowywanie niezbędnych właściwości do zainicjowania żądania.

Interfejsy

AbortSignalLike	Umożliwia przerwanie żądania po wyzwoleniu zdarzenia "przerwania". Zgodne z wbudowanym elementem AbortSignal i typowymi polifillami w przeglądarce.
AccessToken	Reprezentuje token dostępu z czasem wygaśnięcia.
AccessTokenCache	Udostępnia pamięć podręczną dla elementu AccessToken, który został zwrócony z tokenuCredential.
ApiKeyCredentialOptions	Opisuje opcje, które należy podać podczas tworzenia wystąpienia obiektu ApiKeyCredentials
BaseMapper	Podstawowa definicja mapowania. Może być używany w przypadku obiektów XML i zwykłego języka JavaScript.
CompositeMapper	Maper składający się z innych maperów.
CompositeMapperType	Pomaga utworzyć maper opisujący sposób mapowania zestawu właściwości obiektu na podstawie innych maperów. Powinna istnieć tylko jedna z następujących właściwości: className, modelProperties i additionalProperties.
DeserializationContentTypes	Typy zawartości, które wskazują, że odpowiedź operacji powinna być deserializacji w określony sposób.
DeserializationOptions	Opcje konfigurowania deserializacji odpowiedzi interfejsu API.
DictionaryMapper	Maper opisujący zwykłe obiekty JavaScript używane jako pary klucz/wartość.
DictionaryMapperType	Pomaga utworzyć maper, który opisuje sposób analizowania słownika zamapowanych wartości.
EnumMapper	Maper opisujący wartość wyliczenia.
EnumMapperType	Pomaga utworzyć maper opisujący sposób analizowania wartości wyliczenia.
GetTokenOptions	Definiuje opcje tokenCredential.getToken.
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 jest odbierana w formacie JSON lub XML.
HttpPipelineLogger	Rejestrator, który można dodać do protokołu 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 zawsze będą obecne.
InternalPipelineOptions	Definiuje opcje używane do konfigurowania wewnętrznych opcji potoku HTTP dla klienta zestawu SDK.
KeepAliveOptions	Opcje obsługi połączeń HTTP dla przyszłych żądań.
LogPolicyOptions	Opcje przekazywania do logPolicy. Domyślnie tylko ustawiona lista nagłówków jest rejestrowana, chociaż można to skonfigurować. Treść żądań i odpowiedzi nigdy nie jest rejestrowana.
MapperConstraints	Opis różnych ograniczeń wartości, takich jak zakresy liczb całkowitych i wyrażenie regularne ciągów.
OperationArguments	Kolekcja właściwości, które mają zastosowanie do pojedynczego wywołania operacji.
OperationOptions	Typ opcji podstawowych dla wszystkich 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.
OperationRequestOptions	Opcje umożliwiające skonfigurowanie obsługi żądań HTTP wysyłanych przez operację zestawu SDK.
OperationResponse	Element OperationResponse, który można zwrócić z żądania operacji dla pojedynczego kodu stanu.
OperationSpec	Specyfikacja definiująca sposób wykonywania określonej operacji usługi za pośrednictwem protokołu HTTP, w tym sposób prawidłowego serializowania informacji o żądaniach do elementu i deserializacji informacji odpowiedzi do ładunku obiektu zwracanego przez element ServiceClient.
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
PipelineOptions	Definiuje opcje używane do konfigurowania potoku HTTP dla klienta zestawu SDK.
PolymorphicDiscriminator	Służy do uściślania dyskryminowanych związków typów. Jeśli na przykład odpowiedź może zawierać wiele kształtów, ale także pole "kind" (lub podobne), to pole może służyć do określenia, jak deserializować odpowiedź na poprawny typ.
ProxySettings	Opcje konfigurowania serwera proxy dla żądań wychodzących (tylko Node.js).
RedirectOptions	Opcje obsługi odpowiedzi przekierowania.
RequestOptionsBase	Opisuje podstawową strukturę obiektu opcji, który będzie używany w każdej operacji.
RequestPolicy	Podstawowa struktura zasad żądania.
RequestPolicyOptionsLike	Opcjonalne właściwości, których można użyć podczas tworzenia obiektu RequestPolicy.
RequestPrepareOptions	Opcje przygotowywania wychodzącego żądania HTTP.
RestResponse	Spłaszczona odpowiedź na wywołanie REST. Zawiera podstawowe właściwości HttpOperationResponse , a także scalone właściwości parsedBody, parsedHeadersitp.
RetryOptions	Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
SequenceMapper	Maper opisujący tablice.
SequenceMapperType	Ułatwia tworzenie mapera opisującego sposób analizowania sekwencji mapowanych wartości.
SerializerOptions	Opcje zarządzania zachowaniem analizatora XML i konstruktora.
ServiceCallback
ServiceClientCredentials	Reprezentuje obiekt lub klasę signRequest za pomocą metody, która będzie podpisywać żądania wychodzące (na przykład przez ustawienie nagłówka Authorization ).
ServiceClientOptions	Opcje, które należy podać podczas tworzenia klienta.
SimpleMapperType	Typ prostego mapera.
TokenCredential	Reprezentuje poświadczenie umożliwiające podanie tokenu uwierzytelniania.
TracingPolicyOptions	Opcje dostosowywania zasad śledzenia.
UrlParameterValue	Interfejs reprezentujący wartość parametru adresu URL.
UserAgentOptions	Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.
WebResourceLike	Opis żądania HTTP, który ma zostać złożony na serwerze zdalnym.

Aliasy typu

Authenticator	Funkcja, która odbiera wyzwanie i rozwiązuje obietnicę przy użyciu tokenu ciągu.
CommonRequestInfo	Adresy URL ciągów używane podczas wywoływania metody fetch().
CommonRequestInit	Obiekt zawierający informacje o wychodzącym żądaniu HTTP.
CommonResponse	Obiekt zawierający informacje o przychodzącej odpowiedzi HTTP.
HttpMethods	Lista obsługiwanych metod HTTP.
HttpRequestBody	Możliwe typy treści żądań HTTP
Mapper	Mapery to definicje modeli danych używanych w bibliotece. Te modele danych są częścią definicji operacji lub klienta w odpowiedziach lub parametrach.
MapperType	Typ mapera. Zawiera znanych maperów.
ParameterPath	Ścieżka opisując sposób uzyskiwania dostępu do określonej właściwości w danym źródle danych obiektu. Może to być pojedyncza nazwa właściwości, tablica, która określa nazwy zagnieżdżonych właściwości lub zestaw wielu nazwanych właściwości ze ścieżkami w przypadku złożonych wartości obiektów.
ProxyOptions	Alias proxySettings do użycia w przyszłości.
RawHttpHeaders	Kolekcja HttpHeaders reprezentowana jako prosty obiekt JSON.
RequestPolicyFactory	Tworzy nowy element RequestPolicy dla każdego żądania, który używa podanej metody NextPolicy.
TelemetryInfo	Informacje telemetryczne. Pary klucz/wartość do uwzględnienia wewnątrz ciągu User-Agent.
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.
RetryMode	Opisuje typ trybu ponawiania prób. Obecnie obsługuje tylko wykładnik.

Funkcje

applyMixins(unknown, any[])	Stosuje właściwości prototypu obiektu sourceCtors do prototypu obiektu targetCtor
bearerTokenAuthenticationPolicy(TokenCredential, string | string[])	Tworzy nową fabrykę dla zasad RequestPolicy, która stosuje token elementu nośnego do nagłówków żądań Authorization .
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	Tworzy potok HTTP na podstawie podanych opcji.
delay(number, DelayOptions)	Otoka setTimeout, która rozwiązuje obietnicę po milisekundach timeInMs.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Utwórz nową serializacji RequestPolicyCreator, który będzie serializował treści żądań HTTP podczas przekazywania potoku HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Biorąc pod uwagę określony zestaw typów zawartości do analizy jako kod JSON lub XML, używa odpowiedzi HTTP w celu wygenerowania obiektu wynikowego zdefiniowanego przez element OperationSpec żądania.
disableResponseDecompressionPolicy()	Zwraca fabrykę zasad żądań, która może służyć do utworzenia wystąpienia klasy <xref:DisableResponseDecompressionPolicy>.
encodeUri(string)	Koduje identyfikator URI.
executePromisesSequentially(any[], unknown)	Wykonuje tablicę obietnic sekwencyjnie. Inspiracją dla 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)	Zasady, które ponawia próbę żądania tak wiele razy, jak skonfigurowano tak długo, jak określono maksymalny interwał czasu ponawiania próby, każdy ponowny prób czeka dłużej niż czas ostatni.
flattenResponse(HttpOperationResponse, undefined | OperationResponse)	Analizuje element HttpOperationResponse w znormalizowany obiekt odpowiedzi HTTP (RestResponse).
generateClientRequestIdPolicy(string)	Tworzy zasady, które przypisują unikatowy identyfikator żądania do żądań wychodzących.
generateUuid()	Wygenerowany identyfikator UUID
getDefaultProxySettings(string)	Konwertuje dany adres URL serwera proxy na ProxySettings lub próbuje pobrać ProxySettings z bieżącego środowiska, jeśli nie został przekazany.
getDefaultUserAgentValue()	Domyślne podejście do generowania agentów użytkowników. Używa informacji statycznych z tego pakietu oraz informacji systemowych dostępnych w środowisku uruchomieniowym.
isDuration(string)	Wskazuje, czy dany ciąg ma format ISO 8601.
isTokenCredential(unknown)	Testuje obiekt, aby określić, czy implementuje tokenCredential.
isValidUuid(string)	Sprawdza poprawność podanego identyfikatora uuid jako ciągu
keepAlivePolicy(KeepAliveOptions)	Tworzy zasady, które określają, czy połączenia HTTP są utrzymywane na przyszłych żądaniach.
logPolicy(LogPolicyOptions)	Tworzy zasady, które rejestrują informacje o żądaniu wychodzącym i odpowiedziach przychodzących.
operationOptionsToRequestOptionsBase<T>(T)	Konwertuje operacjęOpcje na obiekt RequestOptionsBase
parseXML(string, SerializerOptions)	Konwertuje dany ciąg XML na kod JSON
promiseToCallback(Promise<any>)	Konwertuje obietnicę na wywołanie zwrotne.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Konwertuje obietnicę na wywołanie zwrotne usługi.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Zasady, które umożliwiają stosowanie ustawień serwera proxy do wszystkich żądań. Jeśli nie przekazano ustawień statycznych, zostaną one pobrane z HTTPS_PROXY lub HTTP_PROXY zmiennych środowiskowych.
redirectPolicy(number)	Tworzy zasady przekierowania, które wysyła żądanie do nowego miejsca docelowego, jeśli odpowiedź zostanie wysłana z nagłówkiem "lokalizacja" i kodem stanu z zakresu od 300 do 307.
serializeObject(unknown)	Funkcja narzędzia, która serializuje obiekt, który może zawierać informacje binarne w zwykły obiekt, tablicę lub ciąg.
signingPolicy(ServiceClientCredentials)	Tworzy zasady, które podpisują żądania wychodzące przez wywołanie podanej authenticationProvidermetody .signRequest
stringifyXML(unknown, SerializerOptions)	Konwertuje dany obiekt JSON na ciąg XML
stripRequest(WebResourceLike)	Zwraca rozebraną wersję żądania HTTP, która nie zawiera nagłówka Autoryzacja.
stripResponse(HttpOperationResponse)	Zwraca rozebraną wersję odpowiedzi HTTP, która zawiera tylko treść, nagłówki i stan.
systemErrorRetryPolicy(number, number, number, number)	Zasady, które ponawia próbę, gdy wystąpi błąd systemowy, zidentyfikowane przez kody "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" lub "ENOENT".
throttlingRetryPolicy()	Tworzy zasady, które ponownie wysyłają żądanie, jeśli odpowiedź wskazuje, że żądanie nie powiodło się z powodu ograniczania przepustowości. Jeśli na przykład odpowiedź zawiera nagłówek, ponowi próbę Retry-After wysłania żądania na podstawie wartości tego nagłówka. Aby dowiedzieć się więcej, zapoznaj się z tematem https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits i https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tracingPolicy(TracingPolicyOptions)	Tworzy zasady, które zawijają żądania wychodzące z zakresem śledzenia.
userAgentPolicy(TelemetryInfo)	Zwraca zasady, które dodają nagłówek agenta użytkownika do żądań wychodzących na podstawie danej telemetriiInfo.

Szczegóły funkcji

applyMixins(unknown, any[])

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

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

Parametry

targetCtorParam

unknown

sourceCtors

any[]

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

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Tworzy nową fabrykę dla zasad RequestPolicy, która stosuje token elementu nośnego do nagłówków żądań Authorization .

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

Parametry

credential

TokenCredential

Implementacja TokenCredential, która może dostarczyć token elementu nośnego.

scopes

string | string[]

Zakresy, dla których ma zastosowanie token elementu nośnego.

Zwraca

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Tworzy potok HTTP na podstawie podanych opcji.

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

Parametry

pipelineOptions

InternalPipelineOptions

Definiuje opcje używane do konfigurowania zasad w potoku HTTP dla klienta zestawu SDK.

authPolicyFactory

RequestPolicyFactory

Opcjonalna fabryka zasad uwierzytelniania do użycia na potrzeby żądań podpisywania.

Zwraca

ServiceClientOptions

Zestaw opcji, które można przekazać w celu utworzenia nowego obiektu ServiceClient.

delay(number, DelayOptions)

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

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

Parametry

timeInMs

number

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

options

DelayOptions

Opcje opóźnienia — obecnie przerywanie opcji

Zwraca

Promise<void>

Obietnica rozwiązana po funkcji timeInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Utwórz nową serializacji RequestPolicyCreator, który będzie serializował treści żądań HTTP podczas przekazywania potoku HTTP.

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

Parametry

deserializationContentTypes

DeserializationContentTypes

parsingOptions

SerializerOptions

Zwraca

RequestPolicyFactory

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

Biorąc pod uwagę określony zestaw typów zawartości do analizy jako kod JSON lub XML, używa odpowiedzi HTTP w celu wygenerowania obiektu wynikowego zdefiniowanego przez element OperationSpec żądania.

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

Parametry

jsonContentTypes

string[]

Typy zawartości odpowiedzi, aby przeanalizować treść jako kod JSON.

xmlContentTypes

string[]

Typy zawartości odpowiedzi, aby przeanalizować treść jako xml.

response

HttpOperationResponse

Odpowiedź HTTP z potoku.

options

SerializerOptions

Opcje serializatora, głównie do konfigurowania analizatora XML w razie potrzeby.

Zwraca

Promise<HttpOperationResponse>

Przeanalizowany obiekt HttpOperationResponse , który można zwrócić przez obiekt ServiceClient.

disableResponseDecompressionPolicy()

Zwraca fabrykę zasad żądań, która może służyć do utworzenia wystąpienia klasy <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Zwraca

RequestPolicyFactory

encodeUri(string)

Koduje identyfikator URI.

function encodeUri(uri: string): string

Parametry

uri

string

Identyfikator URI, który ma być zakodowany.

Zwraca

string

Zakodowany identyfikator URI.

executePromisesSequentially(any[], unknown)

Wykonuje tablicę obietnic sekwencyjnie. Inspiracją dla 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: unknown): Promise<any>

Parametry

promiseFactories

any[]

Tablica fabryk obietnic (funkcja zwracająca obietnicę)

kickstart

unknown

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

Zwraca

Promise<any>

Łańcuch rozwiązanych lub odrzuconych obietnic

exponentialRetryPolicy(number, number, number)

Zasady, które ponawia próbę żądania tak wiele razy, jak skonfigurowano tak długo, jak określono maksymalny interwał czasu ponawiania próby, każdy ponowny prób czeka dłużej niż czas ostatni.

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

Parametry

retryCount

number

Maksymalna liczba ponownych prób.

retryInterval

number

Czas bazowy między ponawianiami prób.

maxRetryInterval

number

Maksymalny czas oczekiwania między ponownych próbami.

Zwraca

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Analizuje element HttpOperationResponse w znormalizowany obiekt odpowiedzi HTTP (RestResponse).

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

Parametry

_response

HttpOperationResponse

Obiekt otoki dla odpowiedzi http.

responseSpec

undefined | OperationResponse

Maperzy sposobu analizowania właściwości odpowiedzi.

Zwraca

RestResponse

• Znormalizowany obiekt odpowiedzi.

generateClientRequestIdPolicy(string)

Tworzy zasady, które przypisują unikatowy identyfikator żądania do żądań wychodzących.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parametry

requestIdHeaderName

string

Nazwa nagłówka do użycia podczas przypisywania unikatowego identyfikatora do żądania.

Zwraca

RequestPolicyFactory

generateUuid()

Wygenerowany identyfikator UUID

function generateUuid(): string

Zwraca

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

Konwertuje dany adres URL serwera proxy na ProxySettings lub próbuje pobrać ProxySettings z bieżącego środowiska, jeśli nie został przekazany.

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

Parametry

proxyUrl

string

Adres URL serwera proxy

Zwraca

ProxySettings | undefined

Domyślne ustawienia serwera proxy lub niezdefiniowane.

getDefaultUserAgentValue()

Domyślne podejście do generowania agentów użytkowników. Używa informacji statycznych z tego pakietu oraz informacji systemowych dostępnych w środowisku uruchomieniowym.

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 to prawidłowe, false w przeciwnym razie.

isTokenCredential(unknown)

Testuje obiekt, aby określić, czy implementuje tokenCredential.

function isTokenCredential(credential: unknown): credential

Parametry

credential

unknown

Zakładany tokenCredential do przetestowania.

Zwraca

credential

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; false w przeciwnym razie.

keepAlivePolicy(KeepAliveOptions)

Tworzy zasady, które określają, czy połączenia HTTP są utrzymywane na przyszłych żądaniach.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parametry

keepAliveOptions

KeepAliveOptions

Zachowaj aktywne opcje. Domyślnie połączenia HTTP są obsługiwane dla przyszłych żądań.

Zwraca

RequestPolicyFactory

Wystąpienie obiektu <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Tworzy zasady, które rejestrują informacje o żądaniu wychodzącym i odpowiedziach przychodzących.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parametry

loggingOptions

LogPolicyOptions

Opcje rejestrowania.

Zwraca

RequestPolicyFactory

Wystąpienie obiektu <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Konwertuje operacjęOpcje na obiekt RequestOptionsBase

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

Parametry

opts

T

Obiekt OperationOptions, który ma być konwertowany na RequestOptionsBase

Zwraca

RequestOptionsBase

parseXML(string, SerializerOptions)

Konwertuje dany ciąg XML na kod JSON

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

Parametry

str

string

Ciąg zawierający zawartość XML, która ma być analizowana w formacie JSON

opts

SerializerOptions

Opcje, które zarządzają analizowaniem danego ciągu xml

Zwraca

Promise<any>

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>): (cb: Function) => void

Parametry

promise

Promise<any>

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

Zwraca

(cb: Function) => void

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

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

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

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

Parametry

promise

Promise<HttpOperationResponse>

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

Zwraca

(cb: ServiceCallback<T>) => void

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

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

Zasady, które umożliwiają stosowanie ustawień serwera proxy do wszystkich żądań. Jeśli nie przekazano ustawień statycznych, zostaną one pobrane z HTTPS_PROXY lub HTTP_PROXY zmiennych środowiskowych.

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

Parametry

proxySettings

ProxySettings

ProxySettings do użycia w każdym żądaniu.

options

{ customNoProxyList?: string[] }

dodatkowe ustawienia, na przykład niestandardowe wzorce NO_PROXY

Zwraca

RequestPolicyFactory

redirectPolicy(number)

Tworzy zasady przekierowania, które wysyła żądanie do nowego miejsca docelowego, jeśli odpowiedź zostanie wysłana z nagłówkiem "lokalizacja" i kodem stanu z zakresu od 300 do 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parametry

maximumRetries

number

Maksymalna liczba przekierowań do naśladowania.

Zwraca

RequestPolicyFactory

Wystąpienie obiektu <xref:RedirectPolicy>

serializeObject(unknown)

Funkcja narzędzia, która serializuje obiekt, który może zawierać informacje binarne w zwykły obiekt, tablicę lub ciąg.

function serializeObject(toSerialize: unknown): any

Parametry

toSerialize

unknown

Zwraca

any

signingPolicy(ServiceClientCredentials)

Tworzy zasady, które podpisują żądania wychodzące przez wywołanie podanej authenticationProvidermetody .signRequest

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametry

authenticationProvider

ServiceClientCredentials

Dostawca uwierzytelniania.

Zwraca

RequestPolicyFactory

Wystąpienie klasy <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Konwertuje dany obiekt JSON na ciąg XML

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

Parametry

obj

unknown

Obiekt JSON, który ma zostać przekonwertowany na ciąg XML

opts

SerializerOptions

Opcje, które zarządzają analizowaniem danego obiektu JSON

Zwraca

string

stripRequest(WebResourceLike)

Zwraca rozebraną 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 rozebraną wersję odpowiedzi HTTP, która zawiera tylko treść, nagłówki i stan.

function stripResponse(response: HttpOperationResponse): any

Parametry

response

HttpOperationResponse

Odpowiedź HTTP

Zwraca

any

Rozebrana wersja odpowiedzi HTTP.

systemErrorRetryPolicy(number, number, number, number)

Zasady, które ponawia próbę, gdy wystąpi błąd systemowy, zidentyfikowane przez kody "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" lub "ENOENT".

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

Parametry

retryCount

number

Maksymalna liczba ponownych prób.

retryInterval

number

Interwał ponawiania prób klienta w milisekundach.

minRetryInterval

number

Minimalny interwał ponawiania prób w milisekundach.

maxRetryInterval

number

Maksymalny interwał ponawiania prób w milisekundach.

Zwraca

RequestPolicyFactory

Wystąpienie obiektu <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Tworzy zasady, które ponownie wysyłają żądanie, jeśli odpowiedź wskazuje, że żądanie nie powiodło się z powodu ograniczania przepustowości. Jeśli na przykład odpowiedź zawiera nagłówek, ponowi próbę Retry-After wysłania żądania na podstawie wartości tego nagłówka.

Aby dowiedzieć się więcej, zapoznaj się z tematem https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits i https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): RequestPolicyFactory

Zwraca

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Tworzy zasady, które zawijają żądania wychodzące z zakresem śledzenia.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parametry

tracingOptions

TracingPolicyOptions

Opcje śledzenia.

Zwraca

RequestPolicyFactory

Wystąpienie klasy <xref:TracingPolicy>.

userAgentPolicy(TelemetryInfo)

Zwraca zasady, które dodają nagłówek agenta użytkownika do żądań wychodzących na podstawie danej telemetriiInfo.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametry

userAgentData

TelemetryInfo

Informacje telemetryczne.

Zwraca

RequestPolicyFactory

<xref:UserAgentPolicy>Nowy element .