ShareFileClient
in package
Read onlyYes
FinalYes
Provides operations for an Azure file share file.
Table of Contents
Properties
- $credential : StorageSharedKeyCredential|TokenCredential|null
- $filePath : string
- $shareName : string
- $uri : UriInterface
Methods
- __construct() : mixed
- canGenerateSasUri() : bool
- Returns whether this client has a shared-key credential capable of signing a file SAS.
- generateSasUri() : UriInterface
- Generates a URI for this file containing a signed service SAS query string.
Properties
$credential
public
StorageSharedKeyCredential|TokenCredential|null
$credential
= null
$filePath
public
string
$filePath
$shareName
public
string
$shareName
$uri
public
UriInterface
$uri
Methods
__construct()
public
__construct(UriInterface $uri[, StorageSharedKeyCredential|TokenCredential|null $credential = null ]) : mixed
Parameters
- $uri : UriInterface
-
URI of the file, including any SAS query string.
- $credential : StorageSharedKeyCredential|TokenCredential|null = null
-
Credential used to authorize requests, or null for anonymous/SAS access.
canGenerateSasUri()
Returns whether this client has a shared-key credential capable of signing a file SAS.
public
canGenerateSasUri() : bool
Return values
boolgenerateSasUri()
Generates a URI for this file containing a signed service SAS query string.
public
generateSasUri(ShareSasBuilder $shareSasBuilder) : UriInterface
Parameters
- $shareSasBuilder : ShareSasBuilder