AccountSASSignatureValues Class

Definition

AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once all the values here are set appropriately, call generateSASQueryParameters to obtain a representation of the SAS which can actually be applied to blob urls. Note: that both this class and SASQueryParameters exist because the former is mutable and a logical representation while the latter is immutable and used to generate actual REST requests.

Please see here for more conceptual information on SAS:

Please see here for further descriptions of the parameters, including which are required:

public class AccountSASSignatureValues
Inheritance
java.lang.Object
AccountSASSignatureValues

Remarks

Sample Code

Warning

It looks like the sample you are looking for has moved! Rest assured we are working on resolving this.

For more samples, please see the Samples file

Constructors

AccountSASSignatureValues()

Initializes anAccountSASSignatureValues  object with the version number set to the default and all other values empty.

Methods

expiryTime()

The time after which the SAS will no longer work.

generateSASQueryParameters(SharedKeyCredentials sharedKeyCredentials)

Generates a SASQueryParameters object which contains all SAS query parameters needed to make an actual REST request.

ipRange()

IPRange

permissions()

Specifies which operations the SAS user may perform. Please refer to AccountSASPermission for help constructing the permissions string.

protocol()

SASProtocol

resourceTypes()

The values that indicate the resource types accessible with this SAS. Please refer to AccountSASResourceType to construct this value.

services()

The values that indicate the services accessible with this SAS. Please refer to AccountSASService to construct this value.

startTime()

When the SAS will take effect.

version()

If null or empty, this defaults to the service version targeted by this version of the library.

withExpiryTime(OffsetDateTime expiryTime)

The time after which the SAS will no longer work.

withIpRange(IPRange ipRange)

IPRange

withPermissions(String permissions)

Specifies which operations the SAS user may perform. Please refer to AccountSASPermission for help constructing the permissions string.

withProtocol(SASProtocol protocol)

SASProtocol

withResourceTypes(String resourceTypes)

The values that indicate the resource types accessible with this SAS. Please refer to AccountSASResourceType to construct this value.

withServices(String services)

The values that indicate the services accessible with this SAS. Please refer to AccountSASService to construct this value.

withStartTime(OffsetDateTime startTime)

When the SAS will take effect.

withVersion(String version)

If null or empty, this defaults to the service version targeted by this version of the library.

Applies to