Udostępnij za pośrednictwem

RequestPrepareOptions interface

  • Odwołanie
Pakiet:
@azure/ms-rest-js

Właściwości

abortSignal
baseUrl

Podstawowy adres URL żądania. Wartość domyślna to: "https://management.azure.com". Dotyczy to tylko ścieżkiTemplate. Jeśli udostępniasz adres options.url, oczekuje się, że podasz pełny adres URL.
body

Treść żądania. Może to być dowolny typ. Ta wartość zostanie serializowana, jeśli nie jest strumieniem.
bodyIsStream

Wskazuje, czy treść żądania jest strumieniem (przydatnym w scenariuszach przekazywania plików).
deserializationMapper

Zawiera informacje na temat deserializacji treści odpowiedzi.
disableClientRequestId

Po ustawieniu wartości true klient nie ustawia nagłówka "x-ms-client-request-id" na nowy identyfikator GUID().
disableJsonStringifyOnBody

Wskazuje, czy ta metoda powinna mieć treść żądania JSON.stringify(). Wartość domyślna: false.
formData
headers

Słownik nagłówków żądań, które należy zastosować do żądania. Tutaj klucz jest "nazwa-nagłówka", a wartość to "header-value". Wartość nagłówka MUSI być ciągiem typu .

  • Typ zawartości musi być podany z nazwą klucza jako "Content-Type". Wartość domyślna "application/json; charset=utf-8".
  • Wartość "Transfer-Encoding" jest domyślnie ustawiona na wartość "fragmented", jeśli wartość "options.bodyIsStream" jest ustawiona na wartość true.
  • Wartość "Content-Type" jest domyślnie ustawiona na wartość "application/octet-stream", jeśli wartość "options.bodyIsStream" jest ustawiona na wartość true.
  • Ustawienie "accept-language" domyślnie ma wartość "en-US"
  • Wartość "x-ms-client-request-id" domyślnie jest ustawiona na nowy identyfikator GUID. Aby nie wygenerować identyfikatora GUID dla żądania, ustaw wartość true dla parametru options.disableClientRequestId
mappers

Słownik maperów, które mogą być używane podczas serializacji [de].
method

Metoda żądania HTTP. Prawidłowe wartości to "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" lub "PATCH".
onDownloadProgress
onUploadProgress
pathParameters

Słownik parametrów ścieżki, które należy zastąpić rzeczywistymi wartościami w ścieżceTemplate. Tutaj klucz jest "path-parameter-name", a wartość to "path-parameter-value". "path-parameter-value" może być typu "string" lub może być typu "object". Format "object" powinien być używany, gdy chcesz pominąć kodowanie adresów URL. Podczas korzystania z formatu obiektu obiekt musi mieć właściwość o nazwie value, która zapewnia "path-parameter-value". Przykład:

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

Szablon ścieżki adresu URL żądania. Podaj wartość "url" lub podaj wartość "pathTemplate" w obiekcie options. Obie opcje wykluczają się wzajemnie. Przykład: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"
queryParameters

Słownik parametrów zapytania, które mają być dołączane do adresu URL, gdzie "klucz" jest "query-parameter-name", a "value" to "query-parameter-value". "query-parameter-value" może być typu "string" lub może być typu "object". Format "object" powinien być używany, gdy chcesz pominąć kodowanie adresów URL. Podczas korzystania z formatu obiektu obiekt musi mieć właściwość o nazwie value, która zapewnia wartość "query-parameter-value". Przykład:

  • query-parameter-value w formacie "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value w formacie "string": { "query-parameter-name": "query-parameter-value"}. Uwaga: "Jeśli parametr options.url ma już pewne parametry zapytania, wartość podana w pliku options.queryParameters zostanie dołączona do adresu URL.
redirectLimit

Ogranicz liczbę przekierowań obserwowanych dla tego żądania. Jeśli ustawiono wartość 0, przekierowania nie będą obserwowane. Jeśli pozostawiono niezdefiniowane domyślne zachowanie przekierowania bazowego node_fetch zostanie zastosowane.
serializationMapper

Zawiera informacje na temat serializacji treści żądania.
streamResponseBody
url

Adres URL żądania. Może on zawierać parametry zapytania lub nie może mieć w nim parametrów. Podaj wartość "url" lub podaj wartość "pathTemplate" w obiekcie options. Obie opcje wykluczają się wzajemnie.

Szczegóły właściwości

abortSignal 

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

baseUrl

Podstawowy adres URL żądania. Wartość domyślna to: "https://management.azure.com". Dotyczy to tylko ścieżkiTemplate. Jeśli udostępniasz adres options.url, oczekuje się, że podasz pełny adres URL.

baseUrl?: string

Wartość właściwości

string

body

Treść żądania. Może to być dowolny typ. Ta wartość zostanie serializowana, jeśli nie jest strumieniem.

body?: any

