Dela via

ServiceClientOptions interface

  • Referens
Paket:
@azure/ms-rest-js

Alternativ som ska anges när klienten skapas.

Egenskaper

agentSettings

HTTP- och HTTPS-agenter som används för varje HTTP-begäran (endast Node.js).
baseUri

Om det anges:

  • Detta baseUri blir den bas-URI som begäranden görs mot för denna ServiceClient.
  • Om matchar baseUri en känd resource manager-slutpunkt och om en TokenCredential skickades via konstruktorn definierar detta baseUri omfånget getToken som ${options.baseUri}/.default. Annars skulle omfånget som standard vara "https://management.azure.com/.default".

Om den inte har angetts:

  • Alla OperationSpecs måste innehålla en baseUrl-egenskap.
  • Om en TokenCredential skickades genom konstruktorn är omfånget getToken inställt på "https://management.azure.com/.default".
clientRequestIdHeaderName

Om det anges läggs en GenerateRequestIdPolicy till i HTTP-pipelinen som lägger till ett huvud i alla utgående begäranden med det här rubriknamnet och ett slumpmässigt UUID som begärande-ID.
deserializationContentTypes

De innehållstyper som ska associeras med JSON- eller XML-serialisering.
generateClientRequestIdHeader

Om du vill generera ett klientbegärande-ID för varje HTTP-begäran eller inte.
httpClient

Den HttpClient som ska användas för att skicka HTTP-begäranden.
httpPipelineLogger

HttpPipelineLogger som kan användas för att felsöka RequestPolicies i HTTP-pipelinen.
noRetryPolicy

Om värdet är true inaktiverar du standardprincipen för återförsök.
proxySettings

Proxyinställningar som används för varje HTTP-begäran (endast Node.js).
redirectOptions

Alternativ för hur omdirigeringssvar hanteras.
requestPolicyFactories

En matris med fabriker som anropas för att skapa RequestPolicy-pipelinen som används för att skicka en HTTP-begäran på tråden, eller en funktion som tar in defaultRequestPolicyFactories och returnerar requestPolicyFactories som ska användas.
rpRegistrationRetryTimeout

Hämtar eller anger tidsgränsen för återförsök i sekunder för AutomaticRPRegistration. Standardvärdet är 30.
userAgent

Strängen som ska anges till telemetrihuvudet när begäran skickas, eller en funktion som tar in standardsträngen för användaragenten och returnerar den användaragentsträng som ska användas.
userAgentHeaderName

Rubriknamnet som ska användas för telemetrihuvudet när begäran skickas. Om detta inte anges används "User-Agent" när den körs på Node.js och "x-ms-command-name" används när den körs i en webbläsare.
withCredentials

Om autentiseringsuppgifter ska inkluderas i CORS-begäranden i webbläsaren. Mer information finns i https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Egenskapsinformation

agentSettings

HTTP- och HTTPS-agenter som används för varje HTTP-begäran (endast Node.js).

agentSettings?: AgentSettings

Egenskapsvärde

AgentSettings

baseUri

Om det anges:

  • Detta baseUri blir den bas-URI som begäranden görs mot för denna ServiceClient.
  • Om matchar baseUri en känd resource manager-slutpunkt och om en TokenCredential skickades via konstruktorn definierar detta baseUri omfånget getToken som ${options.baseUri}/.default. Annars skulle omfånget som standard vara "https://management.azure.com/.default".

Om den inte har angetts:

  • Alla OperationSpecs måste innehålla en baseUrl-egenskap.
  • Om en TokenCredential skickades genom konstruktorn är omfånget getToken inställt på "https://management.azure.com/.default".
baseUri?: string

Egenskapsvärde

string

clientRequestIdHeaderName

Om det anges läggs en GenerateRequestIdPolicy till i HTTP-pipelinen som lägger till ett huvud i alla utgående begäranden med det här rubriknamnet och ett slumpmässigt UUID som begärande-ID.

clientRequestIdHeaderName?: string

Egenskapsvärde

string

deserializationContentTypes

De innehållstyper som ska associeras med JSON- eller XML-serialisering.

deserializationContentTypes?: DeserializationContentTypes

Egenskapsvärde

DeserializationContentTypes

generateClientRequestIdHeader

Om du vill generera ett klientbegärande-ID för varje HTTP-begäran eller inte.

generateClientRequestIdHeader?: boolean

Egenskapsvärde

boolean

httpClient

Den HttpClient som ska användas för att skicka HTTP-begäranden.

httpClient?: HttpClient

Egenskapsvärde

HttpClient

httpPipelineLogger

HttpPipelineLogger som kan användas för att felsöka RequestPolicies i HTTP-pipelinen.

httpPipelineLogger?: HttpPipelineLogger

Egenskapsvärde

HttpPipelineLogger

noRetryPolicy

Om värdet är true inaktiverar du standardprincipen för återförsök.

noRetryPolicy?: boolean

Egenskapsvärde

boolean

proxySettings

Proxyinställningar som används för varje HTTP-begäran (endast Node.js).

proxySettings?: ProxySettings

Egenskapsvärde

ProxySettings

redirectOptions

Alternativ för hur omdirigeringssvar hanteras.

redirectOptions?: RedirectOptions

Egenskapsvärde

RedirectOptions

requestPolicyFactories

En matris med fabriker som anropas för att skapa RequestPolicy-pipelinen som används för att skicka en HTTP-begäran på tråden, eller en funktion som tar in defaultRequestPolicyFactories och returnerar requestPolicyFactories som ska användas.

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

Egenskapsvärde

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

rpRegistrationRetryTimeout

Hämtar eller anger tidsgränsen för återförsök i sekunder för AutomaticRPRegistration. Standardvärdet är 30.

rpRegistrationRetryTimeout?: number

Egenskapsvärde

number

userAgent

Strängen som ska anges till telemetrihuvudet när begäran skickas, eller en funktion som tar in standardsträngen för användaragenten och returnerar den användaragentsträng som ska användas.

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

Egenskapsvärde

string | (defaultUserAgent: string) => string

userAgentHeaderName

Rubriknamnet som ska användas för telemetrihuvudet när begäran skickas. Om detta inte anges används "User-Agent" när den körs på Node.js och "x-ms-command-name" används när den körs i en webbläsare.

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

Egenskapsvärde

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Om autentiseringsuppgifter ska inkluderas i CORS-begäranden i webbläsaren. Mer information finns i https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Egenskapsvärde

boolean