ServiceClientOptions interface
Opciones que se deben proporcionar al crear el cliente.
- Extends
Propiedades
base |
Si se especifica, este es el URI base en el que se realizarán las solicitudes para este ServiceClient. Si no se especifica, todas las OperationSpecs deben contener una propiedad baseUrl. |
credential | Credencial usada para autenticar la solicitud. |
credential |
Si se especifica, se usará para compilar BearerTokenAuthenticationPolicy. |
endpoint | Si se especifica, este es el punto de conexión en el que se realizarán solicitudes para este ServiceClient. Si no se especifica, todas las OperationSpecs deben contener una propiedad baseUrl. para animar al cliente a usar el punto de conexión, marcamos el valor baseUri como en desuso. |
pipeline | Una canalización personalizada que se va a usar; de lo contrario, se creará una predeterminada. |
request |
Tipo de contenido de solicitud predeterminado para el servicio. Se usa si no hay requestContentType presente en operationSpec. |
Propiedades heredadas
additional |
Directivas adicionales que se van a incluir en la canalización HTTP. |
allow |
Se establece en true si la solicitud se envía a través de HTTP en lugar de HTTPS. |
http |
HttpClient que se usará para enviar solicitudes HTTP. |
proxy |
Opciones para configurar un proxy para las solicitudes salientes. |
redirect |
Opciones para controlar las respuestas de redireccionamiento. |
retry |
Opciones que controlan cómo reintentar solicitudes con error. |
telemetry |
Opciones para establecer la telemetría común y la información de seguimiento en las solicitudes salientes. |
tls |
Opciones para configurar la autenticación TLS |
user |
Opciones para agregar detalles del agente de usuario a las solicitudes salientes. |
Detalles de las propiedades
baseUri
Advertencia
Esta API ya está en desuso.
This property is deprecated and will be removed soon, please use endpoint instead
Si se especifica, este es el URI base en el que se realizarán las solicitudes para este ServiceClient. Si no se especifica, todas las OperationSpecs deben contener una propiedad baseUrl.
baseUri?: string
Valor de propiedad
string
credential
Credencial usada para autenticar la solicitud.
credential?: TokenCredential
Valor de propiedad
credentialScopes
Si se especifica, se usará para compilar BearerTokenAuthenticationPolicy.
credentialScopes?: string | string[]
Valor de propiedad
string | string[]
endpoint
Si se especifica, este es el punto de conexión en el que se realizarán solicitudes para este ServiceClient. Si no se especifica, todas las OperationSpecs deben contener una propiedad baseUrl. para animar al cliente a usar el punto de conexión, marcamos el valor baseUri como en desuso.
endpoint?: string
Valor de propiedad
string
pipeline
Una canalización personalizada que se va a usar; de lo contrario, se creará una predeterminada.
pipeline?: Pipeline
Valor de propiedad
requestContentType
Tipo de contenido de solicitud predeterminado para el servicio. Se usa si no hay requestContentType presente en operationSpec.
requestContentType?: string
Valor de propiedad
string
Detalles de las propiedades heredadas
additionalPolicies
Directivas adicionales que se van a incluir en la canalización HTTP.
additionalPolicies?: AdditionalPolicyConfig[]
Valor de propiedad
Heredado deCommonClientOptions.additionalPolicies
allowInsecureConnection
Se establece en true si la solicitud se envía a través de HTTP en lugar de HTTPS.
allowInsecureConnection?: boolean
Valor de propiedad
boolean
Heredado deCommonClientOptions.allowInsecureConnection
httpClient
HttpClient que se usará para enviar solicitudes HTTP.
httpClient?: HttpClient
Valor de propiedad
Se hereda deCommonClientOptions.httpClient
proxyOptions
Opciones para configurar un proxy para las solicitudes salientes.
proxyOptions?: ProxySettings
Valor de propiedad
Heredado deCommonClientOptions.proxyOptions
redirectOptions
Opciones para controlar las respuestas de redireccionamiento.
redirectOptions?: RedirectPolicyOptions
Valor de propiedad
Heredado deCommonClientOptions.redirectOptions
retryOptions
Opciones que controlan cómo reintentar solicitudes con error.
retryOptions?: PipelineRetryOptions
Valor de propiedad
Heredado deCommonClientOptions.retryOptions
telemetryOptions
Opciones para establecer la telemetría común y la información de seguimiento en las solicitudes salientes.
telemetryOptions?: TelemetryOptions
Valor de propiedad
Heredado deCommonClientOptions.telemetryOptions
tlsOptions
Opciones para configurar la autenticación TLS
tlsOptions?: TlsSettings
Valor de propiedad
Se hereda deCommonClientOptions.tlsOptions
userAgentOptions
Opciones para agregar detalles del agente de usuario a las solicitudes salientes.
userAgentOptions?: UserAgentPolicyOptions
Valor de propiedad
Heredado deCommonClientOptions.userAgentOptions