TableSasBuilder Class

Definition

Namespace:

Azure.Data.Tables.Sas

Assembly:

Azure.Data.Tables.dll

Package:

Azure.Data.Tables v12.9.1

Source:

TableSasBuilder.cs

TableSasBuilder is used to generate a Shared Access Signature (SAS) for an Azure Storage table. For more information, see Constructing an Account SAS.

public class TableSasBuilder

type TableSasBuilder = class

Public Class TableSasBuilder

Inheritance

Object

TableSasBuilder

Constructors

TableSasBuilder()	Initializes an instance of a TableSasBuilder with no details set. At minimum, additional properties must be set to create a valid SaS. These include setting the TableName, permissions, and an expiry. Permissions and expiry can also be specified in a shared access policy, which can be selected by specifying the name of the policy on the Identifier property.
TableSasBuilder(String, String, DateTimeOffset)	Initializes an instance of a TableSasBuilder.
TableSasBuilder(String, TableSasPermissions, DateTimeOffset)	Initializes an instance of a TableSasBuilder.
TableSasBuilder(Uri)	Initializes a new instance of TableSasBuilder based on an existing Uri containing a shared access signature.

Properties

ExpiresOn	The time at which the shared access signature becomes invalid. This field must be omitted if it has been specified in an associated stored access policy.
Identifier	An optional unique value up to 64 characters in length that correlates to an access policy specified for the container. Note: Either the stored access policy specified by the Identifier or the created shared access signature must define an expiry. If neither define an expiry or both do, authentication will fail.
IPRange	Specifies an IP address or a range of IP addresses from which to accept requests. If the IP address from which the request originates does not match the IP address or address range specified on the SAS token, the request is not authenticated. When specifying a range of IP addresses, note that the range is inclusive.
PartitionKeyEnd	The optional end of the partition key values range being made available. PartitionKeyStart must be specified if this value is set.
PartitionKeyStart	The optional start of the partition key values range being made available.
Permissions	The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. This field must be omitted if it has been specified in an associated stored access policy. TableSasPermissions can be used to create the permissions string.
Protocol	The optional signed protocol field specifies the protocol permitted for a request made with the SAS. Possible values are HttpsAndHttp, Https, and None.
RowKeyEnd	The optional end of the row key values range being made available. RowKeyStart must be specified if this value is set.
RowKeyStart	The optional start of the row key values range being made available.
StartsOn	Optionally specify the time at which the shared access signature becomes valid. If omitted when DateTimeOffset.MinValue is used, start time for this call is assumed to be the time when the storage service receives the request.
TableName	The name of the table being made accessible.

Methods

SetPermissions(String)	Sets the permissions for the SAS using a raw permissions string.
SetPermissions(TableSasPermissions)	Sets the permissions for a table SAS.
Sign(TableSharedKeyCredential)	Use an account's TableSharedKeyCredential to sign this shared access signature values to produce the proper SAS query parameters for authenticating requests.
ToSasQueryParameters(TableSharedKeyCredential)	Use an account's TableSharedKeyCredential to sign this shared access signature values to produce the proper SAS query parameters for authenticating requests.