@azure/core-http package

Sınıflar

AccessTokenRefresher	Şu anda yeni bir belirteç beklemiyorsak çekirdek-http belirteci kimlik doğrulama ilkelerinin yeni belirteç istemesine yardımcı olur.
ApiKeyCredentials	API anahtarı kullanarak bir hizmette kimlik doğrulaması yapar.
BaseRequestPolicy	Tüm istek ilkelerinin türetildiği temel sınıf.
BasicAuthenticationCredentials	Kullanıcı adı ve parola ile kimlik doğrulaması yapılan basit <xref:ServiceClientCredential> bir.
DefaultHttpClient	kullanan node-fetchbir HTTP istemcisi.
ExpiringAccessTokenCache	Süresi dolanOnTimestamp geçtikten sonra önbelleğe alınan AccessToken'leri temizleyen bir AccessTokenCache uygulaması sağlar.
HttpHeaders	HTTP üst bilgi anahtarı/değer çiftleri koleksiyonu.
RequestPolicyOptions	RequestPolicy oluştururken kullanılabilecek isteğe bağlı özellikler.
RestError	Hizmet uç noktasına yapılan HTTP isteğinden kaynaklanan bir hata.
Serializer	Ham yanıt nesnelerini son şekillere eşlemek için kullanılır. Tarihleri ve JSON'a ait olmayan diğer kodlanmış türleri paketlemeye ve açmaya yardımcı olur. Ayrıca üst bilgilerden değer çekmenin yanı sıra varsayılan değerleri ve sabitleri eklemeye de olanak tanır.
ServiceClient	ServiceClient hizmet istekleri gönderir ve yanıtları alır.
TopicCredentials	Azure Event Grid için kullanılan topiccredentials nesnesi.
URLBuilder	URL'leri oluşturma, değiştirme ve ayrıştırma işlemlerini işleyen bir sınıf.
URLQuery	URLBuilder'ın sorgu bölümünü işleyen bir sınıf.
WebResource	Yeni bir WebResource nesnesi oluşturur. Bu sınıf, kitaplık / uygulamadan bağımsız olarak ve bir istek başlatmak için gerekli özellikleri sarmalayarak REST çağrısı üzerinde bir soyutlama sağlar.

Arabirimler

