StorageClient class

Package:

@azure/storage-file

Extends

StorageClientContext

Constructors

StorageClient(string, string, msRest.ServiceClientOptions)

Initializes a new instance of the StorageClient class.

Properties

directory
file
fileRangeWriteFromUrl
service
share
url
version

Methods

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)	Send the provided httpRequest.

Constructor Details

StorageClient(string, string, msRest.ServiceClientOptions)

Initializes a new instance of the StorageClient class.

new StorageClient(version: string, url: string, options?: msRest.ServiceClientOptions)

Parameters

version

string

Specifies the version of the operation to use for this request.

url

string

The URL of the service account, share, directory or file that is the target of the desired operation.

options

msRest.ServiceClientOptions

Property Details

directory

directory: Directory

Property Value

Directory

file

file: File

Property Value

File

fileRangeWriteFromUrl

fileRangeWriteFromUrl: string

Property Value

string

service

service: Service

Property Value

Service

share

share: Share

Property Value

Share

url

url: string

Property Value

string

version

version: string

Property Value

string

Method Details

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>)

Parameters

operationArguments

OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec

OperationSpec

The OperationSpec to use to populate the httpRequest.

callback

ServiceCallback<any>

The callback to call when the response is received.

Returns

Promise<RestResponse>

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

function sendRequest(options: RequestPrepareOptions | WebResourceLike)

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>