@azure/core-client package

Referencia

Clases

Inicializa una nueva instancia de ServiceClient.

Interfaces

AdditionalPolicyConfig	Se usa para configurar directivas adicionales agregadas a la canalización en la construcción.
BaseMapper	Definición base de un asignador. Se puede usar para objetos XML y JavaScript sin formato.
CommonClientOptions	El conjunto común de opciones que se espera que los clientes de alto nivel expongan.
CompositeMapper	Asignador compuesto por otros asignadores.
CompositeMapperType	Ayuda a crear un asignador que describe cómo asignar un conjunto de propiedades de un objeto en función de otros asignadores. Solo una de las siguientes propiedades debe estar presente: `className`, `modelProperties` y `additionalProperties`.
DeserializationContentTypes	Los tipos de contenido que indicarán que se debe deserializar una respuesta de operación de una manera determinada.
DeserializationPolicyOptions	Opciones para configurar la deserialización de respuesta de API.
DictionaryMapper	Asignador que describe objetos JavaScript sin formato que se usan como pares clave-valor.
DictionaryMapperType	Ayuda a crear un asignador que describe cómo analizar un diccionario de valores asignados.
EnumMapper	Asignador que describe un valor de enumeración.
EnumMapperType	Ayuda a crear un asignador que describe cómo analizar un valor de enumeración.
FullOperationResponse	Objeto contenedor para la solicitud http y la respuesta. El objeto deserializado se almacena en la `parsedBody` propiedad cuando el cuerpo de la respuesta se recibe en JSON o XML.
InternalClientPipelineOptions	Opciones para crear una canalización que se usará con ServiceClient. Principalmente para personalizar la directiva de autenticación (si se usa la autenticación de token) o las opciones de deserialización al usar XML.
MapperConstraints	Descripción de varias restricciones de valor, como intervalos enteros y regex de cadena.
OperationArguments	Colección de propiedades que se aplican a una única invocación de una operación.
OperationOptions	Tipo de opciones base para todas las operaciones.
OperationParameter	Interfaz común que extiende todo el parámetro Operation.
OperationQueryParameter	Parámetro de una operación que se agregará como parámetro de consulta a la solicitud HTTP de la operación.
OperationRequestInfo	Metadatos que se usan para analizar correctamente una respuesta.
OperationRequestOptions	Opciones usadas al crear y enviar solicitudes HTTP para esta operación.
OperationResponseMap	OperationResponse que se puede devolver desde una solicitud de operación para un único código de estado.
OperationSpec	Especificación que define una operación.
OperationURLParameter	Parámetro para una operación que se sustituirá en la dirección URL de solicitud de la operación.
PolymorphicDiscriminator	Se usa para desambiguar uniones de tipos discriminadas. Por ejemplo, si la respuesta puede tener muchas formas, pero también incluye un campo "kind" (o similar), ese campo se puede usar para determinar cómo deserializar la respuesta al tipo correcto.
SequenceMapper	Asignador que describe matrices.
SequenceMapperType	Ayuda a crear un asignador que describe cómo analizar una secuencia de valores asignados.
SerializationPolicyOptions	Opciones para configurar la serialización de solicitudes de API.
Serializer	Se usa para asignar objetos de respuesta sin procesar a formas finales. Ayuda a empaquetar y desempaquetar fechas y otros tipos codificados que no son intrínsecos a JSON. También permite extraer valores de encabezados, así como insertar valores y constantes predeterminados.
SerializerOptions	Opciones para configurar el comportamiento de serialización o des serialización.
ServiceClientOptions	Opciones que se proporcionarán al crear el cliente.
SimpleMapperType	Tipo de asignador simple.
SpanConfig	Configuración para crear un nuevo intervalo de seguimiento
XmlOptions	Opciones para controlar el comportamiento del analizador xml y del generador.

Alias de tipos

Mapper	Los asignadores son definiciones de los modelos de datos usados en la biblioteca. Estos modelos de datos forman parte de las definiciones de operación o cliente en las respuestas o parámetros.
MapperType	Tipo del asignador. Incluye asignadores conocidos.
OperationRequest	Alias de tipo para la corrección futura.
ParameterPath	Codifica cómo alcanzar una propiedad determinada en un objeto .
QueryCollectionFormat	Formato que se usará para combinar una matriz de valores para un valor de parámetro de consulta.
RawResponseCallback	Una 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.