AbortSignalLike	"Abort" olayı tetiklendikten sonra isteğin durdurulmasına izin verir. Tarayıcının yerleşik AbortSignal ve yaygın polyfills ile uyumludur.
AccessToken	Süre sonu olan bir erişim belirtecini temsil eder.
AccessTokenCache	Bir TokenCredential'dan döndürülen AccessToken için bir önbellek sağlar.
ApiKeyCredentialOptions	ApiKeyCredentials örneği oluşturulurken sağlanacak seçenekleri açıklar
BaseMapper	Eşleyicinin temel tanımı. XML ve düz JavaScript nesneleri için kullanılabilir.
CompositeMapper	Diğer eşleyicilerden oluşan bir eşleyici.
CompositeMapperType	Diğer eşleyicileri temel alarak bir nesnenin bir özellik kümesinin nasıl eşlendiğini açıklayan bir eşleyici oluşturmaya yardımcı olur. Aşağıdaki özelliklerden yalnızca biri mevcut olmalıdır: className, modelProperties ve additionalProperties.
DeserializationContentTypes	bir işlem yanıtının belirli bir şekilde seri durumdan çıkarılması gerektiğini belirten içerik türleri.
DeserializationOptions	API yanıt seri durumdan çıkarma yapılandırma seçenekleri.
DictionaryMapper	Anahtar/değer çiftleri olarak kullanılan düz JavaScript nesnelerini açıklayan bir eşleyici.
DictionaryMapperType	Eşlenen değerlerden oluşan bir sözlüğün nasıl ayrıştırıldığını açıklayan bir eşleyici oluşturmaya yardımcı olur.
EnumMapper	Sabit listesi değerini açıklayan bir eşleyici.
EnumMapperType	Bir sabit listesi değerini ayrıştırmayı açıklayan bir eşleyici oluşturmaya yardımcı olur.
GetTokenOptions	TokenCredential.getToken seçeneklerini tanımlar.
HttpClient	HttpRequests gönderebilen ve vaat edilen HttpResponses'i alabilen bir arabirim.
HttpHeader	HttpHeaders koleksiyonu içindeki tek bir üst bilgi.
HttpHeadersLike	HTTP üst bilgi anahtarı/değer çiftleri koleksiyonu.
HttpOperationResponse	Http isteği ve yanıtı için sarmalayıcı nesnesi. Seri durumdan çıkarılmış nesne, yanıt gövdesi JSON veya XML'de alındığında özelliğinde depolanır parsedBody .
HttpPipelineLogger	HttpPipeline'e eklenebilen bir Günlükçü. Bu, her RequestPolicy'nin hata ayıklama amacıyla kullanılabilecek iletileri günlüğe kaydetmesini sağlar.
HttpResponse	Her zaman mevcut olacak http yanıt özellikleri.
InternalPipelineOptions	BIR SDK istemcisi için HTTP işlem hattının iç seçeneklerini yapılandırmak için kullanılan seçenekleri tanımlar.
KeepAliveOptions	Http bağlantılarının gelecekteki istekler için nasıl korunacağıyla ilgili seçenekler.
LogPolicyOptions	logPolicy'ye geçirme seçenekleri. Varsayılan olarak yalnızca belirli bir üst bilgi listesi günlüğe kaydedilir, ancak bu yapılandırılabilir. İstek ve yanıt gövdeleri hiçbir zaman günlüğe kaydedilmez.
MapperConstraints	Tamsayı aralıkları ve dize regex gibi çeşitli değer kısıtlamalarının açıklaması.
OperationArguments	Bir işlemin tek bir çağrısına uygulanan özellikler koleksiyonu.
OperationOptions	Tüm işlemler için temel seçenekler türü.
OperationParameter	Tüm operation parametrelerinin genişleten ortak bir arabirim.
OperationQueryParameter	İşlemin HTTP isteğine sorgu parametresi olarak eklenecek bir işlem parametresi.
OperationRequestOptions	SDK işlemi tarafından yapılan HTTP isteklerinin işlenmesini yapılandırmaya olanak sağlayan seçenekler.
OperationResponse	Tek bir durum kodu için bir işlem isteğinden döndürülebilen operationResponse.
OperationSpec	İstek bilgilerinin ServiceClient tarafından döndürülebilir bir nesne yüküne doğru şekilde seri hale getirme ve yanıt bilgilerini seri durumdan çıkarma dahil olmak üzere HTTP üzerinde belirli bir hizmet işleminin nasıl gerçekleştirildiğini tanımlayan belirtim.
OperationURLParameter	İşlemin istek URL'sinin yerine geçecek bir işlem parametresi.
ParameterValue	RequestPrepareOptions içinde yol veya sorgu parametreleri için sağlanan Parametre değeri
PipelineOptions	BIR SDK istemcisi için HTTP işlem hattını yapılandırmak için kullanılan seçenekleri tanımlar.
PolymorphicDiscriminator	Ayrımcı tür birleşimlerini belirsiz hale getirmek için kullanılır. Örneğin, yanıtın birçok şekli olabilir ancak aynı zamanda bir 'tür' alanı (veya benzeri) varsa, yanıtın doğru türe nasıl seri durumdan çıkarıldığını belirlemek için bu alan kullanılabilir.
ProxySettings	Giden istekler için ara sunucu yapılandırma seçenekleri (yalnızca Node.js).
RedirectOptions	Yeniden yönlendirme yanıtlarının nasıl işlenme seçenekleri.
RequestOptionsBase	Her işlemde kullanılacak options nesnesinin temel yapısını açıklar.
RequestPolicy	İstek ilkesinin temel yapısı.
RequestPolicyOptionsLike	RequestPolicy oluştururken kullanılabilecek isteğe bağlı özellikler.
RequestPrepareOptions	Giden HTTP isteği hazırlama seçenekleri.
RestResponse	REST çağrısına düzleştirilmiş yanıt. Temel alınan HttpOperationResponse'unparsedBodyyanı sıra , vb parsedHeaders. birleştirilmiş özelliklerini içerir.
RetryOptions	Başarısız isteklerin nasıl yeniden denendiğini denetleyebilen seçenekler.
SequenceMapper	Dizileri açıklayan bir eşleyici.
SequenceMapperType	Eşlenen değerler dizisinin nasıl ayrıştırıldığını açıklayan bir eşleyici oluşturmaya yardımcı olur.
SerializerOptions	Xml ayrıştırıcısının ve oluşturucunun davranışını idare etme seçenekleri.
ServiceCallback
ServiceClientCredentials	Giden istekleri imzalayacak bir yönteme sahip bir signRequest nesneyi veya sınıfı temsil eder (örneğin, üst bilgiyi ayarlayarak Authorization ).
ServiceClientOptions	İstemci oluşturulurken sağlanacak seçenekler.
SimpleMapperType	Basit bir eşleştiricinin türü.
TokenCredential	Kimlik doğrulama belirteci sağlayabilen bir kimlik bilgilerini temsil eder.
TracingPolicyOptions	İzleme ilkesini özelleştirme seçenekleri.
UrlParameterValue	URL parametre değerini temsil eden bir arabirim.
UserAgentOptions	Giden isteklere kullanıcı aracısı ayrıntılarını ekleme seçenekleri.
WebResourceLike	Uzak sunucuya yapılacak HTTP isteğinin açıklaması.

