FileSharesOperations interface
Interface representing a FileShares operations.
Properties
| create | Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share. |
| delete | Deletes specified share under its account. |
| get | Gets properties of a specified share. |
| lease | The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite. |
| list | Lists all shares. |
| restore | Restore a file share within a valid retention days if share soft delete is enabled |
| update | Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist. |
Property Details
create
Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share.
create: (resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesCreateOptionalParams) => Promise<FileShare>Property Value
(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesCreateOptionalParams) => Promise<FileShare>
delete
Deletes specified share under its account.
delete: (resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams) => Promise<void>
get
Gets properties of a specified share.
get: (resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams) => Promise<FileShare>Property Value
(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams) => Promise<FileShare>
lease
The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
lease: (resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesLeaseOptionalParams) => Promise<LeaseShareResponse>Property Value
(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesLeaseOptionalParams) => Promise<LeaseShareResponse>
list
Lists all shares.
list: (resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams) => PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>Property Value
(resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams) => PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>
restore
Restore a file share within a valid retention days if share soft delete is enabled
restore: (resourceGroupName: string, accountName: string, shareName: string, deletedShare: DeletedShare, options?: FileSharesRestoreOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, accountName: string, shareName: string, deletedShare: DeletedShare, options?: FileSharesRestoreOptionalParams) => Promise<void>
update
Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
update: (resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesUpdateOptionalParams) => Promise<FileShare>Property Value
(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesUpdateOptionalParams) => Promise<FileShare>