RequestPrepareOptions interface

Csomag:

@azure/core-http

A kimenő HTTP-kérések előkészítésének lehetőségei.

Tulajdonságok

abortSignal	Megszakító vezérlő jelzése. A hálózati kérések küldésének megszakítására és a válaszra való várakozásra is használható.
baseUrl	A kérés alap URL-címe. Alapértelmezett érték: "https://management.azure.com". Ez csak a pathTemplate esetén alkalmazható. Ha a options.url címet adja meg, akkor a teljes URL-címet kell megadnia.
body	A kérelem törzse. Bármilyen típusú lehet. Ez az érték szerializálva lesz, ha nem stream.
bodyIsStream	Azt jelzi, hogy a kérelem törzse stream-e (a fájlfeltöltési forgatókönyvekben hasznos).
deserializationMapper	A válasz törzsének deszerializálásáról nyújt tájékoztatást.
disableClientRequestId	Ha igaz értékre van állítva, arra utasítja az ügyfelet, hogy ne állítsa az "x-ms-client-request-id" fejlécet új Guid() azonosítóra.
disableJsonStringifyOnBody	Azt jelzi, hogy ennek a metódusnak jSON.stringify() kell-e a kérelem törzsét. Alapértelmezett érték: hamis.
formData	A kérelem törzsének létrehozásához használt űrlapadatok.
headers	A kérelemfejlécek szótára, amelyeket alkalmazni kell a kérelemre. Itt a kulcs a "fejléc-név", az érték pedig a "fejléc-érték". A fejlécértéknek sztring típusúnak kell lennie. A ContentType-t "Content-Type" kulcsnévként kell megadni. Alapértelmezett érték : "application/json; charset=utf-8". A "Transfer-Encoding" alapértelmezés szerint "adattömb" értékre van állítva, ha a "options.bodyIsStream" értéke igaz. A "Content-Type" alapértelmezés szerint "application/octet-stream" értékre van állítva, ha a "options.bodyIsStream" értéke igaz. Az "accept-language" alapértelmezés szerint "en-US" értékre van állítva Az "x-ms-client-request-id" alapértelmezés szerint új GUID-ra van állítva. Ha nem szeretne GUID-azonosítót létrehozni a kéréshez, állítsa be a options.disableClientRequestId értéket igaz értékre
mappers	A [de]szerializálás során használható mapperek szótára.
method	A HTTP-kérelem metódusa. Az érvényes értékek a következők: "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST", vagy "PATCH".
onDownloadProgress	Lehetővé teszi a bejövő válasz letöltésének előrehaladásának nyomon követését.
onUploadProgress	Lehetővé teszi a kimenő kérés feltöltésének előrehaladásának nyomon követését.
pathParameters	Az elérésiút-paraméterek szótára, amelyet a pathTemplate tényleges értékeivel kell helyettesíteni. Itt a kulcs a "path-parameter-name", az érték pedig a "path-parameter-value". A "path-parameter-value" lehet "sztring" típusú, vagy "object" típusú. Az "object" formátumot akkor kell használni, ha ki szeretné hagyni az URL-kódolást. Az objektumformátum használata során az objektumnak rendelkeznie kell egy névvel ellátott tulajdonságtal, amely az "elérési út-paraméter-érték" értéket adja meg. Példa: elérési út-paraméter-érték "objektum" formátumban: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } } elérési út-paraméter-érték "karakterlánc" formátumban: { "path-parameter-name": "path-parameter-value" }.
pathTemplate	A kérelem URL-címének elérésiút-sablonja. Adja meg az "url"-t, vagy adja meg a "pathTemplate" értéket a beállításobjektumban. Mindkét lehetőség kölcsönösen kizárja egymást. Példa: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
queryParameters	Az URL-címhez hozzáfűzendő lekérdezési paraméterek szótára, ahol a "kulcs" a "query-parameter-name", az "érték" pedig a "query-parameter-value". A "query-parameter-value" lehet "sztring" vagy "object" típusú. Az "object" formátumot akkor kell használni, ha ki szeretné hagyni az URL-kódolást. Az objektumformátum használata során az objektumnak rendelkeznie kell egy névvel ellátott tulajdonságtal, amely a "query-parameter-value" értéket adja meg. Példa: query-parameter-value in "object" formátumban: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } } query-paraméter-érték "karakterlánc" formátumban: { "query-parameter-name": "query-parameter-value"}. Megjegyzés: "Ha a options.url már rendelkezik lekérdezési paraméterekkel, akkor az options.queryParameters fájlban megadott érték hozzá lesz fűzve az URL-címhez.
serializationMapper	Információt nyújt a kérelem törzsének szerializálásáról.
spanOptions	Nyomkövetés: A hatókör létrehozására szolgáló beállítások, ha a nyomkövetés engedélyezve van.
tracingContext	Nyomkövetés: A spanok létrehozásakor használt környezet.
url	A kérelem URL-címe. Előfordulhat, hogy lekérdezési paraméterek vannak benne. Adja meg az "url"-t, vagy adja meg a "pathTemplate" értéket a beállításobjektumban. Mindkét lehetőség kölcsönösen kizárja egymást.