Tür Diğer Adları

Authenticator	Bir sınama alan ve bir dize belirteci ile bir promise'i çözümleyen bir işlev.
CommonRequestInfo	çağrısı yapılırken fetch()kullanılan dize URL'leri.
CommonRequestInit	Giden HTTP isteği hakkında bilgi içeren bir nesne.
CommonResponse	Gelen HTTP yanıtı hakkında bilgi içeren bir nesne.
HttpMethods	Desteklenen HTTP yöntemlerinin listesi.
HttpRequestBody	Olası HTTP isteği gövde türleri
Mapper	Eşleyiciler, kitaplıkta kullanılan veri modellerinin tanımlarıdır. Bu veri modelleri yanıtlarda veya parametrelerde İşlem veya İstemci tanımlarının bir parçasıdır.
MapperType	Eşleyicinin türü. Bilinen eşleştiricileri içerir.
ParameterPath	Belirli bir nesne veri kaynağındaki belirli bir özelliğe nasıl erişileceğini açıklayan yol. Tek bir özellik adı, iç içe özellik adlarını belirten bir dizi veya karmaşık nesne değerleri söz konusu olduğunda yolları olan birden çok adlandırılmış özellik kümesi olabilir.
ProxyOptions	Gelecekte kullanmak için ProxySettings'in diğer adı.
RawHttpHeaders	Basit bir JSON nesnesi olarak temsil edilen httpheaders koleksiyonu.
RequestPolicyFactory	Sağlanan nextPolicy'yi kullanan yeni bir RequestPolicy istek başına oluşturur.
TelemetryInfo	Telemetri bilgileri. User-Agent dizesinin içine eklenecek anahtar/değer çiftleri.
TransferProgressEvent	Karşıya yükleme veya indirme ilerlemesine yanıt olarak tetiklenir.

Numaralandırmalar

