Service class

Package:

@azure/storage-blob

Class representing a Service.

Constructors

Service(StorageClientContext)

Create a Service.

Methods

getAccountInfo(msRest.RequestOptionsBase)	Returns the sku name and account kind
getAccountInfo(RequestOptionsBase, ServiceCallback<void>)
getAccountInfo(ServiceCallback<void>)
getProperties(Models.ServiceGetPropertiesOptionalParams)	gets the properties of a storage account's Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
getProperties(ServiceCallback<StorageServiceProperties>)
getProperties(ServiceGetPropertiesOptionalParams, ServiceCallback<StorageServiceProperties>)
getStatistics(Models.ServiceGetStatisticsOptionalParams)	Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.
getStatistics(ServiceCallback<StorageServiceStats>)
getStatistics(ServiceGetStatisticsOptionalParams, ServiceCallback<StorageServiceStats>)
getUserDelegationKey(KeyInfo, Models.ServiceGetUserDelegationKeyOptionalParams)	Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication.
getUserDelegationKey(KeyInfo, ServiceCallback<UserDelegationKey>)
getUserDelegationKey(KeyInfo, ServiceGetUserDelegationKeyOptionalParams, ServiceCallback<UserDelegationKey>)
listContainersSegment(Models.ServiceListContainersSegmentOptionalParams)	The List Containers Segment operation returns a list of the containers under the specified account
listContainersSegment(ServiceCallback<ListContainersSegmentResponse>)
listContainersSegment(ServiceListContainersSegmentOptionalParams, ServiceCallback<ListContainersSegmentResponse>)
setProperties(StorageServiceProperties, Models.ServiceSetPropertiesOptionalParams)	Sets properties for a storage account's Blob service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules
setProperties(StorageServiceProperties, ServiceCallback<void>)
setProperties(StorageServiceProperties, ServiceSetPropertiesOptionalParams, ServiceCallback<void>)
submitBatch(msRest.HttpRequestBody, number, string, Models.ServiceSubmitBatchOptionalParams)	The Batch operation allows multiple API calls to be embedded into a single HTTP request.
submitBatch(msRest.HttpRequestBody, number, string, ServiceCallback<void>)
submitBatch(msRest.HttpRequestBody, number, string, ServiceSubmitBatchOptionalParams, ServiceCallback<void>)

Constructor Details

Service(StorageClientContext)

Create a Service.

new Service(client: StorageClientContext)

Parameters

client

StorageClientContext

Reference to the service client.

Method Details

getAccountInfo(msRest.RequestOptionsBase)

Returns the sku name and account kind

function getAccountInfo(options?: msRest.RequestOptionsBase)

Parameters

options

msRest.RequestOptionsBase

Returns

Promise<Models.ServiceGetAccountInfoResponse>

Promise<Models.ServiceGetAccountInfoResponse>

getAccountInfo(RequestOptionsBase, ServiceCallback<void>)