Tulajdonság adatai

abortSignal

Megszakító vezérlő jelzése. A hálózati kérések küldésének megszakítására és a válaszra való várakozásra is használható.

abortSignal?: AbortSignalLike

Tulajdonság értéke

AbortSignalLike

baseUrl

A kérés alap URL-címe. Alapértelmezett érték: "https://management.azure.com". Ez csak a pathTemplate esetén alkalmazható. Ha a options.url címet adja meg, akkor a teljes URL-címet kell megadnia.

baseUrl?: string

Tulajdonság értéke

string

body

A kérelem törzse. Bármilyen típusú lehet. Ez az érték szerializálva lesz, ha nem stream.

body?: any

Tulajdonság értéke

any

bodyIsStream

Azt jelzi, hogy a kérelem törzse stream-e (a fájlfeltöltési forgatókönyvekben hasznos).

bodyIsStream?: boolean

Tulajdonság értéke

boolean

deserializationMapper

A válasz törzsének deszerializálásáról nyújt tájékoztatást.

deserializationMapper?: Record<string, unknown>

Tulajdonság értéke

Record<string, unknown>

disableClientRequestId

Ha igaz értékre van állítva, arra utasítja az ügyfelet, hogy ne állítsa az "x-ms-client-request-id" fejlécet új Guid() azonosítóra.

disableClientRequestId?: boolean

Tulajdonság értéke

boolean

disableJsonStringifyOnBody

Azt jelzi, hogy ennek a metódusnak jSON.stringify() kell-e a kérelem törzsét. Alapértelmezett érték: hamis.

disableJsonStringifyOnBody?: boolean

Tulajdonság értéke

boolean

formData

A kérelem törzsének létrehozásához használt űrlapadatok.

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

Tulajdonság értéke

{[key: string]: any}

headers

A kérelemfejlécek szótára, amelyeket alkalmazni kell a kérelemre. Itt a kulcs a "fejléc-név", az érték pedig a "fejléc-érték". A fejlécértéknek sztring típusúnak kell lennie.

• A ContentType-t "Content-Type" kulcsnévként kell megadni. Alapértelmezett érték : "application/json; charset=utf-8".
• A "Transfer-Encoding" alapértelmezés szerint "adattömb" értékre van állítva, ha a "options.bodyIsStream" értéke igaz.
• A "Content-Type" alapértelmezés szerint "application/octet-stream" értékre van állítva, ha a "options.bodyIsStream" értéke igaz.
• Az "accept-language" alapértelmezés szerint "en-US" értékre van állítva
• Az "x-ms-client-request-id" alapértelmezés szerint új GUID-ra van állítva. Ha nem szeretne GUID-azonosítót létrehozni a kéréshez, állítsa be a options.disableClientRequestId értéket igaz értékre

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

