FileShares interface
Интерфейс, представляющий файловый ресурс.
Методы
| 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>