ServiceClientOptions interface

Paquete:

@azure/core-http

Opciones que se proporcionarán al crear el cliente.

Propiedades

clientRequestIdHeaderName	Si se especifica, se agregará un GenerateRequestIdPolicy a la canalización HTTP que agregará un encabezado a todas las solicitudes salientes con este nombre de encabezado y un UUID aleatorio como identificador de solicitud.
credentialScopes	Si se especifica, se usará para compilar BearerTokenAuthenticationPolicy.
deserializationContentTypes	Los tipos de contenido que se asociarán a la serialización JSON o XML.
generateClientRequestIdHeader	Si se va a generar o no un encabezado de identificador de solicitud de cliente para cada solicitud HTTP.
httpClient	HttpClient que se usará para enviar solicitudes HTTP.
httpPipelineLogger	HttpPipelineLogger que se puede usar para depurar RequestPolicies dentro de la canalización HTTP.
noRetryPolicy	Si se establece en true, desactive la directiva de reintento predeterminada.
proxySettings	Configuración de proxy que se usará para cada solicitud HTTP (solo Node.js).
requestPolicyFactories	Matriz de generadores a los que se llama para crear la canalización RequestPolicy usada para enviar una solicitud HTTP en la conexión, o una función que toma defaultRequestPolicyFactories y devuelve requestPolicyFactories que se usará.
rpRegistrationRetryTimeout	Obtiene o establece el tiempo de espera de reintento en segundos para AutomaticRPRegistration. El valor predeterminado es 30.
userAgent	Cadena que se va a establecer en el encabezado de telemetría al enviar la solicitud, o una función que toma la cadena predeterminada user-agent y devuelve la cadena user-agent que se usará.
userAgentHeaderName	Nombre de encabezado que se va a usar para el encabezado de telemetría al enviar la solicitud. Si no se especifica, se usará "User-Agent" cuando se ejecute en Node.js y se usará "x-ms-useragent" al ejecutarse en un explorador.
withCredentials	Si se deben incluir credenciales en las solicitudes de CORS en el explorador. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obtener más información.

Detalles de las propiedades

clientRequestIdHeaderName

Si se especifica, se agregará un GenerateRequestIdPolicy a la canalización HTTP que agregará un encabezado a todas las solicitudes salientes con este nombre de encabezado y un UUID aleatorio como identificador de solicitud.

clientRequestIdHeaderName?: string

Valor de propiedad

string

credentialScopes

Si se especifica, se usará para compilar BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Valor de propiedad

string | string[]

deserializationContentTypes

Los tipos de contenido que se asociarán a la serialización JSON o XML.

deserializationContentTypes?: DeserializationContentTypes

Valor de propiedad

DeserializationContentTypes

generateClientRequestIdHeader

Si se va a generar o no un encabezado de identificador de solicitud de cliente para cada solicitud HTTP.

generateClientRequestIdHeader?: boolean

Valor de propiedad

boolean

httpClient

HttpClient que se usará para enviar solicitudes HTTP.

httpClient?: HttpClient

Valor de propiedad

HttpClient

httpPipelineLogger

HttpPipelineLogger que se puede usar para depurar RequestPolicies dentro de la canalización HTTP.

httpPipelineLogger?: HttpPipelineLogger

Valor de propiedad

HttpPipelineLogger

noRetryPolicy

Si se establece en true, desactive la directiva de reintento predeterminada.

noRetryPolicy?: boolean

Valor de propiedad

boolean

proxySettings

Configuración de proxy que se usará para cada solicitud HTTP (solo Node.js).

proxySettings?: ProxySettings

Valor de propiedad

ProxySettings

requestPolicyFactories

Matriz de generadores a los que se llama para crear la canalización RequestPolicy usada para enviar una solicitud HTTP en la conexión, o una función que toma defaultRequestPolicyFactories y devuelve requestPolicyFactories que se usará.

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

Valor de propiedad

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

rpRegistrationRetryTimeout

Obtiene o establece el tiempo de espera de reintento en segundos para AutomaticRPRegistration. El valor predeterminado es 30.

rpRegistrationRetryTimeout?: number

Valor de propiedad

number

userAgent

Cadena que se va a establecer en el encabezado de telemetría al enviar la solicitud, o una función que toma la cadena predeterminada user-agent y devuelve la cadena user-agent que se usará.

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

Valor de propiedad

string | (defaultUserAgent: string) => string

userAgentHeaderName

Nombre de encabezado que se va a usar para el encabezado de telemetría al enviar la solicitud. Si no se especifica, se usará "User-Agent" cuando se ejecute en Node.js y se usará "x-ms-useragent" al ejecutarse en un explorador.

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

Valor de propiedad

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Si se deben incluir credenciales en las solicitudes de CORS en el explorador. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obtener más información.

withCredentials?: boolean

Valor de propiedad

boolean