HttpPipelineLogLevel	HttpPipelineLogger ile kullanılabilecek farklı günlük düzeyleri.
QueryCollectionFormat	Sorgu parametresi değeri için bir değer dizisini birleştirmek için kullanılacak biçim.
RetryMode	Yeniden Deneme Modu türünü açıklar. Şu anda yalnızca Üstel'i destekliyor.

İşlevler

applyMixins(unknown, any[])	sourceCtors prototipi üzerindeki özellikleri targetCtor prototipine uygular
bearerTokenAuthenticationPolicy(TokenCredential, string | string[])	RequestPolicy için isteklerin Authorization üst bilgilerine taşıyıcı belirteci uygulayan yeni bir fabrika oluşturur.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	Verilen seçenekleri temel alan bir HTTP işlem hattı oluşturur.
delay(number, DelayOptions)	timeInMs milisaniyeden sonra bir promise'i çözümleyen setTimeout için bir sarmalayıcı.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	HTTP işlem hattından geçerken HTTP istek gövdelerini seri hale getiren yeni bir serileştirme RequestPolicyCreator oluşturun.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	JSON veya XML olarak ayrıştırmak için belirli bir içerik türü kümesi verüldüğünde, isteğin OperationSpec değeri tarafından tanımlanan sonuç nesnesini üretmek için HTTP yanıtını kullanır.
disableResponseDecompressionPolicy()	bir örneği <xref:DisableResponseDecompressionPolicy>oluşturmak için kullanılabilecek bir istek ilkesi fabrikası döndürür.
encodeUri(string)	Bir URI'yi kodlar.
executePromisesSequentially(any[], unknown)	Bir dizi promise'i sırayla yürütür. Bu yöntemin ilham kaynağı buradadır: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Vaatler üzerine harika bir blog!
exponentialRetryPolicy(number, number, number)	Belirtilen en uzun yeniden deneme süresi aralığı kadar, her yeniden denemenin son seferden daha uzun süre başlamasını beklediği sürece, isteği yapılandırıldığı kadar yeniden deneyen ilke.
flattenResponse(HttpOperationResponse, undefined | OperationResponse)	Bir HttpOperationResponse öğesini normalleştirilmiş bir HTTP yanıt nesnesine (RestResponse) ayrıştırıyor.
generateClientRequestIdPolicy(string)	Giden isteklere benzersiz bir istek kimliği atayan bir ilke oluşturur.
generateUuid()	Oluşturulan UUID
getDefaultProxySettings(string)	Bir ara sunucunun belirli bir URL'sini içine ProxySettings dönüştürür veya geçirilmemişse geçerli ortamdan almayı ProxySettings dener.
getDefaultUserAgentValue()	Kullanıcı aracıları oluşturmak için varsayılan yaklaşım. Bu paketten gelen statik bilgilerin yanı sıra çalışma zamanından sağlanan sistem bilgilerini kullanır.
isDuration(string)	Verilen dizenin ISO 8601 biçiminde olup olmadığını gösterir.
isTokenCredential(unknown)	TokenCredential uygulayıp uygulamadığını belirlemek için bir nesneyi test eder.
isValidUuid(string)	Verilen uuid değerini dize olarak doğrular
keepAlivePolicy(KeepAliveOptions)	Http bağlantılarının gelecekteki isteklerde korunup korunmayacağını denetleyebilen bir ilke oluşturur.
logPolicy(LogPolicyOptions)	Giden istek ve gelen yanıtlar hakkındaki bilgileri günlüğe kaydeden bir ilke oluşturur.
operationOptionsToRequestOptionsBase<T>(T)	OperationOptions'ı RequestOptionsBase'e dönüştürür
parseXML(string, SerializerOptions)	Verilen XML dizesini JSON'a dönüştürür
promiseToCallback(Promise<any>)	Promise'i geri çağırmaya dönüştürür.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Promise'i bir hizmet geri çağırmasına dönüştürür.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Birinin tüm isteklere ara sunucu ayarları uygulamasına izin veren bir ilke. Statik ayarlar geçirilmediyse, bunlar HTTPS_PROXY veya HTTP_PROXY ortam değişkenlerinden alınır.
redirectPolicy(number)	Bir yanıt "konum" üst bilgisi ve 300 ile 307 arasında bir durum kodu ile geldiğinde isteği yeni bir hedefe tekrarlayan bir yeniden yönlendirme ilkesi oluşturur.
serializeObject(unknown)	İkili bilgi içerebilen bir nesneyi düz bir nesne, dizi veya dize halinde serileştiren yardımcı program işlevi.
signingPolicy(ServiceClientCredentials)	Sağlanan authenticationProvider'nin signRequest yöntemine çağrı yaparak giden istekleri imzalayan bir ilke oluşturur.
stringifyXML(unknown, SerializerOptions)	Verilen JSON nesnesini XML dizesine dönüştürür
stripRequest(WebResourceLike)	Yetkilendirme üst bilgisini içermeyen Http İsteğinin kaldırılmış bir sürümünü döndürür.
stripResponse(HttpOperationResponse)	Http Yanıtı'nın yalnızca gövde, üst bilgiler ve durumu içeren kaldırılmış bir sürümünü döndürür.
systemErrorRetryPolicy(number, number, number, number)	"ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" veya "ENOENT" kodlarıyla tanımlanan bir sistem hatası olduğunda yeniden denenen bir ilke.
throttlingRetryPolicy()	Yanıt, isteğin azaltma nedeniyle başarısız olduğunu gösterirse isteği yeniden gönderen bir ilke oluşturur. Örneğin, yanıt bir Retry-After üst bilgi içeriyorsa, isteği bu üst bilginin değerine göre göndermeyi yeniden dener. Daha fazla bilgi edinmek için https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitslütfen adresine https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits bakın ve https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tracingPolicy(TracingPolicyOptions)	Giden istekleri bir izleme aralığıyla sarmalayan bir ilke oluşturur.
userAgentPolicy(TelemetryInfo)	Verilen TelemetryInfo'ya göre giden isteklere kullanıcı aracısı üst bilgisini ekleyen bir ilke döndürür.

