FileURL class

Paquete:

@azure/storage-file

Un FileURL representa una dirección URL a un archivo de Azure Storage.

Extends

StorageURL

Constructores

FileURL(string, Pipeline)

Crea una instancia de FileURL.

Propiedades

pipeline	Canalización de directiva de solicitud.
url	Valor de cadena de dirección URL.

Métodos

abortCopyFromURL(Aborter, string)	Anula una operación Copy File pendiente y deja un archivo de destino con una longitud cero y metadatos completos.
clearRange(Aborter, number, number)	Borra el intervalo especificado y libera el espacio usado en el almacenamiento de ese intervalo.
create(Aborter, number, IFileCreateOptions)	Crea un nuevo archivo o reemplaza un archivo. Tenga en cuenta que solo inicializa el archivo sin contenido.
delete(Aborter)	Quita el archivo de la cuenta de almacenamiento. Cuando un archivo se elimina correctamente, se quita inmediatamente del índice de la cuenta de almacenamiento y ya no es accesible para los clientes. Los datos del archivo se quitan más adelante del servicio durante la recolección de elementos no utilizados. Se producirá un error en la eliminación del archivo con el código de estado 409 (conflicto) y el código de error SharingViolation si el archivo está abierto en un cliente SMB. Delete File no se admite en una instantánea de recurso compartido, que es una copia de solo lectura de un recurso compartido. Se producirá un error al intentar realizar esta operación en una instantánea de recurso compartido con 400 (InvalidQueryParameterValue)
download(Aborter, number, undefined | number, IFileDownloadOptions)	Lee o descarga un archivo del sistema, incluidos sus metadatos y propiedades. En Node.js, los datos devuelven en una secuencia legible readableStreamBody En los exploradores, los datos se devuelven en una promesa blobBody
forceCloseHandle(Aborter, string)	Forzar cierre un identificador específico para un archivo.
forceCloseHandlesSegment(Aborter, undefined | string)	Forzar el cierre de todos los identificadores de un archivo.
fromDirectoryURL(DirectoryURL, string)	Crea un objeto FileURL a partir de un objeto DirectoryURL.
getProperties(Aborter)	Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el archivo. No devuelve el contenido del archivo.
getRangeList(Aborter, IFileGetRangeListOptions)	Devuelve la lista de intervalos válidos para un archivo.
listHandlesSegment(Aborter, undefined | string, IFileListHandlesSegmentOptions)	Enumera los identificadores de un archivo.
newPipeline(Credential, INewPipelineOptions)	Método estático que se usa para crear un nuevo objeto Pipeline con credential proporcionado.
resize(Aborter, number)	Cambiar el tamaño del archivo.
setHTTPHeaders(Aborter, IFileHTTPHeaders)	Establece encabezados HTTP en el archivo. Si no se proporciona ninguna opción o ningún valor proporcionado para los encabezados HTTP del archivo en las opciones, estos encabezados HTTP de archivo sin un valor se borrarán.
setMetadata(Aborter, IMetadata)	Actualiza los metadatos definidos por el usuario para el archivo especificado. Si no hay metadatos definidos en el parámetro de opción, se quitarán los metadatos del archivo.
setProperties(Aborter, IFileProperties)	Establece las propiedades en el archivo.
startCopyFromURL(Aborter, string, IFileStartCopyOptions)	Copia un blob o un archivo en un archivo de destino dentro de la cuenta de almacenamiento.
uploadRange(Aborter, HttpRequestBody, number, number, IFileUploadRangeOptions)	Cargue un intervalo de bytes en un archivo. Se deben especificar tanto el inicio como el recuento del intervalo. El intervalo puede tener un tamaño de hasta 4 MB.
uploadRangeFromURL(Aborter, string, number, number, number)	Cargue un intervalo de bytes en un archivo donde el contenido se lea desde la dirección URL de otro archivo. El intervalo puede tener un tamaño de hasta 4 MB.
withPipeline(Pipeline)	Crea un nuevo objeto FileURL idéntico al origen, pero con la canalización de directiva de solicitud especificada.

Detalles del constructor

FileURL(string, Pipeline)

Crea una instancia de FileURL.

new FileURL(url: string, pipeline: Pipeline)

Parámetros

url

string

Cadena de dirección URL que apunta al archivo de Azure Storage, como "https://myaccount.file.core.windows.net/myshare/mydirectory/file". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". Este método acepta una dirección URL codificada o una dirección URL no codificada que apunta a un archivo. La cadena de dirección URL codificada NO se escapará dos veces, solo se escaparán los caracteres especiales de la ruta de acceso de dirección URL. Sin embargo, si un nombre de archivo o directorio incluye %, el nombre de archivo o directorio debe estar codificado en la dirección URL. Por ejemplo, un archivo denominado "myfile%", la dirección URL debe ser "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".

pipeline

Pipeline

