DirectoryListFilesAndDirectoriesSegmentOptionalParams interface

Paquete:

@azure/storage-file

Parámetros opcionales.

Extends

RequestOptionsBase

Propiedades

abortSignal	Señal que se puede usar para anular las solicitudes.
customHeaders	{object} [customHeaders] Encabezados de solicitud personalizados definidos por el usuario que se aplicarán antes de enviar la solicitud.
marker	Valor de cadena que identifica la parte de la lista que se va a devolver con la siguiente operación de lista. La operación devuelve un valor de marcador dentro del cuerpo de la respuesta si la lista devuelta no se completó. Después, el valor del marcador se puede usar en una llamada posterior para solicitar el siguiente conjunto de elementos de lista. El valor del marcador es opaco para el cliente.
maxresults	Especifica el número máximo de entradas que se van a devolver. Si la solicitud no especifica maxresults o especifica un valor mayor que 5000, el servidor devolverá hasta 5000 elementos.
onDownloadProgress	Devolución de llamada que se desencadena tras el progreso de la descarga.
onUploadProgress	Devolución de llamada que se desencadena tras el progreso de la carga.
prefix	Filtra los resultados para devolver solo entradas cuyo nombre comienza con el prefijo especificado.
sharesnapshot	El parámetro snapshot es un valor DateTime opaco que, cuando está presente, especifica la instantánea de recurso compartido que se va a consultar.
timeout	El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente.
timeoutParameter	El parámetro timeout se expresa en segundos. Para obtener más información, consulte Establecer tiempos de espera para las operaciones del servicio de archivos.

Detalles de las propiedades

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

customHeaders

{object} [customHeaders] Encabezados de solicitud personalizados definidos por el usuario que se aplicarán antes de enviar la solicitud.

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

Valor de propiedad

undefined | [key: string]: string

marker

Valor de cadena que identifica la parte de la lista que se va a devolver con la siguiente operación de lista. La operación devuelve un valor de marcador dentro del cuerpo de la respuesta si la lista devuelta no se completó. Después, el valor del marcador se puede usar en una llamada posterior para solicitar el siguiente conjunto de elementos de lista. El valor del marcador es opaco para el cliente.

marker?: undefined | string

Valor de propiedad

undefined | string

maxresults

Especifica el número máximo de entradas que se van a devolver. Si la solicitud no especifica maxresults o especifica un valor mayor que 5000, el servidor devolverá hasta 5000 elementos.

maxresults?: undefined | number

Valor de propiedad

undefined | number

onDownloadProgress

Devolución de llamada que se desencadena tras el progreso de la descarga.

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

Valor de propiedad

undefined | (progress: TransferProgressEvent) => void

onUploadProgress

Devolución de llamada que se desencadena tras el progreso de la carga.

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

Valor de propiedad

undefined | (progress: TransferProgressEvent) => void

prefix

Filtra los resultados para devolver solo entradas cuyo nombre comienza con el prefijo especificado.

prefix?: undefined | string

Valor de propiedad

undefined | string

sharesnapshot

El parámetro snapshot es un valor DateTime opaco que, cuando está presente, especifica la instantánea de recurso compartido que se va a consultar.

sharesnapshot?: undefined | string

Valor de propiedad

undefined | string

timeout

El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente.

timeout?: undefined | number

Valor de propiedad

undefined | number

timeoutParameter

El parámetro timeout se expresa en segundos. Para obtener más información, consulte Establecer tiempos de espera para las operaciones del servicio de archivos.

timeoutParameter?: undefined | number

Valor de propiedad

undefined | number