@azure/core-client package
Service |
Inizializza una nuova istanza di ServiceClient. |
Additional |
Usato per configurare criteri aggiuntivi aggiunti alla pipeline in fase di costruzione. |
Base |
Definizione di base di un mapper. Può essere usato per oggetti JavaScript XML e semplici. |
Common |
Il set comune di opzioni che i client di alto livello devono esporre. |
Composite |
Mapper composto da altri mapper. |
Composite |
Consente di creare un mapper che descrive come eseguire il mapping di un set di proprietà di un oggetto basato su altri mapper. Deve essere presente solo una delle proprietà seguenti: |
Deserialization |
I tipi di contenuto che indicano che una risposta dell'operazione deve essere deserializzata in modo particolare. |
Deserialization |
Opzioni per configurare la deserializzazione della risposta dell'API. |
Dictionary |
Mapper che descrive gli oggetti JavaScript semplici usati come coppie chiave/valore. |
Dictionary |
Consente di creare un mapper che descrive come analizzare un dizionario di valori mappati. |
Enum |
Mapper che descrive un valore di enumerazione. |
Enum |
Consente di compilare un mapper che descrive come analizzare un valore di enumerazione. |
Full |
Oggetto wrapper per richiesta e risposta HTTP. L'oggetto deserializzato viene archiviato nella proprietà quando il corpo della |
Internal |
Opzioni per la creazione di una pipeline da usare con ServiceClient. Per lo più per personalizzare i criteri di autenticazione (se si usa l'autenticazione token) o le opzioni di deserializzazione quando si usa XML. |
Mapper |
Descrizione di vari vincoli di valore, ad esempio intervalli interi e regex stringa. |
Operation |
Raccolta di proprietà che si applicano a una singola chiamata di un'operazione. |
Operation |
Tipo di opzioni di base per tutte le operazioni. |
Operation |
Interfaccia comune estesa da tutti i parametri Operation. |
Operation |
Parametro per un'operazione che verrà aggiunto come parametro di query alla richiesta HTTP dell'operazione. |
Operation |
Metadati usati per analizzare correttamente una risposta. |
Operation |
Opzioni utilizzate durante la creazione e l'invio di richieste HTTP per questa operazione. |
Operation |
Oggetto OperationResponse che può essere restituito da una richiesta di operazione per un singolo codice di stato. |
Operation |
Specifica che definisce un'operazione. |
Operation |
Parametro per un'operazione che verrà sostituito nell'URL della richiesta dell'operazione. |
Polymorphic |
Usato per disambiguare le unioni dei tipi discriminate. 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. |
Sequence |
Mapper che descrive le matrici. |
Sequence |
Consente di creare un mapper che descrive come analizzare una sequenza di valori mappati. |
Serialization |
Opzioni per configurare la serializzazione delle richieste API. |
Serializer |
Utilizzato per eseguire il mapping degli 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 di valori dalle intestazioni, nonché l'inserimento di valori e costanti predefiniti. |
Serializer |
Opzioni per configurare il comportamento di serializzazione/de-serializzazione. |
Service |
Opzioni da fornire durante la creazione del client. |
Simple |
Tipo di un semplice mapper. |
Span |
Configurazione per la creazione di un nuovo intervallo di traccia |
Xml |
Opzioni per gestire il comportamento del parser xml e del generatore. |
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. |
Mapper |
Tipo del mapper. Include i mapper noti. |
Operation |
Alias di tipo per la correzione futura. |
Parameter |
Codifica come raggiungere una determinata proprietà in un oggetto . |
Query |
Formato che verrà utilizzato per unire una matrice di valori per un valore del parametro di query. |
Raw |
Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte. |
authorize |
Questa funzione può essere usata come callback per , per supportare le problematiche CAE: Valutazione dell'accesso Chiamare con
Una volta specificato, i criteri gestiranno internamente le problematiche di valutazione dell'accesso continuo .Once provided, the Richiesta di esempio con attestazioni:
|
authorize |
Definisce un callback per gestire la richiesta di autenticazione per le API di archiviazione. Questo implementa il processo di verifica di connessione descritto qui: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge La gestione include funzionalità specifiche per l'archiviazione che parte dalla documentazione generale della richiesta di verifica di AAD. |
create |
Crea una nuova pipeline da usare con un client del servizio. Aggiunge in deserializationPolicy per impostazione predefinita. Aggiunge anche bearerTokenAuthenticationPolicy se ha passato un tokenCredential. |
create |
Metodo che crea e restituisce un serializzatore. |
deserialization |
Questo criterio gestisce l'analisi delle risposte in base a OperationSpecs nella richiesta. |
serialization |
Questo criterio gestisce l'assemblaggio del corpo e delle intestazioni della richiesta tramite OperationSpec e OperationArguments nella richiesta. |
Questa funzione può essere usata come callback per , per supportare le problematiche CAE: Valutazione dell'accessobearerTokenAuthenticationPolicy
@azure/core-rest-pipeline
continuo.
Chiamare con bearerTokenAuthenticationPolicy
le opzioni seguenti:
import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});
Una volta specificato, i criteri gestiranno internamente le problematiche di valutazione dell'accesso continuo .Once provided, the bearerTokenAuthenticationPolicy
policy will internally handle Continuous Access Evaluation (CAE).
Quando non riesce a completare una richiesta, restituisce la risposta 401 (non autorizzata) da ARM.
Richiesta di esempio 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>
Definisce un callback per gestire la richiesta di autenticazione per le API di archiviazione. Questo implementa il processo di verifica di connessione descritto qui: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge La gestione include funzionalità specifiche per l'archiviazione che parte dalla documentazione generale della richiesta di verifica di AAD.
function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>
Parametri
- challengeOptions
- AuthorizeRequestOnChallengeOptions
Restituisce
Promise<boolean>
Crea una nuova pipeline da usare con un client del servizio. Aggiunge in deserializationPolicy per impostazione predefinita. Aggiunge anche bearerTokenAuthenticationPolicy se ha passato un tokenCredential.
function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline
Parametri
- options
- InternalClientPipelineOptions
Opzioni per personalizzare la pipeline creata.
Restituisce
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
Questo criterio gestisce l'analisi delle risposte in base a OperationSpecs nella richiesta.
function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy
Parametri
- options
- DeserializationPolicyOptions
Restituisce
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