StorageClient class

Package:

@azure/storage-blob

Extends

StorageClientContext

Constructors

StorageClient(string, Models.StorageClientOptions)

Initializes a new instance of the StorageClient class.

Properties

appendBlob
blob
blockBlob
container
directory
pageBlob
pathRenameMode
service
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, Models.StorageClientOptions)

Initializes a new instance of the StorageClient class.

new StorageClient(url: string, options?: Models.StorageClientOptions)

Parameters

url

string

The URL of the service account, container, or blob that is the targe of the desired operation.

options

Models.StorageClientOptions

Property Details

appendBlob

appendBlob: AppendBlob

Property Value

AppendBlob

blob

blob: Blob

Property Value

Blob

blockBlob

blockBlob: BlockBlob

Property Value

BlockBlob

container

container: Container

Property Value

Container

directory

directory: Directory

Property Value

Directory

pageBlob

pageBlob: PageBlob

Property Value

PageBlob

pathRenameMode

pathRenameMode?: Models.PathRenameMode

Property Value

Models.PathRenameMode

service

service: Service

Property Value

Service

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>