@azure-rest/core-client package

Arabirimler

AddCredentialPipelinePolicyOptions	İşlem hattına kimlik bilgisi ilkesi eklemek için isteğe bağlı parametreler.
AdditionalPolicyConfig	oluşturma sırasında işlem hattına eklenen ek ilkeleri yapılandırmak için kullanılır.
Client	Rest Düzeyi İstemcisinin Şekli
ErrorModel	Hata nesnesi.
ErrorResponse	Hata ayrıntılarını içeren bir yanıt.
FullOperationResponse	Http isteği ve yanıtı için sarmalayıcı nesnesi. Seri durumdan çıkarılmış nesne, yanıt gövdesi JSON'da parsedBody alındığında özelliğinde depolanır.
InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
OperationOptions	Tüm işlemler için temel seçenekler türü.
OperationRequestOptions	Bu işlem için HTTP istekleri oluştururken ve gönderirken kullanılan seçenekler.
ResourceMethods	Bir kaynakta çağrılabilecek yöntemleri tanımlar

Tür Diğer Adları

ClientOptions	Rest Düzeyi İstemcisi'nin alabildiği genel seçenekler
HttpBrowserStreamResponse	Hangi gövdenin NodeJS akış nesnesi olduğu Http Yanıtı
HttpNodeStreamResponse	Hangi gövdenin NodeJS akış nesnesi olduğu Http Yanıtı
HttpResponse	HttpResponse şeklini temsil eder
PathParameters	Çevrelenen {} bir yol şablonu metnindeki parametreleri algılamak için kullanılan yardımcı türü yol parametresi olarak kabul edilir
PathUnchecked	pathUnchecked için imzayı tanımlar.
PathUncheckedResponse	pathUnchecked ile kullanılacak tür, esneklik sağlamak için gövde türünü herhangi birine geçersiz kılar
RawResponseCallback	İstenen işlem gerçekleştirilirken sunucudan her yanıt alındığında çağrılacak bir işlev. Birden çok kez çağrılabilir.
RequestParameters	Varsayılan istek parametrelerinin şekli, güçlü türler sağlamak için belirli istek türleri tarafından geçersiz kılınabilir
StreamableMethod	Yanıt gövdesini ham akış olarak almayı destekleyen bir yöntemin türünü tanımlar

İşlevler

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)	Kimlik bilgisi sağlanırsa işlem hattına bir kimlik bilgisi ilkesi ekler. Hiçbir ilke sağlanmazsa, ilke eklenmez.
createRestError(PathUncheckedResponse)	PathUnchecked yanıtından rest hatası oluşturur
createRestError(string, PathUncheckedResponse)	Hata iletisinden ve PathUnchecked yanıtından rest hatası oluşturur
getClient(string, ClientOptions)	Varsayılan işlem hattı ile bir istemci oluşturur
getClient(string, TokenCredential | KeyCredential, ClientOptions)	Varsayılan işlem hattı ile bir istemci oluşturur
operationOptionsToRequestParameters(OperationOptions)	OperationOptions'ı RequestParameters'a dönüştürmek için yardımcı işlev

İşlev Ayrıntıları

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Kimlik bilgisi sağlanırsa işlem hattına bir kimlik bilgisi ilkesi ekler. Hiçbir ilke sağlanmazsa, ilke eklenmez.

function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)

Parametreler

pipeline

Pipeline

endpoint

string

options

AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

PathUnchecked yanıtından rest hatası oluşturur

function createRestError(response: PathUncheckedResponse): RestError

Parametreler

response

PathUncheckedResponse

Döndürülenler

RestError

createRestError(string, PathUncheckedResponse)

Hata iletisinden ve PathUnchecked yanıtından rest hatası oluşturur

function createRestError(message: string, response: PathUncheckedResponse): RestError

Parametreler

message

string

response

PathUncheckedResponse

Döndürülenler

RestError

getClient(string, ClientOptions)

Varsayılan işlem hattı ile bir istemci oluşturur

function getClient(endpoint: string, options?: ClientOptions): Client

Parametreler

endpoint

string

İstemci için temel uç nokta

options

ClientOptions

İstemci seçenekleri

Döndürülenler

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Varsayılan işlem hattı ile bir istemci oluşturur

function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client

Parametreler

endpoint

string

İstemci için temel uç nokta

credentials

TokenCredential | KeyCredential

İsteklerin kimliğini doğrulamak için kimlik bilgileri

options

ClientOptions

İstemci seçenekleri

Döndürülenler

Client

operationOptionsToRequestParameters(OperationOptions)

OperationOptions'ı RequestParameters'a dönüştürmek için yardımcı işlev

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parametreler

options

OperationOptions

Modüler katman tarafından isteği göndermek için kullanılan seçenekler

Döndürülenler

RequestParameters

RLC katmanının RequestParameters'ında dönüştürmenin sonucu