Wartość właściwości

any

bodyIsStream

Wskazuje, czy treść żądania jest strumieniem (przydatnym w scenariuszach przekazywania plików).

bodyIsStream?: boolean

Wartość właściwości

boolean

deserializationMapper

Zawiera informacje na temat deserializacji treści odpowiedzi.

deserializationMapper?: object

Wartość właściwości

object

disableClientRequestId

Po ustawieniu wartości true klient nie ustawia nagłówka "x-ms-client-request-id" na nowy identyfikator GUID().

disableClientRequestId?: boolean

Wartość właściwości

boolean

disableJsonStringifyOnBody

Wskazuje, czy ta metoda powinna mieć treść żądania JSON.stringify(). Wartość domyślna: false.

disableJsonStringifyOnBody?: boolean

Wartość właściwości

boolean

formData 

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

Wartość właściwości

{[key: string]: any}

headers

Słownik nagłówków żądań, które należy zastosować do żądania. Tutaj klucz jest "nazwa-nagłówka", a wartość to "header-value". Wartość nagłówka MUSI być ciągiem typu .

  • Typ zawartości musi być podany z nazwą klucza jako "Content-Type". Wartość domyślna "application/json; charset=utf-8".
  • Wartość "Transfer-Encoding" jest domyślnie ustawiona na wartość "fragmented", jeśli wartość "options.bodyIsStream" jest ustawiona na wartość true.
  • Wartość "Content-Type" jest domyślnie ustawiona na wartość "application/octet-stream", jeśli wartość "options.bodyIsStream" jest ustawiona na wartość true.
  • Ustawienie "accept-language" domyślnie ma wartość "en-US"
  • Wartość "x-ms-client-request-id" domyślnie jest ustawiona na nowy identyfikator GUID. Aby nie wygenerować identyfikatora GUID dla żądania, ustaw wartość true dla parametru options.disableClientRequestId
headers?: {[key: string]: any}

Wartość właściwości

{[key: string]: any}

mappers

Słownik maperów, które mogą być używane podczas serializacji [de].

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

Wartość właściwości

{[x: string]: any}

method

Metoda żądania HTTP. Prawidłowe wartości to "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST" lub "PATCH".

method: HttpMethods

Wartość właściwości

HttpMethods

onDownloadProgress 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

pathParameters

Słownik parametrów ścieżki, które należy zastąpić rzeczywistymi wartościami w ścieżceTemplate. Tutaj klucz jest "path-parameter-name", a wartość to "path-parameter-value". "path-parameter-value" może być typu "string" lub może być typu "object". Format "object" powinien być używany, gdy chcesz pominąć kodowanie adresów URL. Podczas korzystania z formatu obiektu obiekt musi mieć właściwość o nazwie value, która zapewnia "path-parameter-value". Przykład:

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

Wartość właściwości

{[key: string]: any | ParameterValue}

pathTemplate

Szablon ścieżki adresu URL żądania. Podaj wartość "url" lub podaj wartość "pathTemplate" w obiekcie options. Obie opcje wykluczają się wzajemnie. Przykład: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"

pathTemplate?: string

Wartość właściwości

string

queryParameters

Słownik parametrów zapytania, które mają być dołączane do adresu URL, gdzie "klucz" jest "query-parameter-name", a "value" to "query-parameter-value". "query-parameter-value" może być typu "string" lub może być typu "object". Format "object" powinien być używany, gdy chcesz pominąć kodowanie adresów URL. Podczas korzystania z formatu obiektu obiekt musi mieć właściwość o nazwie value, która zapewnia wartość "query-parameter-value". Przykład:

  • query-parameter-value w formacie "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value w formacie "string": { "query-parameter-name": "query-parameter-value"}. Uwaga: "Jeśli parametr options.url ma już pewne parametry zapytania, wartość podana w pliku options.queryParameters zostanie dołączona do adresu URL.
queryParameters?: {[key: string]: any | ParameterValue}

Wartość właściwości

{[key: string]: any | ParameterValue}

redirectLimit

Ogranicz liczbę przekierowań obserwowanych dla tego żądania. Jeśli ustawiono wartość 0, przekierowania nie będą obserwowane. Jeśli pozostawiono niezdefiniowane domyślne zachowanie przekierowania bazowego node_fetch zostanie zastosowane.

redirectLimit?: number

Wartość właściwości

number

serializationMapper

Zawiera informacje na temat serializacji treści żądania.

serializationMapper?: Mapper

Wartość właściwości

Mapper

streamResponseBody 

streamResponseBody?: boolean

Wartość właściwości

boolean

url

Adres URL żądania. Może on zawierać parametry zapytania lub nie może mieć w nim parametrów. Podaj wartość "url" lub podaj wartość "pathTemplate" w obiekcie options. Obie opcje wykluczają się wzajemnie.

url?: string

Wartość właściwości

string