@azure/core-client package

Riferimento

Classi

Inizializza una nuova istanza di ServiceClient.

Interfacce

AdditionalPolicyConfig	Usato per configurare criteri aggiuntivi aggiunti alla pipeline in fase di costruzione.
BaseMapper	Definizione di base di un mapper. Può essere usato per gli oggetti XML e JavaScript semplici.
CommonClientOptions	Il set comune di opzioni che i client di alto livello devono esporre.
CompositeMapper	Mapper composto da altri mapper.
CompositeMapperType	Consente di compilare un mapper che descrive come eseguire il mapping di un set di proprietà di un oggetto basato su altri mapper. Devono essere presenti solo una delle proprietà seguenti: `className`, `modelProperties` e `additionalProperties`.
DeserializationContentTypes	Tipi di contenuto che indicano che una risposta dell'operazione deve essere deserializzata in modo specifico.
DeserializationPolicyOptions	Opzioni per configurare la deserializzazione delle risposte dell'API.
DictionaryMapper	Mapper che descrive gli oggetti JavaScript semplici usati come coppie chiave/valore.
DictionaryMapperType	Consente di creare un mapper che descrive come analizzare un dizionario di valori mappati.
EnumMapper	Mapper che descrive un valore di enumerazione.
EnumMapperType	Consente di compilare un mapper che descrive come analizzare un valore di enumerazione.
FullOperationResponse	Oggetto wrapper per la richiesta e la risposta HTTP. L'oggetto deserializzato viene archiviato nella proprietà `parsedBody` quando il corpo della risposta viene ricevuto in JSON o XML.
InternalClientPipelineOptions	Opzioni per la creazione di una pipeline da usare con ServiceClient. Principalmente per personalizzare i criteri di autenticazione (se si usa l'autenticazione del token) o le opzioni di deserializzazione quando si usa XML.
MapperConstraints	Descrizione di vari vincoli di valore, ad esempio intervalli interi e regex stringa.
OperationArguments	Raccolta di proprietà che si applicano a una singola chiamata di un'operazione.
OperationOptions	Tipo di opzioni di base per tutte le operazioni.
OperationParameter	Interfaccia comune estesa da tutti i parametri Operation.
OperationQueryParameter	Parametro per un'operazione che verrà aggiunta come parametro di query alla richiesta HTTP dell'operazione.
OperationRequestInfo	Metadati usati per analizzare correttamente una risposta.
OperationRequestOptions	Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.
OperationResponseMap	Oggetto OperationResponse che può essere restituito da una richiesta di operazione per un singolo codice di stato.
OperationSpec	Specifica che definisce un'operazione.
OperationURLParameter	Parametro per un'operazione che verrà sostituito nell'URL della richiesta dell'operazione.
PolymorphicDiscriminator	Usato per evitare ambiguità tra unioni di tipi discriminati. Ad esempio, se la risposta può avere molte forme, ma include anche un campo "kind" (o simile), tale campo può essere usato per determinare come deserializzare la risposta al tipo corretto.
SequenceMapper	Mapper che descrive le matrici.
SequenceMapperType	Consente di compilare un mapper che descrive come analizzare una sequenza di valori mappati.
SerializationPolicyOptions	Opzioni per configurare la serializzazione delle richieste API.
Serializer	Utilizzato per eseguire il mapping di oggetti risposta non elaborati alle forme finali. Consente di creare pacchetti e decomprimere date e altri tipi codificati che non sono intrinseci a JSON. Consente anche il pull dei valori dalle intestazioni, nonché l'inserimento di valori e costanti predefiniti.
SerializerOptions	Opzioni per configurare il comportamento di serializzazione/de-serializzazione.
ServiceClientOptions	Opzioni da fornire durante la creazione del client.
SimpleMapperType	Tipo di un semplice mapper.
SpanConfig	Configurazione per la creazione di un nuovo intervallo di traccia
XmlOptions	Opzioni per gestire il comportamento del parser xml e del generatore.

Alias tipo

Mapper	I mapper sono definizioni dei modelli di dati usati nella libreria. Questi modelli di dati fanno parte delle definizioni operation o client nelle risposte o nei parametri.
MapperType	Tipo del mapper. Include mapper noti.
OperationRequest	Alias di tipo per la correzione futura.
ParameterPath	Codifica come raggiungere una determinata proprietà su un oggetto .
QueryCollectionFormat	Formato che verrà usato per unire una matrice di valori per un valore del parametro di query.
RawResponseCallback	Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

Funzioni

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	Questa funzione può essere usata come callback per l'`bearerTokenAuthenticationPolicy` di `@azure/core-rest-pipeline`, per supportare le problematiche CAE: valutazione dell'accesso continuo. Chiamare il `bearerTokenAuthenticationPolicy` con le opzioni seguenti: `import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline"; import { authorizeRequestOnClaimChallenge } from "@azure/core-client"; const policy = bearerTokenAuthenticationPolicy({ challengeCallbacks: { authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge, }, scopes: ["https://service/.default"], });` Una volta specificato, i criteri di `bearerTokenAuthenticationPolicy` gestiranno internamente i problemi di valutazione dell'accesso continuo (CAE). Quando non riesce a completare una richiesta, restituirà la risposta 401 (non autorizzata) da ARM. Esempio di richiesta con attestazioni: `Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token", error_description="User session has been revoked", claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="`
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)	Definisce un callback per gestire la richiesta di autenticazione per le API di archiviazione. In questo modo viene implementato il processo di verifica del bearer descritto qui: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Handling include funzionalità specifiche per l'archiviazione che parte dalla documentazione generale sulla richiesta di verifica di AAD.
createClientPipeline(InternalClientPipelineOptions)	Crea una nuova pipeline da usare con un client del servizio. Aggiunge in deserializationPolicy per impostazione predefinita. Aggiunge anche in bearerTokenAuthenticationPolicy se è stato passato un tokenCredential.
createSerializer({[key: string]: any}, boolean)	Metodo che crea e restituisce un serializzatore.
deserializationPolicy(DeserializationPolicyOptions)	Questo criterio gestisce l'analisi delle risposte in base a OperationSpecs nella richiesta.
serializationPolicy(SerializationPolicyOptions)	Questo criterio gestisce l'assemblaggio del corpo e delle intestazioni della richiesta tramite OperationSpec e OperationArguments nella richiesta.