Llame a StorageURL.newPipeline() para crear una canalización predeterminada o proporcionar una canalización personalizada.

Detalles de las propiedades

pipeline

Canalización de directiva de solicitud.

pipeline: Pipeline

Valor de propiedad

Pipeline

url

Valor de cadena de dirección URL.

url: string

Valor de propiedad

string

Detalles del método

abortCopyFromURL(Aborter, string)

Anula una operación Copy File pendiente y deja un archivo de destino con una longitud cero y metadatos completos.

function abortCopyFromURL(aborter: Aborter, copyId: string)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

copyId

string

Devoluciones

Promise<Models.FileAbortCopyResponse>

clearRange(Aborter, number, number)

Borra el intervalo especificado y libera el espacio usado en el almacenamiento de ese intervalo.

function clearRange(aborter: Aborter, offset: number, contentLength: number)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

offset

number

contentLength

number

Devoluciones

Promise<Models.FileUploadRangeResponse>

create(Aborter, number, IFileCreateOptions)

Crea un nuevo archivo o reemplaza un archivo. Tenga en cuenta que solo inicializa el archivo sin contenido.

function create(aborter: Aborter, size: number, options?: IFileCreateOptions)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

size

number

Especifica el tamaño máximo en bytes para el archivo, hasta 1 TB.

options

IFileCreateOptions

Devoluciones

Promise<Models.FileCreateResponse>

delete(Aborter)

Quita el archivo de la cuenta de almacenamiento. Cuando un archivo se elimina correctamente, se quita inmediatamente del índice de la cuenta de almacenamiento y ya no es accesible para los clientes. Los datos del archivo se quitan más adelante del servicio durante la recolección de elementos no utilizados. Se producirá un error en la eliminación del archivo con el código de estado 409 (conflicto) y el código de error SharingViolation si el archivo está abierto en un cliente SMB.

Delete File no se admite en una instantánea de recurso compartido, que es una copia de solo lectura de un recurso compartido. Se producirá un error al intentar realizar esta operación en una instantánea de recurso compartido con 400 (InvalidQueryParameterValue)

function delete(aborter: Aborter)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

Devoluciones

Promise<Models.FileDeleteResponse>

download(Aborter, number, undefined | number, IFileDownloadOptions)

Lee o descarga un archivo del sistema, incluidos sus metadatos y propiedades.

• En Node.js, los datos devuelven en una secuencia legible readableStreamBody
• En los exploradores, los datos se devuelven en una promesa blobBody

function download(aborter: Aborter, offset: number, count?: undefined | number, options?: IFileDownloadOptions)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

offset

number

Desde qué posición del archivo se va a descargar, >= 0

count

undefined | number

options

IFileDownloadOptions

Devoluciones

Promise<Models.FileDownloadResponse>

forceCloseHandle(Aborter, string)

Forzar cierre un identificador específico para un archivo.

function forceCloseHandle(aborter: Aborter, handleId: string)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

handleId

string

Identificador de identificador de identificador específico, no puede ser asterisco "*". Use forceCloseHandlesSegment() para cerrar todos los identificadores.

Devoluciones

Promise<Models.FileForceCloseHandlesResponse>

forceCloseHandlesSegment(Aborter, undefined | string)

Forzar el cierre de todos los identificadores de un archivo.

function forceCloseHandlesSegment(aborter: Aborter, marker?: undefined | string)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

marker

undefined | string

Devoluciones

Promise<Models.FileForceCloseHandlesResponse>

fromDirectoryURL(DirectoryURL, string)

Crea un objeto FileURL a partir de un objeto DirectoryURL.

static function fromDirectoryURL(directoryURL: DirectoryURL, fileName: string)

Parámetros

directoryURL

DirectoryURL

Un objeto DirectoryURL

fileName

string

Un nombre de archivo

Devoluciones

FileURL

getProperties(Aborter)

Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el archivo. No devuelve el contenido del archivo.

function getProperties(aborter: Aborter)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

Devoluciones

Promise<Models.FileGetPropertiesResponse>

getRangeList(Aborter, IFileGetRangeListOptions)

Devuelve la lista de intervalos válidos para un archivo.

function getRangeList(aborter: Aborter, options?: IFileGetRangeListOptions)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

options

IFileGetRangeListOptions

Devoluciones

Promise<FileGetRangeListResponse>

listHandlesSegment(Aborter, undefined | string, IFileListHandlesSegmentOptions)

Enumera los identificadores de un archivo.

function listHandlesSegment(aborter: Aborter, marker?: undefined | string, options?: IFileListHandlesSegmentOptions)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

marker

undefined | string

options

IFileListHandlesSegmentOptions

Devoluciones

Promise<Models.FileListHandlesResponse>

newPipeline(Credential, INewPipelineOptions)

Método estático que se usa para crear un nuevo objeto Pipeline con credential proporcionado.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)

