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 extra beleidsregels die zijn toegevoegd aan de pijplijn tijdens de bouw.
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 eigenschap parsedBody wanneer de hoofdtekst van het antwoord wordt ontvangen in JSON.
InnerError

Een object met meer specifieke 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.
PathParameterWithOptions

Een object dat kan worden doorgegeven als padparameter, zodat extra opties kunnen worden ingesteld met betrekking tot hoe de parameter wordt gecodeerd.
ResourceMethods

Definieert de methoden die kunnen worden aangeroepen voor een resource

Type-aliassen

ClientOptions

Algemene opties die een client op restniveau kan nemen
HttpBrowserStreamResponse

Http Response: hoofdtekst van een NodeJS-streamobject
HttpNodeStreamResponse

Http Response: hoofdtekst van een NodeJS-streamobject
HttpResponse

Vertegenwoordigt de vorm van een HttpResponse
PathParameters

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

Hiermee definieert u de handtekening voor pathUnchecked.
PathUncheckedResponse

Type dat moet worden gebruikt met pathUnchecked, overschrijft het type hoofdtekst om flexibiliteit mogelijk te maken
RawResponseCallback

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

Deze callback wordt aangeroepen met twee parameters: het onbewerkte antwoord, inclusief headers en hoofdtekst van het antwoord; en een foutobject dat wordt opgegeven als er een fout is opgetreden tijdens het verwerken van de aanvraag. De derde __legacyError parameter is alleen bedoeld voor achterwaartse compatibiliteit en heeft een identieke waarde voor de error parameter.
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 is opgegeven. Als er geen beleid is opgegeven, wordt er geen beleid toegevoegd.
createRestError(PathUncheckedResponse)

Hiermee maakt u een rustfout op basis van een PathUnchecked-antwoord
createRestError(string, PathUncheckedResponse)

Hiermee maakt u een rustfout op basis 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)

De Helper-functie voor het converteren van OperationOptions naar RequestParameters

Functiedetails

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

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

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

Parameters

pipeline
Pipeline
endpoint

string

options
AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Hiermee maakt u een rustfout op basis van een PathUnchecked-antwoord

function createRestError(response: PathUncheckedResponse): RestError

Parameters

response
PathUncheckedResponse

Retouren

RestError

createRestError(string, PathUncheckedResponse)

Hiermee maakt u een rustfout op basis 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 voor het verifiëren van de aanvragen

options
ClientOptions

Clientopties

Retouren

Client

operationOptionsToRequestParameters(OperationOptions)

De Helper-functie 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 RLC-laag