Class ShareServiceClient

Package version

Hierarchy

StorageClient
- ShareServiceClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ShareServiceClient(url: string, credential: Credential, options: StoragePipelineOptions): ShareServiceClient
new ShareServiceClient(url: string, pipeline: Pipeline): ShareServiceClient

Overrides StorageClient.constructor
- Defined in ShareServiceClient.ts:213
Parameters
- url: string
- Optional credential: Credential
- Optional options: StoragePipelineOptions
Returns ShareServiceClient
Overrides StorageClient.constructor
- Defined in ShareServiceClient.ts:226
Parameters
- url: string
- pipeline: Pipeline
Returns ShareServiceClient

Properties

accountName

accountName: string

Protected storageClientContext

storageClientContext: StorageClientContext

url

url: string

Methods

createShare

createShare(shareName: string, options?: ShareCreateOptions): Promise<object>

- Defined in ShareServiceClient.ts:291
Parameters
- shareName: string
- Default value options: ShareCreateOptions = {}
Returns Promise<object>

} Share creation response and the corresponding share client.

deleteShare

deleteShare(shareName: string, options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

- Defined in ShareServiceClient.ts:328
Parameters
- shareName: string
- Default value options: ShareDeleteMethodOptions = {}
Returns Promise<ShareDeleteResponse>

Share deletion response and the corresponding share client.

getProperties

getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

- Defined in ShareServiceClient.ts:362
Parameters
- Default value options: ServiceGetPropertiesOptions = {}
Returns Promise<ServiceGetPropertiesResponse>

Response data for the Get Properties operation.

getShareClient

getShareClient(shareName: string): ShareClient

- Defined in ShareServiceClient.ts:279
Parameters
- shareName: string
Returns ShareClient

The ShareClient object for the given share name.

listShares

listShares(options?: ServiceListSharesOptions): PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse>

- Defined in ShareServiceClient.ts:546
Parameters
- Default value options: ServiceListSharesOptions = {}
Returns PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse>

An asyncIterableIterator that supports paging.

setProperties

setProperties(properties: FileServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

- Defined in ShareServiceClient.ts:395
Parameters
- properties: FileServiceProperties
- Default value options: ServiceSetPropertiesOptions = {}
Returns Promise<ServiceSetPropertiesResponse>

Response data for the Set Properties operation.

Static fromConnectionString

fromConnectionString(connectionString: string, options: StoragePipelineOptions): ShareServiceClient

- Defined in ShareServiceClient.ts:183
Parameters
- connectionString: string
- Optional options: StoragePipelineOptions
Returns ShareServiceClient

A new ShareServiceClient from the given connection string.

Generated using TypeDoc