OperationSpec interface

패키지:

@azure/ms-rest-js

작업을 정의하는 사양입니다.

속성

baseUrl	서비스 사양에 제공된 URL입니다. 여기에는 여전히 모든 URL 템플릿 변수가 있습니다. OperationSpec을 만들 때 제공되지 않으면 ServiceClient의 "baseUri" 속성으로 채워집니다.
contentType	요청 본문의 콘텐츠 형식입니다. 이 값은 제공된 경우 "Content-Type" 헤더로 사용됩니다.
formDataParameters	작업의 HTTP 요청에 대한 formdata 본문을 만드는 데 사용할 작업 메서드에 대한 매개 변수입니다.
headerParameters	작업의 HTTP 요청에서 헤더로 변환될 작업 메서드에 대한 매개 변수입니다.
httpMethod	이 작업에 대한 요청에서 사용해야 하는 HTTP 메서드입니다.
isXML	이 작업에서 XML 요청 및 응답 본문을 사용하는지 여부입니다.
path	이 작업의 URL에 대한 고정 경로입니다. 여기에는 여전히 모든 URL 템플릿 변수가 있습니다.
queryParameters	생성된 URL의 쿼리에 추가될 작업 메서드에 대한 매개 변수입니다.
requestBody	HTTP 요청의 본문을 생성하는 데 사용할 매개 변수입니다.
responses	반환되는 상태 코드에 따라 이 작업이 반환할 수 있는 다양한 유형의 응답입니다.
serializer	이 작업에 사용할 serializer입니다.
urlParameters	생성된 URL로 대체될 작업 메서드에 대한 매개 변수입니다.

속성 세부 정보

baseUrl

서비스 사양에 제공된 URL입니다. 여기에는 여전히 모든 URL 템플릿 변수가 있습니다. OperationSpec을 만들 때 제공되지 않으면 ServiceClient의 "baseUri" 속성으로 채워집니다.

baseUrl?: string

속성 값

string

contentType

요청 본문의 콘텐츠 형식입니다. 이 값은 제공된 경우 "Content-Type" 헤더로 사용됩니다.

contentType?: string

속성 값

string

formDataParameters

작업의 HTTP 요청에 대한 formdata 본문을 만드는 데 사용할 작업 메서드에 대한 매개 변수입니다.

formDataParameters?: readonly OperationParameter[]

속성 값

readonly OperationParameter[]

headerParameters

작업의 HTTP 요청에서 헤더로 변환될 작업 메서드에 대한 매개 변수입니다.

headerParameters?: readonly OperationParameter[]

속성 값

readonly OperationParameter[]

httpMethod

이 작업에 대한 요청에서 사용해야 하는 HTTP 메서드입니다.

httpMethod: HttpMethods

속성 값

HttpMethods

isXML

이 작업에서 XML 요청 및 응답 본문을 사용하는지 여부입니다.

isXML?: boolean

속성 값

boolean

path

이 작업의 URL에 대한 고정 경로입니다. 여기에는 여전히 모든 URL 템플릿 변수가 있습니다.

path?: string

속성 값

string

queryParameters

생성된 URL의 쿼리에 추가될 작업 메서드에 대한 매개 변수입니다.

queryParameters?: readonly OperationQueryParameter[]

속성 값

readonly OperationQueryParameter[]

requestBody

HTTP 요청의 본문을 생성하는 데 사용할 매개 변수입니다.

requestBody?: OperationParameter

속성 값

OperationParameter

responses

반환되는 상태 코드에 따라 이 작업이 반환할 수 있는 다양한 유형의 응답입니다.

responses: {[responseCode: string]: OperationResponse}

속성 값

{[responseCode: string]: OperationResponse}

serializer

이 작업에 사용할 serializer입니다.

serializer: Serializer

속성 값

Serializer

urlParameters

생성된 URL로 대체될 작업 메서드에 대한 매개 변수입니다.

urlParameters?: readonly OperationURLParameter[]

속성 값

readonly OperationURLParameter[]