Tulajdonság értéke

{[key: string]: any}

mappers

A [de]szerializálás során használható mapperek szótára.

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

Tulajdonság értéke

{[x: string]: any}

method

A HTTP-kérelem metódusa. Az érvényes értékek a következők: "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST", vagy "PATCH".

method: HttpMethods

Tulajdonság értéke

HttpMethods

onDownloadProgress

Lehetővé teszi a bejövő válasz letöltésének előrehaladásának nyomon követését.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Tulajdonság értéke

(progress: TransferProgressEvent) => void

onUploadProgress

Lehetővé teszi a kimenő kérés feltöltésének előrehaladásának nyomon követését.

onUploadProgress?: (progress: TransferProgressEvent) => void

Tulajdonság értéke

(progress: TransferProgressEvent) => void

pathParameters

Az elérésiút-paraméterek szótára, amelyet a pathTemplate tényleges értékeivel kell helyettesíteni. Itt a kulcs a "path-parameter-name", az érték pedig a "path-parameter-value". A "path-parameter-value" lehet "sztring" típusú, vagy "object" típusú. Az "object" formátumot akkor kell használni, ha ki szeretné hagyni az URL-kódolást. Az objektumformátum használata során az objektumnak rendelkeznie kell egy névvel ellátott tulajdonságtal, amely az "elérési út-paraméter-érték" értéket adja meg. Példa:

• elérési út-paraméter-érték "objektum" formátumban: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
• elérési út-paraméter-érték "karakterlánc" formátumban: { "path-parameter-name": "path-parameter-value" }.

pathParameters?: {[key: string]: any | ParameterValue}

Tulajdonság értéke

{[key: string]: any | ParameterValue}

pathTemplate

A kérelem URL-címének elérésiút-sablonja. Adja meg az "url"-t, vagy adja meg a "pathTemplate" értéket a beállításobjektumban. Mindkét lehetőség kölcsönösen kizárja egymást. Példa: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}

pathTemplate?: string

Tulajdonság értéke

string

queryParameters

Az URL-címhez hozzáfűzendő lekérdezési paraméterek szótára, ahol a "kulcs" a "query-parameter-name", az "érték" pedig a "query-parameter-value". A "query-parameter-value" lehet "sztring" vagy "object" típusú. Az "object" formátumot akkor kell használni, ha ki szeretné hagyni az URL-kódolást. Az objektumformátum használata során az objektumnak rendelkeznie kell egy névvel ellátott tulajdonságtal, amely a "query-parameter-value" értéket adja meg. Példa:

• query-parameter-value in "object" formátumban: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
• query-paraméter-érték "karakterlánc" formátumban: { "query-parameter-name": "query-parameter-value"}. Megjegyzés: "Ha a options.url már rendelkezik lekérdezési paraméterekkel, akkor az options.queryParameters fájlban megadott érték hozzá lesz fűzve az URL-címhez.

queryParameters?: {[key: string]: any | ParameterValue}

Tulajdonság értéke

{[key: string]: any | ParameterValue}

serializationMapper

Információt nyújt a kérelem törzsének szerializálásáról.

serializationMapper?: Mapper

Tulajdonság értéke

Mapper

spanOptions

Nyomkövetés: A hatókör létrehozására szolgáló beállítások, ha a nyomkövetés engedélyezve van.

spanOptions?: SpanOptions

Tulajdonság értéke

@azure/core-tracing.SpanOptions

tracingContext

Nyomkövetés: A spanok létrehozásakor használt környezet.

tracingContext?: Context

Tulajdonság értéke

@azure/core-tracing.Context

url

A kérelem URL-címe. Előfordulhat, hogy lekérdezési paraméterek vannak benne. Adja meg az "url"-t, vagy adja meg a "pathTemplate" értéket a beállításobjektumban. Mindkét lehetőség kölcsönösen kizárja egymást.

url?: string

Tulajdonság értéke

string