@azure/core-https package

Sınıflar

DefaultHttpsClient

HTTPS istekleri göndermek için Node'un "https" modülünü kullanan bir HttpsClient uygulaması.

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.

BearerTokenAuthenticationPolicyOptions

bearerTokenAuthenticationPolicy yapılandırma seçenekleri

ExponentialRetryPolicyOptions

Başarısız isteklerin nasıl yeniden denendiğini denetleyebilen seçenekler.

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.

HttpsClient

İşlem hattı adına HTTPS istekleri yapan bir istemci için gerekli arabirim.

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.

LogPolicyOptions

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

Pipeline

Bir URL'ye HTTPS isteğinde bulunmak 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 PipelineRequest'e<> eşdeğerdir, ancak url zorunludur.

PipelineResponse

İşlem hattı tarafından alınan yanıtla ilgili meta veriler.

ProxySettings

Giden istekler için ara sunucu yapılandırma seçenekleri (yalnızcaNode.js).

RedirectPolicyOptions

Yeniden yönlendirme yanıtlarının nasıl işleneceğini gösteren seçenekler.

RestErrorOptions

RestError tarafından desteklenen seçenekler.

SystemErrorRetryPolicyOptions

Başarısız isteklerin nasıl yeniden denendiğini denetleyebilen seçenekler.

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 veya (tarayıcıda) bir Blob olabilir.

HttpMethods

İstekte bulunurken kullanılacak HTTP yöntemleri destekleniyor.

PipelinePhase

İlkeler aşamalar halinde yürütülür. Yürütme sırası:

  1. Aşamayı Seri Hale Getirme
  2. Bir aşamada olmayan ilkeler
  3. Seri Durumdan Çıkarma Aşaması
  4. Yeniden Deneme Aşaması
RawHttpHeaders

Basit bir JSON nesnesi olarak temsil edilen httpheaders koleksiyonu.

RequestBodyType

İstekte desteklenen gövde türleri. NodeJS.ReadableStream yalnızca Node'dur. Blob 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

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

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

createEmptyPipeline()

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

createHttpHeaders(RawHttpHeaders)

HttpHeaders arabirimini karşılayan 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 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

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 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_PROXYortam değişkenlerinden bir ara sunucu URL'sini ayrıştırmaya çalışır.

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)

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 izlemeye yönelik bir ilke.

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)

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.

throttlingRetryPolicy()

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://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits ve https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

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.

userAgentPolicy(UserAgentPolicyOptions)

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

Değişkenler

bearerTokenAuthenticationPolicyName

bearerTokenAuthenticationPolicy'nin programatik tanımlayıcısı.

decompressResponsePolicyName

DecompressResponsePolicy'nin programatik tanımlayıcısı.

expontentialRetryPolicyName

Üstel RetryPolicy'nin programatik tanımlayıcısı.

formDataPolicyName

formDataPolicy'nin programatik tanımlayıcısı.

logPolicyName

logPolicy'nin programatik tanımlayıcısı.

ndJsonPolicyName

ndJsonPolicy'nin programatik tanımlayıcısı.

proxyPolicyName

proxyPolicy'nin programatik tanımlayıcısı.

redirectPolicyName

RedirectPolicy'nin programatik tanımlayıcısı.

setClientRequestIdPolicyName

setClientRequestIdPolicy programatik tanımlayıcısı.

systemErrorRetryPolicyName

systemErrorRetryPolicy'nin programatik tanımlayıcısı.

throttlingRetryPolicyName

throttlingRetryPolicy programatik tanımlayıcısı.

tracingPolicyName

TracingPolicy'nin programatik tanımlayıcısı.

userAgentPolicyName

userAgentPolicy'nin programatik tanımlayıcısı.

İşlev Ayrıntıları

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

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

createHttpHeaders(RawHttpHeaders)

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

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

Parametreler

rawHeaders
RawHttpHeaders

İ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

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)

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_PROXYortam 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

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

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)

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): PipelinePolicy

Parametreler

proxySettings
ProxySettings

Her istekte kullanılacak ProxySettings.

Döndürülenler

redirectPolicy(RedirectPolicyOptions)

Sunucu tarafı yeniden yönlendirmeyi desteklemek için sunucudan Konum üst bilgilerini izlemeye yönelik bir ilke.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parametreler

options
RedirectPolicyOptions

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

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()

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://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits ve https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): PipelinePolicy

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.

Döndürülenler

Variable Details

bearerTokenAuthenticationPolicyName

bearerTokenAuthenticationPolicy'nin programatik tanımlayıcısı.

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

Tür

"bearerTokenAuthenticationPolicy"

decompressResponsePolicyName

DecompressResponsePolicy'nin programatik tanımlayıcısı.

decompressResponsePolicyName: "decompressResponsePolicy"

Tür

"decompressResponsePolicy"

expontentialRetryPolicyName

Üstel RetryPolicy'nin programatik tanımlayıcısı.

expontentialRetryPolicyName: "exponentialRetryPolicy"

Tür

"exponentialRetryPolicy"

formDataPolicyName

formDataPolicy'nin programatik tanımlayıcısı.

formDataPolicyName: "formDataPolicy"

Tür

"formDataPolicy"

logPolicyName

logPolicy'nin programatik tanımlayıcısı.

logPolicyName: "logPolicy"

Tür

"logPolicy"

ndJsonPolicyName

ndJsonPolicy'nin programatik tanımlayıcısı.

ndJsonPolicyName: "ndJsonPolicy"

Tür

"ndJsonPolicy"

proxyPolicyName

proxyPolicy'nin programatik tanımlayıcısı.

proxyPolicyName: "proxyPolicy"

Tür

"proxyPolicy"

redirectPolicyName

RedirectPolicy'nin programatik tanımlayıcısı.

redirectPolicyName: "redirectPolicy"

Tür

"redirectPolicy"

setClientRequestIdPolicyName

setClientRequestIdPolicy programatik tanımlayıcısı.

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

Tür

"setClientRequestIdPolicy"

systemErrorRetryPolicyName

systemErrorRetryPolicy'nin programatik tanımlayıcısı.

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

Tür

"systemErrorRetryPolicy"

throttlingRetryPolicyName

throttlingRetryPolicy programatik tanımlayıcısı.

throttlingRetryPolicyName: "throttlingRetryPolicy"

Tür

"throttlingRetryPolicy"

tracingPolicyName

TracingPolicy'nin programatik tanımlayıcısı.

tracingPolicyName: "tracingPolicy"

Tür

"tracingPolicy"

userAgentPolicyName

userAgentPolicy'nin programatik tanımlayıcısı.

userAgentPolicyName: "userAgentPolicy"

Tür

"userAgentPolicy"