Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly by the user; it is only generated by the AccountSASSignatureValues and BlobSASSignatureValues types. Once generated, it can be encoded into a toString() and appended to a URL directly (though caution should be taken here in case there are existing query parameters, which might affect the appropriate means of appending these query parameters).
NOTE: Instances of this class are immutable.
Constructors SASQueryParameters(string, string, SASQueryParametersOptions)Creates an instance of SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string, string, string)Creates an instance of SASQueryParameters.
Methods toString()Encodes all SAS query parameters into a string that can be appended to a URL.
Constructor Details SASQueryParameters(string, string, SASQueryParametersOptions)Creates an instance of SASQueryParameters.
new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions)
Parameters
string
Representing the storage version
string
Representing the signature for the SAS token
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string, string, string)Creates an instance of SASQueryParameters.
new SASQueryParameters(version: string, signature: string, permissions?: string, services?: string, resourceTypes?: string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: string, resource?: string, cacheControl?: string, contentDisposition?: string, contentEncoding?: string, contentLanguage?: string, contentType?: string, userDelegationKey?: UserDelegationKey, preauthorizedAgentObjectId?: string, correlationId?: string, encryptionScope?: string)
Parameters
string
Representing the storage version
string
Representing the signature for the SAS token
string
Representing the storage permissions
string
Representing the storage services being accessed (only for Account SAS)
string
Representing the storage resource types being accessed (only for Account SAS)
Representing the allowed HTTP protocol(s)
Date
Representing the start time for this SAS token
Date
Representing the expiry time for this SAS token
Representing the range of valid IP addresses for this SAS token
string
Representing the signed identifier (only for Service SAS)
string
Representing the storage container or blob (only for Service SAS)
string
Representing the cache-control header (only for Blob/File Service SAS)
string
Representing the content-disposition header (only for Blob/File Service SAS)
string
Representing the content-encoding header (only for Blob/File Service SAS)
string
Representing the content-language header (only for Blob/File Service SAS)
string
Representing the content-type header (only for Blob/File Service SAS)
string
Representing the authorized AAD Object ID (only for User Delegation SAS)
string
Representing the correlation ID (only for User Delegation SAS)
Property Details cacheControlValue for cache-control header in Blob/File Service SAS.
cacheControl?: string
Property Value
string
contentDispositionValue for content-disposition header in Blob/File Service SAS.
contentDisposition?: string
Property Value
string
contentEncodingValue for content-encoding header in Blob/File Service SAS.
contentEncoding?: string
Property Value
string
contentLanguageValue for content-length header in Blob/File Service SAS.
contentLanguage?: string
Property Value
string
contentTypeValue for content-type header in Blob/File Service SAS.
contentType?: string
Property Value
string
correlationIdA GUID value that will be logged in the storage diagnostic logs and can be used to correlate SAS generation with storage resource access. This is only used for User Delegation SAS.
correlationId?: string
Property Value
string
encryptionScopeOptional. Encryption scope to use when sending requests authorized with this SAS URI.
encryptionScope?: string
Property Value
string
expiresOnOptional only when identifier is provided. The expiry time for this SAS token.
expiresOn?: Date
Property Value
Date
ipRangeOptional. IP range allowed for this SAS.
undefined | SasIPRange ipRange
Property Value
undefined | SasIPRange
Authorized AAD Object ID in GUID format. The AAD Object ID of a user authorized by the owner of the User Delegation Key to perform the action granted by the SAS. The Azure Storage service will ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission check for the user specified in this value will be performed. This is only used for User Delegation SAS.
preauthorizedAgentObjectId?: string
Property Value
string
protocolOptional. The allowed HTTP protocol(s).
protocol?: SASProtocol
Property Value resourceTypes
Optional. The storage resource types being accessed (only for Account SAS). Please refer to AccountSASResourceTypes for more details.
resourceTypes?: string
Property Value
string
servicesOptional. The storage services being accessed (only for Account SAS). Please refer to AccountSASServices for more details.
services?: string
Property Value
string
signatureThe signature for the SAS token.
signature: string
Property Value
string
startsOnOptional. The start time for this SAS token.
startsOn?: Date
Property Value
Date
versionThe storage API version.
version: string
Property Value
string
Method Details toString()Encodes all SAS query parameters into a string that can be appended to a URL.
function toString(): string
Returns
string
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4