DirectoryURL class

Paquete:

@azure/storage-file

Un DirectoryURL representa una dirección URL al directorio de Azure Storage que le permite manipular sus archivos y directorios.

Extends

StorageURL

Constructores

DirectoryURL(string, Pipeline)

Crea una instancia de DirectoryURL.

Propiedades

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

Métodos

create(Aborter, IDirectoryCreateOptions)	Crea un nuevo directorio bajo el recurso compartido o el directorio primario especificados.
delete(Aborter)	Quita el directorio vacío especificado. Tenga en cuenta que el directorio debe estar vacío para poder eliminarlo.
forceCloseHandle(Aborter, string)	Forzar cierre un identificador específico para un directorio.
forceCloseHandlesSegment(Aborter, undefined | string, IDirectoryForceCloseHandlesSegmentOptions)	Forzar el cierre de todos los identificadores de un directorio.
fromDirectoryURL(DirectoryURL, string)	Crea un objeto DirectoryURL a partir de un directoryURL existente.
fromShareURL(ShareURL, string)	Crea un objeto DirectoryURL a partir de ShareURL.
getProperties(Aborter)	Devuelve todas las propiedades del sistema del directorio especificado y también se puede usar para comprobar la existencia de un directorio. Los datos devueltos no incluyen los archivos en el directorio ni en ningún subdirectorio.
listFilesAndDirectoriesSegment(Aborter, undefined | string, IDirectoryListFilesAndDirectoriesSegmentOptions)	Devuelve una lista de archivos o directorios en el recurso compartido o directorio especificados. Enumera el contenido solo para un único nivel de la jerarquía de directorios.
listHandlesSegment(Aborter, undefined | string, IDirectoryListHandlesSegmentOptions)	Enumera los identificadores de un directorio.
newPipeline(Credential, INewPipelineOptions)	Método estático que se usa para crear un nuevo objeto Pipeline con credential proporcionado.
setMetadata(Aborter, IMetadata)	Actualiza los metadatos definidos por el usuario para el directorio especificado.
setProperties(Aborter, IDirectoryProperties)	Establece las propiedades en el directorio.
withPipeline(Pipeline)	Crea un nuevo objeto DirectoryURL idéntico al origen, pero con la canalización de directiva de solicitud especificada.

Detalles del constructor

DirectoryURL(string, Pipeline)

Crea una instancia de DirectoryURL.

new DirectoryURL(url: string, pipeline: Pipeline)

Parámetros

url

string

Cadena de dirección URL que apunta al directorio de archivos de Azure Storage, como "https://myaccount.file.core.windows.net/myshare/mydirectory". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.file.core.windows.net/myshare/mydirectory?sasString". Este método acepta una dirección URL codificada o una dirección URL no codificada que apunta a un directorio. 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 directorio incluye %, el nombre del directorio debe estar codificado en la dirección URL. Por ejemplo, un directorio denominado "mydir%", la dirección URL debe ser "https://myaccount.file.core.windows.net/myshare/mydir%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

create(Aborter, IDirectoryCreateOptions)

Crea un nuevo directorio bajo el recurso compartido o el directorio primario especificados.

function create(aborter: Aborter, options?: IDirectoryCreateOptions)

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

IDirectoryCreateOptions

Devoluciones

Promise<Models.DirectoryCreateResponse>

delete(Aborter)

Quita el directorio vacío especificado. Tenga en cuenta que el directorio debe estar vacío para poder eliminarlo.

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.DirectoryDeleteResponse>

forceCloseHandle(Aborter, string)

Forzar cierre un identificador específico para un directorio.

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.DirectoryForceCloseHandlesResponse>

forceCloseHandlesSegment(Aborter, undefined | string, IDirectoryForceCloseHandlesSegmentOptions)

Forzar el cierre de todos los identificadores de un directorio.

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

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

IDirectoryForceCloseHandlesSegmentOptions

Devoluciones

Promise<Models.DirectoryForceCloseHandlesResponse>

fromDirectoryURL(DirectoryURL, string)

Crea un objeto DirectoryURL a partir de un directoryURL existente.

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

Parámetros

directoryURL

DirectoryURL

Un objeto DirectoryURL

directoryName

string

Un nombre de subdirectorio

Devoluciones

DirectoryURL

fromShareURL(ShareURL, string)

Crea un objeto DirectoryURL a partir de ShareURL.

static function fromShareURL(shareURL: ShareURL, directoryName: string)

Parámetros

shareURL

ShareURL

Un objeto ShareURL

directoryName

string

Un nombre de directorio

Devoluciones

DirectoryURL

getProperties(Aborter)

Devuelve todas las propiedades del sistema del directorio especificado y también se puede usar para comprobar la existencia de un directorio. Los datos devueltos no incluyen los archivos en el directorio ni en ningún subdirectorio.

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.DirectoryGetPropertiesResponse>

listFilesAndDirectoriesSegment(Aborter, undefined | string, IDirectoryListFilesAndDirectoriesSegmentOptions)

Devuelve una lista de archivos o directorios en el recurso compartido o directorio especificados. Enumera el contenido solo para un único nivel de la jerarquía de directorios.

function listFilesAndDirectoriesSegment(aborter: Aborter, marker?: undefined | string, options?: IDirectoryListFilesAndDirectoriesSegmentOptions)

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

IDirectoryListFilesAndDirectoriesSegmentOptions

Devoluciones

Promise<Models.DirectoryListFilesAndDirectoriesSegmentResponse>

listHandlesSegment(Aborter, undefined | string, IDirectoryListHandlesSegmentOptions)

Enumera los identificadores de un directorio.

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

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

IDirectoryListHandlesSegmentOptions

Devoluciones

Promise<Models.DirectoryListHandlesResponse>

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.

setMetadata(Aborter, IMetadata)

Actualiza los metadatos definidos por el usuario para el directorio especificado.

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.DirectorySetMetadataResponse>

setProperties(Aborter, IDirectoryProperties)

Establece las propiedades en el directorio.

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

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

IDirectoryProperties

Devoluciones

Promise<Models.DirectorySetPropertiesResponse>

withPipeline(Pipeline)

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

function withPipeline(pipeline: Pipeline)

Parámetros

pipeline

Pipeline

Devoluciones

DirectoryURL