PHP OSS for Azure API Reference

BlobSasBuilder

in package

• Application

Builds an Azure Blob Storage service shared access signature (SAS).

Table of Contents

Properties

$blobName  : string|null

$blobVersionId  : string|null

$cacheControl  : string|null

$containerName  : string

$contentDisposition  : string|null

$contentEncoding  : string|null

$contentLanguage  : string|null

$contentType  : string|null

$encryptionScope  : string|null

$expiresOn  : DateTimeInterface

$identifier  : string|null

$ipRange  : SasIpRange|null

$permissions  : string|null

$protocol  : SasProtocol|null

$snapshot  : string|null

$startsOn  : DateTimeInterface|null

$version  : string

Methods

build()  : string

Signs and returns the service SAS query string without a leading question mark.

new()  : self

Creates an empty blob service SAS builder.

setBlobName()  : BlobSasBuilder

Sets the blob name, or omits it to create a container SAS.

setBlobVersionId()  : self

Sets the opaque blob version identifier for a version-specific SAS.

setCacheControl()  : self

Overrides the Cache-Control response header for requests using the SAS.

setContainerName()  : BlobSasBuilder

Sets the container name included in the canonical signed resource.

setContentDisposition()  : self

Overrides the Content-Disposition response header for requests using the SAS.

setContentEncoding()  : self

Overrides the Content-Encoding response header for requests using the SAS.

setContentLanguage()  : self

Overrides the Content-Language response header for requests using the SAS.

setContentType()  : self

Overrides the Content-Type response header for requests using the SAS.

setEncryptionScope()  : self

Sets the encryption scope required for requests authorized by the SAS.

setExpiresOn()  : self

Sets the instant at which the SAS expires.

setIdentifier()  : self

Associates the SAS with a stored access policy identifier.

setIPRange()  : self

Restricts requests to the specified source IP address or range.

setPermissions()  : self

Sets the operations permitted by the SAS.

setProtocol()  : self

Restricts requests to HTTPS, or permits both HTTPS and HTTP.

setSnapshot()  : self

Sets the opaque snapshot identifier for a snapshot-specific SAS.

setStartsOn()  : self

Sets the earliest instant at which the SAS is valid.

setVersion()  : self

Sets the Storage service version signed by the SAS.

getCanonicalizedResource()  : string

validateState()  : void

Ensures the builder contains the minimum state required to sign a SAS.