Share class

Package:

@azure/storage-file

Class representing a Share.

Constructors

Share(StorageClientContext)

Create a Share.

Methods

create(Models.ShareCreateOptionalParams)	Creates a new share under the specified account. If the share with the same name already exists, the operation fails.
create(ServiceCallback<void>)
create(ShareCreateOptionalParams, ServiceCallback<void>)
createPermission(Permission, Models.ShareCreatePermissionOptionalParams)	Create a permission (a security descriptor).
createPermission(Permission, ServiceCallback<void>)
createPermission(Permission, ShareCreatePermissionOptionalParams, ServiceCallback<void>)
createSnapshot(Models.ShareCreateSnapshotOptionalParams)	Creates a read-only snapshot of a share.
createSnapshot(ServiceCallback<void>)
createSnapshot(ShareCreateSnapshotOptionalParams, ServiceCallback<void>)
deleteMethod(Models.ShareDeleteMethodOptionalParams)	Operation marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection.
deleteMethod(ServiceCallback<void>)
deleteMethod(ShareDeleteMethodOptionalParams, ServiceCallback<void>)
getAccessPolicy(Models.ShareGetAccessPolicyOptionalParams)	Returns information about stored access policies specified on the share.
getAccessPolicy(ServiceCallback<SignedIdentifier[]>)
getAccessPolicy(ShareGetAccessPolicyOptionalParams, ServiceCallback<SignedIdentifier[]>)
getPermission(string, Models.ShareGetPermissionOptionalParams)	Returns the permission (security descriptor) for a given key
getPermission(string, ServiceCallback<Permission>)
getPermission(string, ShareGetPermissionOptionalParams, ServiceCallback<Permission>)
getProperties(Models.ShareGetPropertiesOptionalParams)	Returns all user-defined metadata and system properties for the specified share or share snapshot. The data returned does not include the share's list of files.
getProperties(ServiceCallback<void>)
getProperties(ShareGetPropertiesOptionalParams, ServiceCallback<void>)
getStatistics(Models.ShareGetStatisticsOptionalParams)	Retrieves statistics related to the share.
getStatistics(ServiceCallback<ShareStats>)
getStatistics(ShareGetStatisticsOptionalParams, ServiceCallback<ShareStats>)
setAccessPolicy(Models.ShareSetAccessPolicyOptionalParams)	Sets a stored access policy for use with shared access signatures.
setAccessPolicy(ServiceCallback<void>)
setAccessPolicy(ShareSetAccessPolicyOptionalParams, ServiceCallback<void>)
setMetadata(Models.ShareSetMetadataOptionalParams)	Sets one or more user-defined name-value pairs for the specified share.
setMetadata(ServiceCallback<void>)
setMetadata(ShareSetMetadataOptionalParams, ServiceCallback<void>)
setQuota(Models.ShareSetQuotaOptionalParams)	Sets quota for the specified share.
setQuota(ServiceCallback<void>)
setQuota(ShareSetQuotaOptionalParams, ServiceCallback<void>)

Constructor Details

Share(StorageClientContext)

Create a Share.

new Share(client: StorageClientContext)

Parameters

client

StorageClientContext

Reference to the service client.

Method Details

create(Models.ShareCreateOptionalParams)

Creates a new share under the specified account. If the share with the same name already exists, the operation fails.

function create(options?: Models.ShareCreateOptionalParams)

Parameters

options

Models.ShareCreateOptionalParams

Returns

Promise<Models.ShareCreateResponse>

Promise<Models.ShareCreateResponse>

create(ServiceCallback<void>)

function create(callback: ServiceCallback<void>)

Parameters

callback

ServiceCallback<void>

The callback

create(ShareCreateOptionalParams, ServiceCallback<void>)

function create(options: ShareCreateOptionalParams, callback: ServiceCallback<void>)

Parameters

options

ShareCreateOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

createPermission(Permission, Models.ShareCreatePermissionOptionalParams)

Create a permission (a security descriptor).

function createPermission(permission: Permission, options?: Models.ShareCreatePermissionOptionalParams)

Parameters

permission

Permission

Permission(a security descriptor) described in the SDDL.

