Package version:

Class ShareClient

A ShareClient represents a URL to the Azure Storage share allowing you to manipulate its directories and files.

Hierarchy

StorageClient
- ShareClient

Constructors

constructor

new ShareClient(connectionString, name, options?): ShareClient
Parameters
- connectionString: string
  Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
- name: string
  Share name.
- Optionaloptions: ShareClientOptions
  Optional. Options to configure the HTTP pipeline.
Returns ShareClient
Overrides StorageClient.constructor
- Defined in storage-file-share/src/Clients.ts:669
new ShareClient(url, credential?, options?): ShareClient
Creates an instance of ShareClient.
Parameters
- url: string
  A URL string pointing to Azure Storage file share, such as "https://myaccount.file.core.windows.net/share". You can append a SAS if using AnonymousCredential, such as "https://myaccount.file.core.windows.net/share?sasString".
- Optionalcredential: any
  Such as AnonymousCredential or StorageSharedKeyCredential. If not specified, AnonymousCredential is used.
- Optionaloptions: ShareClientOptions
  Optional. Options to configure the HTTP pipeline.
Returns ShareClient
Overrides StorageClient.constructor
- Defined in storage-file-share/src/Clients.ts:681
new ShareClient(url, pipeline, options?): ShareClient
Creates an instance of ShareClient.
Parameters
- url: string
  A URL string pointing to Azure Storage file share, such as "https://myaccount.file.core.windows.net/share". You can append a SAS if using AnonymousCredential, such as "https://myaccount.file.core.windows.net/share?sasString".
- pipeline: Pipeline
  Call newPipeline() to create a default pipeline, or provide a customized pipeline.
- Optionaloptions: ShareClientConfig
Returns ShareClient
Overrides StorageClient.constructor
- Defined in storage-file-share/src/Clients.ts:698

Properties

`Readonly`accountName

accountName: string

`Protected` `Readonly`storageClientContext

storageClientContext: StorageClient

StorageClient is a reference to protocol layer operations entry, which is generated by AutoRest generator.

`Readonly`url

url: string

URL string value.

Accessors

name

get name(): string
The name of the share

Returns string
- Defined in storage-file-share/src/Clients.ts:653

rootDirectoryClient

get rootDirectoryClient(): ShareDirectoryClient
Gets the directory client for the root directory of this share. Note that the root directory always exists and cannot be deleted.

A new ShareDirectoryClient object for the root directory.

Returns ShareDirectoryClient
- Defined in storage-file-share/src/Clients.ts:860

Methods

create

create(options?): Promise<ShareCreateResponse>
Creates a new share under the specified account. If the share with the same name already exists, the operation fails.
Parameters
- options: ShareCreateOptions = {}
  Options to Share Create operation.
Returns Promise<ShareCreateResponse>
Response data for the Share Create operation.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/create-share
- Defined in storage-file-share/src/Clients.ts:789

createDirectory

createDirectory(directoryName, options?): Promise<{
directoryClient: ShareDirectoryClient;
directoryCreateResponse: DirectoryCreateResponse;
}>
Creates a new subdirectory under this share.
Parameters
- directoryName: string
- options: DirectoryCreateOptions = {}
  Options to Directory Create operation.
Returns Promise<{
directoryClient: ShareDirectoryClient;
directoryCreateResponse: DirectoryCreateResponse;
}>
Directory creation response data and the corresponding directory client.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
- Defined in storage-file-share/src/Clients.ts:872

createFile

createFile(fileName, size, options?): Promise<{
fileClient: ShareFileClient;
fileCreateResponse: FileCreateResponse;
}>
Creates a new file or replaces a file under the root directory of this share. Note it only initializes the file with no content.
Parameters
- fileName: string
- size: number
  Specifies the maximum size in bytes for the file, up to 4 TB.
- options: FileCreateOptions = {}
  Options to File Create operation.
