@azure/core-client package
Kelas
| ServiceClient |
Menginisialisasi instans baru ServiceClient. |
Antarmuka
| AdditionalPolicyConfig |
Digunakan untuk mengonfigurasi kebijakan tambahan yang ditambahkan ke alur saat konstruksi. |
| BaseMapper |
Definisi dasar pemeta. Dapat digunakan untuk XML dan objek JavaScript biasa. |
| CommonClientOptions |
Serangkaian opsi umum yang diharapkan untuk diekspos oleh klien tingkat tinggi. |
| CompositeMapper |
Pemeta yang terdiri dari pemeta lain. |
| CompositeMapperType |
Membantu membangun pemeta yang menjelaskan cara memetakan sekumpulan properti objek berdasarkan pemeta lain. Hanya salah satu properti berikut yang harus ada: |
| DeserializationContentTypes |
Jenis konten yang akan menunjukkan bahwa respons operasi harus dideserialisasi dengan cara tertentu. |
| DeserializationPolicyOptions |
Opsi untuk mengonfigurasi deserialisasi respons API. |
| DictionaryMapper |
Pemeta yang menjelaskan objek JavaScript biasa yang digunakan sebagai pasangan kunci/nilai. |
| DictionaryMapperType |
Membantu membangun pemeta yang menjelaskan cara mengurai kamus nilai yang dipetakan. |
| EnumMapper |
Pemeta yang menjelaskan nilai enum. |
| EnumMapperType |
Membantu membangun pemeta yang menjelaskan cara mengurai nilai enum. |
| FullOperationResponse |
Objek pembungkus untuk permintaan dan respons http. Objek yang dideserialisasi disimpan di |
| InternalClientPipelineOptions |
Opsi untuk membuat Alur yang akan digunakan dengan ServiceClient. Sebagian besar untuk menyesuaikan kebijakan autentikasi (jika menggunakan autentikasi token) atau opsi deserialisasi saat menggunakan XML. |
| MapperConstraints |
Deskripsi berbagai batasan nilai seperti rentang bilangan bulat dan regex string. |
| OperationArguments |
Kumpulan properti yang berlaku untuk satu pemanggilan operasi. |
| OperationOptions |
Jenis opsi dasar untuk semua operasi. |
| OperationParameter |
Antarmuka umum yang diperluas oleh semua parameter Operasi. |
| OperationQueryParameter |
Parameter untuk operasi yang akan ditambahkan sebagai parameter kueri ke permintaan HTTP operasi. |
| OperationRequestInfo |
Metadata yang digunakan untuk mengurai respons dengan benar. |
| OperationRequestOptions |
Opsi yang digunakan saat membuat dan mengirim permintaan HTTP untuk operasi ini. |
| OperationResponseMap |
Respons Operasi yang dapat dikembalikan dari permintaan operasi untuk satu kode status. |
| OperationSpec |
Spesifikasi yang mendefinisikan operasi. |
| OperationURLParameter |
Parameter untuk operasi yang akan diganti ke dalam URL permintaan operasi. |
| PolymorphicDiscriminator |
Digunakan untuk membedakan jenis serikat yang diskriminasi. Misalnya, jika respons dapat memiliki banyak bentuk tetapi juga menyertakan bidang 'jenis' (atau sejenisnya), bidang tersebut dapat digunakan untuk menentukan cara mendeserialisasi respons ke jenis yang benar. |
| SequenceMapper |
Pemeta yang menjelaskan array. |
| SequenceMapperType |
Membantu membangun pemeta yang menjelaskan cara mengurai urutan nilai yang dipetakan. |
| SerializationPolicyOptions |
Opsi untuk mengonfigurasi serialisasi permintaan API. |
| Serializer |
Digunakan untuk memetakan objek respons mentah ke bentuk akhir. Membantu pengemasan dan pembukaan Tanggal dan jenis yang dikodekan lainnya yang tidak intrinsik ke JSON. Juga memungkinkan menarik nilai dari header, serta menyisipkan nilai dan konstanta default. |
| SerializerOptions |
Opsi untuk mengonfigurasi perilaku serialisasi/deserialisasi. |
| ServiceClientOptions |
Opsi yang akan disediakan saat membuat klien. |
| SimpleMapperType |
Jenis pemeta sederhana. |
| SpanConfig |
Konfigurasi untuk membuat Rentang Pelacakan baru |
| XmlOptions |
Opsi untuk mengatur perilaku pengurai dan penyusun xml. |
Alias Jenis
| Mapper |
Pemeta adalah definisi dari model data yang digunakan dalam pustaka. Model data ini adalah bagian dari definisi Operasi atau Klien dalam respons atau parameter. |
| MapperType |
Jenis pemeta. Termasuk pemeta yang diketahui. |
| OperationRequest |
Alias jenis untuk pemeriksaan di masa mendatang. |
| ParameterPath |
Mengodekan cara menjangkau properti tertentu pada objek. |
| QueryCollectionFormat |
Format yang akan digunakan untuk menggabungkan array nilai bersama-sama untuk nilai parameter kueri. |
| RawResponseCallback |
Fungsi yang akan dipanggil setiap kali respons diterima dari server saat melakukan operasi yang diminta. Dapat dipanggil beberapa kali. |
Fungsi
| authorize |
Fungsi ini dapat digunakan sebagai panggilan balik untuk
Setelah disediakan, Contoh tantangan dengan klaim: |
| authorize |
Mendefinisikan panggilan balik untuk menangani tantangan autentikasi untuk API Penyimpanan. Ini menerapkan proses tantangan pembawa yang dijelaskan di sini: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Penanganan memiliki fitur khusus untuk penyimpanan yang berangkat ke dokumen tantangan AAD umum. |
| create |
Membuat Alur baru untuk digunakan dengan Klien Layanan. Menambahkan deserializationPolicy secara default. Juga menambahkan dalam bearerTokenAuthenticationPolicy jika melewati TokenCredential. |
| create |
Metode yang membuat dan mengembalikan Serializer. |
| deserialization |
Kebijakan ini menangani penguraian respons sesuai dengan OperationSpecs pada permintaan. |
| serialization |
Kebijakan ini menangani perakitan isi permintaan dan header menggunakan OperationSpec dan OperationArguments pada permintaan. |
Detail Fungsi
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
Fungsi ini dapat digunakan sebagai panggilan balik untuk bearerTokenAuthenticationPolicy dari @azure/core-rest-pipeline, untuk mendukung tantangan CAE: Evaluasi Akses Berkelanjutan.
bearerTokenAuthenticationPolicy Panggil dengan opsi berikut:
import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});
Setelah disediakan, bearerTokenAuthenticationPolicy kebijakan akan menangani tantangan Evaluasi Akses Berkelanjutan (CAE) secara internal.
Ketika tidak dapat menyelesaikan tantangan, ia akan mengembalikan respons 401 (tidak sah) dari ARM.
Contoh tantangan dengan klaim:
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>Parameter
- onChallengeOptions
- AuthorizeRequestOnChallengeOptions
Mengembalikan
Promise<boolean>
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)
Mendefinisikan panggilan balik untuk menangani tantangan autentikasi untuk API Penyimpanan. Ini menerapkan proses tantangan pembawa yang dijelaskan di sini: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Penanganan memiliki fitur khusus untuk penyimpanan yang berangkat ke dokumen tantangan AAD umum.
function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>Parameter
- challengeOptions
- AuthorizeRequestOnChallengeOptions
Mengembalikan
Promise<boolean>
createClientPipeline(InternalClientPipelineOptions)
Membuat Alur baru untuk digunakan dengan Klien Layanan. Menambahkan deserializationPolicy secara default. Juga menambahkan dalam bearerTokenAuthenticationPolicy jika melewati TokenCredential.
function createClientPipeline(options?: InternalClientPipelineOptions): PipelineParameter
- options
- InternalClientPipelineOptions
Opsi untuk menyesuaikan alur yang dibuat.
Mengembalikan
createSerializer({[key: string]: any}, boolean)
Metode yang membuat dan mengembalikan Serializer.
function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): SerializerParameter
- modelMappers
-
{[key: string]: any}
Model yang diketahui untuk dipetakan
- isXML
-
boolean
Jika XML harus didukung
Mengembalikan
deserializationPolicy(DeserializationPolicyOptions)
Kebijakan ini menangani penguraian respons sesuai dengan OperationSpecs pada permintaan.
function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicyParameter
- options
- DeserializationPolicyOptions
Mengembalikan
serializationPolicy(SerializationPolicyOptions)
Kebijakan ini menangani perakitan isi permintaan dan header menggunakan OperationSpec dan OperationArguments pada permintaan.
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicyParameter
- options
- SerializationPolicyOptions