Parámetros

credential

Credential

Por ejemplo, AnonymousCredential, SharedKeyCredential.

pipelineOptions

INewPipelineOptions

Devoluciones

Pipeline

Nuevo objeto Pipeline.

resize(Aborter, number)

Cambiar el tamaño del archivo.

function resize(aborter: Aborter, length: number)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

length

number

Cambia el tamaño de un archivo al tamaño especificado en bytes. Si el valor de byte especificado es menor que el tamaño actual del archivo, se borran todos los intervalos por encima del valor de bytes especificado.

Devoluciones

Promise<Models.FileSetHTTPHeadersResponse>

setHTTPHeaders(Aborter, IFileHTTPHeaders)

Establece encabezados HTTP en el archivo. Si no se proporciona ninguna opción o ningún valor proporcionado para los encabezados HTTP del archivo en las opciones, estos encabezados HTTP de archivo sin un valor se borrarán.

function setHTTPHeaders(aborter: Aborter, fileHTTPHeaders?: IFileHTTPHeaders)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

fileHTTPHeaders

IFileHTTPHeaders

Devoluciones

Promise<Models.FileSetHTTPHeadersResponse>

setMetadata(Aborter, IMetadata)

Actualiza los metadatos definidos por el usuario para el archivo especificado. Si no hay metadatos definidos en el parámetro de opción, se quitarán los metadatos del archivo.

function setMetadata(aborter: Aborter, metadata?: IMetadata)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

metadata

IMetadata

Devoluciones

Promise<Models.FileSetMetadataResponse>

setProperties(Aborter, IFileProperties)

Establece las propiedades en el archivo.

function setProperties(aborter: Aborter, properties?: IFileProperties)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

properties

IFileProperties

Devoluciones

Promise<ISetPropertiesResponse>

startCopyFromURL(Aborter, string, IFileStartCopyOptions)

Copia un blob o un archivo en un archivo de destino dentro de la cuenta de almacenamiento.

function startCopyFromURL(aborter: Aborter, copySource: string, options?: IFileStartCopyOptions)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

copySource

string

Especifica la dirección URL del archivo de origen o el blob, hasta 2 KB de longitud. Para copiar un archivo en otro archivo dentro de la misma cuenta de almacenamiento, puede usar clave compartida para autenticar el archivo de origen. Si va a copiar un archivo desde otra cuenta de almacenamiento o si va a copiar un blob desde la misma cuenta de almacenamiento u otra cuenta de almacenamiento, debe autenticar el archivo de origen o el blob mediante una firma de acceso compartido. Si el origen es un blob público, no se requiere autenticación para realizar la operación de copia. Un archivo de una instantánea de recurso compartido también se puede especificar como origen de copia.

options

IFileStartCopyOptions

Devoluciones

Promise<Models.FileStartCopyResponse>

uploadRange(Aborter, HttpRequestBody, number, number, IFileUploadRangeOptions)

Cargue un intervalo de bytes en un archivo. Se deben especificar tanto el inicio como el recuento del intervalo. El intervalo puede tener un tamaño de hasta 4 MB.

function uploadRange(aborter: Aborter, body: HttpRequestBody, offset: number, contentLength: number, options?: IFileUploadRangeOptions)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

body

HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView o una función que devuelve una nueva secuencia legible cuyo desplazamiento procede del origen de datos.

offset

number

Posición de desplazamiento del archivo de Azure de destino que se va a cargar.

contentLength

number

Longitud del cuerpo en bytes. Use Buffer.byteLength() para calcular la longitud del cuerpo de una cadena, incluidos caracteres no codificados en Base64/Hexadecimal.

options

IFileUploadRangeOptions

Devoluciones

Promise<Models.FileUploadRangeResponse>

uploadRangeFromURL(Aborter, string, number, number, number)

Cargue un intervalo de bytes en un archivo donde el contenido se lea desde la dirección URL de otro archivo. El intervalo puede tener un tamaño de hasta 4 MB.

function uploadRangeFromURL(aborter: Aborter, sourceURL: string, sourceOffset: number, destOffset: number, count: number)

Parámetros

aborter

Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

sourceURL

string

Especifique una dirección URL para el origen de copia, la firma de acceso compartido (SAS) quizá sea necesaria para la autenticación.

sourceOffset

number

Desplazamiento de origen desde el que se va a copiar. Pase 0 para copiar desde el principio del archivo de origen.

destOffset

number

Desplazamiento del archivo de destino.

count

number

Número de bytes que se van a cargar desde el archivo de origen.

Devoluciones

Promise<Models.FileUploadRangeFromURLResponse>

withPipeline(Pipeline)

Crea un nuevo objeto FileURL idéntico al origen, pero con la canalización de directiva de solicitud especificada.

function withPipeline(pipeline: Pipeline)

Parámetros

pipeline

Pipeline

Devoluciones

FileURL