function getAccountInfo(options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

getAccountInfo(ServiceCallback<void>)

function getAccountInfo(callback: ServiceCallback<void>)

Parameters

callback

ServiceCallback<void>

The callback

getProperties(Models.ServiceGetPropertiesOptionalParams)

gets the properties of a storage account's Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

function getProperties(options?: Models.ServiceGetPropertiesOptionalParams)

Parameters

options

Models.ServiceGetPropertiesOptionalParams

Returns

Promise<Models.ServiceGetPropertiesResponse>

Promise<Models.ServiceGetPropertiesResponse>

getProperties(ServiceCallback<StorageServiceProperties>)

function getProperties(callback: ServiceCallback<StorageServiceProperties>)

Parameters

callback

ServiceCallback<StorageServiceProperties>

The callback

getProperties(ServiceGetPropertiesOptionalParams, ServiceCallback<StorageServiceProperties>)

function getProperties(options: ServiceGetPropertiesOptionalParams, callback: ServiceCallback<StorageServiceProperties>)

Parameters

options

ServiceGetPropertiesOptionalParams

The optional parameters

callback

ServiceCallback<StorageServiceProperties>

The callback

getStatistics(Models.ServiceGetStatisticsOptionalParams)

Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.

function getStatistics(options?: Models.ServiceGetStatisticsOptionalParams)

Parameters

options

Models.ServiceGetStatisticsOptionalParams

Returns

Promise<Models.ServiceGetStatisticsResponse>

Promise<Models.ServiceGetStatisticsResponse>

getStatistics(ServiceCallback<StorageServiceStats>)

function getStatistics(callback: ServiceCallback<StorageServiceStats>)

Parameters

callback

ServiceCallback<StorageServiceStats>

The callback

getStatistics(ServiceGetStatisticsOptionalParams, ServiceCallback<StorageServiceStats>)

function getStatistics(options: ServiceGetStatisticsOptionalParams, callback: ServiceCallback<StorageServiceStats>)

Parameters

options

ServiceGetStatisticsOptionalParams

The optional parameters

callback

ServiceCallback<StorageServiceStats>

The callback

getUserDelegationKey(KeyInfo, Models.ServiceGetUserDelegationKeyOptionalParams)

Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication.

function getUserDelegationKey(keyInfo: KeyInfo, options?: Models.ServiceGetUserDelegationKeyOptionalParams)

Parameters

keyInfo

KeyInfo

options

Models.ServiceGetUserDelegationKeyOptionalParams

Returns

Promise<Models.ServiceGetUserDelegationKeyResponse>

Promise<Models.ServiceGetUserDelegationKeyResponse>

getUserDelegationKey(KeyInfo, ServiceCallback<UserDelegationKey>)

function getUserDelegationKey(keyInfo: KeyInfo, callback: ServiceCallback<UserDelegationKey>)

Parameters

keyInfo

KeyInfo

callback

ServiceCallback<UserDelegationKey>

The callback

getUserDelegationKey(KeyInfo, ServiceGetUserDelegationKeyOptionalParams, ServiceCallback<UserDelegationKey>)

function getUserDelegationKey(keyInfo: KeyInfo, options: ServiceGetUserDelegationKeyOptionalParams, callback: ServiceCallback<UserDelegationKey>)

Parameters

keyInfo

KeyInfo

options

ServiceGetUserDelegationKeyOptionalParams

The optional parameters

callback

ServiceCallback<UserDelegationKey>

The callback

listContainersSegment(Models.ServiceListContainersSegmentOptionalParams)

The List Containers Segment operation returns a list of the containers under the specified account

function listContainersSegment(options?: Models.ServiceListContainersSegmentOptionalParams)

Parameters

options

Models.ServiceListContainersSegmentOptionalParams

Returns

Promise<Models.ServiceListContainersSegmentResponse>

Promise<Models.ServiceListContainersSegmentResponse>

listContainersSegment(ServiceCallback<ListContainersSegmentResponse>)

function listContainersSegment(callback: ServiceCallback<ListContainersSegmentResponse>)

Parameters

callback

ServiceCallback<ListContainersSegmentResponse>

The callback

listContainersSegment(ServiceListContainersSegmentOptionalParams, ServiceCallback<ListContainersSegmentResponse>)

function listContainersSegment(options: ServiceListContainersSegmentOptionalParams, callback: ServiceCallback<ListContainersSegmentResponse>)

Parameters

options

ServiceListContainersSegmentOptionalParams

The optional parameters

callback

ServiceCallback<ListContainersSegmentResponse>

The callback

setProperties(StorageServiceProperties, Models.ServiceSetPropertiesOptionalParams)

Sets properties for a storage account's Blob service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules

function setProperties(storageServiceProperties: StorageServiceProperties, options?: Models.ServiceSetPropertiesOptionalParams)

Parameters

storageServiceProperties

StorageServiceProperties

The StorageService properties.

options

Models.ServiceSetPropertiesOptionalParams

Returns

Promise<Models.ServiceSetPropertiesResponse>

Promise<Models.ServiceSetPropertiesResponse>

setProperties(StorageServiceProperties, ServiceCallback<void>)

function setProperties(storageServiceProperties: StorageServiceProperties, callback: ServiceCallback<void>)

Parameters

storageServiceProperties

StorageServiceProperties

The StorageService properties.

callback

ServiceCallback<void>

The callback

setProperties(StorageServiceProperties, ServiceSetPropertiesOptionalParams, ServiceCallback<void>)

function setProperties(storageServiceProperties: StorageServiceProperties, options: ServiceSetPropertiesOptionalParams, callback: ServiceCallback<void>)

Parameters

storageServiceProperties

StorageServiceProperties

The StorageService properties.

options

ServiceSetPropertiesOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

submitBatch(msRest.HttpRequestBody, number, string, Models.ServiceSubmitBatchOptionalParams)

The Batch operation allows multiple API calls to be embedded into a single HTTP request.

function submitBatch(body: msRest.HttpRequestBody, contentLength: number, multipartContentType: string, options?: Models.ServiceSubmitBatchOptionalParams)

Parameters

body

msRest.HttpRequestBody

Initial data

contentLength

number

The length of the request.

multipartContentType

string

Required. The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_<GUID>

options

Models.ServiceSubmitBatchOptionalParams

Returns

Promise<Models.ServiceSubmitBatchResponse>

Promise<Models.ServiceSubmitBatchResponse>

submitBatch(msRest.HttpRequestBody, number, string, ServiceCallback<void>)

function submitBatch(body: msRest.HttpRequestBody, contentLength: number, multipartContentType: string, callback: ServiceCallback<void>)

Parameters

body

msRest.HttpRequestBody

Initial data

contentLength

number

The length of the request.

multipartContentType

string

Required. The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_<GUID>

callback

ServiceCallback<void>

The callback

submitBatch(msRest.HttpRequestBody, number, string, ServiceSubmitBatchOptionalParams, ServiceCallback<void>)

function submitBatch(body: msRest.HttpRequestBody, contentLength: number, multipartContentType: string, options: ServiceSubmitBatchOptionalParams, callback: ServiceCallback<void>)

Parameters

body

msRest.HttpRequestBody

Initial data

contentLength

number

The length of the request.

multipartContentType

string

Required. The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_<GUID>

options

ServiceSubmitBatchOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback