ServiceClientOptions interface
Opsi yang akan disediakan saat membuat klien.
Properti
agent |
Agen HTTP dan HTTPS yang akan digunakan untuk setiap permintaan HTTP (hanya Node.js). |
base |
Jika ditentukan:
Jika tidak ditentukan:
|
client |
Jika ditentukan, GenerateRequestIdPolicy akan ditambahkan ke alur HTTP yang akan menambahkan header ke semua permintaan keluar dengan nama header ini dan UUID acak sebagai ID permintaan. |
deserialization |
Jenis konten yang akan dikaitkan dengan serialisasi JSON atau XML. |
generate |
Apakah akan menghasilkan header ID permintaan klien untuk setiap permintaan HTTP atau tidak. |
http |
HttpClient yang akan digunakan untuk mengirim permintaan HTTP. |
http |
HttpPipelineLogger yang dapat digunakan untuk men-debug RequestPolicies dalam alur HTTP. |
no |
Jika diatur ke true, nonaktifkan kebijakan coba lagi default. |
proxy |
Pengaturan proksi yang akan digunakan untuk setiap permintaan HTTP (hanya Node.js). |
redirect |
Opsi tentang cara respons pengalihan ditangani. |
request |
Array pabrik yang dipanggil untuk membuat alur RequestPolicy yang digunakan untuk mengirim permintaan HTTP pada kawat, atau fungsi yang mengambil defaultRequestPolicyFactories dan mengembalikan requestPolicyFactories yang akan digunakan. |
rp |
Mendapatkan atau mengatur batas waktu coba lagi dalam detik untuk AutomaticRPRegistration. Nilai defaultnya adalah 30. |
user |
String yang akan diatur ke header telemetri saat mengirim permintaan, atau fungsi yang mengambil string agen pengguna default dan mengembalikan string agen pengguna yang akan digunakan. |
user |
Nama header yang digunakan untuk header telemetri saat mengirim permintaan. Jika ini tidak ditentukan, maka "User-Agent" akan digunakan saat berjalan pada Node.js dan "x-ms-command-name" akan digunakan saat berjalan di browser. |
with |
Apakah akan menyertakan kredensial dalam permintaan CORS di browser. Lihat https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials untuk informasi lebih lanjut. |
Detail Properti
agentSettings
Agen HTTP dan HTTPS yang akan digunakan untuk setiap permintaan HTTP (hanya Node.js).
agentSettings?: AgentSettings
Nilai Properti
baseUri
Jika ditentukan:
- Ini
baseUri
menjadi URI dasar yang akan dibuat permintaan untuk ServiceClient ini. baseUri
Jika cocok dengan titik akhir manajer sumber daya yang diketahui dan jikaTokenCredential
diteruskan melalui konstruktor, inibaseUri
mendefinisikangetToken
cakupan menjadi${options.baseUri}/.default
. Jika tidak, cakupan akan default ke "https://management.azure.com/.default".
Jika tidak ditentukan:
- Semua OperationSpecs harus berisi properti baseUrl.
TokenCredential
Jika diteruskan melalui konstruktor,getToken
cakupan diatur menjadi "https://management.azure.com/.default".
baseUri?: string
Nilai Properti
string
clientRequestIdHeaderName
Jika ditentukan, GenerateRequestIdPolicy akan ditambahkan ke alur HTTP yang akan menambahkan header ke semua permintaan keluar dengan nama header ini dan UUID acak sebagai ID permintaan.
clientRequestIdHeaderName?: string
Nilai Properti
string
deserializationContentTypes
Jenis konten yang akan dikaitkan dengan serialisasi JSON atau XML.
deserializationContentTypes?: DeserializationContentTypes
Nilai Properti
generateClientRequestIdHeader
Apakah akan menghasilkan header ID permintaan klien untuk setiap permintaan HTTP atau tidak.
generateClientRequestIdHeader?: boolean
Nilai Properti
boolean
httpClient
HttpClient yang akan digunakan untuk mengirim permintaan HTTP.
httpClient?: HttpClient
Nilai Properti
httpPipelineLogger
HttpPipelineLogger yang dapat digunakan untuk men-debug RequestPolicies dalam alur HTTP.
httpPipelineLogger?: HttpPipelineLogger
Nilai Properti
noRetryPolicy
Jika diatur ke true, nonaktifkan kebijakan coba lagi default.
noRetryPolicy?: boolean
Nilai Properti
boolean
proxySettings
Pengaturan proksi yang akan digunakan untuk setiap permintaan HTTP (hanya Node.js).
proxySettings?: ProxySettings
Nilai Properti
redirectOptions
Opsi tentang cara respons pengalihan ditangani.
redirectOptions?: RedirectOptions
Nilai Properti
requestPolicyFactories
Array pabrik yang dipanggil untuk membuat alur RequestPolicy yang digunakan untuk mengirim permintaan HTTP pada kawat, atau fungsi yang mengambil defaultRequestPolicyFactories dan mengembalikan requestPolicyFactories yang akan digunakan.
requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]
Nilai Properti
RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]
rpRegistrationRetryTimeout
Mendapatkan atau mengatur batas waktu coba lagi dalam detik untuk AutomaticRPRegistration. Nilai defaultnya adalah 30.
rpRegistrationRetryTimeout?: number
Nilai Properti
number
userAgent
String yang akan diatur ke header telemetri saat mengirim permintaan, atau fungsi yang mengambil string agen pengguna default dan mengembalikan string agen pengguna yang akan digunakan.
userAgent?: string | (defaultUserAgent: string) => string
Nilai Properti
string | (defaultUserAgent: string) => string
userAgentHeaderName
Nama header yang digunakan untuk header telemetri saat mengirim permintaan. Jika ini tidak ditentukan, maka "User-Agent" akan digunakan saat berjalan pada Node.js dan "x-ms-command-name" akan digunakan saat berjalan di browser.
userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string
Nilai Properti
string | (defaultUserAgentHeaderName: string) => string
withCredentials
Apakah akan menyertakan kredensial dalam permintaan CORS di browser. Lihat https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials untuk informasi lebih lanjut.
withCredentials?: boolean
Nilai Properti
boolean