FileShares interface
Интерфейс, представляющий fileShares.
Методы
| create(string, string, string, File |
Создает новую общую папку в указанной учетной записи, как описано в тексте запроса. Ресурс общей папки содержит метаданные и свойства для данной общей папки. Ресурс не включает список файлов, которые содержит общая папка. |
| delete(string, string, string, File |
Удаляет указанную общую папку в своей учетной записи. |
| get(string, string, string, File |
Возвращает свойства указанной общей папки. |
| lease(string, string, string, File |
Операция Аренды общей папки устанавливает блокировку общего ресурса для операций удаления и управляет ею. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной. |
| list(string, string, File |
Выводит список всех общих папок. |
| restore(string, string, string, Deleted |
Восстановление общей папки в течение допустимых дней хранения, если включено обратимое удаление общей папки |
| update(string, string, string, File |
Обновления свойства общего доступа, как указано в тексте запроса. Свойства, не упомянутые в запросе, не будут изменены. Обновление завершается ошибкой, если указанная общая папка еще не существует. |
Сведения о методе
create(string, string, string, FileShare, FileSharesCreateOptionalParams)
Создает новую общую папку в указанной учетной записи, как описано в тексте запроса. Ресурс общей папки содержит метаданные и свойства для данной общей папки. Ресурс не включает список файлов, которые содержит общая папка.
function create(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesCreateOptionalParams): Promise<FileShare>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- shareName
-
string
Имя общей папки в указанной учетной записи хранения. Имена общих папок должны быть длиной от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- fileShare
- FileShare
Свойства создаваемой общей папки.
- options
- FileSharesCreateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<FileShare>
delete(string, string, string, FileSharesDeleteOptionalParams)
Удаляет указанную общую папку в своей учетной записи.
function delete(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- shareName
-
string
Имя общей папки в указанной учетной записи хранения. Имена общих папок должны быть длиной от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- options
- FileSharesDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, FileSharesGetOptionalParams)
Возвращает свойства указанной общей папки.
function get(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams): Promise<FileShare>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- shareName
-
string
Имя общей папки в указанной учетной записи хранения. Имена общих папок должны быть длиной от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- options
- FileSharesGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<FileShare>
lease(string, string, string, FileSharesLeaseOptionalParams)
Операция Аренды общей папки устанавливает блокировку общего ресурса для операций удаления и управляет ею. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной.
function lease(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesLeaseOptionalParams): Promise<FileSharesLeaseResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- shareName
-
string
Имя общей папки в указанной учетной записи хранения. Имена общих папок должны быть длиной от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- options
- FileSharesLeaseOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<FileSharesLeaseResponse>
list(string, string, FileSharesListOptionalParams)
Выводит список всех общих папок.
function list(resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams): PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- options
- FileSharesListOptionalParams
Параметры параметров.
Возвращаемое значение
restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)
Восстановление общей папки в течение допустимых дней хранения, если включено обратимое удаление общей папки
function restore(resourceGroupName: string, accountName: string, shareName: string, deletedShare: DeletedShare, options?: FileSharesRestoreOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- shareName
-
string
Имя общей папки в указанной учетной записи хранения. Имена общих папок должны быть длиной от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- deletedShare
- DeletedShare
Удаленный общий ресурс, который требуется восстановить.
- options
- FileSharesRestoreOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
update(string, string, string, FileShare, FileSharesUpdateOptionalParams)
Обновления свойства общего доступа, как указано в тексте запроса. Свойства, не упомянутые в запросе, не будут изменены. Обновление завершается ошибкой, если указанная общая папка еще не существует.
function update(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesUpdateOptionalParams): Promise<FileShare>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- shareName
-
string
Имя общей папки в указанной учетной записи хранения. Имена общих папок должны быть длиной от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- fileShare
- FileShare
Свойства, обновляемые для общей папки.
- options
- FileSharesUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<FileShare>