com.microsoft.azure.storage.blob

Class AccountSASSignatureValues

java.lang.Object

com.microsoft.azure.storage.blob.AccountSASSignatureValues

public final class AccountSASSignatureValues
extends java.lang.Object

AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Date	expiryTime A java.util.Date object which contains the shared access signature expiry time.
IPRange	ipRange An IPRange representing the IP addresses permitted to use this SAS.
java.lang.String	permissions A String specifying which operations the SAS user may perform.
SASProtocol	protocol A SASProtocol value representing the allowed Internet protocols.
java.lang.String	resourceTypes A String that contains the values that indicate the resource types accessible with this SAS.
java.lang.String	services A String that contains the values that indicate the services accessible with this SAS.
java.util.Date	startTime A java.util.Date object which contains the shared access signature start time.
java.lang.String	version If null or empty, this defaults to the service version targeted by this version of the library.

Constructor Summary

Constructors

Constructor and Description
AccountSASSignatureValues() Initializes an AccountSASSignatureValues object with the version number set to the default and all other values empty.

Method Summary

Modifier and Type	Method and Description
SASQueryParameters	generateSASQueryParameters(SharedKeyCredentials sharedKeyCredentials) Generates SASQueryParameters object which contains all SAS query parameters.

Methods inherited from class java.lang.Object

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

Field Detail

version

public java.lang.String version

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

protocol

public SASProtocol protocol

A SASProtocol value representing the allowed Internet protocols.

startTime

public java.util.Date startTime

A java.util.Date object which contains the shared access signature start time.

expiryTime

public java.util.Date expiryTime

A java.util.Date object which contains the shared access signature expiry time.

permissions

public java.lang.String permissions

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

ipRange

public IPRange ipRange

An IPRange representing the IP addresses permitted to use this SAS.

services

public java.lang.String services

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

resourceTypes

public java.lang.String resourceTypes

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

Constructor Detail

AccountSASSignatureValues

public AccountSASSignatureValues()

Initializes an AccountSASSignatureValues object with the version number set to the default and all other values empty. For more information on how to use this class, please refer to https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

Method Detail

generateSASQueryParameters

public SASQueryParameters generateSASQueryParameters(SharedKeyCredentials sharedKeyCredentials)

Generates SASQueryParameters object which contains all SAS query parameters.

Parameters:

sharedKeyCredentials - A SharedKeyCredentials object for the storage account and corresponding primary or secondary key.

Returns:

A SASQueryParameters object which contains all SAS query parameters.