Azure OSS for PHP API Reference

QueueServiceClient
in package

FinalYes

Provides service-level access to queues in an Azure Storage account.

Table of Contents

Properties

$credential  : StorageSharedKeyCredential|TokenCredential|null
$uri  : UriInterface
$options  : QueueServiceClientOptions

Methods

__construct()  : mixed
fromConnectionString()  : self
Creates a client from an Azure Storage connection string.
getQueueClient()  : QueueClient
Creates a client for the named queue without making a service request.

Properties

Methods

__construct()

public __construct(UriInterface $uri[, StorageSharedKeyCredential|TokenCredential|null $credential = null ][, QueueServiceClientOptions $options = new QueueServiceClientOptions() ]) : mixed
Parameters
$uri : UriInterface

Queue service endpoint, including any SAS query string.

$credential : StorageSharedKeyCredential|TokenCredential|null = null

Credential used to authorize requests, or null for SAS access.

$options : QueueServiceClientOptions = new QueueServiceClientOptions()

Client transport and service-version options.

fromConnectionString()

Creates a client from an Azure Storage connection string.

public static fromConnectionString(string $connectionString[, QueueServiceClientOptions $options = new QueueServiceClientOptions() ]) : self
Parameters
$connectionString : string
$options : QueueServiceClientOptions = new QueueServiceClientOptions()
Tags
throws
InvalidConnectionStringException

When the connection string does not contain a usable Queue endpoint and credential.

Return values
self

getQueueClient()

Creates a client for the named queue without making a service request.

public getQueueClient(string $queueName) : QueueClient
Parameters
$queueName : string
Return values
QueueClient
On this page

Search results