TableSasSignatureValues interface

Package:

@azure/data-tables

ONLY AVAILABLE IN NODE.JS RUNTIME.

TableSASSignatureValues is used to help generating Table service SAS tokens for tables

Properties

endPartitionKey	Define the end of a Partition Key range Table queries will only return results that are within the range, and attempts to use the shared access signature to add, update, or delete entities outside this range will fail. If startPartitionKey equals endPartitionKey the shared access signature only authorizes access to entities in one partition in the table. If startPartitionKey equals endPartitionKey and startRowKey equals endRowKey, the shared access signature can only access one entity in one partition
endRowKey	Define the end of a Row Key range Table queries will only return results that are within the range, and attempts to use the shared access signature to add, update, or delete entities outside this range will fail. If startPartitionKey equals endPartitionKey the shared access signature only authorizes access to entities in one partition in the table. If startPartitionKey equals endPartitionKey and startRowKey equals endRowKey, the shared access signature can only access one entity in one partition
expiresOn	Optional. If identifier is not provided has a default value of one hour from the time the token is generated. The time after which the SAS will no longer work.
identifier	Optional. The name of the access policy on the container this SAS references if any. See https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. IP ranges allowed in this SAS.
permissions	Optional. If identifier is not provided has a default value of "read" Please refer to TableSasPermissions depending on the resource being accessed for help constructing the permissions string.
protocol	Optional. SAS protocols, HTTPS only or HTTPSandHTTP
startPartitionKey	Define the start of a Partition Key range Table queries will only return results that are within the range, and attempts to use the shared access signature to add, update, or delete entities outside this range will fail. If startPartitionKey equals endPartitionKey the shared access signature only authorizes access to entities in one partition in the table. If startPartitionKey equals endPartitionKey and startRowKey equals endRowKey, the shared access signature can only access one entity in one partition
startRowKey	Define the start of a Row Key range Table queries will only return results that are within the range, and attempts to use the shared access signature to add, update, or delete entities outside this range will fail. If startPartitionKey equals endPartitionKey the shared access signature only authorizes access to entities in one partition in the table. If startPartitionKey equals endPartitionKey and startRowKey equals endRowKey, the shared access signature can only access one entity in one partition
startsOn	Optional. When the SAS will take effect.
version	The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

Property Details

endPartitionKey

Define the end of a Partition Key range Table queries will only return results that are within the range, and attempts to use the shared access signature to add, update, or delete entities outside this range will fail. If startPartitionKey equals endPartitionKey the shared access signature only authorizes access to entities in one partition in the table. If startPartitionKey equals endPartitionKey and startRowKey equals endRowKey, the shared access signature can only access one entity in one partition

endPartitionKey?: string

Property Value

string

endRowKey

Define the end of a Row Key range Table queries will only return results that are within the range, and attempts to use the shared access signature to add, update, or delete entities outside this range will fail. If startPartitionKey equals endPartitionKey the shared access signature only authorizes access to entities in one partition in the table. If startPartitionKey equals endPartitionKey and startRowKey equals endRowKey, the shared access signature can only access one entity in one partition

endRowKey?: string

Property Value

string

expiresOn

Optional. If identifier is not provided has a default value of one hour from the time the token is generated. The time after which the SAS will no longer work.

expiresOn?: Date

Property Value

Date

identifier

Optional. The name of the access policy on the container this SAS references if any.

See https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

identifier?: string

Property Value

string

ipRange

Optional. IP ranges allowed in this SAS.

ipRange?: SasIPRange

Property Value

SasIPRange

permissions

Optional. If identifier is not provided has a default value of "read" Please refer to TableSasPermissions depending on the resource being accessed for help constructing the permissions string.

permissions?: TableSasPermissions

Property Value

TableSasPermissions

protocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

protocol?: SasProtocol

Property Value

SasProtocol

startPartitionKey

Define the start of a Partition Key range Table queries will only return results that are within the range, and attempts to use the shared access signature to add, update, or delete entities outside this range will fail. If startPartitionKey equals endPartitionKey the shared access signature only authorizes access to entities in one partition in the table. If startPartitionKey equals endPartitionKey and startRowKey equals endRowKey, the shared access signature can only access one entity in one partition

startPartitionKey?: string

Property Value

string

startRowKey

Define the start of a Row Key range Table queries will only return results that are within the range, and attempts to use the shared access signature to add, update, or delete entities outside this range will fail. If startPartitionKey equals endPartitionKey the shared access signature only authorizes access to entities in one partition in the table. If startPartitionKey equals endPartitionKey and startRowKey equals endRowKey, the shared access signature can only access one entity in one partition

startRowKey?: string

Property Value

string

startsOn

Optional. When the SAS will take effect.

startsOn?: Date

Property Value

Date

version

The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

version?: string

Property Value

string