options

Models.ShareCreatePermissionOptionalParams

Returns

Promise<Models.ShareCreatePermissionResponse>

Promise<Models.ShareCreatePermissionResponse>

createPermission(Permission, ServiceCallback<void>)

function createPermission(permission: Permission, callback: ServiceCallback<void>)

Parameters

permission

Permission

Permission(a security descriptor) described in the SDDL.

callback

ServiceCallback<void>

The callback

createPermission(Permission, ShareCreatePermissionOptionalParams, ServiceCallback<void>)

function createPermission(permission: Permission, options: ShareCreatePermissionOptionalParams, callback: ServiceCallback<void>)

Parameters

permission

Permission

Permission(a security descriptor) described in the SDDL.

options

ShareCreatePermissionOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

createSnapshot(Models.ShareCreateSnapshotOptionalParams)

Creates a read-only snapshot of a share.

function createSnapshot(options?: Models.ShareCreateSnapshotOptionalParams)

Parameters

options

Models.ShareCreateSnapshotOptionalParams

Returns

Promise<Models.ShareCreateSnapshotResponse>

Promise<Models.ShareCreateSnapshotResponse>

createSnapshot(ServiceCallback<void>)

function createSnapshot(callback: ServiceCallback<void>)

Parameters

callback

ServiceCallback<void>

The callback

createSnapshot(ShareCreateSnapshotOptionalParams, ServiceCallback<void>)

function createSnapshot(options: ShareCreateSnapshotOptionalParams, callback: ServiceCallback<void>)

Parameters

options

ShareCreateSnapshotOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

deleteMethod(Models.ShareDeleteMethodOptionalParams)

Operation marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection.

function deleteMethod(options?: Models.ShareDeleteMethodOptionalParams)

Parameters

options

Models.ShareDeleteMethodOptionalParams

Returns

Promise<Models.ShareDeleteResponse>

Promise<Models.ShareDeleteResponse>

deleteMethod(ServiceCallback<void>)

function deleteMethod(callback: ServiceCallback<void>)

Parameters

callback

ServiceCallback<void>

The callback

deleteMethod(ShareDeleteMethodOptionalParams, ServiceCallback<void>)

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

Parameters

options

ShareDeleteMethodOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

getAccessPolicy(Models.ShareGetAccessPolicyOptionalParams)

Returns information about stored access policies specified on the share.

function getAccessPolicy(options?: Models.ShareGetAccessPolicyOptionalParams)

Parameters

options

Models.ShareGetAccessPolicyOptionalParams

Returns

Promise<Models.ShareGetAccessPolicyResponse>

Promise<Models.ShareGetAccessPolicyResponse>

getAccessPolicy(ServiceCallback<SignedIdentifier[]>)

function getAccessPolicy(callback: ServiceCallback<SignedIdentifier[]>)

Parameters

callback

ServiceCallback<SignedIdentifier[]>

The callback

getAccessPolicy(ShareGetAccessPolicyOptionalParams, ServiceCallback<SignedIdentifier[]>)

function getAccessPolicy(options: ShareGetAccessPolicyOptionalParams, callback: ServiceCallback<SignedIdentifier[]>)

Parameters

options

ShareGetAccessPolicyOptionalParams

The optional parameters

callback

ServiceCallback<SignedIdentifier[]>

The callback

getPermission(string, Models.ShareGetPermissionOptionalParams)

Returns the permission (security descriptor) for a given key

function getPermission(filePermissionKey: string, options?: Models.ShareGetPermissionOptionalParams)

Parameters

filePermissionKey

string

Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.

options

Models.ShareGetPermissionOptionalParams

Returns

Promise<Models.ShareGetPermissionResponse>

Promise<Models.ShareGetPermissionResponse>

getPermission(string, ServiceCallback<Permission>)

function getPermission(filePermissionKey: string, callback: ServiceCallback<Permission>)

Parameters

filePermissionKey

string

Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.

callback

ServiceCallback<Permission>

The callback

getPermission(string, ShareGetPermissionOptionalParams, ServiceCallback<Permission>)

function getPermission(filePermissionKey: string, options: ShareGetPermissionOptionalParams, callback: ServiceCallback<Permission>)

