com.azure.storage.common.sas

Class AccountSasSignatureValues

java.lang.Object

com.azure.storage.common.sas.AccountSasSignatureValues

public final class AccountSasSignatureValues
extends Object

Used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once all the values are set, call generateSASQueryParameters(StorageSharedKeyCredential) to obtain a representation of the SAS which can actually be applied to container, file, queue, and tables.

Generating an account SAS

The snippet below generates an account SAS that lasts for two days and gives the user read and list access to blob containers and file shares.

StorageSharedKeyCredential credential = new StorageSharedKeyCredential("my-account", "my-key");

AccountSasPermission permissions = new AccountSasPermission()
    .setListPermission(true)
    .setReadPermission(true);
String resourceTypes = new AccountSasResourceType().setContainer(true).toString();
String services = new AccountSasService().setBlobAccess(true).setFileAccess(true).toString();

// Creates an account SAS that can read and list from blob containers and file shares.
// The following are required: permissions, resourceTypes, services, and expiry date.
AccountSasQueryParameters sasQueryParameters = new AccountSasSignatureValues()
    .setPermissions(permissions)
    .setResourceTypes(resourceTypes)
    .setServices(services)
    .setExpiryTime(OffsetDateTime.now().plus(Duration.ofDays(2)))
    .generateSasQueryParameters(credential);

See Also:

Create an account SAS, Storage SAS overview

Constructor Summary

Constructors

Constructor and Description
AccountSasSignatureValues() Initializes a new AccountSasSignatureValues object.

Method Summary

Modifier and Type	Method and Description
AccountSasQueryParameters	generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials) Generates a AccountSasQueryParameters object which contains all SAS query parameters for authenticating requests.
OffsetDateTime	getExpiryTime()
String	getPermissions() Gets the operations the SAS user may perform.
SasProtocol	getProtocol()
String	getResourceTypes()
SasIpRange	getSasIpRange()
String	getServices()
OffsetDateTime	getStartTime()
String	getVersion()
AccountSasSignatureValues	setExpiryTime(OffsetDateTime expiryTime) Sets the time after which the SAS will no longer work.
AccountSasSignatureValues	setPermissions(AccountSasPermission permissions) Sets the operations the account SAS user may perform.
AccountSasSignatureValues	setProtocol(SasProtocol protocol) Sets the SasProtocol which determines the HTTP protocol that will be used.
AccountSasSignatureValues	setResourceTypes(String resourceTypes) Sets the resource types accessible with this SAS.
AccountSasSignatureValues	setSasIpRange(SasIpRange sasIpRange) Sets the SasIpRange which determines the IP ranges that are allowed to use the SAS.
AccountSasSignatureValues	setServices(String services) Sets the services accessible with this SAS.
AccountSasSignatureValues	setStartTime(OffsetDateTime startTime) Sets when the SAS will take effect.
AccountSasSignatureValues	setVersion(String version) Sets the service version that is targeted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccountSasSignatureValues

public AccountSasSignatureValues()

Initializes a new AccountSasSignatureValues object.

Method Detail

getVersion

public String getVersion()

Returns:

the service version that is targeted, if null or empty the latest service version targeted by the library will be used.

setVersion

public AccountSasSignatureValues setVersion(String version)

Sets the service version that is targeted. Leave this null or empty to target the version used by the library.

Parameters:

version - Target version to set

Returns:

the updated AccountSasSignatureValues object.

getProtocol

public SasProtocol getProtocol()

Returns:

the SasProtocol which determines the HTTP protocol that will be used.

setProtocol

public AccountSasSignatureValues setProtocol(SasProtocol protocol)

Sets the SasProtocol which determines the HTTP protocol that will be used.

Parameters:

protocol - Protocol to set

Returns:

the updated AccountSasSignatureValues object.

getStartTime

public OffsetDateTime getStartTime()

Returns:

when the SAS will take effect.

setStartTime

public AccountSasSignatureValues setStartTime(OffsetDateTime startTime)

Sets when the SAS will take effect.

Parameters:

startTime - Start time to set

Returns:

the updated AccountSasSignatureValues object.

getExpiryTime

public OffsetDateTime getExpiryTime()

Returns:

the time after which the SAS will no longer work.

setExpiryTime

public AccountSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)

Sets the time after which the SAS will no longer work.

Parameters:

expiryTime - Expiry time to set

Returns:

the updated AccountSasSignatureValues object.

getPermissions

public String getPermissions()

Gets the operations the SAS user may perform.

Returns:

The operations the SAS user may perform. Please refer to AccountSasPermission to help determine which permissions are allowed.

setPermissions

public AccountSasSignatureValues setPermissions(AccountSasPermission permissions)

Sets the operations the account SAS user may perform. Please refer to AccountSasPermission for help constructing the permissions string.

Parameters:

permissions - Permissions to set.

Returns:

the updated AccountSasSignatureValues object.

Throws:

NullPointerException - if permissions is null.

getSasIpRange

public SasIpRange getSasIpRange()

Returns:

the SasIpRange which determines the IP ranges that are allowed to use the SAS.

setSasIpRange

public AccountSasSignatureValues setSasIpRange(SasIpRange sasIpRange)

Sets the SasIpRange which determines the IP ranges that are allowed to use the SAS.

Parameters:

sasIpRange - Allowed IP range to set

Returns:

the updated AccountSasSignatureValues object.

getServices

public String getServices()

Returns:

the services accessible with this SAS. Please refer to AccountSasService to help determine which services are accessible.

setServices

public AccountSasSignatureValues setServices(String services)

Sets the services accessible with this SAS. Please refer to AccountSasService to construct this value.

Parameters:

services - Allowed services string to set

Returns:

the updated AccountSasSignatureValues object.

getResourceTypes

public String getResourceTypes()

Returns:

the resource types accessible with this SAS. Please refer to AccountSasResourceType to help determine the resource types that are accessible.

setResourceTypes

public AccountSasSignatureValues setResourceTypes(String resourceTypes)

Sets the resource types accessible with this SAS. Please refer to AccountSasResourceType to construct this value.

Parameters:

resourceTypes - Allowed resource types string to set

Returns:

the updated AccountSasSignatureValues object.

generateSasQueryParameters

public AccountSasQueryParameters generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)

Generates a AccountSasQueryParameters object which contains all SAS query parameters for authenticating requests.

Notes on SAS generation

• If version is not set, the latest service version is used.
• The following parameters are required to generate a SAS:
  • expiryTime
  • services
  • permissions
  • resourceTypes

For samples, see class level JavaDocs.

Parameters:

storageSharedKeyCredentials - Credentials for the storage account.

Returns:

A new AccountSasQueryParameters used for authenticating requests.

Throws:

RuntimeException - If the HMAC-SHA256 signature for storageSharedKeyCredentials fails to generate.

NullPointerException - If any of storageSharedKeyCredentials, services, resourceTypes, expiryTime, or permissions is null.

See Also:

Create an account SAS