@azure/core-rest-pipeline package

Sınıflar

RestError

Başarısız işlem hattı istekleri için özel bir hata türü.

Arabirimler

AddPipelineOptions	İşlem hattına ilke eklerken seçenekler. Diğer ilkelere bağımlılıkları ifade etmek için kullanılır.
Agent	NodeJS'nin http.Agentile uyumlu bir arabirim. Çalışma zamanı sürümleri arasında farklılık gösterebileceğinden gerçek arabirimin genel olarak yeniden dışarı aktarılmasını önlemek istiyoruz.
AuthorizeRequestOnChallengeOptions	authorizeRequestOnChallenge geri çağırmasına gönderilen seçenekler
AuthorizeRequestOptions	authorizeRequest geri çağırmasına gönderilen seçenekler
AuxiliaryAuthenticationHeaderPolicyOptions	yardımcıAuthenticationHeaderPolicy yapılandırma seçenekleri
BearerTokenAuthenticationPolicyOptions	bearerTokenAuthenticationPolicy yapılandırma seçenekleri
ChallengeCallbacks	Sürekli Erişim Değerlendirmesi sınamalarının işlenmesini geçersiz kılma seçenekleri.
DefaultRetryPolicyOptions	Başarısız isteklerin nasıl yeniden denendiğini denetleyebilen seçenekler.
ExponentialRetryPolicyOptions	Başarısız isteklerin nasıl yeniden denendiğini denetleyebilen seçenekler.
HttpClient	İşlem hattı adına HTTP istekleri yapan bir istemci için gerekli arabirim.
HttpHeaders	İstek/yanıtta http üst bilgileri kümesini temsil eder. Üst bilgi adları büyük/küçük harfe duyarsız olarak değerlendirilir.
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.
KeyObject	NodeJS'nin tls.KeyObjectile uyumlu bir arabirim. Çalışma zamanı sürümleri arasında farklılık gösterebileceğinden gerçek arabirimin genel olarak yeniden dışarı aktarılmasını önlemek istiyoruz.
LogPolicyOptions	logPolicy'yi yapılandırma seçenekleri.
Pipeline	URL'ye HTTP isteği göndermek için bir işlem hattını temsil eder. İşlem hatları, her isteğin sunucuya yapılmadan önce ve sonra yönetilmesini yönetmek için birden çok ilkeye sahip olabilir.
PipelineOptions	BIR SDK istemcisi için HTTP işlem hattını yapılandırmak için kullanılan seçenekleri tanımlar.
PipelinePolicy	İşlem hattı ilkesi, işlem hattında ilerlerken bir isteği işler. Kavramsal olarak, istek alınmadan önce değiştirmesine izin verilen bir ara yazılımdır ve alındığında yanıt da verilir.
PipelineRequest	İşlem hattı tarafından yapılan istekle ilgili meta veriler.
PipelineRequestOptions	İstek başlatma ayarları. Kısmi ile neredeyse eşdeğerdir, ancak URL zorunludur.
PipelineResponse	İşlem hattı tarafından alınan yanıt hakkındaki meta veriler.
PipelineRetryOptions	Başarısız isteklerin nasıl yeniden denendiğini denetleyebilen seçenekler.
ProxySettings	Giden istekler için ara sunucu yapılandırma seçenekleri (yalnızca Node.js).
PxfObject	NodeJS'nin tls.PxfObjectile uyumlu bir arabirim. Çalışma zamanı sürümleri arasında farklılık gösterebileceğinden gerçek arabirimin genel olarak yeniden dışarı aktarılmasını önlemek istiyoruz.
RedirectPolicyOptions	Yeniden yönlendirme yanıtlarının nasıl işlenme seçenekleri.
RestErrorOptions	RestError tarafından desteklenen seçenekler.
RetryInformation	Yeniden deneme ilkesinin geçerli ilerleme durumu hakkında yeniden deneme stratejisine sağlanan bilgiler.
RetryModifiers	Yeniden deneme ilkesinin davranışını değiştirebilen özellikler.
RetryPolicyOptions	retryPolicy seçenekleri
RetryStrategy	Yeniden deneme stratejisi, yeniden denenip denenmeyeceğini ve nasıl yeniden denendiğini tanımlamak için tasarlanmıştır.
SystemErrorRetryPolicyOptions	Başarısız isteklerin nasıl yeniden denendiğini denetleyebilen seçenekler.
TelemetryOptions	Ortak telemetri ve izleme bilgilerini yapılandırmak için kullanılan seçenekleri tanımlar
ThrottlingRetryPolicyOptions	Başarısız isteklerin nasıl yeniden denendiğini denetleyebilen seçenekler.
TlsSettings	TLS kimlik doğrulaması için bir sertifikayı temsil eder.
TracingPolicyOptions	İzleme ilkesini yapılandırma seçenekleri.
UserAgentPolicyOptions	Giden isteklere kullanıcı aracısı ayrıntılarını ekleme seçenekleri.