İşlev Ayrıntıları

applyMixins(unknown, any[])

sourceCtors prototipi üzerindeki özellikleri targetCtor prototipine uygular

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

Parametreler

targetCtorParam

unknown

sourceCtors

any[]

Özelliklerin alınması gereken kaynak nesne dizisi.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

RequestPolicy için isteklerin Authorization üst bilgilerine taşıyıcı belirteci uygulayan yeni bir fabrika oluşturur.

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

Parametreler

credential

TokenCredential

Taşıyıcı belirtecini sağlayabilen TokenCredential uygulaması.

scopes

string | string[]

Taşıyıcı belirtecin uygulandığı kapsamlar.

Döndürülenler

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Verilen seçenekleri temel alan bir HTTP işlem hattı oluşturur.

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

Parametreler

pipelineOptions

InternalPipelineOptions

BIR SDK istemcisi için HTTP işlem hattında ilkeleri yapılandırmak için kullanılan seçenekleri tanımlar.

authPolicyFactory

RequestPolicyFactory

İmzalama istekleri için kullanılacak isteğe bağlı bir kimlik doğrulama ilkesi fabrikası.

Döndürülenler

ServiceClientOptions

Yeni bir ServiceClient oluşturmak için geçirilebilen bir dizi seçenek.

delay(number, DelayOptions)

timeInMs milisaniyeden sonra bir promise'i çözümleyen setTimeout için bir sarmalayıcı.

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

Parametreler

timeInMs

number

Geciktirilecek milisaniye sayısı.

options

DelayOptions

Gecikme seçenekleri - şu anda iptal seçenekleri

Döndürülenler

Promise<void>

TimeInMs sonrasında çözümlenen söz

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

HTTP işlem hattından geçerken HTTP istek gövdelerini seri hale getiren yeni bir serileştirme RequestPolicyCreator oluşturun.

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