Parameters

filePermissionKey

string

Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.

options

ShareGetPermissionOptionalParams

The optional parameters

callback

ServiceCallback<Permission>

The callback

getProperties(Models.ShareGetPropertiesOptionalParams)

Returns all user-defined metadata and system properties for the specified share or share snapshot. The data returned does not include the share's list of files.

function getProperties(options?: Models.ShareGetPropertiesOptionalParams)

Parameters

options

Models.ShareGetPropertiesOptionalParams

Returns

Promise<Models.ShareGetPropertiesResponse>

Promise<Models.ShareGetPropertiesResponse>

getProperties(ServiceCallback<void>)

function getProperties(callback: ServiceCallback<void>)

Parameters

callback

ServiceCallback<void>

The callback

getProperties(ShareGetPropertiesOptionalParams, ServiceCallback<void>)

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

Parameters

options

ShareGetPropertiesOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

getStatistics(Models.ShareGetStatisticsOptionalParams)

Retrieves statistics related to the share.

function getStatistics(options?: Models.ShareGetStatisticsOptionalParams)

Parameters

options

Models.ShareGetStatisticsOptionalParams

Returns

Promise<Models.ShareGetStatisticsResponse>

Promise<Models.ShareGetStatisticsResponse>

getStatistics(ServiceCallback<ShareStats>)

function getStatistics(callback: ServiceCallback<ShareStats>)

Parameters

callback

ServiceCallback<ShareStats>

The callback

getStatistics(ShareGetStatisticsOptionalParams, ServiceCallback<ShareStats>)

function getStatistics(options: ShareGetStatisticsOptionalParams, callback: ServiceCallback<ShareStats>)

Parameters

options

ShareGetStatisticsOptionalParams

The optional parameters

callback

ServiceCallback<ShareStats>

The callback

setAccessPolicy(Models.ShareSetAccessPolicyOptionalParams)

Sets a stored access policy for use with shared access signatures.

function setAccessPolicy(options?: Models.ShareSetAccessPolicyOptionalParams)

Parameters

options

Models.ShareSetAccessPolicyOptionalParams

Returns

Promise<Models.ShareSetAccessPolicyResponse>

Promise<Models.ShareSetAccessPolicyResponse>

setAccessPolicy(ServiceCallback<void>)

function setAccessPolicy(callback: ServiceCallback<void>)

Parameters

callback

ServiceCallback<void>

The callback

setAccessPolicy(ShareSetAccessPolicyOptionalParams, ServiceCallback<void>)

function setAccessPolicy(options: ShareSetAccessPolicyOptionalParams, callback: ServiceCallback<void>)

Parameters

options

ShareSetAccessPolicyOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

setMetadata(Models.ShareSetMetadataOptionalParams)

Sets one or more user-defined name-value pairs for the specified share.

function setMetadata(options?: Models.ShareSetMetadataOptionalParams)

Parameters

options

Models.ShareSetMetadataOptionalParams

Returns

Promise<Models.ShareSetMetadataResponse>

Promise<Models.ShareSetMetadataResponse>

setMetadata(ServiceCallback<void>)

function setMetadata(callback: ServiceCallback<void>)

Parameters

callback

ServiceCallback<void>

The callback

setMetadata(ShareSetMetadataOptionalParams, ServiceCallback<void>)

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

Parameters

options

ShareSetMetadataOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

setQuota(Models.ShareSetQuotaOptionalParams)

Sets quota for the specified share.

function setQuota(options?: Models.ShareSetQuotaOptionalParams)

Parameters

options

Models.ShareSetQuotaOptionalParams

Returns

Promise<Models.ShareSetQuotaResponse>

Promise<Models.ShareSetQuotaResponse>

setQuota(ServiceCallback<void>)

function setQuota(callback: ServiceCallback<void>)

Parameters

callback

ServiceCallback<void>

The callback

setQuota(ShareSetQuotaOptionalParams, ServiceCallback<void>)

function setQuota(options: ShareSetQuotaOptionalParams, callback: ServiceCallback<void>)

Parameters

options

ShareSetQuotaOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback