@azure-rest/core-client package
Gränssnitt
| AddCredentialPipelinePolicyOptions |
Valfria parametrar för att lägga till en princip för autentiseringsuppgifter i pipelinen. |
| AdditionalPolicyConfig |
Används för att konfigurera ytterligare principer som läggs till i pipelinen vid konstruktion. |
| Client |
Form av en vilonivåklient |
| ErrorModel |
Felobjektet. |
| ErrorResponse |
Ett svar som innehåller felinformation. |
| FullOperationResponse |
Wrapper-objekt för http-begäran och -svar. Deserialiserat objekt lagras i egenskapen |
| InnerError |
Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
| NodeJSReadableStream |
En Node.js läsbar ström som också har en |
| OperationOptions |
Basalternativtypen för alla åtgärder. |
| OperationRequestOptions |
Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden. |
| PathParameterWithOptions |
Ett objekt som kan skickas som en sökvägsparameter, vilket gör att ytterligare alternativ kan anges som relaterar till hur parametern kodas. |
| ResourceMethods |
Definierar de metoder som kan anropas på en resurs |
Typalias
| ClientOptions |
Allmänna alternativ som en vilonivåklient kan använda |
| HttpBrowserStreamResponse |
Http-svar som brödtext är ett NodeJS-strömobjekt |
| HttpNodeStreamResponse |
Http-svar som brödtext är ett NodeJS-strömobjekt |
| HttpResponse |
Representerar formen på en HttpResponse |
| PathParameters |
Hjälptyp som används för att identifiera parametrar i en sökvägsmalltext omgiven av {} betraktas som en sökvägsparameter |
| PathUnchecked |
Definierar signaturen för pathUnchecked. |
| PathUncheckedResponse |
Typ som ska användas med pathUnchecked, åsidosätter brödtexttypen till valfri för att tillåta flexibilitet |
| RawResponseCallback |
En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger. Det här återanropet anropas med två parametrar: råsvaret, inklusive rubriker och svarstext; och ett felobjekt som anges om ett fel utlöstes när begäran bearbetades.
Den tredje __legacyError parametern tillhandahålls endast för bakåtkompatibilitet och har ett identiskt värde med parametern |
| RequestParameters |
Formen på standardparametrarna för begäranden kan åsidosättas av de specifika begärandetyperna för att tillhandahålla starka typer |
| StreamableMethod |
Definierar typen för en metod som har stöd för att hämta svarstexten som en råström |
Funktioner
| add |
Lägger till en princip för autentiseringsuppgifter i pipelinen om en autentiseringsuppgift tillhandahålls. Om ingen anges läggs ingen princip till. |
| create |
Skapar ett vilofel från ett PathUnchecked-svar |
| create |
Skapar ett vilofel från ett felmeddelande och ett PathUnchecked-svar |
| get |
Skapar en klient med en standardpipeline |
| get |
Skapar en klient med en standardpipeline |
| operation |
Hjälpfunktion för att konvertera OperationOptions till RequestParameters |
Funktionsinformation
addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)
Lägger till en princip för autentiseringsuppgifter i pipelinen om en autentiseringsuppgift tillhandahålls. Om ingen anges läggs ingen princip till.
function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)
Parametrar
- pipeline
- Pipeline
- endpoint
-
string
createRestError(PathUncheckedResponse)
Skapar ett vilofel från ett PathUnchecked-svar
function createRestError(response: PathUncheckedResponse): RestError
Parametrar
- response
- PathUncheckedResponse
Returer
createRestError(string, PathUncheckedResponse)
Skapar ett vilofel från ett felmeddelande och ett PathUnchecked-svar
function createRestError(message: string, response: PathUncheckedResponse): RestError
Parametrar
- message
-
string
- response
- PathUncheckedResponse
Returer
getClient(string, ClientOptions)
Skapar en klient med en standardpipeline
function getClient(endpoint: string, options?: ClientOptions): Client
Parametrar
- endpoint
-
string
Basslutpunkt för klienten
- options
- ClientOptions
Klientalternativ
Returer
getClient(string, TokenCredential | KeyCredential, ClientOptions)
Skapar en klient med en standardpipeline
function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client
Parametrar
- endpoint
-
string
Basslutpunkt för klienten
- credentials
Autentiseringsuppgifter för att autentisera begäranden
- options
- ClientOptions
Klientalternativ
Returer
operationOptionsToRequestParameters(OperationOptions)
Hjälpfunktion för att konvertera OperationOptions till RequestParameters
function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters
Parametrar
- options
- OperationOptions
de alternativ som används av Modulärt lager för att skicka begäran
Returer
resultatet av konverteringen i RequestParameters av RLC-lagret