Parametreler

deserializationContentTypes

DeserializationContentTypes

parsingOptions

SerializerOptions

Döndürülenler

RequestPolicyFactory

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

JSON veya XML olarak ayrıştırmak için belirli bir içerik türü kümesi verüldüğünde, isteğin OperationSpec değeri tarafından tanımlanan sonuç nesnesini üretmek için HTTP yanıtını kullanır.

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

Parametreler

jsonContentTypes

string[]

Gövdeyi JSON olarak ayrıştırmak için yanıt içerik türleri.

xmlContentTypes

string[]

Gövdeyi XML olarak ayrıştırmak için yanıt içerik türleri.

response

HttpOperationResponse

İşlem hattından HTTP Yanıtı.

options

SerializerOptions

Seri hale getirici seçenekleri; çoğunlukla gerekirse XML ayrıştırıcısını yapılandırmaya yöneliktir.

Döndürülenler

Promise<HttpOperationResponse>

ServiceClient tarafından döndürülebilen ayrıştırılmış bir HttpOperationResponse nesnesi.

disableResponseDecompressionPolicy()

bir örneği <xref:DisableResponseDecompressionPolicy>oluşturmak için kullanılabilecek bir istek ilkesi fabrikası döndürür.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Döndürülenler

RequestPolicyFactory

encodeUri(string)

Bir URI'yi kodlar.

function encodeUri(uri: string): string

Parametreler

uri

string

Kodlanacak URI.

Döndürülenler

string

Kodlanmış URI.

executePromisesSequentially(any[], unknown)

Bir dizi promise'i sırayla yürütür. Bu yöntemin ilham kaynağı buradadır: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Vaatler üzerine harika bir blog!

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

Parametreler

promiseFactories

any[]

Promise fabrikaları dizisi (Promise döndüren bir işlev)

kickstart

unknown

Promise zincirini başlatmak için kullanılan ilk söze giriş. Sağlanmazsa söz zinciri tanımsız olarak başlar.

Döndürülenler

Promise<any>

Çözümlenen veya reddedilen sözler zinciri

exponentialRetryPolicy(number, number, number)

Belirtilen en uzun yeniden deneme süresi aralığı kadar, her yeniden denemenin son seferden daha uzun süre başlamasını beklediği sürece, isteği yapılandırıldığı kadar yeniden deneyen ilke.

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

Parametreler

retryCount

number

Yeniden deneme sayısı üst sınırı.

retryInterval

number

Yeniden denemeler arasındaki temel süre.

maxRetryInterval

number

Yeniden denemeler arasında bekleme süresi üst sınırı.

Döndürülenler

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Bir HttpOperationResponse öğesini normalleştirilmiş bir HTTP yanıt nesnesine (RestResponse) ayrıştırıyor.

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

Parametreler

_response

HttpOperationResponse

http yanıtı için sarmalayıcı nesnesi.

responseSpec

undefined | OperationResponse

Yanıt özelliklerini ayrıştırma için eşleyiciler.

Döndürülenler

RestResponse

• Normalleştirilmiş bir yanıt nesnesi.

generateClientRequestIdPolicy(string)

Giden isteklere benzersiz bir istek kimliği atayan bir ilke oluşturur.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parametreler

requestIdHeaderName

string

İsteğe benzersiz kimlik atarken kullanılacak üst bilginin adı.

Döndürülenler

RequestPolicyFactory

generateUuid()

Oluşturulan UUID

function generateUuid(): string

Döndürülenler

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

Bir ara sunucunun belirli bir URL'sini içine ProxySettings dönüştürür veya geçirilmemişse geçerli ortamdan almayı ProxySettings dener.

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

Parametreler

proxyUrl

string

Ara sunucu URL'si

Döndürülenler

ProxySettings | undefined

Varsayılan proxy ayarları veya tanımsız.

