RequestPrepareOptions interface

  • 참조
패키지:
@azure/ms-rest-js

속성

abortSignal
baseUrl

요청의 기본 URL입니다. 기본값은 "https://management.azure.com"입니다. pathTemplate에만 적용됩니다. options.url을 제공하는 경우 전체 URL을 제공해야 합니다.
body

요청 본문. 모든 형식일 수 있습니다. 이 값은 스트림이 아닌 경우 직렬화됩니다.
bodyIsStream

요청 본문이 스트림인지 여부를 나타냅니다(파일 업로드 시나리오에 유용).
deserializationMapper

응답 본문을 역직렬화하는 방법에 대한 정보를 제공합니다.
disableClientRequestId

true로 설정하면 클라이언트가 "x-ms-client-request-id" 헤더를 새 Guid()로 설정하지 않도록 지시합니다.
disableJsonStringifyOnBody

이 메서드가 요청 본문을 JSON.stringify()해야 하는지 여부를 나타냅니다. 기본값: false
formData
headers

요청에 적용해야 하는 요청 헤더의 사전입니다. 여기서 키는 "header-name"이고 값은 "header-value"입니다. 헤더-값은 문자열 형식이어야 합니다.

  • ContentType은 키 이름을 "Content-Type"으로 제공해야 합니다. 기본값 "application/json; charset=utf-8".
  • "options.bodyIsStream"이 true로 설정된 경우 "Transfer-Encoding"은 기본적으로 "청크"로 설정됩니다.
  • "options.bodyIsStream"이 true로 설정된 경우 "Content-Type"은 기본적으로 "application/octet-stream"으로 설정됩니다.
  • 기본적으로 "accept-language"는 "en-US"로 설정됩니다.
  • 기본적으로 "x-ms-client-request-id"는 새 Guid로 설정됩니다. 요청에 대한 GUID를 생성하지 않으려면 options.disableClientRequestId를 true로 설정하세요.
mappers

[de]serialization 동안 사용할 수 있는 매퍼 사전입니다.
method

HTTP 요청 메서드입니다. 유효한 값은 "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" 또는 "PATCH"입니다.
onDownloadProgress
onUploadProgress
pathParameters

pathTemplate의 실제 값으로 바꿔야 하는 경로 매개 변수의 사전입니다. 여기서 키는 "path-parameter-name"이고 값은 "path-parameter-value"입니다. "path-parameter-value"는 "string" 형식이거나 "object" 형식일 수 있습니다. URL 인코딩을 건너뛰려는 경우 "개체" 형식을 사용해야 합니다. 개체 형식을 사용하는 동안 개체에는 "path-parameter-value"를 제공하는 값이라는 속성이 있어야 합니다. 예제:

  • path-parameter-value in "object" format: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value in "string" format: { "path-parameter-name": "path-parameter-value" }.
pathTemplate

요청 URL의 경로 템플릿입니다. 옵션 개체에 "url"을 제공하거나 "pathTemplate"을 제공합니다. 두 옵션은 모두 함께 사용할 수 없습니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"
queryParameters

URL에 추가할 쿼리 매개 변수 사전입니다. 여기서 "key"는 "query-parameter-name"이고 "value"는 "query-parameter-value"입니다. "query-parameter-value"는 "string" 형식이거나 "object" 형식일 수 있습니다. URL 인코딩을 건너뛰려는 경우 "개체" 형식을 사용해야 합니다. 개체 형식을 사용하는 동안 개체에는 "query-parameter-value"를 제공하는 값이라는 속성이 있어야 합니다. 예제:

  • query-parameter-value in "object" format: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value ("string" 형식): { "query-parameter-name": "query-parameter-value"}. 참고: "options.url에 일부 쿼리 매개 변수가 이미 있는 경우 options.queryParameters에 제공된 값이 URL에 추가됩니다.
redirectLimit

이 요청에 대해 수행되는 리디렉션 수를 제한합니다. 0으로 설정하면 리디렉션이 수행되지 않습니다. 정의되지 않은 상태로 두면 기본 node_fetch 기본 리디렉션 동작이 적용됩니다.
serializationMapper

요청 본문을 직렬화하는 방법에 대한 정보를 제공합니다.
streamResponseBody
url

요청 URL입니다. 쿼리 매개 변수가 있을 수도 있고 없을 수도 있습니다. 옵션 개체에 "url"을 제공하거나 "pathTemplate"을 제공합니다. 두 옵션은 모두 함께 사용할 수 없습니다.

속성 세부 정보

abortSignal 

abortSignal?: AbortSignalLike

속성 값

AbortSignalLike

baseUrl

요청의 기본 URL입니다. 기본값은 "https://management.azure.com"입니다. pathTemplate에만 적용됩니다. options.url을 제공하는 경우 전체 URL을 제공해야 합니다.

baseUrl?: string

속성 값

string

body

요청 본문. 모든 형식일 수 있습니다. 이 값은 스트림이 아닌 경우 직렬화됩니다.

body?: any

속성 값

any

bodyIsStream

