Share via

ServiceClientOptions interface

Package:
@azure/ms-rest-js

Options to be provided while creating the client.

Properties

agentSettings

HTTP and HTTPS agents which will be used for every HTTP request (Node.js only).
baseUri

If specified:

  • This baseUri becomes the base URI that requests will be made against for this ServiceClient.
  • If the baseUri matches a known resource manager endpoint and if a TokenCredential was passed through the constructor, this baseUri defines the getToken scope to be ${options.baseUri}/.default. Otherwise, the scope would default to "https://management.azure.com/.default".

If it is not specified:

  • All OperationSpecs must contain a baseUrl property.
  • If a TokenCredential was passed through the constructor, the getToken scope is set to be "https://management.azure.com/.default".
clientRequestIdHeaderName

If specified, a GenerateRequestIdPolicy will be added to the HTTP pipeline that will add a header to all outgoing requests with this header name and a random UUID as the request ID.
deserializationContentTypes

The content-types that will be associated with JSON or XML serialization.
generateClientRequestIdHeader

Whether or not to generate a client request ID header for each HTTP request.
httpClient

The HttpClient that will be used to send HTTP requests.
httpPipelineLogger

The HttpPipelineLogger that can be used to debug RequestPolicies within the HTTP pipeline.
noRetryPolicy

If set to true, turn off the default retry policy.
proxySettings

Proxy settings which will be used for every HTTP request (Node.js only).
redirectOptions

Options for how redirect responses are handled.
requestPolicyFactories

An array of factories which get called to create the RequestPolicy pipeline used to send a HTTP request on the wire, or a function that takes in the defaultRequestPolicyFactories and returns the requestPolicyFactories that will be used.
rpRegistrationRetryTimeout

Gets or sets the retry timeout in seconds for AutomaticRPRegistration. Default value is 30.
userAgent

The string to be set to the telemetry header while sending the request, or a function that takes in the default user-agent string and returns the user-agent string that will be used.
userAgentHeaderName

The header name to use for the telemetry header while sending the request. If this is not specified, then "User-Agent" will be used when running on Node.js and "x-ms-command-name" will be used when running in a browser.
withCredentials

Whether to include credentials in CORS requests in the browser. See https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials for more information.

Property Details

agentSettings

HTTP and HTTPS agents which will be used for every HTTP request (Node.js only).

agentSettings?: AgentSettings

Property Value

AgentSettings

baseUri

If specified:

  • This baseUri becomes the base URI that requests will be made against for this ServiceClient.
  • If the baseUri matches a known resource manager endpoint and if a TokenCredential was passed through the constructor, this baseUri defines the getToken scope to be ${options.baseUri}/.default. Otherwise, the scope would default to "https://management.azure.com/.default".

If it is not specified:

  • All OperationSpecs must contain a baseUrl property.
  • If a TokenCredential was passed through the constructor, the getToken scope is set to be "https://management.azure.com/.default".
baseUri?: string

Property Value

string

clientRequestIdHeaderName

If specified, a GenerateRequestIdPolicy will be added to the HTTP pipeline that will add a header to all outgoing requests with this header name and a random UUID as the request ID.

clientRequestIdHeaderName?: string

Property Value

string

deserializationContentTypes

The content-types that will be associated with JSON or XML serialization.

deserializationContentTypes?: DeserializationContentTypes

Property Value

DeserializationContentTypes

generateClientRequestIdHeader

Whether or not to generate a client request ID header for each HTTP request.

generateClientRequestIdHeader?: boolean

Property Value

boolean

httpClient

The HttpClient that will be used to send HTTP requests.

httpClient?: HttpClient

Property Value

HttpClient

httpPipelineLogger

The HttpPipelineLogger that can be used to debug RequestPolicies within the HTTP pipeline.

httpPipelineLogger?: HttpPipelineLogger

Property Value

HttpPipelineLogger

noRetryPolicy

If set to true, turn off the default retry policy.

noRetryPolicy?: boolean

Property Value

boolean

proxySettings

Proxy settings which will be used for every HTTP request (Node.js only).

proxySettings?: ProxySettings

Property Value

ProxySettings

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectOptions

Property Value

RedirectOptions

requestPolicyFactories

An array of factories which get called to create the RequestPolicy pipeline used to send a HTTP request on the wire, or a function that takes in the defaultRequestPolicyFactories and returns the requestPolicyFactories that will be used.

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

Property Value

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

rpRegistrationRetryTimeout

Gets or sets the retry timeout in seconds for AutomaticRPRegistration. Default value is 30.

rpRegistrationRetryTimeout?: number

Property Value

number

userAgent

The string to be set to the telemetry header while sending the request, or a function that takes in the default user-agent string and returns the user-agent string that will be used.

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

Property Value

string | (defaultUserAgent: string) => string

userAgentHeaderName

The header name to use for the telemetry header while sending the request. If this is not specified, then "User-Agent" will be used when running on Node.js and "x-ms-command-name" will be used when running in a browser.

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

Property Value

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Whether to include credentials in CORS requests in the browser. See https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials for more information.

withCredentials?: boolean

Property Value

boolean