Directory class

Пакет:

@azure/storage-file

Класс, представляющий каталог.

Конструкторы

Directory(StorageClientContext)

Создайте каталог.

Методы

create(string, string, string, DirectoryCreateOptionalParams, ServiceCallback<void>)
create(string, string, string, Models.DirectoryCreateOptionalParams)	Создает новый каталог под указанным общим ресурсом или родительским каталогом.
create(string, string, string, ServiceCallback<void>)
deleteMethod(DirectoryDeleteMethodOptionalParams, ServiceCallback<void>)
deleteMethod(Models.DirectoryDeleteMethodOptionalParams)	Удаляет указанный пустой каталог. Обратите внимание, что каталог должен быть пустым, прежде чем его можно удалить.
deleteMethod(ServiceCallback<void>)
forceCloseHandles(string, DirectoryForceCloseHandlesOptionalParams, ServiceCallback<void>)
forceCloseHandles(string, Models.DirectoryForceCloseHandlesOptionalParams)	Закрывает все дескрипторы, открытые для данного каталога.
forceCloseHandles(string, ServiceCallback<void>)
getProperties(DirectoryGetPropertiesOptionalParams, ServiceCallback<void>)
getProperties(Models.DirectoryGetPropertiesOptionalParams)	Возвращает все системные свойства для указанного каталога, а также можно использовать для проверки существования каталога. Возвращенные данные не содержат файлы в каталоге или в подкаталогах.
getProperties(ServiceCallback<void>)
listFilesAndDirectoriesSegment(DirectoryListFilesAndDirectoriesSegmentOptionalParams, ServiceCallback<ListFilesAndDirectoriesSegmentResponse>)
listFilesAndDirectoriesSegment(Models.DirectoryListFilesAndDirectoriesSegmentOptionalParams)	Возвращает список файлов или каталогов в указанной общей папке или каталоге. Он содержит содержимое только для одного уровня иерархии каталогов.
listFilesAndDirectoriesSegment(ServiceCallback<ListFilesAndDirectoriesSegmentResponse>)
listHandles(DirectoryListHandlesOptionalParams, ServiceCallback<ListHandlesResponse>)
listHandles(Models.DirectoryListHandlesOptionalParams)	Список дескрипторов для каталога.
listHandles(ServiceCallback<ListHandlesResponse>)
setMetadata(DirectorySetMetadataOptionalParams, ServiceCallback<void>)
setMetadata(Models.DirectorySetMetadataOptionalParams)	Обновляет пользовательские метаданные для указанного каталога.
setMetadata(ServiceCallback<void>)
setProperties(string, string, string, DirectorySetPropertiesOptionalParams, ServiceCallback<void>)
setProperties(string, string, string, Models.DirectorySetPropertiesOptionalParams)	Задает свойства в каталоге.
setProperties(string, string, string, ServiceCallback<void>)

Сведения о конструкторе

Directory(StorageClientContext)

Создайте каталог.

new Directory(client: StorageClientContext)

Параметры

client

StorageClientContext

Ссылка на клиент службы.

Сведения о методе

create(string, string, string, DirectoryCreateOptionalParams, ServiceCallback<void>)

function create(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options: DirectoryCreateOptionalParams, callback: ServiceCallback<void>)

Параметры

fileAttributes

string

Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.

fileCreationTime

string

Время создания файла или каталога.

fileLastWriteTime

string

Время последней записи для файла или каталога.

options

DirectoryCreateOptionalParams

Необязательные параметры

callback

ServiceCallback<void>

Обратный вызов

create(string, string, string, Models.DirectoryCreateOptionalParams)

Создает новый каталог под указанным общим ресурсом или родительским каталогом.

function create(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options?: Models.DirectoryCreateOptionalParams)

Параметры

fileAttributes

string

Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.

fileCreationTime

string

Время создания файла или каталога.

fileLastWriteTime

string

Время последней записи для файла или каталога.

options

Models.DirectoryCreateOptionalParams

Возвращаемое значение

Promise<Models.DirectoryCreateResponse>

Обещание<Models.DirectoryCreateResponse>

create(string, string, string, ServiceCallback<void>)

function create(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, callback: ServiceCallback<void>)

Параметры

fileAttributes

string

Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.

fileCreationTime

string

Время создания файла или каталога.

fileLastWriteTime

string

Время последней записи для файла или каталога.

callback

ServiceCallback<void>

Обратный вызов