Dettagli funzione

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Questa funzione può essere usata come callback per l'bearerTokenAuthenticationPolicy di @azure/core-rest-pipeline, per supportare le problematiche CAE: valutazione dell'accesso continuo.

Chiamare il bearerTokenAuthenticationPolicy con le opzioni seguenti:

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

const policy = bearerTokenAuthenticationPolicy({
  challengeCallbacks: {
    authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
  },
  scopes: ["https://service/.default"],
});

Una volta specificato, i criteri di bearerTokenAuthenticationPolicy gestiranno internamente i problemi di valutazione dell'accesso continuo (CAE). Quando non riesce a completare una richiesta, restituirà la risposta 401 (non autorizzata) da ARM.

Esempio di richiesta con attestazioni:

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>

Parametri

onChallengeOptions: AuthorizeRequestOnChallengeOptions

Restituisce

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Definisce un callback per gestire la richiesta di autenticazione per le API di archiviazione. In questo modo viene implementato il processo di verifica del bearer descritto qui: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Handling include funzionalità specifiche per l'archiviazione che parte dalla documentazione generale sulla richiesta di verifica di AAD.

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

Parametri

challengeOptions: AuthorizeRequestOnChallengeOptions

Restituisce

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

Crea una nuova pipeline da usare con un client del servizio. Aggiunge in deserializationPolicy per impostazione predefinita. Aggiunge anche in bearerTokenAuthenticationPolicy se è stato passato un tokenCredential.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Parametri

options: InternalClientPipelineOptions

Opzioni per personalizzare la pipeline creata.

Restituisce

Pipeline

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

Metodo che crea e restituisce un serializzatore.

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

Parametri

modelMappers: {[key: string]: any}

Modelli noti di cui eseguire il mapping

isXML: boolean

Se xml deve essere supportato

Restituisce

Serializer

deserializationPolicy(DeserializationPolicyOptions)

Questo criterio gestisce l'analisi delle risposte in base a OperationSpecs nella richiesta.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parametri

options: DeserializationPolicyOptions

Restituisce

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Questo criterio gestisce l'assemblaggio del corpo e delle intestazioni della richiesta tramite OperationSpec e OperationArguments nella richiesta.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parametri

options: SerializationPolicyOptions

Restituisce

PipelinePolicy

Condividi tramite

@azure/core-client package

Classi

Interfacce

Alias tipo

Funzioni

Dettagli funzione

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Parametri

Restituisce

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Parametri

Restituisce

createClientPipeline(InternalClientPipelineOptions)

Parametri

Restituisce

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

Parametri

Restituisce

deserializationPolicy(DeserializationPolicyOptions)

Parametri

Restituisce

serializationPolicy(SerializationPolicyOptions)

Parametri

Restituisce

Risorse aggiuntive