Class ShareClient

Package version

Hierarchy

StorageClient
- ShareClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ShareClient(connectionString: string, name: string, options: StoragePipelineOptions): ShareClient
new ShareClient(url: string, credential: Credential, options: StoragePipelineOptions): ShareClient
new ShareClient(url: string, pipeline: Pipeline): ShareClient

Overrides StorageClient.constructor
- Defined in ShareClient.ts:366
Parameters
- connectionString: string
- name: string
- Optional options: StoragePipelineOptions
Returns ShareClient
Overrides StorageClient.constructor
- Defined in ShareClient.ts:379
Parameters
- url: string
- Optional credential: Credential
- Optional options: StoragePipelineOptions
Returns ShareClient
Overrides StorageClient.constructor
- Defined in ShareClient.ts:392
Parameters
- url: string
- pipeline: Pipeline
Returns ShareClient

Properties

accountName

accountName: string

Protected storageClientContext

storageClientContext: StorageClientContext

url

url: string

Accessors

name

name:

rootDirectoryClient

rootDirectoryClient:

Methods

create

create(options?: ShareCreateOptions): Promise<ShareCreateResponse>

- Defined in ShareClient.ts:496
Parameters
- Default value options: ShareCreateOptions = {}
Returns Promise<ShareCreateResponse>

Response data for the Share Create operation.

createDirectory

createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<object>

- Defined in ShareClient.ts:549
Parameters
- directoryName: string
- Default value options: DirectoryCreateOptions = {}
Returns Promise<object>

} Directory creation response data and the corresponding directory client.

createFile

createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<object>

- Defined in ShareClient.ts:621
Parameters
- fileName: string
- size: number
- Default value options: FileCreateOptions = {}
Returns Promise<object>

} File creation response data and the corresponding file client.

createPermission

createPermission(filePermission: string, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>

- Defined in ShareClient.ts:992
Parameters
- filePermission: string
- Default value options: ShareCreatePermissionOptions = {}
Returns Promise<ShareCreatePermissionResponse>

createSnapshot

createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>

- Defined in ShareClient.ts:898
Parameters
- Default value options: ShareCreateSnapshotOptions = {}
Returns Promise<ShareCreateSnapshotResponse>

Response data for the Share Create Snapshot operation.

delete

delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

- Defined in ShareClient.ts:735
Parameters
- Default value options: ShareDeleteMethodOptions = {}
Returns Promise<ShareDeleteResponse>

Response data for the Share Delete operation.

deleteDirectory

deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

- Defined in ShareClient.ts:588
Parameters
- directoryName: string
- Default value options: DirectoryDeleteOptions = {}
Returns Promise<DirectoryDeleteResponse>

Directory deletion response data.

deleteFile

deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

- Defined in ShareClient.ts:670
Parameters
- fileName: string
- Default value options: FileDeleteOptions = {}
Returns Promise<FileDeleteResponse>

Promise File Delete response data.

getAccessPolicy

getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>

- Defined in ShareClient.ts:800
Parameters
- Default value options: ShareGetAccessPolicyOptions = {}
Returns Promise<ShareGetAccessPolicyResponse>

Response data for the Share Get Access Policy operation.

getDirectoryClient

getDirectoryClient(directoryName: string): ShareDirectoryClient

- Defined in ShareClient.ts:521
Parameters
- directoryName: string
Returns ShareDirectoryClient

The ShareDirectoryClient object for the given directory name.

getPermission

getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>

- Defined in ShareClient.ts:1029
Parameters
- filePermissionKey: string
- Default value options: ShareGetPermissionOptions = {}
Returns Promise<ShareGetPermissionResponse>

getProperties

getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>

- Defined in ShareClient.ts:706
Parameters
- Default value options: ShareGetPropertiesOptions = {}
Returns Promise<ShareGetPropertiesResponse>

Response data for the Share Get Properties operation.

getStatistics

getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>

- Defined in ShareClient.ts:961
Parameters
- Default value options: ShareGetStatisticsOptions = {}
Returns Promise<ShareGetStatisticsResponse>

Response data for the Share Get Statistics operation.

setAccessPolicy

setAccessPolicy(shareAcl: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>

- Defined in ShareClient.ts:857
Parameters
- Optional shareAcl: SignedIdentifier[]
- Default value options: ShareSetAccessPolicyOptions = {}
Returns Promise<ShareSetAccessPolicyResponse>

Response data for the Share Set Access Policy operation.

setMetadata

setMetadata(metadata: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>

- Defined in ShareClient.ts:765
Parameters
- Optional metadata: Metadata
- Default value options: ShareSetMetadataOptions = {}
Returns Promise<ShareSetMetadataResponse>

Response data for the Share Set Metadata operation.

setQuota

setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>

- Defined in ShareClient.ts:927
Parameters
- quotaInGB: number
- Default value options: ShareSetQuotaOptions = {}
Returns Promise<ShareSetQuotaResponse>

Response data for the Share Get Quota operation.

withSnapshot

withSnapshot(snapshot: string): ShareClient

- Defined in ShareClient.ts:476
Parameters
- snapshot: string
Returns ShareClient

A new ShareClient object identical to the source but with the specified snapshot timestamp

Generated using TypeDoc