deleteMethod(DirectoryDeleteMethodOptionalParams, ServiceCallback<void>)

function deleteMethod(options: DirectoryDeleteMethodOptionalParams, callback: ServiceCallback<void>)

Параметры

options

DirectoryDeleteMethodOptionalParams

Необязательные параметры

callback

ServiceCallback<void>

Обратный вызов

deleteMethod(Models.DirectoryDeleteMethodOptionalParams)

Удаляет указанный пустой каталог. Обратите внимание, что каталог должен быть пустым, прежде чем его можно удалить.

function deleteMethod(options?: Models.DirectoryDeleteMethodOptionalParams)

Параметры

options

Models.DirectoryDeleteMethodOptionalParams

Возвращаемое значение

Promise<Models.DirectoryDeleteResponse>

Обещание<Models.DirectoryDeleteResponse>

deleteMethod(ServiceCallback<void>)

function deleteMethod(callback: ServiceCallback<void>)

Параметры

callback

ServiceCallback<void>

Обратный вызов

forceCloseHandles(string, DirectoryForceCloseHandlesOptionalParams, ServiceCallback<void>)

function forceCloseHandles(handleId: string, options: DirectoryForceCloseHandlesOptionalParams, callback: ServiceCallback<void>)

Параметры

handleId

string

Указывает идентификатор дескриптора, открытый в файле или каталоге для закрытия. Asterix ('*) — это подстановочный знак, указывающий все дескрипторы.

options

DirectoryForceCloseHandlesOptionalParams

Необязательные параметры

callback

ServiceCallback<void>

Обратный вызов

forceCloseHandles(string, Models.DirectoryForceCloseHandlesOptionalParams)

Закрывает все дескрипторы, открытые для данного каталога.

function forceCloseHandles(handleId: string, options?: Models.DirectoryForceCloseHandlesOptionalParams)

Параметры

handleId

string

Указывает идентификатор дескриптора, открытый в файле или каталоге для закрытия. Asterix ('*) — это подстановочный знак, указывающий все дескрипторы.

options

Models.DirectoryForceCloseHandlesOptionalParams

Возвращаемое значение

Promise<Models.DirectoryForceCloseHandlesResponse>

Обещание<Models.DirectoryForceCloseHandlesResponse>

forceCloseHandles(string, ServiceCallback<void>)

function forceCloseHandles(handleId: string, callback: ServiceCallback<void>)

Параметры

handleId

string

Указывает идентификатор дескриптора, открытый в файле или каталоге для закрытия. Asterix ('*) — это подстановочный знак, указывающий все дескрипторы.

callback

ServiceCallback<void>

Обратный вызов

getProperties(DirectoryGetPropertiesOptionalParams, ServiceCallback<void>)

function getProperties(options: DirectoryGetPropertiesOptionalParams, callback: ServiceCallback<void>)

Параметры

options

DirectoryGetPropertiesOptionalParams

Необязательные параметры

callback

ServiceCallback<void>

Обратный вызов

getProperties(Models.DirectoryGetPropertiesOptionalParams)

Возвращает все системные свойства для указанного каталога, а также можно использовать для проверки существования каталога. Возвращенные данные не содержат файлы в каталоге или в подкаталогах.

function getProperties(options?: Models.DirectoryGetPropertiesOptionalParams)

Параметры

options

Models.DirectoryGetPropertiesOptionalParams

Возвращаемое значение

Promise<Models.DirectoryGetPropertiesResponse>

Обещание<Models.DirectoryGetPropertiesResponse>

getProperties(ServiceCallback<void>)

function getProperties(callback: ServiceCallback<void>)

Параметры

callback

ServiceCallback<void>

Обратный вызов

listFilesAndDirectoriesSegment(DirectoryListFilesAndDirectoriesSegmentOptionalParams, ServiceCallback<ListFilesAndDirectoriesSegmentResponse>)

function listFilesAndDirectoriesSegment(options: DirectoryListFilesAndDirectoriesSegmentOptionalParams, callback: ServiceCallback<ListFilesAndDirectoriesSegmentResponse>)

Параметры

options

DirectoryListFilesAndDirectoriesSegmentOptionalParams

Необязательные параметры

callback

ServiceCallback<ListFilesAndDirectoriesSegmentResponse>

Обратный вызов

listFilesAndDirectoriesSegment(Models.DirectoryListFilesAndDirectoriesSegmentOptionalParams)

Возвращает список файлов или каталогов в указанной общей папке или каталоге. Он содержит содержимое только для одного уровня иерархии каталогов.

function listFilesAndDirectoriesSegment(options?: Models.DirectoryListFilesAndDirectoriesSegmentOptionalParams)

Параметры

options

Models.DirectoryListFilesAndDirectoriesSegmentOptionalParams

Возвращаемое значение

Promise<Models.DirectoryListFilesAndDirectoriesSegmentResponse>

Обещание<Models.DirectoryListFilesAndDirectorySegmentResponse>

listFilesAndDirectoriesSegment(ServiceCallback<ListFilesAndDirectoriesSegmentResponse>)

function listFilesAndDirectoriesSegment(callback: ServiceCallback<ListFilesAndDirectoriesSegmentResponse>)

Параметры

callback

ServiceCallback<ListFilesAndDirectoriesSegmentResponse>

Обратный вызов

listHandles(DirectoryListHandlesOptionalParams, ServiceCallback<ListHandlesResponse>)

function listHandles(options: DirectoryListHandlesOptionalParams, callback: ServiceCallback<ListHandlesResponse>)

Параметры

options

DirectoryListHandlesOptionalParams

Необязательные параметры

callback

ServiceCallback<ListHandlesResponse>

Обратный вызов

listHandles(Models.DirectoryListHandlesOptionalParams)

Список дескрипторов для каталога.

function listHandles(options?: Models.DirectoryListHandlesOptionalParams)

Параметры

options

Models.DirectoryListHandlesOptionalParams

Возвращаемое значение

Promise<Models.DirectoryListHandlesResponse>

Обещание<Models.DirectoryListHandlesResponse>

listHandles(ServiceCallback<ListHandlesResponse>)

function listHandles(callback: ServiceCallback<ListHandlesResponse>)

Параметры

callback

ServiceCallback<ListHandlesResponse>

Обратный вызов

setMetadata(DirectorySetMetadataOptionalParams, ServiceCallback<void>)

function setMetadata(options: DirectorySetMetadataOptionalParams, callback: ServiceCallback<void>)

Параметры

options

DirectorySetMetadataOptionalParams

Необязательные параметры

callback

ServiceCallback<void>

Обратный вызов

setMetadata(Models.DirectorySetMetadataOptionalParams)

Обновляет пользовательские метаданные для указанного каталога.

function setMetadata(options?: Models.DirectorySetMetadataOptionalParams)

Параметры

options

Models.DirectorySetMetadataOptionalParams

Возвращаемое значение

Promise<Models.DirectorySetMetadataResponse>

Обещание<Models.DirectorySetMetadataResponse>

setMetadata(ServiceCallback<void>)

function setMetadata(callback: ServiceCallback<void>)

Параметры

callback

ServiceCallback<void>

Обратный вызов

setProperties(string, string, string, DirectorySetPropertiesOptionalParams, ServiceCallback<void>)

function setProperties(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options: DirectorySetPropertiesOptionalParams, callback: ServiceCallback<void>)

Параметры

fileAttributes

string

Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.

fileCreationTime

string

Время создания файла или каталога.

fileLastWriteTime

string

Время последней записи для файла или каталога.

options

DirectorySetPropertiesOptionalParams

Необязательные параметры

callback

ServiceCallback<void>

Обратный вызов

setProperties(string, string, string, Models.DirectorySetPropertiesOptionalParams)

Задает свойства в каталоге.

function setProperties(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options?: Models.DirectorySetPropertiesOptionalParams)

Параметры

fileAttributes

string

Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.

fileCreationTime

string

Время создания файла или каталога.

fileLastWriteTime

string

Время последней записи для файла или каталога.

options

Models.DirectorySetPropertiesOptionalParams

Возвращаемое значение

Promise<Models.DirectorySetPropertiesResponse>

Обещание<Models.DirectorySetPropertiesResponse>

setProperties(string, string, string, ServiceCallback<void>)

function setProperties(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, callback: ServiceCallback<void>)

Параметры

fileAttributes

string

Если задано, указанные атрибуты файла должны быть заданы. Значение по умолчанию: "Архив" для файла и каталога. Значение "Нет" также можно указать как значение по умолчанию.

fileCreationTime

string

Время создания файла или каталога.

fileLastWriteTime

string

Время последней записи для файла или каталога.

callback

ServiceCallback<void>

Обратный вызов