요청 본문이 스트림인지 여부를 나타냅니다(파일 업로드 시나리오에 유용).

bodyIsStream?: boolean

속성 값

boolean

deserializationMapper

응답 본문을 역직렬화하는 방법에 대한 정보를 제공합니다.

deserializationMapper?: object

속성 값

object

disableClientRequestId

true로 설정하면 클라이언트가 "x-ms-client-request-id" 헤더를 새 Guid()로 설정하지 않도록 지시합니다.

disableClientRequestId?: boolean

속성 값

boolean

disableJsonStringifyOnBody

이 메서드가 요청 본문을 JSON.stringify()해야 하는지 여부를 나타냅니다. 기본값: false

disableJsonStringifyOnBody?: boolean

속성 값

boolean

formData 

formData?: {[key: string]: any}

속성 값

{[key: string]: any}

headers

요청에 적용해야 하는 요청 헤더의 사전입니다. 여기서 키는 "header-name"이고 값은 "header-value"입니다. 헤더-값은 문자열 형식이어야 합니다.

  • ContentType은 키 이름을 "Content-Type"으로 제공해야 합니다. 기본값 "application/json; charset=utf-8".
  • "options.bodyIsStream"이 true로 설정된 경우 "Transfer-Encoding"은 기본적으로 "청크"로 설정됩니다.
  • "options.bodyIsStream"이 true로 설정된 경우 "Content-Type"은 기본적으로 "application/octet-stream"으로 설정됩니다.
  • 기본적으로 "accept-language"는 "en-US"로 설정됩니다.
  • 기본적으로 "x-ms-client-request-id"는 새 Guid로 설정됩니다. 요청에 대한 GUID를 생성하지 않으려면 options.disableClientRequestId를 true로 설정하세요.
headers?: {[key: string]: any}

속성 값

{[key: string]: any}

mappers

[de]serialization 동안 사용할 수 있는 매퍼 사전입니다.

mappers?: {[x: string]: any}

속성 값

{[x: string]: any}

method

HTTP 요청 메서드입니다. 유효한 값은 "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" 또는 "PATCH"입니다.

method: HttpMethods

속성 값

HttpMethods

onDownloadProgress 

onDownloadProgress?: (progress: TransferProgressEvent) => void

속성 값

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

속성 값

(progress: TransferProgressEvent) => void

pathParameters

pathTemplate의 실제 값으로 바꿔야 하는 경로 매개 변수의 사전입니다. 여기서 키는 "path-parameter-name"이고 값은 "path-parameter-value"입니다. "path-parameter-value"는 "string" 형식이거나 "object" 형식일 수 있습니다. URL 인코딩을 건너뛰려는 경우 "개체" 형식을 사용해야 합니다. 개체 형식을 사용하는 동안 개체에는 "path-parameter-value"를 제공하는 값이라는 속성이 있어야 합니다. 예제:

  • path-parameter-value in "object" format: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value in "string" format: { "path-parameter-name": "path-parameter-value" }.
pathParameters?: {[key: string]: any | ParameterValue}

속성 값

{[key: string]: any | ParameterValue}

pathTemplate

요청 URL의 경로 템플릿입니다. 옵션 개체에 "url"을 제공하거나 "pathTemplate"을 제공합니다. 두 옵션은 모두 함께 사용할 수 없습니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"

pathTemplate?: string

속성 값

string

queryParameters

URL에 추가할 쿼리 매개 변수 사전입니다. 여기서 "key"는 "query-parameter-name"이고 "value"는 "query-parameter-value"입니다. "query-parameter-value"는 "string" 형식이거나 "object" 형식일 수 있습니다. URL 인코딩을 건너뛰려는 경우 "개체" 형식을 사용해야 합니다. 개체 형식을 사용하는 동안 개체에는 "query-parameter-value"를 제공하는 값이라는 속성이 있어야 합니다. 예제:

  • query-parameter-value in "object" format: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value ("string" 형식): { "query-parameter-name": "query-parameter-value"}. 참고: "options.url에 일부 쿼리 매개 변수가 이미 있는 경우 options.queryParameters에 제공된 값이 URL에 추가됩니다.
queryParameters?: {[key: string]: any | ParameterValue}

속성 값

{[key: string]: any | ParameterValue}

redirectLimit

이 요청에 대해 수행되는 리디렉션 수를 제한합니다. 0으로 설정하면 리디렉션이 수행되지 않습니다. 정의되지 않은 상태로 두면 기본 node_fetch 기본 리디렉션 동작이 적용됩니다.

redirectLimit?: number

속성 값

number

serializationMapper

요청 본문을 직렬화하는 방법에 대한 정보를 제공합니다.

serializationMapper?: Mapper

속성 값

Mapper

streamResponseBody 

streamResponseBody?: boolean

속성 값

boolean

url

요청 URL입니다. 쿼리 매개 변수가 있을 수도 있고 없을 수도 있습니다. 옵션 개체에 "url"을 제공하거나 "pathTemplate"을 제공합니다. 두 옵션은 모두 함께 사용할 수 없습니다.

url?: string

속성 값

string