ShareServiceClient
in package
FinalYes
Provides service-level access to file shares in an Azure Storage account.
Table of Contents
Properties
- $credential : StorageSharedKeyCredential|TokenCredential|null
- $uri : UriInterface
- $options : ShareServiceClientOptions
Methods
- __construct() : mixed
- fromConnectionString() : self
- Creates a client from an Azure Storage connection string.
- getShareClient() : ShareClient
- Creates a client for the named file share without making a service request.
Properties
$credential read-only
public
StorageSharedKeyCredential|TokenCredential|null
$credential
= null
$uri
public
UriInterface
$uri
$options read-only
private
ShareServiceClientOptions
$options
= new ShareServiceClientOptions()
Methods
__construct()
public
__construct(UriInterface $uri[, StorageSharedKeyCredential|TokenCredential|null $credential = null ][, ShareServiceClientOptions $options = new ShareServiceClientOptions() ]) : mixed
Parameters
- $uri : UriInterface
-
File service endpoint, including any SAS query string.
- $credential : StorageSharedKeyCredential|TokenCredential|null = null
-
Credential used to authorize requests, or null for SAS access.
- $options : ShareServiceClientOptions = new ShareServiceClientOptions()
-
Client transport and service-version options.
fromConnectionString()
Creates a client from an Azure Storage connection string.
public
static fromConnectionString(string $connectionString[, ShareServiceClientOptions $options = new ShareServiceClientOptions() ]) : self
Parameters
- $connectionString : string
- $options : ShareServiceClientOptions = new ShareServiceClientOptions()
Tags
Return values
selfgetShareClient()
Creates a client for the named file share without making a service request.
public
getShareClient(string $shareName) : ShareClient
Parameters
- $shareName : string