Partilhar via

AccountSasSignatureValues Class

  • Reference
Package:
com.azure.storage.common.sas
Maven Artifact:
com.azure:azure-storage-common:12.28.0
  • java.lang.Object
    • com.azure.storage.common.sas.AccountSasSignatureValues

public final class AccountSasSignatureValues

Used to initialize parameters for a Shared Access Signature (SAS) for an Azure Storage account. Once all the values here are set, use the generateSas method on the desired service client to obtain a representation of the SAS which can then be applied to a new client using the .sasToken(String) method on the desired client builder.

Constructor Summary

Constructor Description
AccountSasSignatureValues()

Deprecated

Please use #AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService, AccountSasResourceType)

Initializes a new AccountSasSignatureValues object.
AccountSasSignatureValues(OffsetDateTime expiryTime, AccountSasPermission permissions, AccountSasService services, AccountSasResourceType resourceTypes)

Initializes a new AccountSasSignatureValues object.

Method Summary

Modifier and Type Method and Description
AccountSasQueryParameters generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)

Deprecated

Please use the generateAccountSas(AccountSasSignatureValues) method on the desired service client after initializing AccountSasSignatureValues.

Generates a AccountSasQueryParameters object which contains all SAS query parameters for authenticating requests.
String getEncryptionScope()

Gets the encryption scope that will be applied to any write operations performed with the sas
OffsetDateTime getExpiryTime()

Gets the time after which the SAS will no longer work.
String getPermissions()

Gets the operations the SAS user may perform.
SasProtocol getProtocol()

Gets the SasProtocol which determines the HTTP protocol that will be used.
String getResourceTypes()

Gets the resource types accessible with this SAS.
SasIpRange getSasIpRange()

Gets the SasIpRange which determines the IP ranges that are allowed to use the SAS.
String getServices()

Gets the services accessible with this SAS.
OffsetDateTime getStartTime()

Gets when the SAS will take effect.
String getVersion()

Gets the service version that is targeted, if null or empty the latest service version targeted by the library will be used.
AccountSasSignatureValues setEncryptionScope(String encryptionScope)

Sets the encryption scope that will be applied to any write operations performed with the sas
AccountSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)

Deprecated

Please use #AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService, AccountSasResourceType) to specify the expiry time.

Sets the time after which the SAS will no longer work.
AccountSasSignatureValues setPermissions(AccountSasPermission permissions)

Deprecated

Please use #AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService, AccountSasResourceType) to specify the allowed 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)

Deprecated

Please use #AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService, AccountSasResourceType) to specify the resource types being targeted.

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)

Deprecated

Please use #AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService, AccountSasResourceType) to specify the services being targeted.

Sets the services accessible with this SAS.
AccountSasSignatureValues setStartTime(OffsetDateTime startTime)

Sets when the SAS will take effect.
AccountSasSignatureValues setVersion(String version)

Deprecated

The version is set to the latest version of sas. Users should stop calling this API as it is now treated as a no-op.

Sets the service version that is targeted.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AccountSasSignatureValues

@Deprecated
public AccountSasSignatureValues()

Deprecated

Please use #AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService, AccountSasResourceType)

Initializes a new AccountSasSignatureValues object.

AccountSasSignatureValues

public AccountSasSignatureValues(OffsetDateTime expiryTime, AccountSasPermission permissions, AccountSasService services, AccountSasResourceType resourceTypes)

Initializes a new AccountSasSignatureValues object.

Parameters:

expiryTime - The time after which the SAS will no longer work.
permissions - AccountSasPermission allowed by the SAS.
services - AccountSasService targeted by the SAS.
resourceTypes - AccountSasResourceType targeted by the SAS.

Method Details

generateSasQueryParameters

@Deprecated
public AccountSasQueryParameters generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)

Deprecated

Please use the generateAccountSas(AccountSasSignatureValues) method on the desired service client after initializing AccountSasSignatureValues.

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

Notes on SAS generation

For samples, see class level JavaDocs.

Parameters:

storageSharedKeyCredentials - Credentials for the storage account.

Returns:

A new AccountSasQueryParameters used for authenticating requests.

getEncryptionScope

public String getEncryptionScope()

Gets the encryption scope that will be applied to any write operations performed with the sas

Returns:

An encryption scope that will be applied to any write operations performed with the sas

getExpiryTime

public OffsetDateTime getExpiryTime()

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

Returns:

the time after which the SAS will no longer work.

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.

getProtocol

public SasProtocol getProtocol()

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

Returns:

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

getResourceTypes

public String getResourceTypes()

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

Returns:

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

getSasIpRange

public SasIpRange getSasIpRange()

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

Returns:

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

getServices

public String getServices()

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

Returns:

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

getStartTime

public OffsetDateTime getStartTime()

Gets when the SAS will take effect.

Returns:

when the SAS will take effect.

getVersion

public String getVersion()

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

Returns:

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

setEncryptionScope

public AccountSasSignatureValues setEncryptionScope(String encryptionScope)

Sets the encryption scope that will be applied to any write operations performed with the sas

Parameters:

encryptionScope - the encryption scope to set

Returns:

the updated AccountSasSignatureValues object.

setExpiryTime

@Deprecated
public AccountSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)

Deprecated

Please use #AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService, AccountSasResourceType) to specify the expiry time.

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

Parameters:

expiryTime - Expiry time to set

Returns:

the updated AccountSasSignatureValues object.

setPermissions

@Deprecated
public AccountSasSignatureValues setPermissions(AccountSasPermission permissions)

Deprecated

Please use #AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService, AccountSasResourceType) to specify the allowed 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.

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.

setResourceTypes

@Deprecated
public AccountSasSignatureValues setResourceTypes(String resourceTypes)

Deprecated

Please use #AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService, AccountSasResourceType) to specify the resource types being targeted.

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.

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.

setServices

@Deprecated
public AccountSasSignatureValues setServices(String services)

Deprecated

Please use #AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService, AccountSasResourceType) to specify the services being targeted.

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.

setStartTime

public AccountSasSignatureValues setStartTime(OffsetDateTime startTime)

Sets when the SAS will take effect.

Parameters:

startTime - Start time to set

Returns:

the updated AccountSasSignatureValues object.

setVersion

@Deprecated
public AccountSasSignatureValues setVersion(String version)

Deprecated

The version is set to the latest version of sas. Users should stop calling this API as it is now treated as a no-op.

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.

Applies to