@azure/data-tables package
Classes
| AzureNamedKeyCredential |
A static name/key-based credential that supports updating the underlying name and key values. |
| AzureSASCredential |
A static-signature-based credential that supports updating the underlying signature value. |
| TableClient |
A TableClient represents a Client to the Azure Tables service allowing you to perform operations on a single table. |
| TableServiceClient |
A TableServiceClient represents a Client to the Azure Tables service allowing you to perform operations on the tables and the entities. |
| TableTransaction |
Helper to build a list of transaction actions |
Interfaces
| AccessPolicy |
An Access policy. |
| AccountSasOptions |
Options to configure generateAccountSas operation. |
| AccountSasPermissions |
A type that looks like an account SAS permission. Used in AccountSasPermissions to parse SAS permissions from raw objects. |
| AccountSasServices |
Services that the SAS token can access |
| CorsRule |
CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain. |
| Edm |
Entity Data Model representation for an entity property. |
| GeoReplication |
Geo-Replication information for the Secondary Storage Service |
| Logging |
Azure Analytics Logging settings. |
| Metrics |
A summary of request statistics grouped by API |
| NamedKeyCredential |
Represents a credential defined by a static API name and key. |
| RestError |
A custom error type for failed pipeline requests. |
| RetentionPolicy |
The retention policy. |
| SasIPRange |
Allowed IP range for a SAS. |
| ServiceGetPropertiesHeaders |
Defines headers for Service_getProperties operation. |
| ServiceGetStatisticsHeaders |
Defines headers for Service_getStatistics operation. |
| ServiceProperties |
Table Service Properties. |
| ServiceSetPropertiesHeaders |
Defines headers for Service_setProperties operation. |
| SetPropertiesOptions |
Optional parameters. |
| SignedIdentifier |
A signed identifier. |
| TableCreateHeaders |
Defines headers for Table_create operation. |
| TableDeleteEntityHeaders |
Defines headers for Table_deleteEntity operation. |
| TableDeleteHeaders |
Defines headers for Table_delete operation. |
| TableEntityQueryOptions |
OData Query options to limit the set of entities returned. |
| TableGetAccessPolicyHeaders |
Defines headers for Table_getAccessPolicy operation. |
| TableInsertEntityHeaders |
Defines headers for Table_insertEntity operation. |
| TableItem |
The properties for the table item. |
| TableItemResultPage |
Output page type for table query operations |
| TableMergeEntityHeaders |
Defines headers for Table_mergeEntity operation. |
| TableQueryOptions |
OData Query options to limit the set of tables returned. |
| TableQueryResponse |
The properties for the table query response. |
| TableSasPermissions |
A type that looks like a Table SAS permission. Used in TableSasPermissions to parse SAS permissions from raw objects. |
| TableSasSignatureValues |
ONLY AVAILABLE IN NODE.JS RUNTIME. TableSASSignatureValues is used to help generating Table service SAS tokens for tables |
| TableServiceStats |
Stats for the service. |
| TableSetAccessPolicyHeaders |
Defines headers for Table_setAccessPolicy operation. |
| TableTransactionEntityResponse |
Represents a sub-response of a Transaction operation |
| TableTransactionResponse |
Represents the response of a Transaction operation |
| TableUpdateEntityHeaders |
Defines headers for Table_updateEntity operation. |
Type Aliases
| CreateDeleteEntityAction |
Represents the Create or Delete Entity operation to be included in a Transaction request |
| CreateTableEntityResponse |
Contains response data for the createEntity operation. |
| DeleteTableEntityOptions |
Optional parameters for DeleteTableEntity operation |
| DeleteTableEntityResponse |
Contains response data for the deleteEntity operation. |
| EdmTypes |
Supported EDM Types by Azure Tables. |
| GeoReplicationStatusType |
Defines values for GeoReplicationStatusType. Known values supported by the servicelive |
| GetAccessPolicyResponse |
Contains response data for the getAccessPolicy operation. |
| GetPropertiesResponse |
Contains response data for the getProperties operation. |
| GetStatisticsResponse |
Contains response data for the getStatistics operation. |
| GetTableEntityOptions |
GetEntity optional parameters. |
| GetTableEntityResponse |
Contains response data for the listEntities operation. |
| ListTableEntitiesOptions |
List entities optional parameters. |
| ListTableItemsOptions |
List tables optional parameters. |
| SasProtocol |
Protocols for generated SAS. |
| SetAccessPolicyResponse |
Contains response data for the setAccessPolicy operation. |
| SetPropertiesResponse |
Contains response data for the setProperties operation. |
| TableEntity |
A set of key-value pairs representing the table entity. |
| TableEntityResult |
Output type for query operations |
| TableEntityResultPage |
Output page type for query operations |
| TableServiceClientOptions |
Client options used to configure Tables Api requests |
| TransactionAction |
Represents the union of all the available transactional actions |
| UpdateEntityAction |
Represents the Update or Upsert Entity operation to be included in a Transaction request |
| UpdateEntityResponse |
Contains response data for the updateEntity operation. |
| UpdateMode |
The different modes for Update and Upsert methods
|
| UpdateTableEntityOptions |
Update entity optional parameters. |
| UpsertEntityResponse |
Contains response data for the mergeEntity operation. |
Enums
| KnownGeoReplicationStatusType |
Known values of GeoReplicationStatusType that the service accepts. |
Functions
| generate |
Generates a Table Account Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client. See https://free.blessedness.top/en-us/rest/api/storageservices/create-account-sas |
| generate |
Generates a Table Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client. See https://free.blessedness.top/en-us/rest/api/storageservices/constructing-a-service-sas |
| odata(Template |
Escapes an odata filter expression to avoid errors with quoting string literals. Encodes Date objects. |
Function Details
generateAccountSas(NamedKeyCredential, AccountSasOptions)
Generates a Table Account Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
See https://free.blessedness.top/en-us/rest/api/storageservices/create-account-sas
function generateAccountSas(credential: NamedKeyCredential, options?: AccountSasOptions): string
Parameters
- credential
- NamedKeyCredential
- options
- AccountSasOptions
Optional parameters.
Returns
string
An account SAS token
generateTableSas(string, NamedKeyCredential, TableSasSignatureValues)
Generates a Table Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
See https://free.blessedness.top/en-us/rest/api/storageservices/constructing-a-service-sas
function generateTableSas(tableName: string, credential: NamedKeyCredential, options?: TableSasSignatureValues): string
Parameters
- tableName
-
string
- credential
- NamedKeyCredential
- options
- TableSasSignatureValues
Optional parameters.
Returns
string
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
odata(TemplateStringsArray, unknown[])
Escapes an odata filter expression to avoid errors with quoting string literals. Encodes Date objects.
function odata(strings: TemplateStringsArray, values: unknown[]): string
Parameters
- strings
-
TemplateStringsArray
- values
-
unknown[]
Returns
string