RequestPrepareOptions interface

  • Başvuru
Paket:
@azure/ms-rest-js

Özellikler

abortSignal
baseUrl

İsteğin temel URL'si. Varsayılan değer: "https://management.azure.com". Bu yalnızca pathTemplate ile geçerlidir. options.url sağlıyorsanız url'nin tamamını sağlamanız beklenir.
body

İstek gövdesi. Herhangi bir türde olabilir. Bu değer bir akış değilse seri hale getirilir.
bodyIsStream

İstek gövdesinin bir akış olup olmadığını gösterir (dosya yükleme senaryoları için kullanışlıdır).
deserializationMapper

Yanıt gövdesini seri durumdan çıkarma hakkında bilgi sağlar.
disableClientRequestId

true olarak ayarlandığında, istemciye "x-ms-client-request-id" üst bilgisini yeni bir Guid() olarak ayarlamamasını belirtir.
disableJsonStringifyOnBody

Bu yöntemin istek gövdesinde JSON.stringify() olup olmayacağını gösterir. Varsayılan değer: false.
formData
headers

İsteğe uygulanması gereken istek üst bilgileri sözlüğü. Burada anahtar "header-name" ve değer ise "header-value" şeklindedir. Üst bilgi-değer dize türünde olmalıdır.

  • ContentType anahtar adı "Content-Type" olarak sağlanmalıdır. Varsayılan değer "application/json; charset=utf-8".
  • "options.bodyIsStream" true olarak ayarlandıysa"Transfer-Encoding" varsayılan olarak "öbekli" olarak ayarlanır.
  • "options.bodyIsStream" true olarak ayarlandıysa, "Content-Type" varsayılan olarak "application/octet-stream" olarak ayarlanır.
  • "accept-language" varsayılan olarak "en-US" olarak ayarlanır
  • Varsayılan olarak "x-ms-client-request-id" yeni bir Guid olarak ayarlanır. İstek için guid oluşturmamak için lütfen options.disableClientRequestId değerini true olarak ayarlayın
mappers

[de]serileştirme sırasında kullanılabilecek eşleyiciler sözlüğü.
method

HTTP istek yöntemi. Geçerli değerler şunlardır: "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" veya "PATCH".
onDownloadProgress
onUploadProgress
pathParameters

pathTemplate içindeki gerçek değerlerle değiştirilmesi gereken yol parametrelerinin sözlüğü. Burada anahtar "path-parameter-name" ve değer ise "path-parameter-value" şeklindedir. "path-parameter-value", "string" türünde veya "object" türünde olabilir. URL kodlamasını atlamak istediğinizde "object" biçimi kullanılmalıdır. Nesne biçimi kullanılırken, nesnenin "path-parameter-value" sağlayan value adlı bir özelliği olmalıdır. Örnek:

  • "nesne" biçiminde path-parameter-value: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • "dize" biçiminde path-parameter-value: { "path-parameter-name": "path-parameter-value" }.
pathTemplate

İstek URL'sinin yol şablonu. Seçenekler nesnesinde "url"yi veya "pathTemplate" öğesini sağlayın. Her iki seçenek de birbirini dışlar. Örnek: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"
queryParameters

URL'ye eklenecek sorgu parametrelerinin sözlüğü; burada "anahtar" "query-parameter-name" ve "value" ise "query-parameter-value" olur. "query-parameter-value", "string" türünde veya "object" türünde olabilir. URL kodlamasını atlamak istediğinizde "object" biçimi kullanılmalıdır. Nesne biçimi kullanılırken, nesnenin "query-parameter-value" sağlayan value adlı bir özelliği olmalıdır. Örnek:

  • "object" biçiminde query-parameter-value: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • "dize" biçiminde query-parameter-value: { "query-parameter-name": "query-parameter-value"}. Not: "options.url dosyasında zaten bazı sorgu parametreleri varsa, options.queryParameters içinde sağlanan değer url'ye eklenir.
redirectLimit

Bu istek için izlenen yeniden yönlendirme sayısını sınırlayın. 0 olarak ayarlanırsa, yeniden yönlendirmeler izlenmez. Tanımsız bırakılırsa, temel node_fetch varsayılan yeniden yönlendirme davranışı uygulanır.
serializationMapper

İstek gövdesini seri hale getirme hakkında bilgi sağlar.
streamResponseBody
url

İstek URL'si. Içinde sorgu parametreleri olabilir veya olmayabilir. Seçenekler nesnesinde "url"yi veya "pathTemplate" öğesini sağlayın. Her iki seçenek de birbirini dışlar.

Özellik Ayrıntıları

abortSignal 

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

baseUrl

İsteğin temel URL'si. Varsayılan değer: "https://management.azure.com". Bu yalnızca pathTemplate ile geçerlidir. options.url sağlıyorsanız url'nin tamamını sağlamanız beklenir.

baseUrl?: string

Özellik Değeri

string

body

İstek gövdesi. Herhangi bir türde olabilir. Bu değer bir akış değilse seri hale getirilir.

body?: any

Özellik Değeri

any

bodyIsStream

