Freigeben über

@azure-rest/core-client package

  • Referenz

Schnittstellen

AddCredentialPipelinePolicyOptions

Optionale Parameter zum Hinzufügen einer Anmeldeinformationsrichtlinie zur Pipeline.
AdditionalPolicyConfig

Wird verwendet, um zusätzliche Richtlinien zu konfigurieren, die der Pipeline beim Bau hinzugefügt wurden.
Client

Shape eines Rest-Level-Clients
ErrorModel

Das Fehlerobjekt.
ErrorResponse

Eine Antwort, die Fehlerdetails enthält.
FullOperationResponse

Wrapperobjekt für HTTP-Anforderung und -Antwort. Das deserialisierte Objekt wird in der eigenschaft parsedBody gespeichert, wenn der Antworttext in JSON empfangen wird.
InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
OperationOptions

Der Basisoptionentyp für alle Vorgänge.
OperationRequestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
PathParameterWithOptions

Ein Objekt, das als Pfadparameter übergeben werden kann, sodass zusätzliche Optionen festgelegt werden können, die sich auf die Codierung des Parameters beziehen.
ResourceMethods

Definiert die Methoden, die für eine Ressource aufgerufen werden können.

Typaliase

ClientOptions

Allgemeine Optionen, die ein Client auf Restebene übernehmen kann
HttpBrowserStreamResponse

Http-Antwort, der Textkörper ein NodeJS-Streamobjekt ist
HttpNodeStreamResponse

Http-Antwort, der Textkörper ein NodeJS-Streamobjekt ist
HttpResponse

Stellt die Form einer HttpResponse dar.
PathParameters

Hilfstyp, der verwendet wird, um Parameter in einem Pfadvorlagentext zu erkennen, der von {} umgeben ist, wird als Pfadparameter betrachtet.
PathUnchecked

Definiert die Signatur für "pathUnchecked".
PathUncheckedResponse

Type to use with pathUnchecked, overrides the body type to any to allow flexibility
RawResponseCallback

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

Dieser Rückruf wird mit zwei Parametern aufgerufen: der unformatierten Antwort, einschließlich Kopfzeilen und Antworttext; und ein Fehlerobjekt, das angegeben wird, wenn beim Verarbeiten der Anforderung ein Fehler ausgelöst wurde. Der dritte __legacyError Parameter wird nur für die Abwärtskompatibilität bereitgestellt und hat einen identischen Wert mit dem parameter error.
RequestParameters

Die Form der Standardanforderungsparameter kann von den spezifischen Anforderungstypen überschrieben werden, um starke Typen bereitzustellen.
StreamableMethod

Definiert den Typ für eine Methode, die das Abrufen des Antworttexts als rohen Datenstrom unterstützt.

Functions

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Fügt der Pipeline eine Anmeldeinformationsrichtlinie hinzu, wenn eine Anmeldeinformation bereitgestellt wird. Wenn keines angegeben wird, wird keine Richtlinie hinzugefügt.
createRestError(PathUncheckedResponse)

Erstellt einen Restfehler aus einer PathUnchecked-Antwort.
createRestError(string, PathUncheckedResponse)

Erstellt einen Restfehler aus einer Fehlermeldung und einer PathUnchecked-Antwort.
getClient(string, ClientOptions)

Erstellt einen Client mit einer Standardpipeline.
getClient(string, TokenCredential | KeyCredential, ClientOptions)

Erstellt einen Client mit einer Standardpipeline.
operationOptionsToRequestParameters(OperationOptions)

Hilfsfunktion zum Konvertieren von OperationOptions in RequestParameters

Details zur Funktion

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Fügt der Pipeline eine Anmeldeinformationsrichtlinie hinzu, wenn eine Anmeldeinformation bereitgestellt wird. Wenn keines angegeben wird, wird keine Richtlinie hinzugefügt.

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

Parameter

pipeline
Pipeline
endpoint

string

options
AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Erstellt einen Restfehler aus einer PathUnchecked-Antwort.

function createRestError(response: PathUncheckedResponse): RestError

Parameter

response
PathUncheckedResponse

Gibt zurück

RestError

createRestError(string, PathUncheckedResponse)

Erstellt einen Restfehler aus einer Fehlermeldung und einer PathUnchecked-Antwort.

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

Parameter

message

string

response
PathUncheckedResponse

Gibt zurück

RestError

getClient(string, ClientOptions)

Erstellt einen Client mit einer Standardpipeline.

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

Parameter

endpoint

string

Basisendpunkt für den Client

options
ClientOptions

Clientoptionen

Gibt zurück

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Erstellt einen Client mit einer Standardpipeline.

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

Parameter

endpoint

string

Basisendpunkt für den Client

credentials

TokenCredential | KeyCredential

Anmeldeinformationen zum Authentifizieren der Anforderungen

options
ClientOptions

Clientoptionen

Gibt zurück

Client

operationOptionsToRequestParameters(OperationOptions)

Hilfsfunktion zum Konvertieren von OperationOptions in RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parameter

options
OperationOptions

die Optionen, die von modularer Schicht zum Senden der Anforderung verwendet werden

Gibt zurück

RequestParameters

das Ergebnis der Konvertierung in RequestParameters der RLC-Ebene