@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 |
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 |
BodyPart |
Çok bölümlü bir istekte istek gövdesinin bir parçası. |
ChallengeCallbacks |
Sürekli Erişim Değerlendirme zorluklarının işlenmesini geçersiz kılma seçenekleri. |
CreateFileFromStreamOptions |
Akış geçirilirken createFile için ek seçenekler. |
CreateFileOptions |
Dosyayla ilgili meta verileri belirten createFile dosyasına geçirilen seçenekler. |
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 isteklerinde bulunan bir istemci için gerekli arabirim. |
HttpHeaders |
İstek/yanıt üzerindeki bir HTTP üst bilgisi 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 |
LogPolicyOptions |
logPolicy'yi yapılandırma seçenekleri. |
MultipartRequestBody |
Birden çok bölümden oluşan bir istek gövdesi. |
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 manipülesini 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, bir isteği işlem hattı üzerinden geçerken işleme alır. Kavramsal olarak, istek alınmadan önce değiştirmesine izin verilen bir ara yazılımdır ve alındığında verilen yanıttır. |
PipelineRequest |
İşlem hattı tarafından yapılan bir istekle ilgili meta veriler. |
PipelineRequestOptions |
İstek başlatma ayarları. Neredeyse Kısmi ile eşdeğerdir, ancak URL zorunludur. |
PipelineResponse |
İşlem hattı tarafından alınan yanıtla ilgili 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ızcaNode.js). |
PxfObject |
NodeJS'nin |
RedirectPolicyOptions |
Yeniden yönlendirme yanıtlarının nasıl işleneceğini gösteren seçenekler. |
RestErrorOptions |
RestError tarafından desteklenen seçenekler. |
RetryInformation |
Yeniden deneme stratejisine, yeniden deneme ilkesinin geçerli ilerleme durumu hakkında sağlanan bilgiler. |
RetryModifiers |
Yeniden deneme ilkesinin davranışını değiştirebilen özellikler. |
RetryPolicyOptions |
yeniden denemeİlke 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 |
Yaygın 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 |
Bir tarayıcı formundan olduğu gibi form verileri sağlayan basit bir nesne. |
FormDataValue |
Her form veri girişi bir dize, Blob veya Dosya olabilir. Bir ada sahip bir dosya geçirmek istiyorsanız ancak Dosya sınıfına erişiminiz yoksa createFile yardımcısını kullanarak bir dosya oluşturabilirsiniz. |
HttpMethods |
İstekte bulunurken kullanılacak HTTP yöntemleri destekleniyor. |
PipelinePhase |
İlkeler aşamalar halinde yürütülür. Yürütme sırası:
|
RawHttpHeaders |
Basit bir JSON nesnesi olarak temsil edilen httpheaders koleksiyonu. |
RawHttpHeadersInput |
Giriş için basit bir JSON nesnesi olarak temsil edilen bir 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
agent |
http.agent'ı ayarlayan bir işlem hattı ilkesi alır |
auxiliary |
Üst bilgi |
bearer |
TokenCredential uygulamasından belirteç isteyebilen ve bunu bir isteğin Yetkilendirme üst bilgisine Taşıyıcı belirteci olarak uygulayabilen bir ilke. |
create |
Geçerli ortam için doğru HttpClient'u oluşturun. |
create |
Tamamen boş bir işlem hattı oluşturur. Test veya özel bir tane oluşturmak için kullanışlıdır. |
create |
Dosya arabirimini uygulayan bir nesne oluşturun. Bu nesnenin RequestBodyType.formData dosyasına geçirilmesi amaçlanmıştır ve diğer durumlarda beklendiği gibi çalışacağı garanti edilmemektedir. Bu işlevi kullanın, genel Dosya nesnesinin kullanılamadığı ortamlarda RequestBodyType.formData içinde kullanmak üzere bir Dosya nesnesi oluşturun. |
create |
Dosya arabirimini uygulayan bir nesne oluşturun. Bu nesnenin RequestBodyType.formData dosyasına geçirilmesi amaçlanmıştır ve diğer durumlarda beklendiği gibi çalışacağı garanti edilmemektedir. Şu işlevi kullanarak:
|
create |
|
create |
Varsayılan özelleştirilebilir ilke kümesiyle yeni bir işlem hattı oluşturun. |
create |
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. |
decompress |
Accept-Encoding üst bilgi https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding göre yanıt sıkıştırmasını etkinleştirme ilkesi |
default |
Üç stratejiye göre yeniden denenen bir ilke:
|
exponential |
Üstel olarak artan bir gecikmeye neden olurken istekleri yeniden denemeyi deneyen bir ilke. |
form |
İstekte FormData kodunu gövdeye kodlayan bir ilke. |
get |
Bu yöntem ara sunucu URL'sini ProxyPolicy ile kullanmak üzere |
is |
RestError için Typeguard |
log |
Tüm istekleri ve yanıtları günlüğe kaydeden bir ilke. |
multipart |
Çok parçalı istekler için işlem hattı ilkesi |
nd |
ndJsonPolicy, her istek için etkin tutma ayarlarını denetlemek için kullanılan bir ilkedir. |
proxy |
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. |
redirect |
Sunucu tarafı yeniden yönlendirmeyi desteklemek için sunucudan Konum üst bilgilerini izlemeye yönelik bir ilke. Tarayıcıda bu ilke kullanılmaz. |
retry |
retryPolicy, belirli koşullar karşılandığında isteklerin yeniden denenebilmesini sağlayan genel bir ilkedir |
set |
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. |
system |
Sunucunun kendisinden yeniden denenebilir hata kodları yerine temel alınan aktarım katmanındaki hataları (örneğin DNS arama hataları) işlemeyi isteyen bir yeniden deneme ilkesi. |
throttling |
Sunucu bir Retry-After üst bilgisi ile 429 yanıtı gönderdiğinde yeniden denenen ilke. Daha fazla bilgi edinmek için lütfen https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits ve https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors |
tls |
İstemci sertifikasını kimlik doğrulaması için HttpClient aracısına ekleyen bir işlem hattı ilkesi alır. |
tracing |
Üst öğeye sahip SpanOptions içeren işlem hattı tarafından yapılan her istek için OpenTelemetry Spans oluşturmak için basit bir ilke. Üst Span olmadan yapılan istekler kaydedilmez. |
user |
User-Agent üst bilgisini (veya eşdeğerini) kitaplık sürümünü yansıtacak şekilde ayarlayan ilke. |
İşlev Ayrıntıları
agentPolicy(Agent)
http.agent'ı ayarlayan bir işlem hattı ilkesi alır
function agentPolicy(agent?: Agent): PipelinePolicy
Parametreler
- agent
- Agent
Döndürülenler
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
Üst bilgi x-ms-authorization-auxiliary
dış belirteçler için bir ilke.
Bu üst bilgi, farklı kiracılardaki kaynaklar için kimlik doğrulama isteklerini işlememiz gerekebilecek bir kiracılar arası uygulama oluştururken kullanılacaktır.
Bu özelliğin nasıl çalıştığına ilişkin bir özet için ARM belgeleri görebilirsiniz
function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy
Parametreler
Döndürülenler
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
TokenCredential uygulamasından belirteç isteyebilen ve bunu bir isteğin Yetkilendirme üst bilgisine Taşıyıcı belirteci olarak uygulayabilen bir ilke.
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy
Parametreler
Döndürülenler
createDefaultHttpClient()
Geçerli ortam için doğru HttpClient'u oluşturun.
function createDefaultHttpClient(): HttpClient
Döndürülenler
createEmptyPipeline()
Tamamen boş bir işlem hattı oluşturur. Test veya özel bir tane oluşturmak için kullanışlıdır.
function createEmptyPipeline(): Pipeline
Döndürülenler
createFile(Uint8Array, string, CreateFileOptions)
Dosya arabirimini uygulayan bir nesne oluşturun. Bu nesnenin RequestBodyType.formData dosyasına geçirilmesi amaçlanmıştır ve diğer durumlarda beklendiği gibi çalışacağı garanti edilmemektedir.
Bu işlevi kullanın, genel Dosya nesnesinin kullanılamadığı ortamlarda RequestBodyType.formData içinde kullanmak üzere bir Dosya nesnesi oluşturun.
function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File
Parametreler
- content
-
Uint8Array
dosyanın içeriğini bellekte Uint8Array olarak gösterir.
- name
-
string
dosyasının adı.
- options
- CreateFileOptions
dosyayla ilgili isteğe bağlı meta veriler, örneğin dosya adı, dosya boyutu, MIME türü.
Döndürülenler
File
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)
Dosya arabirimini uygulayan bir nesne oluşturun. Bu nesnenin RequestBodyType.formData dosyasına geçirilmesi amaçlanmıştır ve diğer durumlarda beklendiği gibi çalışacağı garanti edilmemektedir.
Şu işlevi kullanarak:
- Genel Dosya nesnesinin kullanılamadığı ortamlarda RequestBodyType.formData içinde kullanmak üzere bir Dosya nesnesi oluşturun.
- Akışı belleğe okumadan okunabilir bir akıştan Dosya benzeri bir nesne oluşturun.
function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File
Parametreler
- stream
-
() => ReadableStream<Uint8Array> | ReadableStream
akış döndüren bir geri çağırma olarak dosyanın içeriği. createFile kullanılarak yapılan bir Dosya nesnesi isteğin form veri eşlemesine geçirildiğinde akış belleğe okunmayacak ve istek yapıldığında akışa alınacaktır. Yeniden deneme durumunda akışın yeniden okunması gerekir, bu nedenle bu geri çağırma mümkünse yeni bir akış döndürmelidir.
- name
-
string
dosyasının adı.
- options
- CreateFileFromStreamOptions
dosyayla ilgili isteğe bağlı meta veriler, örneğin dosya adı, dosya boyutu, MIME türü.
Döndürülenler
File
createHttpHeaders(RawHttpHeadersInput)
HttpHeaders
arabirimini karşılayan bir nesne oluşturur.
function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders
Parametreler
- rawHeaders
- RawHttpHeadersInput
İlk üst bilgileri temsil eden basit bir nesne
Döndürülenler
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
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
decompressResponsePolicy()
Accept-Encoding üst bilgi https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding göre yanıt sıkıştırmasını etkinleştirme ilkesi
function decompressResponsePolicy(): PipelinePolicy
Döndürülenler
defaultRetryPolicy(DefaultRetryPolicyOptions)
Üç stratejiye göre yeniden denenen bir ilke:
- Sunucu, Retry-After üst bilgisine sahip bir 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, üstel olarak artan bir gecikmeyle yeniden dener.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy
Parametreler
- options
- DefaultRetryPolicyOptions
Döndürülenler
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
formDataPolicy()
İstekte FormData kodunu gövdeye kodlayan bir ilke.
function formDataPolicy(): PipelinePolicy
Döndürülenler
getDefaultProxySettings(string)
Uyarı
Bu API artık kullanım dışıdır.
- Internally this method is no longer necessary when setting proxy information.
Bu yöntem ara sunucu URL'sini ProxyPolicy ile kullanmak üzere ProxySettings
dönüştürür.
Bağımsız değişken verilmezse, HTTPS_PROXY
veya HTTP_PROXY
ortam değişkenlerinden 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
multipartPolicy()
Çok parçalı istekler için işlem hattı ilkesi
function multipartPolicy(): PipelinePolicy
Döndürülenler
ndJsonPolicy()
ndJsonPolicy, her istek için etkin tutma ayarlarını denetlemek için kullanılan bir ilkedir.
function ndJsonPolicy(): PipelinePolicy
Döndürülenler
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
redirectPolicy(RedirectPolicyOptions)
Sunucu tarafı yeniden yönlendirmeyi desteklemek için sunucudan Konum üst bilgilerini izlemeye yönelik bir ilke. 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
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
- options
- RetryPolicyOptions
Döndürülenler
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
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
Sunucunun kendisinden yeniden denenebilir hata kodları 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
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)
Sunucu bir Retry-After üst bilgisi ile 429 yanıtı gönderdiğinde yeniden denenen ilke.
Daha fazla bilgi edinmek için lütfen https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits ve https://learn.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
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
tracingPolicy(TracingPolicyOptions)
Üst öğeye sahip SpanOptions içeren işlem hattı tarafından yapılan her istek için OpenTelemetry Spans oluşturmak için 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
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.