ServiceClientOptions interface

  • Referencia
Paquete:
@azure/ms-rest-js

Opciones que se proporcionarán al crear el cliente.

Propiedades

agentSettings

Agentes HTTP y HTTPS que se usarán para cada solicitud HTTP (solo Node.js).
baseUri

Si se especifica:

  • Esto baseUri se convierte en el URI base en el que se realizarán solicitudes para este ServiceClient.
  • baseUri Si coincide con un punto de conexión conocido de Resource Manager y si se pasó a TokenCredential través del constructor , define baseUri el getToken ámbito como ${options.baseUri}/.default. De lo contrario, el ámbito tendría como valor predeterminado "https://management.azure.com/.default".

Si no se especifica:

  • Todas las OperationSpecs deben contener una propiedad baseUrl.
  • Si se pasó a TokenCredential través del constructor, el getToken ámbito se establece en "https://management.azure.com/.default".
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.
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).
redirectOptions

Opciones para controlar las respuestas de redireccionamiento.
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" al ejecutarse en Node.js y se usará "x-ms-command-name" 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

agentSettings

Agentes HTTP y HTTPS que se usarán para cada solicitud HTTP (solo Node.js).

agentSettings?: AgentSettings

Valor de propiedad

AgentSettings

baseUri

Si se especifica:

  • Esto baseUri se convierte en el URI base en el que se realizarán solicitudes para este ServiceClient.
  • baseUri Si coincide con un punto de conexión conocido de Resource Manager y si se pasó a TokenCredential través del constructor , define baseUri el getToken ámbito como ${options.baseUri}/.default. De lo contrario, el ámbito tendría como valor predeterminado "https://management.azure.com/.default".

Si no se especifica:

  • Todas las OperationSpecs deben contener una propiedad baseUrl.
  • Si se pasó a TokenCredential través del constructor, el getToken ámbito se establece en "https://management.azure.com/.default".
baseUri?: string

Valor de propiedad

string

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

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

redirectOptions

Opciones para controlar las respuestas de redireccionamiento.

redirectOptions?: RedirectOptions

Valor de propiedad

RedirectOptions

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" al ejecutarse en Node.js y se usará "x-ms-command-name" 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