ShareClient
in package
Read onlyYes
FinalYes
Provides operations for an Azure file share and the directories and files within it.
Table of Contents
Properties
- $credential : StorageSharedKeyCredential|TokenCredential|null
- $shareName : string
- $uri : UriInterface
- $options : ShareClientOptions
Methods
- __construct() : mixed
- canGenerateSasUri() : bool
- Returns whether this client has a shared-key credential capable of signing a share SAS.
- generateSasUri() : UriInterface
- Generates a URI for this share containing a signed service SAS query string.
- getDirectoryClient() : ShareDirectoryClient
- Creates a client for a directory in this share without making a service request.
- getFileClient() : ShareFileClient
- Creates a client for a file in this share without making a service request.
Properties
$credential
public
StorageSharedKeyCredential|TokenCredential|null
$credential
= null
$shareName
public
string
$shareName
$uri
public
UriInterface
$uri
$options
private
ShareClientOptions
$options
= new ShareClientOptions()
Methods
__construct()
public
__construct(UriInterface $uri[, StorageSharedKeyCredential|TokenCredential|null $credential = null ][, ShareClientOptions $options = new ShareClientOptions() ]) : mixed
Parameters
- $uri : UriInterface
-
URI of the share, including any SAS query string.
- $credential : StorageSharedKeyCredential|TokenCredential|null = null
-
Credential used to authorize requests, or null for anonymous/SAS access.
- $options : ShareClientOptions = new ShareClientOptions()
-
Client transport and service-version options.
canGenerateSasUri()
Returns whether this client has a shared-key credential capable of signing a share SAS.
public
canGenerateSasUri() : bool
Return values
boolgenerateSasUri()
Generates a URI for this share containing a signed service SAS query string.
public
generateSasUri(ShareSasBuilder $shareSasBuilder) : UriInterface
Parameters
- $shareSasBuilder : ShareSasBuilder
Tags
Return values
UriInterfacegetDirectoryClient()
Creates a client for a directory in this share without making a service request.
public
getDirectoryClient(string $directoryPath) : ShareDirectoryClient
Parameters
- $directoryPath : string
Return values
ShareDirectoryClientgetFileClient()
Creates a client for a file in this share without making a service request.
public
getFileClient(string $filePath) : ShareFileClient
Parameters
- $filePath : string