Funciones

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	Esta función se puede usar como devolución de llamada para , `bearerTokenAuthenticationPolicy@azure/core-rest-pipeline`para admitir desafíos de CAE: Evaluación continua de acceso. `bearerTokenAuthenticationPolicy` Llame a con las siguientes opciones: `import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline"; import { authorizeRequestOnClaimChallenge } from "@azure/core-client"; const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({ authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge });` Una vez proporcionada, la `bearerTokenAuthenticationPolicy` directiva controlará internamente los desafíos de evaluación continua de acceso (CAE). Cuando no pueda completar un desafío, devolverá la respuesta 401 (no autorizada) de ARM. Ejemplo de desafío con notificaciones: `Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token", error_description="User session has been revoked", claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="`
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)	Define una devolución de llamada para controlar el desafío de autenticación de las API de Storage. Esto implementa el proceso de desafío de portador que se describe aquí: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge El control tiene características específicas para el almacenamiento que sale a la documentación de desafío general de AAD.
createClientPipeline(InternalClientPipelineOptions)	Crea una canalización para su uso con un cliente de servicio. Agrega en deserializationPolicy de forma predeterminada. También agrega en bearerTokenAuthenticationPolicy si se pasa un TokenCredential.
createSerializer({[key: string]: any}, boolean)	Método que crea y devuelve un serializador.
deserializationPolicy(DeserializationPolicyOptions)	Esta directiva controla el análisis de las respuestas según OperationSpecs en la solicitud.
serializationPolicy(SerializationPolicyOptions)	Esta directiva controla el montaje del cuerpo y los encabezados de la solicitud mediante OperationSpec y OperationArguments en la solicitud.

Detalles de la función

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Esta función se puede usar como devolución de llamada para , bearerTokenAuthenticationPolicy@azure/core-rest-pipelinepara admitir desafíos de CAE: Evaluación continua de acceso.

bearerTokenAuthenticationPolicy Llame a con las siguientes opciones:

import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";

const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
  authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});

Una vez proporcionada, la bearerTokenAuthenticationPolicy directiva controlará internamente los desafíos de evaluación continua de acceso (CAE). Cuando no pueda completar un desafío, devolverá la respuesta 401 (no autorizada) de ARM.

Ejemplo de desafío con notificaciones:

Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token",
error_description="User session has been revoked",
claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="

function authorizeRequestOnClaimChallenge(onChallengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

Parámetros

onChallengeOptions: AuthorizeRequestOnChallengeOptions

Devoluciones

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Define una devolución de llamada para controlar el desafío de autenticación de las API de Storage. Esto implementa el proceso de desafío de portador que se describe aquí: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge El control tiene características específicas para el almacenamiento que sale a la documentación de desafío general de AAD.

function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

Parámetros

challengeOptions: AuthorizeRequestOnChallengeOptions

Devoluciones

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

Crea una canalización para su uso con un cliente de servicio. Agrega en deserializationPolicy de forma predeterminada. También agrega en bearerTokenAuthenticationPolicy si se pasa un TokenCredential.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Parámetros

options: InternalClientPipelineOptions

Opciones para personalizar la canalización creada.

Devoluciones

Pipeline

createSerializer({[key: string]: any}, boolean)

Método que crea y devuelve un serializador.

function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): Serializer

Parámetros

modelMappers: {[key: string]: any}

Modelos conocidos para asignar

isXML: boolean

Si se debe admitir XML

Devoluciones

Serializer

deserializationPolicy(DeserializationPolicyOptions)

Esta directiva controla el análisis de las respuestas según OperationSpecs en la solicitud.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parámetros

options: DeserializationPolicyOptions

Devoluciones

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Esta directiva controla el montaje del cuerpo y los encabezados de la solicitud mediante OperationSpec y OperationArguments en la solicitud.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parámetros

options: SerializationPolicyOptions

Devoluciones

PipelinePolicy

Compartir a través de

@azure/core-client package

Clases

Interfaces

Alias de tipos

Funciones

Detalles de la función

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Parámetros

Devoluciones

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Parámetros

Devoluciones

createClientPipeline(InternalClientPipelineOptions)

Parámetros

Devoluciones

createSerializer({[key: string]: any}, boolean)

Parámetros

Devoluciones

deserializationPolicy(DeserializationPolicyOptions)

Parámetros

Devoluciones

serializationPolicy(SerializationPolicyOptions)

Parámetros

Devoluciones

Recursos adicionales