@azure-rest/core-client package
Interfaces
AddCredentialPipelinePolicyOptions |
Parámetros opcionales para agregar una directiva de credenciales a la canalización. |
AdditionalPolicyConfig |
Se usa para configurar directivas adicionales agregadas a la canalización en la construcción. |
Client |
Forma de un cliente de nivel de rest |
ErrorModel |
Objeto de error. |
ErrorResponse |
Respuesta que contiene los detalles del error. |
FullOperationResponse |
Objeto contenedor para la solicitud y respuesta http. El objeto deserializado se almacena en la propiedad |
InnerError |
Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
OperationOptions |
Tipo de opciones base para todas las operaciones. |
OperationRequestOptions |
Opciones que se usan al crear y enviar solicitudes HTTP para esta operación. |
PathParameterWithOptions |
Objeto que se puede pasar como parámetro de ruta de acceso, lo que permite establecer opciones adicionales relacionadas con cómo se codifica el parámetro. |
ResourceMethods |
Define los métodos a los que se puede llamar en un recurso. |
Alias de tipos
ClientOptions |
Opciones generales que puede tomar un cliente de nivel de rest |
HttpBrowserStreamResponse |
Respuesta HTTP que cuerpo es un objeto de secuencia NodeJS |
HttpNodeStreamResponse |
Respuesta HTTP que cuerpo es un objeto de secuencia NodeJS |
HttpResponse |
Representa la forma de httpResponse. |
PathParameters |
El tipo auxiliar que se usa para detectar parámetros en un texto de plantilla de ruta de acceso rodeado por {} se considerará un parámetro de ruta de acceso. |
PathUnchecked |
Define la firma de pathUnchecked. |
PathUncheckedResponse |
Tipo que se va a usar con pathUnchecked, invalida el tipo de cuerpo en cualquiera para permitir la flexibilidad. |
RawResponseCallback |
Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces. Se llamará a esta devolución de llamada con dos parámetros: la respuesta sin procesar, incluidos los encabezados y el cuerpo de la respuesta; y un objeto de error que se proporcionará si se produjo un error al procesar la solicitud.
El tercer parámetro __legacyError solo se proporciona para la compatibilidad con versiones anteriores y tendrá un valor idéntico al parámetro |
RequestParameters |
Forma de los parámetros de solicitud predeterminados, los tipos de solicitud específicos pueden invalidar esto para proporcionar tipos seguros. |
StreamableMethod |
Define el tipo de un método que admite la obtención del cuerpo de la respuesta como una secuencia sin procesar. |
Funciones
add |
Agrega una directiva de credenciales a la canalización si se proporciona una credencial. Si no se proporciona ninguno, no se agrega ninguna directiva. |
create |
Crea un error de resto a partir de una respuesta PathUnchecked |
create |
Crea un error de resto a partir de un mensaje de error y una respuesta PathUnchecked |
get |
Crea un cliente con una canalización predeterminada. |
get |
Crea un cliente con una canalización predeterminada. |
operation |
Función auxiliar para convertir OperationOptions en RequestParameters |
Detalles de la función
addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)
Agrega una directiva de credenciales a la canalización si se proporciona una credencial. Si no se proporciona ninguno, no se agrega ninguna directiva.
function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)
Parámetros
- pipeline
- Pipeline
- endpoint
-
string
createRestError(PathUncheckedResponse)
Crea un error de resto a partir de una respuesta PathUnchecked
function createRestError(response: PathUncheckedResponse): RestError
Parámetros
- response
- PathUncheckedResponse
Devoluciones
createRestError(string, PathUncheckedResponse)
Crea un error de resto a partir de un mensaje de error y una respuesta PathUnchecked
function createRestError(message: string, response: PathUncheckedResponse): RestError
Parámetros
- message
-
string
- response
- PathUncheckedResponse
Devoluciones
getClient(string, ClientOptions)
Crea un cliente con una canalización predeterminada.
function getClient(endpoint: string, options?: ClientOptions): Client
Parámetros
- endpoint
-
string
Punto de conexión base para el cliente
- options
- ClientOptions
Opciones de cliente
Devoluciones
getClient(string, TokenCredential | KeyCredential, ClientOptions)
Crea un cliente con una canalización predeterminada.
function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client
Parámetros
- endpoint
-
string
Punto de conexión base para el cliente
- credentials
Credenciales para autenticar las solicitudes
- options
- ClientOptions
Opciones de cliente
Devoluciones
operationOptionsToRequestParameters(OperationOptions)
Función auxiliar para convertir OperationOptions en RequestParameters
function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters
Parámetros
- options
- OperationOptions
las opciones que usa la capa modular para enviar la solicitud
Devoluciones
el resultado de la conversión en RequestParameters de la capa de RLC