Class QueueServiceClient

Package version

Hierarchy

StorageClient
- QueueServiceClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new QueueServiceClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options: StoragePipelineOptions): QueueServiceClient
new QueueServiceClient(url: string, pipeline: Pipeline): QueueServiceClient

Overrides StorageClient.constructor
- Defined in QueueServiceClient.ts:215
Parameters
- url: string
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
- Optional options: StoragePipelineOptions
Returns QueueServiceClient
Overrides StorageClient.constructor
- Defined in QueueServiceClient.ts:261
Parameters
- url: string
- pipeline: Pipeline
Returns QueueServiceClient

Properties

accountName

accountName: string

Protected storageClientContext

storageClientContext: StorageClientContext

url

url: string

Methods

createQueue

createQueue(queueName: string, options?: QueueCreateOptions): Promise<QueueCreateResponse>

- Defined in QueueServiceClient.ts:649
Parameters
- queueName: string
- Default value options: QueueCreateOptions = {}
Returns Promise<QueueCreateResponse>

Response data for the Queue create operation.

deleteQueue

deleteQueue(queueName: string, options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

- Defined in QueueServiceClient.ts:682
Parameters
- queueName: string
- Default value options: QueueDeleteOptions = {}
Returns Promise<QueueDeleteResponse>

Response data for the Queue delete operation.

getProperties

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

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

Response data including the queue service properties.

getQueueClient

getQueueClient(queueName: string): QueueClient

- Defined in QueueServiceClient.ts:320
Parameters
- queueName: string
Returns QueueClient

a new QueueClient

getStatistics

getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>

- Defined in QueueServiceClient.ts:617
Parameters
- Default value options: ServiceGetStatisticsOptions = {}
Returns Promise<ServiceGetStatisticsResponse>

Response data for get statistics the operation.

listQueues

listQueues(options?: ServiceListQueuesOptions): PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse>

- Defined in QueueServiceClient.ts:502
Parameters
- Default value options: ServiceListQueuesOptions = {}
Returns PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse>

An asyncIterableIterator that supports paging.

setProperties

setProperties(properties: QueueServiceProperties, options?: ServiceGetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

- Defined in QueueServiceClient.ts:583
Parameters
- properties: QueueServiceProperties
- Default value options: ServiceGetPropertiesOptions = {}
Returns Promise<ServiceSetPropertiesResponse>

Response data for the Set Properties operation.

Static fromConnectionString

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

- Defined in QueueServiceClient.ts:175
Parameters
- connectionString: string
- Optional options: StoragePipelineOptions
Returns QueueServiceClient

A new QueueServiceClient object from the given connection string.

Generated using TypeDoc