Tür Diğer Adları

FormDataMap	Tarayıcı formundan gibi form verileri sağlayan basit bir nesne.
FormDataValue	Her form veri girişi bir dize veya (tarayıcıda) bir Blob olabilir.
HttpMethods	İstek yaparken kullanılacak HTTP yöntemleri destekleniyor.
PipelinePhase	İlkeler aşamalar halinde yürütülür. Yürütme sırası: Aşamayı Seri Hale Getirme Bir aşamada olmayan ilkeler Seri Durumdan Çıkarma Aşaması Yeniden Deneme Aşaması İmza Aşaması
RawHttpHeaders	Basit bir JSON nesnesi olarak temsil edilen httpheaders koleksiyonu.
RawHttpHeadersInput	Giriş için basit bir JSON nesnesi olarak temsil edilen httpheaders koleksiyonu.
RequestBodyType	İstekte desteklenen gövde türleri. NodeJS.ReadableStream ve () => NodeJS.ReadableStream yalnızca Node'dur. Blob, ReadableStream ve () => ReadableStream yalnızca tarayıcıdır.
SendRequest	İşlem hattı isteğinde bulunmak ve yanıt almak için basit bir arabirim.
TransferProgressEvent	Karşıya yükleme veya indirme ilerlemesine yanıt olarak tetiklenir.

İşlevler

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Üst bilgi için dış belirteçler x-ms-authorization-auxiliary için bir ilke. Bu üst bilgi, kiracılar arası bir uygulama oluştururken kullanılacaktır. Farklı kiracılardaki kaynaklar için kimlik doğrulama isteklerini işlememiz gerekebilir. Bu özelliğin nasıl çalıştığına ilişkin bir özet için ARM belgelerini görebilirsiniz
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	TokenCredential uygulamasından belirteç isteyebilen ve bunu bir isteğin Yetkilendirme üst bilgisine Taşıyıcı belirteç olarak uygulayabilen ilke.
createDefaultHttpClient()	Geçerli ortam için doğru HttpClient'i oluşturun.
createEmptyPipeline()	Tamamen boş bir işlem hattı oluşturur. Test etme veya özel bir tane oluşturma için kullanışlıdır.
createHttpHeaders(RawHttpHeadersInput)	Arabirimi karşılayan HttpHeaders bir nesne oluşturur.
createPipelineFromOptions(InternalPipelineOptions)	Varsayılan özelleştirilebilir ilke kümesiyle yeni bir işlem hattı oluşturun.
createPipelineRequest(PipelineRequestOptions)	Verilen seçeneklerle yeni bir işlem hattı isteği oluşturur. Bu yöntem, varsayılan değerlerin kolay ayarlanmasına izin vermektir ve gerekli değildir.
decompressResponsePolicy()	Accept-Encoding üst bilgisine göre yanıt sıkıştırmasını etkinleştirme ilkesi https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Üç stratejiye göre yeniden denenen bir ilke: Sunucu bir Retry-After üst bilgisi ile 429 yanıtı gönderdiğinde. Temel alınan aktarım katmanında hatalar olduğunda (örn. DNS arama hataları). Aksi takdirde, giden istek başarısız olursa katlanarak artan bir gecikmeyle yeniden dener.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Üstel olarak artan bir gecikmeye neden olurken istekleri yeniden denemeyi deneyen bir ilke.
formDataPolicy()	İstekte FormData kodunu gövdeye kodlayan bir ilke.
getDefaultProxySettings(string)	Bu yöntem proxy url'sini ProxyPolicy ile kullanılmak üzere 'ye ProxySettings dönüştürür. Bağımsız değişken verilmezse, ortam değişkenlerinden HTTPS_PROXY veya HTTP_PROXY'den bir ara sunucu URL'sini ayrıştırmaya çalışır.
isRestError(unknown)	RestError için Typeguard
logPolicy(LogPolicyOptions)	Tüm istekleri ve yanıtları günlüğe kaydeden bir ilke.
ndJsonPolicy()	ndJsonPolicy, her istek için etkin tutma ayarlarını denetlemek için kullanılan bir ilkedir.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Tüm isteklere ara sunucu ayarlarının uygulanmasına izin veren bir ilke. Statik ayarlar geçirilmediyse, bunlar HTTPS_PROXY veya HTTP_PROXY ortam değişkenlerinden alınır.
redirectPolicy(RedirectPolicyOptions)	Sunucu tarafı yeniden yönlendirmeyi desteklemek için sunucudan Konum üst bilgilerini izleme ilkesi. Tarayıcıda bu ilke kullanılmaz.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy, belirli koşullar karşılandığında isteklerin yeniden denenebilmesini sağlayan genel bir ilkedir
setClientRequestIdPolicy(string)	Her PipelineRequest oluşturuldukten sonra benzersiz bir kimlik alır. Bu ilke, daha iyi telemetri ve izleme sağlamak için bu benzersiz kimliği bir HTTP üst bilgisi aracılığıyla geçirir.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Sunucudaki hata kodlarını yeniden denemek yerine temel alınan aktarım katmanındaki hataları (örneğin DNS arama hataları) işlemeyi isteyen bir yeniden deneme ilkesi.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Sunucu bir Retry-After üst bilgisi ile 429 yanıtı gönderdiğinde yeniden denenen ilke. 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
tlsPolicy(TlsSettings)	İstemci sertifikasını kimlik doğrulaması için HttpClient aracısına ekleyen bir işlem hattı ilkesi alır.
tracingPolicy(TracingPolicyOptions)	Üst öğeye sahip SpanOptions içeren işlem hattı tarafından yapılan her istek için OpenTelemetry Spans oluşturmaya yönelik basit bir ilke. Üst Span olmadan yapılan istekler kaydedilmez.
userAgentPolicy(UserAgentPolicyOptions)	User-Agent üst bilgisini (veya eşdeğerini) kitaplık sürümünü yansıtacak şekilde ayarlayan ilke.

