OperationSpec interface

Package:

@azure/core-client

A specification that defines an operation.

Properties

baseUrl	The URL that was provided in the service's specification. This will still have all of the URL template variables in it. If this is not provided when the OperationSpec is created, then it will be populated by a "baseUri" property on the ServiceClient.
contentType	The content type of the request body. This value will be used as the "Content-Type" header if it is provided.
formDataParameters	The parameters to the operation method that will be used to create a formdata body for the operation's HTTP request.
headerParameters	The parameters to the operation method that will be converted to headers on the operation's HTTP request.
httpMethod	The HTTP method that should be used by requests for this operation.
isXML	Whether or not this operation uses XML request and response bodies.
mediaType	The media type of the request body. This value can be used to aide in serialization if it is provided.
path	The fixed path for this operation's URL. This will still have all of the URL template variables in it.
queryParameters	The parameters to the operation method that will be added to the constructed URL's query.
requestBody	The parameter that will be used to construct the HTTP request's body.
responses	The different types of responses that this operation can return based on what status code is returned.
serializer	The serializer to use in this operation.
urlParameters	The parameters to the operation method that will be substituted into the constructed URL.

Property Details

baseUrl

The URL that was provided in the service's specification. This will still have all of the URL template variables in it. If this is not provided when the OperationSpec is created, then it will be populated by a "baseUri" property on the ServiceClient.

baseUrl?: string

Property Value

string

contentType

The content type of the request body. This value will be used as the "Content-Type" header if it is provided.

contentType?: string

Property Value

string

formDataParameters

The parameters to the operation method that will be used to create a formdata body for the operation's HTTP request.

formDataParameters?: readonly OperationParameter[]

Property Value

readonly OperationParameter[]

headerParameters

The parameters to the operation method that will be converted to headers on the operation's HTTP request.

headerParameters?: readonly OperationParameter[]

Property Value

readonly OperationParameter[]

httpMethod

The HTTP method that should be used by requests for this operation.

httpMethod: HttpMethods

Property Value

HttpMethods

isXML

Whether or not this operation uses XML request and response bodies.

isXML?: boolean

Property Value

boolean

mediaType

The media type of the request body. This value can be used to aide in serialization if it is provided.

mediaType?: string

Property Value

string

path

The fixed path for this operation's URL. This will still have all of the URL template variables in it.

path?: string

Property Value

string

queryParameters

The parameters to the operation method that will be added to the constructed URL's query.

queryParameters?: readonly OperationQueryParameter[]

Property Value

readonly OperationQueryParameter[]

requestBody

The parameter that will be used to construct the HTTP request's body.

requestBody?: OperationParameter

Property Value

OperationParameter

responses

The different types of responses that this operation can return based on what status code is returned.

responses: {[responseCode: string]: OperationResponseMap}

Property Value

{[responseCode: string]: OperationResponseMap}

serializer

The serializer to use in this operation.

serializer: Serializer

Property Value

Serializer

urlParameters

The parameters to the operation method that will be substituted into the constructed URL.

urlParameters?: readonly OperationURLParameter[]

Property Value

readonly OperationURLParameter[]