Delen via

@azure-rest/core-client package

  • Referentie

Interfaces

AddCredentialPipelinePolicyOptions

Optionele parameters voor het toevoegen van een referentiebeleid aan de pijplijn.
AdditionalPolicyConfig

Wordt gebruikt voor het configureren van aanvullende beleidsregels die tijdens de bouw aan de pijplijn zijn toegevoegd.
Client

Vorm van een client op restniveau
ErrorModel

Het foutobject.
ErrorResponse

Een antwoord met foutdetails.
FullOperationResponse

Wrapper-object voor http-aanvraag en -antwoord. Het gedeserialiseerde object wordt opgeslagen in de parsedBody eigenschap wanneer de hoofdtekst van het antwoord wordt ontvangen in JSON.
InnerError

Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
OperationOptions

Het type basisopties voor alle bewerkingen.
OperationRequestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
ResourceMethods

Definieert de methoden die kunnen worden aangeroepen voor een resource

Type-aliassen

ClientOptions

Algemene opties die een Rest Level Client kan gebruiken
HttpBrowserStreamResponse

HTTP-antwoord welke hoofdtekst een NodeJS-streamobject is
HttpNodeStreamResponse

HTTP-antwoord welke hoofdtekst een NodeJS-streamobject is
HttpResponse

Vertegenwoordigt de vorm van een HttpResponse
PathParameters

Het helpertype dat wordt gebruikt voor het detecteren van parameters in een padsjabloontekst die wordt omgeven door {} , wordt beschouwd als een padparameter
PathUnchecked

Definieert de handtekening voor pathUnchecked.
PathUncheckedResponse

Het type dat moet worden gebruikt met pathUnchecked, overschrijft het hoofdteksttype op een om flexibiliteit toe te staan
RawResponseCallback

Een functie die moet worden aangeroepen telkens wanneer er een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
RequestParameters

Vorm van de standaardaanvraagparameters. Dit kan worden overschreven door de specifieke aanvraagtypen om sterke typen te bieden
StreamableMethod

Definieert het type voor een methode die ondersteuning biedt voor het verkrijgen van de hoofdtekst van het antwoord als een onbewerkte stroom

Functies

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Voegt een referentiebeleid toe aan de pijplijn als er een referentie wordt opgegeven. Als er geen beleid wordt opgegeven, wordt er geen beleid toegevoegd.
createRestError(PathUncheckedResponse)

Maakt een rest-fout van een PathUnchecked-antwoord
createRestError(string, PathUncheckedResponse)

Hiermee wordt een rustfout gemaakt van een foutbericht en een PathUnchecked-antwoord
getClient(string, ClientOptions)

Hiermee maakt u een client met een standaardpijplijn
getClient(string, TokenCredential | KeyCredential, ClientOptions)

Hiermee maakt u een client met een standaardpijplijn
operationOptionsToRequestParameters(OperationOptions)

Helperfunctie voor het converteren van OperationOptions naar RequestParameters

Functiedetails

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Voegt een referentiebeleid toe aan de pijplijn als er een referentie wordt opgegeven. Als er geen beleid wordt opgegeven, wordt er geen beleid toegevoegd.

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

Parameters

pipeline
Pipeline
endpoint

string

options
AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Maakt een rest-fout van een PathUnchecked-antwoord

function createRestError(response: PathUncheckedResponse): RestError

Parameters

response
PathUncheckedResponse

Retouren

RestError

createRestError(string, PathUncheckedResponse)

Hiermee wordt een rustfout gemaakt van een foutbericht en een PathUnchecked-antwoord

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

Parameters

message

string

response
PathUncheckedResponse

Retouren

RestError

getClient(string, ClientOptions)

Hiermee maakt u een client met een standaardpijplijn

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

Parameters

endpoint

string

Basiseindpunt voor de client

options
ClientOptions

Clientopties

Retouren

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Hiermee maakt u een client met een standaardpijplijn

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

Parameters

endpoint

string

Basiseindpunt voor de client

credentials

TokenCredential | KeyCredential

Referenties om de aanvragen te verifiëren

options
ClientOptions

Clientopties

Retouren

Client

operationOptionsToRequestParameters(OperationOptions)

Helperfunctie voor het converteren van OperationOptions naar RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parameters

options
OperationOptions

de opties die door de modulaire laag worden gebruikt om de aanvraag te verzenden

Retouren

RequestParameters

het resultaat van de conversie in RequestParameters van de RLC-laag