İşlev Ayrıntıları

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Üst bilgi için dış belirteçler x-ms-authorization-auxiliary için bir ilke. Bu üst bilgi, kiracılar arası bir uygulama oluştururken kullanılacaktır. Farklı kiracılardaki kaynaklar için kimlik doğrulama isteklerini işlememiz gerekebilir. Bu özelliğin nasıl çalıştığına ilişkin bir özet için ARM belgelerini görebilirsiniz

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parametreler

options

AuxiliaryAuthenticationHeaderPolicyOptions

Döndürülenler

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

TokenCredential uygulamasından belirteç isteyebilen ve bunu bir isteğin Yetkilendirme üst bilgisine Taşıyıcı belirteç olarak uygulayabilen ilke.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parametreler

options

BearerTokenAuthenticationPolicyOptions

Döndürülenler

PipelinePolicy

createDefaultHttpClient()

Geçerli ortam için doğru HttpClient'i oluşturun.

function createDefaultHttpClient(): HttpClient

Döndürülenler

HttpClient

createEmptyPipeline()

Tamamen boş bir işlem hattı oluşturur. Test etme veya özel bir tane oluşturma için kullanışlıdır.

function createEmptyPipeline(): Pipeline

Döndürülenler

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Arabirimi karşılayan HttpHeaders bir nesne oluşturur.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parametreler

rawHeaders

RawHttpHeadersInput

İlk üst bilgileri temsil eden basit bir nesne

Döndürülenler

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Varsayılan özelleştirilebilir ilke kümesiyle yeni bir işlem hattı oluşturun.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Parametreler

options

InternalPipelineOptions

Özel işlem hattı yapılandırma seçenekleri.

Döndürülenler

Pipeline

createPipelineRequest(PipelineRequestOptions)

Verilen seçeneklerle yeni bir işlem hattı isteği oluşturur. Bu yöntem, varsayılan değerlerin kolay ayarlanmasına izin vermektir ve gerekli değildir.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parametreler

options

PipelineRequestOptions

İsteğin oluşturulacağı seçenekler.

Döndürülenler

PipelineRequest

decompressResponsePolicy()

Accept-Encoding üst bilgisine göre yanıt sıkıştırmasını etkinleştirme ilkesi https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Döndürülenler

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Üç stratejiye göre yeniden denenen bir ilke:

• Sunucu bir Retry-After üst bilgisi ile 429 yanıtı gönderdiğinde.
• Temel alınan aktarım katmanında hatalar olduğunda (örn. DNS arama hataları).
• Aksi takdirde, giden istek başarısız olursa katlanarak artan bir gecikmeyle yeniden dener.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parametreler

options

DefaultRetryPolicyOptions

