OperationSpec interface

Paket:

@azure/core-http

Eine Spezifikation, die definiert, wie ein bestimmter Dienstvorgang über HTTP ausgeführt wird, einschließlich der ordnungsgemäßen Serialisierung von Anforderungsinformationen in und deserialisieren von Antwortinformationen in eine Objektnutzlast, die vom ServiceClient-zurückgegeben werden kann.

Eigenschaften

baseUrl	Die URL, die in der Spezifikation des Diensts bereitgestellt wurde. Dies enthält weiterhin alle URL-Vorlagenvariablen. Wenn dies beim Erstellen der OperationSpec nicht angegeben wird, wird sie von einer "baseUri"-Eigenschaft im ServiceClient aufgefüllt.
contentType	Der Inhaltstyp des Anforderungstexts. Dieser Wert wird als "Content-Type"-Header verwendet, wenn er angegeben wird.
formDataParameters	Die Parameter für die Vorgangsmethode, die zum Erstellen eines Formulardatentexts für die HTTP-Anforderung des Vorgangs verwendet wird.
headerParameters	Die Parameter für die Vorgangsmethode, die in Header in die HTTP-Anforderung des Vorgangs konvertiert werden.
httpMethod	Die HTTP-Methode, die von Anforderungen für diesen Vorgang verwendet werden soll.
isXML	Gibt an, ob dieser Vorgang XML-Anforderungs- und Antworttexte verwendet.
mediaType	Der Medientyp des Anforderungstexts. Dieser Wert kann verwendet werden, um die Serialisierung zu verwenden, wenn er bereitgestellt wird.
path	Der feste Pfad für die URL dieses Vorgangs. Dies enthält weiterhin alle URL-Vorlagenvariablen.
queryParameters	Die Parameter zur Vorgangsmethode, die der Abfrage der erstellten URL hinzugefügt werden.
requestBody	Der Parameter, der zum Erstellen des Textkörpers der HTTP-Anforderung verwendet wird.
responses	Die verschiedenen Arten von Antworten, die dieser Vorgang basierend auf dem zurückgegebenen Statuscode zurückgeben kann.
serializer	Der serialisierer, der in diesem Vorgang verwendet werden soll.
urlParameters	Die Parameter für die Vorgangsmethode, die in die erstellte URL ersetzt wird.

Details zur Eigenschaft

baseUrl

Die URL, die in der Spezifikation des Diensts bereitgestellt wurde. Dies enthält weiterhin alle URL-Vorlagenvariablen. Wenn dies beim Erstellen der OperationSpec nicht angegeben wird, wird sie von einer "baseUri"-Eigenschaft im ServiceClient aufgefüllt.

baseUrl?: string

Eigenschaftswert

string

contentType

Der Inhaltstyp des Anforderungstexts. Dieser Wert wird als "Content-Type"-Header verwendet, wenn er angegeben wird.

contentType?: string

Eigenschaftswert

string

formDataParameters

Die Parameter für die Vorgangsmethode, die zum Erstellen eines Formulardatentexts für die HTTP-Anforderung des Vorgangs verwendet wird.

formDataParameters?: readonly OperationParameter[]

Eigenschaftswert

readonly OperationParameter[]

headerParameters

Die Parameter für die Vorgangsmethode, die in Header in die HTTP-Anforderung des Vorgangs konvertiert werden.

headerParameters?: readonly OperationParameter[]

Eigenschaftswert

readonly OperationParameter[]

httpMethod

Die HTTP-Methode, die von Anforderungen für diesen Vorgang verwendet werden soll.

httpMethod: HttpMethods

Eigenschaftswert

HttpMethods

isXML

Gibt an, ob dieser Vorgang XML-Anforderungs- und Antworttexte verwendet.

isXML?: boolean

Eigenschaftswert

boolean

mediaType

Der Medientyp des Anforderungstexts. Dieser Wert kann verwendet werden, um die Serialisierung zu verwenden, wenn er bereitgestellt wird.

mediaType?: string

Eigenschaftswert

string

path

Der feste Pfad für die URL dieses Vorgangs. Dies enthält weiterhin alle URL-Vorlagenvariablen.

path?: string

Eigenschaftswert

string

queryParameters

Die Parameter zur Vorgangsmethode, die der Abfrage der erstellten URL hinzugefügt werden.

queryParameters?: readonly OperationQueryParameter[]

Eigenschaftswert

readonly OperationQueryParameter[]

requestBody

Der Parameter, der zum Erstellen des Textkörpers der HTTP-Anforderung verwendet wird.

requestBody?: OperationParameter

Eigenschaftswert

OperationParameter

responses

Die verschiedenen Arten von Antworten, die dieser Vorgang basierend auf dem zurückgegebenen Statuscode zurückgeben kann.

responses: {[responseCode: string]: OperationResponse}

Eigenschaftswert

{[responseCode: string]: OperationResponse}

serializer

Der serialisierer, der in diesem Vorgang verwendet werden soll.

serializer: Serializer

Eigenschaftswert

Serializer

urlParameters

Die Parameter für die Vorgangsmethode, die in die erstellte URL ersetzt wird.

urlParameters?: readonly OperationURLParameter[]

Eigenschaftswert

readonly OperationURLParameter[]