Returns Promise<{
fileClient: ShareFileClient;
fileCreateResponse: FileCreateResponse;
}>
File creation response data and the corresponding file client.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
- Defined in storage-file-share/src/Clients.ts:926

createIfNotExists

createIfNotExists(options?): Promise<ShareCreateIfNotExistsResponse>
Creates a new share under the specified account. If the share with the same name already exists, it is not changed.
Parameters
- options: ShareCreateOptions = {}
Returns Promise<ShareCreateIfNotExistsResponse>
See
https://learn.microsoft.com/en-us/rest/api/storageservices/create-share
- Defined in storage-file-share/src/Clients.ts:808

createPermission

createPermission(filePermission, options?): Promise<ShareCreatePermissionResponse>
Creates a file permission (a security descriptor) at the share level. The created security descriptor can be used for the files/directories in the share.
Parameters
- filePermission: string | SharePermission
  File permission described in the SDDL
- options: ShareCreatePermissionOptions = {}
  Options to Share Create Permission operation.
Returns Promise<ShareCreatePermissionResponse>
See
https://learn.microsoft.com/en-us/rest/api/storageservices/create-permission
- Defined in storage-file-share/src/Clients.ts:1315

createSnapshot

createSnapshot(options?): Promise<ShareCreateSnapshotResponse>
Creates a read-only snapshot of a share.
Parameters
- options: ShareCreateSnapshotOptions = {}
  Options to Share Create Snapshot operation.
Returns Promise<ShareCreateSnapshotResponse>
Response data for the Share Create Snapshot operation.
- Defined in storage-file-share/src/Clients.ts:1223

delete

delete(options?): Promise<ShareDeleteResponse>
Marks the specified share for deletion. The share and any directories or files contained within it are later deleted during garbage collection.
Parameters
- options: ShareDeleteMethodOptions = {}
  Options to Share Delete operation.
Returns Promise<ShareDeleteResponse>
Response data for the Share Delete operation.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share
- Defined in storage-file-share/src/Clients.ts:1031

deleteDirectory

deleteDirectory(directoryName, options?): Promise<DirectoryDeleteResponse>
Removes the specified empty sub directory under this share. Note that the directory must be empty before it can be deleted.
Parameters
- directoryName: string
- options: DirectoryDeleteOptions = {}
  Options to Directory Delete operation.
Returns Promise<DirectoryDeleteResponse>
Directory deletion response data.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
- Defined in storage-file-share/src/Clients.ts:902

deleteFile

deleteFile(fileName, options?): Promise<FileDeleteResponse>
Removes a file under the root directory of this share from the storage account. When a file is successfully deleted, it is immediately removed from the storage account's index and is no longer accessible to clients. The file's data is later removed from the service during garbage collection.

Delete File will fail with status code 409 (Conflict) and error code SharingViolation if the file is open on an SMB client.

Delete File is not supported on a share snapshot, which is a read-only copy of a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)
Parameters
- fileName: string
- options: FileDeleteOptions = {}
  Options to File Delete operation.
Returns Promise<FileDeleteResponse>
Promise File Delete response data.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
- Defined in storage-file-share/src/Clients.ts:962

deleteIfExists

deleteIfExists(options?): Promise<ShareDeleteIfExistsResponse>
Marks the specified share for deletion if it exists. The share and any directories or files contained within it are later deleted during garbage collection.
Parameters
- options: ShareDeleteMethodOptions = {}
Returns Promise<ShareDeleteIfExistsResponse>
See
https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share
- Defined in storage-file-share/src/Clients.ts:1049

exists

exists(options?): Promise<boolean>
Returns true if the Azrue share resource represented by this client exists; false otherwise.

NOTE: use this function with care since an existing share might be deleted by other clients or applications. Vice versa new shares might be added by other clients or applications after this function completes.
Parameters
- options: ShareExistsOptions = {}
  options to Exists operation.
Returns Promise<boolean>
- Defined in storage-file-share/src/Clients.ts:982

generateSasStringToSign

