ServiceClientOptions interface

Paket:

@azure/ms-rest-js

Opsi yang akan disediakan saat membuat klien.

Properti

agentSettings	Agen HTTP dan HTTPS yang akan digunakan untuk setiap permintaan HTTP (hanyaNode.js).
baseUri	Jika ditentukan: baseUri ini menjadi URI dasar yang akan dibuat permintaan untuk ServiceClient ini. Jika baseUri cocok dengan titik akhir resource manager yang diketahui dan jika TokenCredential diteruskan melalui konstruktor, baseUri ini menentukan cakupan getToken menjadi ${options.baseUri}/.default. Jika tidak, cakupan akan default ke "https://management.azure.com/.default". Jika tidak ditentukan: Semua OperationSpecs harus berisi properti baseUrl. Jika TokenCredential diteruskan melalui konstruktor, cakupan getToken diatur menjadi "https://management.azure.com/.default".
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.
deserializationContentTypes	Jenis konten yang akan dikaitkan dengan serialisasi JSON atau XML.
generateClientRequestIdHeader	Apakah akan menghasilkan header ID permintaan klien untuk setiap permintaan HTTP atau tidak.
httpClient	HttpClient yang akan digunakan untuk mengirim permintaan HTTP.
httpPipelineLogger	HttpPipelineLogger yang dapat digunakan untuk men-debug RequestPolicies dalam alur HTTP.
noRetryPolicy	Jika diatur ke true, nonaktifkan kebijakan coba lagi default.
proxySettings	Pengaturan proksi yang akan digunakan untuk setiap permintaan HTTP ( hanyaNode.js).
redirectOptions	Opsi untuk bagaimana respons pengalihan ditangani.
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.
rpRegistrationRetryTimeout	Mendapatkan atau mengatur batas waktu coba lagi dalam detik untuk AutomaticRPRegistration. Nilai defaultnya adalah 30.
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.
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.
withCredentials	Apakah akan menyertakan kredensial dalam permintaan CORS di browser. Lihat https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials untuk informasi selengkapnya.

Detail Properti

agentSettings

Agen HTTP dan HTTPS yang akan digunakan untuk setiap permintaan HTTP (hanyaNode.js).

agentSettings?: AgentSettings

Nilai Properti

AgentSettings

baseUri

Jika ditentukan:

• baseUri ini menjadi URI dasar yang akan dibuat permintaan untuk ServiceClient ini.
• Jika baseUri cocok dengan titik akhir resource manager yang diketahui dan jika TokenCredential diteruskan melalui konstruktor, baseUri ini menentukan cakupan getToken menjadi ${options.baseUri}/.default. Jika tidak, cakupan akan default ke "https://management.azure.com/.default".

Jika tidak ditentukan:

• Semua OperationSpecs harus berisi properti baseUrl.
• Jika TokenCredential diteruskan melalui konstruktor, cakupan getToken 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

DeserializationContentTypes

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

HttpClient

httpPipelineLogger

HttpPipelineLogger yang dapat digunakan untuk men-debug RequestPolicies dalam alur HTTP.

httpPipelineLogger?: HttpPipelineLogger

Nilai Properti

HttpPipelineLogger

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 ( hanyaNode.js).

proxySettings?: ProxySettings

Nilai Properti

ProxySettings

redirectOptions

Opsi untuk bagaimana respons pengalihan ditangani.

redirectOptions?: RedirectOptions

Nilai Properti

RedirectOptions

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 selengkapnya.

withCredentials?: boolean

Nilai Properti

boolean