İstek gövdesinin bir akış olup olmadığını gösterir (dosya yükleme senaryoları için kullanışlıdır).

bodyIsStream?: boolean

Özellik Değeri

boolean

deserializationMapper

Yanıt gövdesini seri durumdan çıkarma hakkında bilgi sağlar.

deserializationMapper?: object

Özellik Değeri

object

disableClientRequestId

true olarak ayarlandığında, istemciye "x-ms-client-request-id" üst bilgisini yeni bir Guid() olarak ayarlamamasını belirtir.

disableClientRequestId?: boolean

Özellik Değeri

boolean

disableJsonStringifyOnBody

Bu yöntemin istek gövdesinde JSON.stringify() olup olmayacağını gösterir. Varsayılan değer: false.

disableJsonStringifyOnBody?: boolean

Özellik Değeri

boolean

formData 

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

Özellik Değeri

{[key: string]: any}

headers

İsteğe uygulanması gereken istek üst bilgileri sözlüğü. Burada anahtar "header-name" ve değer ise "header-value" şeklindedir. Üst bilgi-değer dize türünde olmalıdır.

  • ContentType anahtar adı "Content-Type" olarak sağlanmalıdır. Varsayılan değer "application/json; charset=utf-8".
  • "options.bodyIsStream" true olarak ayarlandıysa"Transfer-Encoding" varsayılan olarak "öbekli" olarak ayarlanır.
  • "options.bodyIsStream" true olarak ayarlandıysa, "Content-Type" varsayılan olarak "application/octet-stream" olarak ayarlanır.
  • "accept-language" varsayılan olarak "en-US" olarak ayarlanır
  • Varsayılan olarak "x-ms-client-request-id" yeni bir Guid olarak ayarlanır. İstek için guid oluşturmamak için lütfen options.disableClientRequestId değerini true olarak ayarlayın
headers?: {[key: string]: any}

Özellik Değeri

{[key: string]: any}

mappers

[de]serileştirme sırasında kullanılabilecek eşleyiciler sözlüğü.

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

Özellik Değeri

{[x: string]: any}

method

HTTP istek yöntemi. Geçerli değerler şunlardır: "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" veya "PATCH".

method: HttpMethods

Özellik Değeri

HttpMethods

onDownloadProgress 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

pathParameters

pathTemplate içindeki gerçek değerlerle değiştirilmesi gereken yol parametrelerinin sözlüğü. Burada anahtar "path-parameter-name" ve değer ise "path-parameter-value" şeklindedir. "path-parameter-value", "string" türünde veya "object" türünde olabilir. URL kodlamasını atlamak istediğinizde "object" biçimi kullanılmalıdır. Nesne biçimi kullanılırken, nesnenin "path-parameter-value" sağlayan value adlı bir özelliği olmalıdır. Örnek:

  • "nesne" biçiminde path-parameter-value: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • "dize" biçiminde path-parameter-value: { "path-parameter-name": "path-parameter-value" }.
pathParameters?: {[key: string]: any | ParameterValue}

Özellik Değeri

{[key: string]: any | ParameterValue}

pathTemplate

İstek URL'sinin yol şablonu. Seçenekler nesnesinde "url"yi veya "pathTemplate" öğesini sağlayın. Her iki seçenek de birbirini dışlar. Örnek: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"

pathTemplate?: string

Özellik Değeri

string

queryParameters

URL'ye eklenecek sorgu parametrelerinin sözlüğü; burada "anahtar" "query-parameter-name" ve "value" ise "query-parameter-value" olur. "query-parameter-value", "string" türünde veya "object" türünde olabilir. URL kodlamasını atlamak istediğinizde "object" biçimi kullanılmalıdır. Nesne biçimi kullanılırken, nesnenin "query-parameter-value" sağlayan value adlı bir özelliği olmalıdır. Örnek:

  • "object" biçiminde query-parameter-value: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • "dize" biçiminde query-parameter-value: { "query-parameter-name": "query-parameter-value"}. Not: "options.url dosyasında zaten bazı sorgu parametreleri varsa, options.queryParameters içinde sağlanan değer url'ye eklenir.
queryParameters?: {[key: string]: any | ParameterValue}

Özellik Değeri

{[key: string]: any | ParameterValue}

redirectLimit

Bu istek için izlenen yeniden yönlendirme sayısını sınırlayın. 0 olarak ayarlanırsa, yeniden yönlendirmeler izlenmez. Tanımsız bırakılırsa, temel node_fetch varsayılan yeniden yönlendirme davranışı uygulanır.

redirectLimit?: number

Özellik Değeri

number

serializationMapper

İstek gövdesini seri hale getirme hakkında bilgi sağlar.

serializationMapper?: Mapper

Özellik Değeri

Mapper

streamResponseBody 

streamResponseBody?: boolean

Özellik Değeri

boolean

url

İstek URL'si. Içinde sorgu parametreleri olabilir veya olmayabilir. Seçenekler nesnesinde "url"yi veya "pathTemplate" öğesini sağlayın. Her iki seçenek de birbirini dışlar.

url?: string

Özellik Değeri

string