generateSasStringToSign(options): string
Only available for ShareClient constructed with a shared key credential.

Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
Parameters
- options: ShareGenerateSasUrlOptions
  Optional parameters.
Returns string
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
- Defined in storage-file-share/src/Clients.ts:1410

generateSasUrl

generateSasUrl(options): string
Only available for ShareClient constructed with a shared key credential.

Generates a Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
Parameters
- options: ShareGenerateSasUrlOptions
  Optional parameters.
Returns string
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
- Defined in storage-file-share/src/Clients.ts:1380

getAccessPolicy

getAccessPolicy(options?): Promise<ShareGetAccessPolicyResponse>
Gets the permissions for the specified share. The permissions indicate whether share data may be accessed publicly.

WARNING: JavaScript Date will potential lost precision when parsing start and expiry string. For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
Parameters
- options: ShareGetAccessPolicyOptions = {}
Returns Promise<ShareGetAccessPolicyResponse>
Response data for the Share Get Access Policy operation.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-acl
- Defined in storage-file-share/src/Clients.ts:1110

getDirectoryClient

getDirectoryClient(directoryName): ShareDirectoryClient
Creates a ShareDirectoryClient object.
Parameters
- directoryName: string
  A directory name
Returns ShareDirectoryClient
The ShareDirectoryClient object for the given directory name.
- Defined in storage-file-share/src/Clients.ts:844

getPermission

getPermission(filePermissionKey, options?): Promise<ShareGetPermissionResponse>
Gets the Security Descriptor Definition Language (SDDL) for a given file permission key which indicates a security descriptor.
Parameters
- filePermissionKey: string
  File permission key which indicates the security descriptor of the permission.
- options: ShareGetPermissionOptions = {}
  Options to Share Create Permission operation.
Returns Promise<ShareGetPermissionResponse>
See
https://learn.microsoft.com/en-us/rest/api/storageservices/get-permission
- Defined in storage-file-share/src/Clients.ts:1341

getProperties

getProperties(options?): Promise<ShareGetPropertiesResponse>
Returns all user-defined metadata and system properties for the specified share.
Parameters
- options: ShareGetPropertiesOptions = {}
Returns Promise<ShareGetPropertiesResponse>
Response data for the Share Get Properties operation.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-properties

WARNING: The metadata object returned in the response will have its keys in lowercase, even if they originally contained uppercase characters. This differs from the metadata keys returned by the listShares method of ShareServiceClient using the includeMetadata option, which will retain their original casing.
- Defined in storage-file-share/src/Clients.ts:1008

getShareLeaseClient

getShareLeaseClient(proposeLeaseId?): ShareLeaseClient
Get a ShareLeaseClient that manages leases on the file.
Parameters
- OptionalproposeLeaseId: string
  Initial proposed lease Id.
Returns ShareLeaseClient
A new ShareLeaseClient object for managing leases on the file.
- Defined in storage-file-share/src/Clients.ts:1365

getStatistics

getStatistics(options?): Promise<ShareGetStatisticsResponse>
Retrieves statistics related to the share.
Parameters
- options: ShareGetStatisticsOptions = {}
Returns Promise<ShareGetStatisticsResponse>
Response data for the Share Get Statistics operation.
- Defined in storage-file-share/src/Clients.ts:1287

setAccessPolicy

setAccessPolicy(shareAcl?, options?): Promise<ShareSetAccessPolicyResponse>
Sets the permissions for the specified share. The permissions indicate whether directories or files in a share may be accessed publicly.

When you set permissions for a share, the existing permissions are replaced. If no shareAcl provided, the existing share ACL will be removed.

When you establish a stored access policy on a share, it may take up to 30 seconds to take effect. During this interval, a shared access signature that is associated with the stored access policy will fail with status code 403 (Forbidden), until the access policy becomes active.
Parameters
- OptionalshareAcl: SignedIdentifier[]
  Array of signed identifiers, each having a unique Id and details of access policy.
