ServiceClientOptions interface

  • 參考
套件:
@azure/ms-rest-js

建立用戶端時要提供的選項。

屬性

agentSettings

HTTP 和 HTTPS 代理程式，這些代理程式只會用於每個 HTTP 要求 (Node.js) 。
baseUri

如果指定：

  • 這會 baseUri 成為將針對此 ServiceClient 提出要求的基底 URI。
  • baseUri如果 符合已知的 Resource Manager 端點，而且 如果 TokenCredential 通過建構函式傳遞 ，則這會 baseUri 定義範圍 getToken 為 ${options.baseUri}/.default 。 否則，範圍會預設為 「 https://management.azure.com/.default" ;。

如果未指定：

  • 所有 OperationSpecs 都必須包含 baseUrl 屬性。
  • TokenCredential如果 已透過建構函式傳遞 ，則 getToken 範圍會設定為 「 https://management.azure.com/.default" ;。
clientRequestIdHeaderName

如果指定，GenerateRequestIdPolicy 將會新增至 HTTP 管線，此管線會將標頭新增至具有此標頭名稱的所有傳出要求，以及隨機 UUID 作為要求識別碼。
deserializationContentTypes

與 JSON 或 XML 序列化相關聯的內容類型。
generateClientRequestIdHeader

是否要為每個 HTTP 要求產生用戶端要求識別碼標頭。
httpClient

將用來傳送 HTTP 要求的 HttpClient。
httpPipelineLogger

可用來偵錯 HTTP 管線內 RequestPolicies 的 HttpPipelineLogger。
noRetryPolicy

如果設定為 true，請關閉預設重試原則。
proxySettings

將用於每個 HTTP 要求的 Proxy 設定 (Node.js 只會) 。
redirectOptions

如何處理重新導向回應的選項。
requestPolicyFactories

呼叫以建立 RequestPolicy 管線的處理站陣列，用來在線上傳送 HTTP 要求，或接受 defaultRequestPolicyFactories 的函式，並傳回將使用的 requestPolicyFactories。
rpRegistrationRetryTimeout

取得或設定 AutomaticRPRegistration 的重試逾時，以秒為單位。 預設值為 30。
userAgent

傳送要求時要設定為遙測標頭的字串，或接受預設使用者代理程式字串的函式，並傳回將使用的使用者代理程式字串。
userAgentHeaderName

傳送要求時，要用於遙測標頭的標頭名稱。 如果未指定此專案，則在Node.js上執行時，將會使用 「User-Agent」，並在瀏覽器中執行時使用 「x-ms-command-name」。
withCredentials

是否要在瀏覽器中的 CORS 要求中包含認證。 如需相關資訊，請參閱 https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials 。

屬性詳細資料

agentSettings

HTTP 和 HTTPS 代理程式，這些代理程式只會用於每個 HTTP 要求 (Node.js) 。

agentSettings?: AgentSettings

屬性值

AgentSettings

baseUri

如果指定：

  • 這會 baseUri 成為將針對此 ServiceClient 提出要求的基底 URI。
  • baseUri如果 符合已知的 Resource Manager 端點，而且 如果 TokenCredential 通過建構函式傳遞 ，則這會 baseUri 定義範圍 getToken 為 ${options.baseUri}/.default 。 否則，範圍會預設為 「 https://management.azure.com/.default" ;。

如果未指定：

  • 所有 OperationSpecs 都必須包含 baseUrl 屬性。
  • TokenCredential如果 已透過建構函式傳遞 ，則 getToken 範圍會設定為 「 https://management.azure.com/.default" ;。
baseUri?: string

屬性值

string

clientRequestIdHeaderName

如果指定，GenerateRequestIdPolicy 將會新增至 HTTP 管線，此管線會將標頭新增至具有此標頭名稱的所有傳出要求，以及隨機 UUID 作為要求識別碼。

clientRequestIdHeaderName?: string

屬性值

string

deserializationContentTypes

與 JSON 或 XML 序列化相關聯的內容類型。

deserializationContentTypes?: DeserializationContentTypes

屬性值

DeserializationContentTypes

generateClientRequestIdHeader

是否要為每個 HTTP 要求產生用戶端要求識別碼標頭。

generateClientRequestIdHeader?: boolean

屬性值

boolean

httpClient

將用來傳送 HTTP 要求的 HttpClient。

httpClient?: HttpClient

屬性值

HttpClient

httpPipelineLogger

可用來偵錯 HTTP 管線內 RequestPolicies 的 HttpPipelineLogger。

httpPipelineLogger?: HttpPipelineLogger

屬性值

HttpPipelineLogger

noRetryPolicy

如果設定為 true，請關閉預設重試原則。

noRetryPolicy?: boolean

屬性值

boolean

proxySettings

將用於每個 HTTP 要求的 Proxy 設定 (Node.js 只會) 。

proxySettings?: ProxySettings

屬性值

ProxySettings

redirectOptions

如何處理重新導向回應的選項。

redirectOptions?: RedirectOptions

屬性值

RedirectOptions

requestPolicyFactories

呼叫以建立 RequestPolicy 管線的處理站陣列，用來在線上傳送 HTTP 要求，或接受 defaultRequestPolicyFactories 的函式，並傳回將使用的 requestPolicyFactories。

requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

屬性值

RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

rpRegistrationRetryTimeout

取得或設定 AutomaticRPRegistration 的重試逾時，以秒為單位。 預設值為 30。

rpRegistrationRetryTimeout?: number

屬性值

number

userAgent

傳送要求時要設定為遙測標頭的字串，或接受預設使用者代理程式字串的函式，並傳回將使用的使用者代理程式字串。

userAgent?: string | (defaultUserAgent: string) => string

屬性值

string | (defaultUserAgent: string) => string

userAgentHeaderName

傳送要求時，要用於遙測標頭的標頭名稱。 如果未指定此專案，則在Node.js上執行時，將會使用 「User-Agent」，並在瀏覽器中執行時使用 「x-ms-command-name」。

userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string

屬性值

string | (defaultUserAgentHeaderName: string) => string

withCredentials

是否要在瀏覽器中的 CORS 要求中包含認證。 如需相關資訊，請參閱 https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials 。

withCredentials?: boolean

屬性值

boolean