Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountSASSignatureValues

Package version

ONLY AVAILABLE IN NODE.JS RUNTIME.

AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once all the values here are set appropriately, call generateAccountSASQueryParameters 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.

see

https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 for more conceptual information on SAS

see

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas for descriptions of the parameters, including which are required

export

Hierarchy

  • AccountSASSignatureValues

Index

Properties

expiresOn

expiresOn: Date

The time after which the SAS will no longer work.

memberof

AccountSASSignatureValues

Optional ipRange

ipRange: SasIPRange

Optional. IP range allowed.

memberof

AccountSASSignatureValues

permissions

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

memberof

AccountSASSignatureValues

Optional protocol

protocol: SASProtocol

Optional. SAS protocols allowed.

memberof

AccountSASSignatureValues

resourceTypes

resourceTypes: string

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

memberof

AccountSASSignatureValues

services

services: string

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

memberof

AccountSASSignatureValues

Optional startsOn

startsOn: Date

Optional. When the SAS will take effect.

memberof

AccountSASSignatureValues

Optional version

version: undefined | string

If not provided, this defaults to the service version targeted by this version of the library.

memberof

AccountSASSignatureValues

Generated using TypeDoc