AccountSasBuilder
in package
FinalYes
Builds an Azure Storage account shared access signature (SAS).
Table of Contents
Properties
- $encryptionScope : string|null
- $expiresOn : DateTimeInterface
- $ipRange : SasIpRange|null
- $permissions : string
- $protocol : SasProtocol|null
- $resourceTypes : string
- $services : string
- $startsOn : DateTimeInterface|null
- $version : string
Methods
- build() : string
- Signs and returns the account SAS query string without a leading question mark.
- new() : self
- Creates an empty account SAS builder.
- setEncryptionScope() : AccountSasBuilder
- Sets the encryption scope required for requests authorized by the SAS.
- setExpiresOn() : AccountSasBuilder
- Sets the instant at which the SAS expires.
- setIpRange() : AccountSasBuilder
- Restricts requests to the specified source IP address or range.
- setPermissions() : AccountSasBuilder
- Sets the operations permitted by the SAS.
- setProtocol() : AccountSasBuilder
- Restricts requests to HTTPS, or permits both HTTPS and HTTP.
- setResourceTypes() : AccountSasBuilder
- Sets the service, container, and object resource types accessible through the SAS.
- setServices() : AccountSasBuilder
- Sets the storage services accessible through the SAS.
- setStartsOn() : AccountSasBuilder
- Sets the earliest instant at which the SAS is valid.
- setVersion() : AccountSasBuilder
- Sets the Storage service version signed by the SAS.
Properties
$encryptionScope
private
string|null
$encryptionScope
= null
$expiresOn
private
DateTimeInterface
$expiresOn
$ipRange
private
SasIpRange|null
$ipRange
= null
$permissions
private
string
$permissions
$protocol
private
SasProtocol|null
$protocol
= null
$resourceTypes
private
string
$resourceTypes
$services
private
string
$services
$startsOn
private
DateTimeInterface|null
$startsOn
= null
$version
private
string
$version
Methods
build()
Signs and returns the account SAS query string without a leading question mark.
public
build(StorageSharedKeyCredential $sharedKeyCredential) : string
Parameters
- $sharedKeyCredential : StorageSharedKeyCredential
Return values
stringnew()
Creates an empty account SAS builder.
public
static new() : self
Return values
selfsetEncryptionScope()
Sets the encryption scope required for requests authorized by the SAS.
public
setEncryptionScope(string $encryptionScope) : AccountSasBuilder
Parameters
- $encryptionScope : string
Return values
AccountSasBuildersetExpiresOn()
Sets the instant at which the SAS expires.
public
setExpiresOn(DateTimeInterface $expiresOn) : AccountSasBuilder
Parameters
- $expiresOn : DateTimeInterface
Return values
AccountSasBuildersetIpRange()
Restricts requests to the specified source IP address or range.
public
setIpRange(SasIpRange $ipRange) : AccountSasBuilder
Parameters
- $ipRange : SasIpRange
Return values
AccountSasBuildersetPermissions()
Sets the operations permitted by the SAS.
public
setPermissions(string|AccountSasPermissions $permissions) : AccountSasBuilder
Parameters
- $permissions : string|AccountSasPermissions
Return values
AccountSasBuildersetProtocol()
Restricts requests to HTTPS, or permits both HTTPS and HTTP.
public
setProtocol(SasProtocol $protocol) : AccountSasBuilder
Parameters
- $protocol : SasProtocol
Return values
AccountSasBuildersetResourceTypes()
Sets the service, container, and object resource types accessible through the SAS.
public
setResourceTypes(string|AccountSasResourceTypes $resourceTypes) : AccountSasBuilder
Parameters
- $resourceTypes : string|AccountSasResourceTypes
Return values
AccountSasBuildersetServices()
Sets the storage services accessible through the SAS.
public
setServices(string|AccountSasServices $services) : AccountSasBuilder
Parameters
- $services : string|AccountSasServices
Return values
AccountSasBuildersetStartsOn()
Sets the earliest instant at which the SAS is valid.
public
setStartsOn(DateTimeInterface $startsOn) : AccountSasBuilder
Parameters
- $startsOn : DateTimeInterface
Return values
AccountSasBuildersetVersion()
Sets the Storage service version signed by the SAS.
public
setVersion(string $version) : AccountSasBuilder
Parameters
- $version : string