Condividi tramite

@azure-rest/core-client package

  • Riferimento

Interfacce

AddCredentialPipelinePolicyOptions

Parametri facoltativi per l'aggiunta di criteri di credenziali alla pipeline.
AdditionalPolicyConfig

Usato per configurare criteri aggiuntivi aggiunti alla pipeline in fase di costruzione.
Client

Forma di un client a livello di rest
ErrorModel

Oggetto error.
ErrorResponse

Risposta contenente i dettagli dell'errore.
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.
InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
OperationOptions

Tipo di opzioni di base per tutte le operazioni.
OperationRequestOptions

Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.
PathParameterWithOptions

Oggetto che può essere passato come parametro di percorso, consentendo l'impostazione di opzioni aggiuntive relative alla codifica del parametro.
ResourceMethods

Definisce i metodi che possono essere chiamati su una risorsa

Alias tipo

ClientOptions

Opzioni generali che un client a livello di rest può accettare
HttpBrowserStreamResponse

Risposta Http che corpo è un oggetto flusso NodeJS
HttpNodeStreamResponse

Risposta Http che corpo è un oggetto flusso NodeJS
HttpResponse

Rappresenta la forma di un oggetto HttpResponse
PathParameters

Tipo di helper usato per rilevare i parametri in un testo del modello di percorso racchiuso da {} verrà considerato un parametro path
PathUnchecked

Definisce la firma per pathUnchecked.
PathUncheckedResponse

Tipo da usare con pathUnchecked, esegue l'override del tipo di corpo a qualsiasi per consentire la flessibilità
RawResponseCallback

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

Questo callback verrà chiamato con due parametri: la risposta non elaborata, incluse le intestazioni e il corpo della risposta; e un oggetto di errore che verrà fornito se è stato generato un errore durante l'elaborazione della richiesta. Il terzo parametro __legacyError viene fornito solo per compatibilità con le versioni precedenti e avrà un valore identico al parametro error.
RequestParameters

Forma dei parametri di richiesta predefiniti, che può essere sottoposto a override dai tipi di richiesta specifici per fornire tipi sicuri
StreamableMethod

Definisce il tipo per un metodo che supporta il recupero del corpo della risposta come flusso non elaborato

Funzioni

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Aggiunge un criterio di credenziali alla pipeline se viene fornita una credenziale. Se non viene specificato alcun criterio, non viene aggiunto alcun criterio.
createRestError(PathUncheckedResponse)

Crea un errore di riposo da una risposta PathUnchecked
createRestError(string, PathUncheckedResponse)

Crea un errore di riposo da un messaggio di errore e una risposta PathUnchecked
getClient(string, ClientOptions)

Crea un client con una pipeline predefinita
getClient(string, TokenCredential | KeyCredential, ClientOptions)

Crea un client con una pipeline predefinita
operationOptionsToRequestParameters(OperationOptions)

Funzione helper per convertire OperationOptions in RequestParameters

Dettagli funzione

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Aggiunge un criterio di credenziali alla pipeline se viene fornita una credenziale. Se non viene specificato alcun criterio, non viene aggiunto alcun criterio.

function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)

Parametri

pipeline
Pipeline
endpoint

string

options
AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Crea un errore di riposo da una risposta PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

Parametri

response
PathUncheckedResponse

Restituisce

RestError

createRestError(string, PathUncheckedResponse)

Crea un errore di riposo da un messaggio di errore e una risposta PathUnchecked

function createRestError(message: string, response: PathUncheckedResponse): RestError

Parametri

message

string

response
PathUncheckedResponse

Restituisce

RestError

getClient(string, ClientOptions)

Crea un client con una pipeline predefinita

function getClient(endpoint: string, options?: ClientOptions): Client

Parametri

endpoint

string

Endpoint di base per il client

options
ClientOptions

Opzioni client

Restituisce

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Crea un client con una pipeline predefinita

function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client

Parametri

endpoint

string

Endpoint di base per il client

credentials

TokenCredential | KeyCredential

Credenziali per autenticare le richieste

options
ClientOptions

Opzioni client

Restituisce

Client

operationOptionsToRequestParameters(OperationOptions)

Funzione helper per convertire OperationOptions in RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parametri

options
OperationOptions

le opzioni utilizzate dal livello modulare per inviare la richiesta

Restituisce

RequestParameters

risultato della conversione in RequestParameters del livello RLC