getDefaultUserAgentValue()

Kullanıcı aracıları oluşturmak için varsayılan yaklaşım. Bu paketten gelen statik bilgilerin yanı sıra çalışma zamanından sağlanan sistem bilgilerini kullanır.

function getDefaultUserAgentValue(): string

Döndürülenler

string

isDuration(string)

Verilen dizenin ISO 8601 biçiminde olup olmadığını gösterir.

function isDuration(value: string): boolean

Parametreler

value

string

ISO 8601 süre biçimi için doğrulanacak değer.

Döndürülenler

boolean

true geçerliyse, false aksi takdirde.

isTokenCredential(unknown)

TokenCredential uygulayıp uygulamadığını belirlemek için bir nesneyi test eder.

function isTokenCredential(credential: unknown): credential

Parametreler

credential

unknown

Test edilecek varsayılan TokenCredential.

Döndürülenler

credential

isValidUuid(string)

Verilen uuid değerini dize olarak doğrular

function isValidUuid(uuid: string): boolean

Parametreler

uuid

string

Doğrulanması gereken bir dize olarak uuid

Döndürülenler

boolean

uuid geçerliyse true; false olarak ayarlayın.

keepAlivePolicy(KeepAliveOptions)

Http bağlantılarının gelecekteki isteklerde korunup korunmayacağını denetleyebilen bir ilke oluşturur.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parametreler

keepAliveOptions

KeepAliveOptions

Canlı tutma seçenekleri. Http bağlantıları varsayılan olarak gelecekteki istekler için korunur.

Döndürülenler

RequestPolicyFactory

Bir örnek <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Giden istek ve gelen yanıtlar hakkındaki bilgileri günlüğe kaydeden bir ilke oluşturur.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parametreler

loggingOptions

LogPolicyOptions

Günlüğe kaydetme seçenekleri.

Döndürülenler

RequestPolicyFactory

Bir örnek <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

OperationOptions'ı RequestOptionsBase'e dönüştürür

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

Parametreler

opts

T

RequestOptionsBase'e dönüştürülecek OperationOptions nesnesi

Döndürülenler

RequestOptionsBase

parseXML(string, SerializerOptions)

Verilen XML dizesini JSON'a dönüştürür

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

Parametreler

str

string

JSON'a ayrıştırılacak XML içeriğini içeren dize

opts

SerializerOptions

Verilen xml dizesini ayrıştırma işlemini yöneten seçenekler

Döndürülenler

Promise<any>

promiseToCallback(Promise<any>)

Uyarı

Bu API artık kullanım dışıdır.

generated code should instead depend on responseToBody

Promise'i geri çağırmaya dönüştürür.

function promiseToCallback(promise: Promise<any>): (cb: Function) => void

Parametreler

promise

Promise<any>

Geri çağırmaya dönüştürülecek Promise

Döndürülenler

(cb: Function) => void

