@azure/core-client package

Sınıflar

ServiceClient

ServiceClient'ın yeni bir örneğini başlatır.

Arabirimler

AdditionalPolicyConfig	oluşturma sırasında işlem hattına eklenen ek ilkeleri yapılandırmak için kullanılır.
BaseMapper	Eşleyicinin temel tanımı. XML ve düz JavaScript nesneleri için kullanılabilir.
CommonClientOptions	Üst düzey istemcilerin kullanıma sunmaları beklenen ortak seçenek kümesi.
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.
DeserializationPolicyOptions	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.
FullOperationResponse	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 .
InternalClientPipelineOptions	ServiceClient ile kullanılacak bir İşlem Hattı oluşturma seçenekleri. Çoğunlukla, XML kullanırken kimlik doğrulama ilkesini (belirteç kimlik doğrulaması kullanılıyorsa) veya seri durumdan çıkarma seçeneklerini özelleştirmek için kullanılır.
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.
OperationRequestInfo	Yanıtı düzgün ayrıştırmak için kullanılan meta veriler.
OperationRequestOptions	Bu işlem için HTTP istekleri oluştururken ve gönderirken kullanılan seçenekler.
OperationResponseMap	Tek bir durum kodu için bir işlem isteğinden döndürülebilen operationResponse.
OperationSpec	bir işlemi tanımlayan belirtim.
OperationURLParameter	İşlemin istek URL'sinin yerine geçecek bir işlem parametresi.
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.
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.
SerializationPolicyOptions	API isteği serileştirmesini yapılandırma seçenekleri.
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.
SerializerOptions	Serileştirme/serileştirmeyi kaldırma davranışını yapılandırma seçenekleri.
ServiceClientOptions	İstemci oluşturulurken sağlanacak seçenekler.
SimpleMapperType	Basit bir eşleştiricinin türü.
SpanConfig	Yeni bir İzleme Aralığı oluşturmak için yapılandırma
XmlOptions	Xml ayrıştırıcısının ve oluşturucunun davranışını idare etme seçenekleri.

Tür Diğer Adları

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.
OperationRequest	Gelecekteki yazım denetleme için bir tür diğer adı.
ParameterPath	Bir nesnedeki belirli bir özelliğe nasıl ulaşacaklarını kodlar.
QueryCollectionFormat	Sorgu parametresi değeri için bir değer dizisini birleştirmek için kullanılacak biçim.
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.

İşlevler

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	Bu işlev, CAE zorluklarını desteklemek için bearerTokenAuthenticationPolicy@azure/core-rest-pipelineiçin geri çağırma olarak kullanılabilir: Sürekli Erişim Değerlendirmesi. bearerTokenAuthenticationPolicy aşağıdaki seçeneklerle çağrısı yapın: import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline"; import { authorizeRequestOnClaimChallenge } from "@azure/core-client"; const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({ authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge }); İlke sağlandıktan bearerTokenAuthenticationPolicy sonra Sürekli Erişim Değerlendirmesi (CAE) zorluklarını dahili olarak ele alır. Bir sınamayı tamamlayamazsa ARM'den 401 (yetkisiz) yanıt döndürür. Taleplerle ilgili örnek sınama: Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token", error_description="User session has been revoked", claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)	Depolama API'leri için kimlik doğrulaması sınamasını işlemek için bir geri çağırma tanımlar. Bu, burada açıklanan taşıyıcı sınama sürecini uygular: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge İşleme, genel AAD sınama belgelerine ayrılan depolama için belirli özelliklere sahiptir.
createClientPipeline(InternalClientPipelineOptions)	Hizmet İstemcisi ile kullanmak için yeni bir İşlem Hattı oluşturur. DeserializationPolicy'yi varsayılan olarak ekler. Ayrıca tokenCredential geçirildiyse bearerTokenAuthenticationPolicy değerini ekler.
createSerializer({[key: string]: any}, boolean)	Seri hale getirici oluşturan ve döndüren yöntem.
deserializationPolicy(DeserializationPolicyOptions)	Bu ilke, istekte OperationSpecs'e göre yanıtları ayrıştırmayı işler.
serializationPolicy(SerializationPolicyOptions)	Bu ilke, istekte OperationSpec ve OperationArguments kullanarak istek gövdesini ve üst bilgilerini derlemeyi işler.

İşlev Ayrıntıları

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Bu işlev, CAE zorluklarını desteklemek için bearerTokenAuthenticationPolicy@azure/core-rest-pipelineiçin geri çağırma olarak kullanılabilir: Sürekli Erişim Değerlendirmesi.

bearerTokenAuthenticationPolicy aşağıdaki seçeneklerle çağrısı yapın:

import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";

const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
  authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});

İlke sağlandıktan bearerTokenAuthenticationPolicy sonra Sürekli Erişim Değerlendirmesi (CAE) zorluklarını dahili olarak ele alır. Bir sınamayı tamamlayamazsa ARM'den 401 (yetkisiz) yanıt döndürür.

Taleplerle ilgili örnek sınama:

Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token",
error_description="User session has been revoked",
claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="

function authorizeRequestOnClaimChallenge(onChallengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

Parametreler

onChallengeOptions

AuthorizeRequestOnChallengeOptions

Döndürülenler

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Depolama API'leri için kimlik doğrulaması sınamasını işlemek için bir geri çağırma tanımlar. Bu, burada açıklanan taşıyıcı sınama sürecini uygular: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge İşleme, genel AAD sınama belgelerine ayrılan depolama için belirli özelliklere sahiptir.

function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

Parametreler

challengeOptions

AuthorizeRequestOnChallengeOptions

Döndürülenler

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

Hizmet İstemcisi ile kullanmak için yeni bir İşlem Hattı oluşturur. DeserializationPolicy'yi varsayılan olarak ekler. Ayrıca tokenCredential geçirildiyse bearerTokenAuthenticationPolicy değerini ekler.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Parametreler

options

InternalClientPipelineOptions

Oluşturulan işlem hattını özelleştirme seçenekleri.

Döndürülenler

Pipeline

createSerializer({[key: string]: any}, boolean)

Seri hale getirici oluşturan ve döndüren yöntem.

function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): Serializer

Parametreler

modelMappers

{[key: string]: any}

Eşlenecek bilinen modeller

isXML

boolean

XML'nin desteklenmesi gerekiyorsa

Döndürülenler

Serializer

deserializationPolicy(DeserializationPolicyOptions)

Bu ilke, istekte OperationSpecs'e göre yanıtları ayrıştırmayı işler.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parametreler

options

DeserializationPolicyOptions

Döndürülenler

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Bu ilke, istekte OperationSpec ve OperationArguments kullanarak istek gövdesini ve üst bilgilerini derlemeyi işler.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parametreler

options

SerializationPolicyOptions

Döndürülenler

PipelinePolicy