Udostępnij za pośrednictwem

RequestPrepareOptions interface

  • Odwołanie
Pakiet:
@azure/core-http

Opcje przygotowywania wychodzącego żądania HTTP.

Właściwości

abortSignal

Sygnał przerwania kontrolera. Może służyć do przerwania zarówno wysyłania żądania sieciowego, jak i oczekiwania na odpowiedź.
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, oczekiwane jest podanie pełnego adresu 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

W przypadku ustawienia wartości true powoduje, że klient nie ustawi 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

Dane formularza używane do tworzenia treści żądania.
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 parametr "options.bodyIsStream" ma wartość true.
  • Wartość "Content-Type" jest domyślnie ustawiona na wartość "application/octet-stream", jeśli parametr "options.bodyIsStream" ma wartość true.
  • Ustawienie "accept-language" domyślnie ma wartość "en-US"
  • Ustawienie "x-ms-client-request-id" domyślnie ma nowy identyfikator GUID. Aby nie wygenerować identyfikatora GUID dla żądania, ustaw właściwość options.disableClientRequestId na true
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

Umożliwia śledzenie postępu pobierania odpowiedzi przychodzącej.
onUploadProgress

Umożliwia śledzenie postępu przekazywania żądania wychodzącego.
pathParameters

Słownik parametrów ścieżki, które należy zastąpić rzeczywistymi wartościami w pathTemplate. Tutaj klucz jest "path-parameter-name", a wartość to "path-parameter-value". Wartość "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 wartość "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". Wartość "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.
serializationMapper

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

Śledzenie: opcje używane do tworzenia zakresu po włączeniu śledzenia.
tracingContext

Śledzenie: kontekst używany podczas tworzenia zakresów.
url

Adres URL żądania. Może on mieć w nim parametry zapytania lub może nie 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

Sygnał przerwania kontrolera. Może służyć do przerwania zarówno wysyłania żądania sieciowego, jak i oczekiwania na odpowiedź.

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, oczekiwane jest podanie pełnego adresu 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?: Record<string, unknown>

Wartość właściwości

Record<string, unknown>

disableClientRequestId

W przypadku ustawienia wartości true powoduje, że klient nie ustawi 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

Dane formularza używane do tworzenia treści żądania.

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 parametr "options.bodyIsStream" ma wartość true.
  • Wartość "Content-Type" jest domyślnie ustawiona na wartość "application/octet-stream", jeśli parametr "options.bodyIsStream" ma wartość true.
  • Ustawienie "accept-language" domyślnie ma wartość "en-US"
  • Ustawienie "x-ms-client-request-id" domyślnie ma nowy identyfikator GUID. Aby nie wygenerować identyfikatora GUID dla żądania, ustaw właściwość options.disableClientRequestId na true
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

Umożliwia śledzenie postępu pobierania odpowiedzi przychodzącej.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

onUploadProgress

Umożliwia śledzenie postępu przekazywania żądania wychodzącego.

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 pathTemplate. Tutaj klucz jest "path-parameter-name", a wartość to "path-parameter-value". Wartość "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 wartość "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". Wartość "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}

serializationMapper

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

serializationMapper?: Mapper

Wartość właściwości

Mapper

spanOptions

Śledzenie: opcje używane do tworzenia zakresu po włączeniu śledzenia.

spanOptions?: SpanOptions

Wartość właściwości

@azure/core-tracing.SpanOptions

tracingContext

Śledzenie: kontekst używany podczas tworzenia zakresów.

tracingContext?: Context

Wartość właściwości

@azure/core-tracing.Context

url

Adres URL żądania. Może on mieć w nim parametry zapytania lub może nie 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