Geri çağırmayı alan bir işlev (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Promise'i bir hizmet geri çağırmasına dönüştürür.

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

Parametreler

promise

Promise<HttpOperationResponse>

Hizmet geri çağırmasına dönüştürülecek HttpOperationResponse Taahhüdü

Döndürülenler

(cb: ServiceCallback<T>) => void

Hizmet geri çağırmasını alan bir işlev (cb: ServiceCallback): void

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

Birinin tüm isteklere ara sunucu ayarları uygulamasına izin veren bir ilke. Statik ayarlar geçirilmediyse, bunlar HTTPS_PROXY veya HTTP_PROXY ortam değişkenlerinden alınır.

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

Parametreler

proxySettings

ProxySettings

Her istekte kullanılacak ProxySettings.

options

{ customNoProxyList?: string[] }

özel NO_PROXY desenleri gibi ek ayarlar

Döndürülenler

RequestPolicyFactory

redirectPolicy(number)

Bir yanıt "konum" üst bilgisi ve 300 ile 307 arasında bir durum kodu ile geldiğinde isteği yeni bir hedefe tekrarlayan bir yeniden yönlendirme ilkesi oluşturur.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parametreler

maximumRetries

number

İzleyebileceğiniz en fazla yeniden yönlendirme sayısı.

Döndürülenler

RequestPolicyFactory

Bir örnek <xref:RedirectPolicy>

serializeObject(unknown)

İkili bilgi içerebilen bir nesneyi düz bir nesne, dizi veya dize halinde serileştiren yardımcı program işlevi.

function serializeObject(toSerialize: unknown): any

Parametreler

toSerialize

unknown

Döndürülenler

any

signingPolicy(ServiceClientCredentials)

Sağlanan authenticationProvider'nin signRequest yöntemine çağrı yaparak giden istekleri imzalayan bir ilke oluşturur.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametreler

authenticationProvider

ServiceClientCredentials

Kimlik doğrulama sağlayıcısı.

Döndürülenler

RequestPolicyFactory

<xref:SigningPolicy> örneği.

stringifyXML(unknown, SerializerOptions)

Verilen JSON nesnesini XML dizesine dönüştürür

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

Parametreler

obj

unknown

XML dizesine dönüştürülecek JSON nesnesi

opts

SerializerOptions

Verilen JSON nesnesini ayrıştırma işlemini yöneten seçenekler

Döndürülenler

string

stripRequest(WebResourceLike)

Yetkilendirme üst bilgisini içermeyen Http İsteğinin kaldırılmış bir sürümünü döndürür.

function stripRequest(request: WebResourceLike): WebResourceLike

Parametreler

request

WebResourceLike

Http İsteği nesnesi

Döndürülenler

WebResourceLike

Http İsteğinin kaldırılmış sürümü.

stripResponse(HttpOperationResponse)

Http Yanıtı'nın yalnızca gövde, üst bilgiler ve durumu içeren kaldırılmış bir sürümünü döndürür.

function stripResponse(response: HttpOperationResponse): any

Parametreler

response

HttpOperationResponse

Http Yanıtı

Döndürülenler

any

Http Yanıtı'nın kaldırılmış sürümü.

systemErrorRetryPolicy(number, number, number, number)

"ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" veya "ENOENT" kodlarıyla tanımlanan bir sistem hatası olduğunda yeniden denenen bir ilke.

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

Parametreler

retryCount

number

Yeniden deneme sayısı üst sınırı.

retryInterval

number

İstemci yeniden deneme aralığı (milisaniye cinsinden).

minRetryInterval

number

Milisaniye cinsinden en düşük yeniden deneme aralığı.

maxRetryInterval

number

Milisaniye cinsinden en yüksek yeniden deneme aralığı.

Döndürülenler

RequestPolicyFactory

Bir örnek <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Yanıt, isteğin azaltma nedeniyle başarısız olduğunu gösterirse isteği yeniden gönderen bir ilke oluşturur. Örneğin, yanıt bir Retry-After üst bilgi içeriyorsa, isteği bu üst bilginin değerine göre göndermeyi yeniden dener.

Daha fazla bilgi edinmek için https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitslütfen adresine https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits bakın ve https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): RequestPolicyFactory

Döndürülenler

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Giden istekleri bir izleme aralığıyla sarmalayan bir ilke oluşturur.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parametreler

tracingOptions

TracingPolicyOptions

İzleme seçenekleri.

Döndürülenler

RequestPolicyFactory

<xref:TracingPolicy> sınıfının örneği.

userAgentPolicy(TelemetryInfo)

Verilen TelemetryInfo'ya göre giden isteklere kullanıcı aracısı üst bilgisini ekleyen bir ilke döndürür.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametreler

userAgentData

TelemetryInfo

Telemetri bilgileri.

Döndürülenler

RequestPolicyFactory

Yeni <xref:UserAgentPolicy>bir .