- options: ShareSetAccessPolicyOptions = {}
Returns Promise<ShareSetAccessPolicyResponse>
Response data for the Share Set Access Policy operation.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-acl
- Defined in storage-file-share/src/Clients.ts:1182

setMetadata

setMetadata(metadata?, options?): Promise<ShareSetMetadataResponse>
Sets one or more user-defined name-value pairs for the specified share.

If no option provided, or no metadata defined in the option parameter, the share metadata will be removed.
Parameters
- Optionalmetadata: Metadata
  If no metadata provided, all existing directory metadata will be removed.
- options: ShareSetMetadataOptions = {}
Returns Promise<ShareSetMetadataResponse>
Response data for the Share Set Metadata operation.

See
https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-metadata
- Defined in storage-file-share/src/Clients.ts:1083

setProperties

setProperties(options?): Promise<ShareSetPropertiesResponse>
Sets properties of the share.
Parameters
- options: ShareSetPropertiesOptions = {}
Returns Promise<ShareSetPropertiesResponse>
Response data for the Share Set Properties operation.
- Defined in storage-file-share/src/Clients.ts:1266

setQuota

setQuota(quotaInGB, options?): Promise<ShareSetQuotaResponse>
Sets quota for the specified share.
Parameters
- quotaInGB: number
  Specifies the maximum size of the share in gigabytes
- options: ShareSetQuotaOptions = {}
Returns Promise<ShareSetQuotaResponse>
Response data for the Share Get Quota operation.

Deprecated
Use ShareClient.setProperties instead.
- Defined in storage-file-share/src/Clients.ts:1245

withSnapshot

withSnapshot(snapshot): ShareClient
Creates a new ShareClient object identical to the source but with the specified snapshot timestamp. Provide "" will remove the snapshot and return a URL to the base share.
Parameters
- snapshot: string
  The snapshot timestamp.
Returns ShareClient
A new ShareClient object identical to the source but with the specified snapshot timestamp
- Defined in storage-file-share/src/Clients.ts:769

Class ShareClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ShareClient

Parameters

Returns ShareClient

Parameters

Returns ShareClient

Properties

ReadonlyaccountName

Protected ReadonlystorageClientContext

Readonlyurl

Accessors

name

Returns string

rootDirectoryClient

Returns ShareDirectoryClient

Methods

create

Parameters

Returns Promise<ShareCreateResponse>

See

createDirectory

Parameters

Returns Promise<{ directoryClient: ShareDirectoryClient; directoryCreateResponse: DirectoryCreateResponse; }>

See

createFile

Parameters

Returns Promise<{ fileClient: ShareFileClient; fileCreateResponse: FileCreateResponse; }>

See

createIfNotExists

Parameters

Returns Promise<ShareCreateIfNotExistsResponse>

See

createPermission

Parameters

Returns Promise<ShareCreatePermissionResponse>

See

createSnapshot

Parameters

Returns Promise<ShareCreateSnapshotResponse>

delete

Parameters

Returns Promise<ShareDeleteResponse>

See

deleteDirectory

Parameters

Returns Promise<DirectoryDeleteResponse>

See

deleteFile

Parameters

Returns Promise<FileDeleteResponse>

See

deleteIfExists

Parameters

Returns Promise<ShareDeleteIfExistsResponse>

See

exists

Parameters

Returns Promise<boolean>

generateSasStringToSign

Parameters

Returns string

See

generateSasUrl

Parameters

Returns string

See

getAccessPolicy

Parameters

Returns Promise<ShareGetAccessPolicyResponse>

See

getDirectoryClient

`Readonly`accountName

`Protected` `Readonly`storageClientContext

`Readonly`url

Returns Promise<{
directoryClient: ShareDirectoryClient;
directoryCreateResponse: DirectoryCreateResponse;
}>

Returns Promise<{
fileClient: ShareFileClient;
fileCreateResponse: FileCreateResponse;
}>