Döndürülenler

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Üstel olarak artan bir gecikmeye neden olurken istekleri yeniden denemeyi deneyen bir ilke.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parametreler

options

ExponentialRetryPolicyOptions

Yeniden deneme mantığını yapılandıran seçenekler.

Döndürülenler

PipelinePolicy

formDataPolicy()

İstekte FormData kodunu gövdeye kodlayan bir ilke.

function formDataPolicy(): PipelinePolicy

Döndürülenler

PipelinePolicy

getDefaultProxySettings(string)

Bu yöntem proxy url'sini ProxyPolicy ile kullanılmak üzere 'ye ProxySettings dönüştürür. Bağımsız değişken verilmezse, ortam değişkenlerinden HTTPS_PROXY veya HTTP_PROXY'den bir ara sunucu URL'sini ayrıştırmaya çalışır.

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

Parametreler

proxyUrl

string

Kullanılacak proxy'nin URL'si. Kimlik doğrulama bilgileri içerebilir.

Döndürülenler

ProxySettings | undefined

isRestError(unknown)

RestError için Typeguard

function isRestError(e: unknown): e

Parametreler

e

unknown

Catch yan tümcesi tarafından yakalanan bir şey.

Döndürülenler

e

logPolicy(LogPolicyOptions)

Tüm istekleri ve yanıtları günlüğe kaydeden bir ilke.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parametreler

options

LogPolicyOptions

logPolicy'yi yapılandırma seçenekleri.

Döndürülenler

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy, her istek için etkin tutma ayarlarını denetlemek için kullanılan bir ilkedir.

function ndJsonPolicy(): PipelinePolicy

Döndürülenler

PipelinePolicy

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

Tüm isteklere ara sunucu ayarlarının uygulanması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[] }): PipelinePolicy

Parametreler

proxySettings

ProxySettings

Her istekte kullanılacak ProxySettings.

options

{ customNoProxyList?: string[] }

özel NO_PROXY desenleri gibi ek ayarlar

Döndürülenler

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Sunucu tarafı yeniden yönlendirmeyi desteklemek için sunucudan Konum üst bilgilerini izleme ilkesi. Tarayıcıda bu ilke kullanılmaz.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parametreler

options

RedirectPolicyOptions

İlke davranışını denetleme seçenekleri.

Döndürülenler

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy, belirli koşullar karşılandığında isteklerin yeniden denenebilmesini sağlayan genel bir ilkedir

function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy

Parametreler

strategies

RetryStrategy[]

options

RetryPolicyOptions

Döndürülenler

PipelinePolicy

setClientRequestIdPolicy(string)

Her PipelineRequest oluşturuldukten sonra benzersiz bir kimlik alır. Bu ilke, daha iyi telemetri ve izleme sağlamak için bu benzersiz kimliği bir HTTP üst bilgisi aracılığıyla geçirir.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parametreler

requestIdHeaderName

string

İstek kimliğini geçirecek üst bilginin adı.

Döndürülenler

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Sunucudaki hata kodlarını yeniden denemek yerine temel alınan aktarım katmanındaki hataları (örneğin DNS arama hataları) işlemeyi isteyen bir yeniden deneme ilkesi.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parametreler

options

SystemErrorRetryPolicyOptions

İlkeyi özelleştiren seçenekler.

Döndürülenler

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Sunucu bir Retry-After üst bilgisi ile 429 yanıtı gönderdiğinde yeniden denenen ilke.

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(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Parametreler

options

ThrottlingRetryPolicyOptions

Yeniden deneme mantığını yapılandıran seçenekler.

Döndürülenler

PipelinePolicy

tlsPolicy(TlsSettings)

İstemci sertifikasını kimlik doğrulaması için HttpClient aracısına ekleyen bir işlem hattı ilkesi alır.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Parametreler

tlsSettings

TlsSettings

Döndürülenler

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

Üst öğeye sahip SpanOptions içeren işlem hattı tarafından yapılan her istek için OpenTelemetry Spans oluşturmaya yönelik basit bir ilke. Üst Span olmadan yapılan istekler kaydedilmez.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parametreler

options

TracingPolicyOptions

İzleme ilkesi tarafından günlüğe kaydedilen telemetriyi yapılandırma seçenekleri.

Döndürülenler

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

User-Agent üst bilgisini (veya eşdeğerini) kitaplık sürümünü yansıtacak şekilde ayarlayan ilke.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parametreler

options

UserAgentPolicyOptions

Kullanıcı aracısı değerini özelleştirme seçenekleri.

Döndürülenler

PipelinePolicy