RequestPrepareOptions interface
Tulajdonságok
abort |
|
base |
A kérelem alap URL-címe. Az alapértelmezett érték: "https://management.azure.com". Ez csak a pathTemplate esetében alkalmazható. Ha options.url címet ad 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. |
body |
Azt jelzi, hogy a kérelemtörzs stream-e (a fájlfeltöltési forgatókönyvekben hasznos). |
deserialization |
A válasz törzsének deszerializálásáról nyújt tájékoztatást. |
disable |
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() értékre. |
disable |
Azt jelzi, hogy ennek a metódusnak jSON.stringify() kell-e a kérelem törzsét. Alapértelmezett érték: false. |
form |
|
headers | A kérelemfejlécek szótára, amelyeket a kérelemre kell alkalmazni. 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.
|
mappers | A [de]szerializálás során használható leképezők 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". |
on |
|
on |
|
path |
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" típus lehet "sztring" vagy "object" típusú. Az "object" formátumot kell használni, ha ki szeretné hagyni az URL-kódolást. Az objektumformátum használata során az objektumnak rendelkeznie kell egy value nevű tulajdonságmal, amely a "path-parameter-value" értéket biztosítja. Példa:
|
path |
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}" |
query |
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" típus lehet "sztring" vagy "object" típusú. Az "object" formátumot kell használni, ha ki szeretné hagyni az URL-kódolást. Az objektumformátum használata során az objektumnak rendelkeznie kell egy value nevű tulajdonságmal, amely a "query-parameter-value" értéket biztosítja. Példa:
|
redirect |
Korlátozza a kéréshez követett átirányítások számát. Ha 0-ra van állítva, az átirányítások nem lesznek követve. Ha nincs meghatározva, a mögöttes node_fetch alapértelmezett átirányítási viselkedése lesz érvényben. |
serialization |
A kérelem törzsének szerializálásáról nyújt tájékoztatást. |
stream |
|
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
baseUrl
A kérelem alap URL-címe. Az alapértelmezett érték: "https://management.azure.com". Ez csak a pathTemplate esetében alkalmazható. Ha options.url címet ad 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érelemtörzs 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?: object
Tulajdonság értéke
object
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() értékre.
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: false.
disableJsonStringifyOnBody?: boolean
Tulajdonság értéke
boolean
formData
formData?: {[key: string]: any}
Tulajdonság értéke
{[key: string]: any}
headers
A kérelemfejlécek szótára, amelyeket a kérelemre kell alkalmazni. 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-nak a kulcsnévvel "Content-Type" (Tartalomtípus) nevet kell adni. Alapértelmezett érték: "application/json; charset=utf-8".
- A "Transfer-Encoding" alapértelmezés szerint "darabolt" é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 egy új GUID-ra van beállítva. Ha nem szeretne guid azonosítót létrehozni a kéréshez, állítsa az options.disableClientRequestId értéket true (igaz) értékre.
headers?: {[key: string]: any}
Tulajdonság értéke
{[key: string]: any}
mappers
A [de]szerializálás során használható leképezők 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
onDownloadProgress
onDownloadProgress?: (progress: TransferProgressEvent) => void
Tulajdonság értéke
(progress: TransferProgressEvent) => void
onUploadProgress
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" típus lehet "sztring" vagy "object" típusú. Az "object" formátumot kell használni, ha ki szeretné hagyni az URL-kódolást. Az objektumformátum használata során az objektumnak rendelkeznie kell egy value nevű tulajdonságmal, amely a "path-parameter-value" értéket biztosítja. Példa:
- 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}
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" típus lehet "sztring" vagy "object" típusú. Az "object" formátumot kell használni, ha ki szeretné hagyni az URL-kódolást. Az objektumformátum használata során az objektumnak rendelkeznie kell egy value nevű tulajdonságmal, amely a "query-parameter-value" értéket biztosítja. Példa:
- query-parameter-value in "object" format: { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
- query-parameter-value "string" formátumban: { "query-parameter-name": "query-parameter-value"}. Megjegyzés: "Ha az options.url már tartalmaz néhány lekérdezési paramétert, akkor az options.queryParameters elemben megadott érték hozzá lesz fűzve az URL-címhez.
queryParameters?: {[key: string]: any | ParameterValue}
Tulajdonság értéke
{[key: string]: any | ParameterValue}
redirectLimit
Korlátozza a kéréshez követett átirányítások számát. Ha 0-ra van állítva, az átirányítások nem lesznek követve. Ha nincs meghatározva, a mögöttes node_fetch alapértelmezett átirányítási viselkedése lesz érvényben.
redirectLimit?: number
Tulajdonság értéke
number
serializationMapper
A kérelem törzsének szerializálásáról nyújt tájékoztatást.
serializationMapper?: Mapper
Tulajdonság értéke
streamResponseBody
streamResponseBody?: boolean
Tulajdonság értéke
boolean
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