ServiceListSharesSegmentOptionalParams interface

Paket:

@azure/storage-file

Valfria parametrar.

Extends

RequestOptionsBase

Egenskaper

abortSignal	Den signal som kan användas för att avbryta begäranden.
customHeaders	{object} [customHeaders] Användardefinierade anpassade begärandehuvuden som ska tillämpas innan begäran skickas.
include	Inkludera den här parametern för att ange en eller flera datauppsättningar som ska ingå i svaret.
marker	Ett strängvärde som identifierar den del av listan som ska returneras med nästa liståtgärd. Åtgärden returnerar ett markörvärde i svarstexten om listan som returnerades inte var slutförd. Markörvärdet kan sedan användas i ett efterföljande anrop för att begära nästa uppsättning listobjekt. Markörvärdet är ogenomskinlig för klienten.
maxresults	Anger det maximala antalet poster som ska returneras. Om begäran inte anger maxresults eller anger ett värde som är större än 5 000 returnerar servern upp till 5 000 objekt.
onDownloadProgress	Återanrop som utlöses när nedladdningen förlopp.
onUploadProgress	Återanrop som utlöses när uppladdningen förlopp.
prefix	Filtrerar resultatet så att endast poster vars namn börjar med det angivna prefixet returneras.
timeout	Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt.
timeoutParameter	Tidsgränsparametern uttrycks i sekunder. Mer information finns i Ange tidsgränser för filtjänståtgärder.

Egenskapsinformation

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

customHeaders

{object} [customHeaders] Användardefinierade anpassade begärandehuvuden som ska tillämpas innan begäran skickas.

customHeaders?: undefined | [key: string]: string

Egenskapsvärde

undefined | [key: string]: string

include

Inkludera den här parametern för att ange en eller flera datauppsättningar som ska ingå i svaret.

include?: ListSharesIncludeType[]

Egenskapsvärde

ListSharesIncludeType[]

marker

Ett strängvärde som identifierar den del av listan som ska returneras med nästa liståtgärd. Åtgärden returnerar ett markörvärde i svarstexten om listan som returnerades inte var slutförd. Markörvärdet kan sedan användas i ett efterföljande anrop för att begära nästa uppsättning listobjekt. Markörvärdet är ogenomskinlig för klienten.

marker?: undefined | string

Egenskapsvärde

undefined | string

maxresults

Anger det maximala antalet poster som ska returneras. Om begäran inte anger maxresults eller anger ett värde som är större än 5 000 returnerar servern upp till 5 000 objekt.

maxresults?: undefined | number

Egenskapsvärde

undefined | number

onDownloadProgress

Återanrop som utlöses när nedladdningen förlopp.

onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void

Egenskapsvärde

undefined | (progress: TransferProgressEvent) => void

onUploadProgress

Återanrop som utlöses när uppladdningen förlopp.

onUploadProgress?: undefined | (progress: TransferProgressEvent) => void

Egenskapsvärde

undefined | (progress: TransferProgressEvent) => void

prefix

Filtrerar resultatet så att endast poster vars namn börjar med det angivna prefixet returneras.

prefix?: undefined | string

Egenskapsvärde

undefined | string

timeout

Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt.

timeout?: undefined | number

Egenskapsvärde

undefined | number

timeoutParameter

Tidsgränsparametern uttrycks i sekunder. Mer information finns i Ange tidsgränser för filtjänståtgärder.

timeoutParameter?: undefined | number

Egenskapsvärde

undefined | number