TableService class

Definition

This is the main class managing Azure Table resources.

The Azure Table service offers structured storage in the form of tables. Tables store data as collections of entities. Entities are similar to rows. An entity has a primary key and a set of properties. A property is a name, typed-value pair, similar to a column. The Table service does not enforce any schema for tables, so two entities in the same table may have different sets of properties. Developers may choose to enforce a schema on the client side. A table may contain any number of entities.

TableService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)
Inheritance
builtins.object
TableService

Variables

key_encryption_key
object
The key-encryption-key optionally provided by the user. If provided, will be used to encrypt/decrypt in supported methods. For methods requiring decryption, either the key_encryption_key OR the resolver must be provided. If both are provided, the resolver will take precedence. Must implement the following methods for APIs requiring encryption: wrap_key(key)--wraps the specified key (bytes) using an algorithm of the user's choice. Returns the encrypted key as bytes. get_key_wrap_algorithm()--returns the algorithm used to wrap the specified symmetric key. get_kid()--returns a string key id for this key-encryption-key. Must implement the following methods for APIs requiring decryption: unwrap_key(key, algorithm)--returns the unwrapped form of the specified symmetric key using the string-specified algorithm. get_kid()--returns a string key id for this key-encryption-key.
key_resolver_function(kid)
function
A function to resolve keys optionally provided by the user. If provided, will be used to decrypt in supported methods. For methods requiring decryption, either the key_encryption_key OR the resolver must be provided. If both are provided, the resolver will take precedence. It uses the kid string to return a key-encryption-key implementing the interface defined above.
row_key, property_name) encryption_resolver_functions
function(partition_key,
A function that takes in an entity's partition key, row key, and property name and returns a boolean that indicates whether that property should be encrypted.
require_encryption
bool
A flag that may be set to ensure that all messages successfully uploaded to the queue and all those downloaded and successfully read from the queue are/were encrypted while on the server. If this flag is set, all required parameters for encryption/decryption must be provided. See the above comments on the key_encryption_key and resolver.

Methods

batch(table_name, timeout=None)

Creates a batch object which can be used as a context manager. Commits the batch on exit.

commit_batch(table_name, batch, timeout=None)

Commits a <xref:azure.storage.table.TableBatch> request.

create_table(table_name, fail_on_exist=False, timeout=None)

Creates a new table in the storage account.

delete_entity(table_name, partition_key, row_key, if_match='*', timeout=None)

Deletes an existing entity in a table. Throws if the entity does not exist.

When an entity is successfully deleted, the entity is immediately marked for deletion and is no longer accessible to clients. The entity is later removed from the Table service during garbage collection.

delete_table(table_name, fail_not_exist=False, timeout=None)

Deletes the specified table and any data it contains.

When a table is successfully deleted, it is immediately marked for deletion and is no longer accessible to clients. The table is later removed from the Table service during garbage collection.

Note that deleting a table is likely to take at least 40 seconds to complete. If an operation is attempted against the table while it was being deleted, an <xref:azure.cosmosdb.table.tableservice.AzureConflictHttpError> will be thrown.

exists(table_name, timeout=None)

Returns a boolean indicating whether the table exists.

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

Generates a shared access signature for the table service. Use the returned signature with the sas_token parameter of TableService.

generate_table_shared_access_signature(table_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, start_pk=None, start_rk=None, end_pk=None, end_rk=None)

Generates a shared access signature for the table. Use the returned signature with the sas_token parameter of TableService.

get_entity(table_name, partition_key, row_key, select=None, accept='application/json;odata=minimalmetadata', property_resolver=None, timeout=None)

Get an entity from the specified table. Throws if the entity does not exist.

get_table_acl(table_name, timeout=None)

Returns details about any stored access policies specified on the table that may be used with Shared Access Signatures.

get_table_service_properties(timeout=None)

Gets the properties of a storage account's Table service, including logging, analytics and CORS rules.

get_table_service_stats(timeout=None)

Retrieves statistics related to replication for the Table service. It is only available when read-access geo-redundant replication is enabled for the storage account.

With geo-redundant replication, Azure Storage maintains your data durable in two locations. In both locations, Azure Storage constantly maintains multiple healthy replicas of your data. The location where you read, create, update, or delete data is the primary storage account location. The primary location exists in the region you choose at the time you create an account via the Azure Management Azure classic portal, for example, North Central US. The location to which your data is replicated is the secondary location. The secondary location is automatically determined based on the location of the primary; it is in a second data center that resides in the same region as the primary location. Read-only access is available from the secondary location, if read-access geo-redundant replication is enabled for your storage account.

insert_entity(table_name, entity, timeout=None)

Inserts a new entity into the table. Throws if an entity with the same PartitionKey and RowKey already exists.

When inserting an entity into a table, you must specify values for the PartitionKey and RowKey system properties. Together, these properties form the primary key and must be unique within the table. Both the PartitionKey and RowKey values must be string values; each key value may be up to 64 KB in size. If you are using an integer value for the key value, you should convert the integer to a fixed-width string, because they are canonically sorted. For example, you should convert the value 1 to 0000001 to ensure proper sorting.

insert_or_merge_entity(table_name, entity, timeout=None)

Merges an existing entity or inserts a new entity if it does not exist in the table.

If insert_or_merge_entity is used to merge an entity, any properties from the previous entity will be retained if the request does not define or include them.

insert_or_replace_entity(table_name, entity, timeout=None)

Replaces an existing entity or inserts a new entity if it does not exist in the table. Because this operation can insert or update an entity, it is also known as an "upsert" operation.

If insert_or_replace_entity is used to replace an entity, any properties from the previous entity will be removed if the new entity does not define them.

list_tables(num_results=None, marker=None, timeout=None)

Returns a generator to list the tables. The generator will lazily follow the continuation tokens returned by the service and stop when all tables have been returned or num_results is reached.

If num_results is specified and the account has more than that number of tables, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired.

merge_entity(table_name, entity, if_match='*', timeout=None)

Updates an existing entity by merging the entity's properties. Throws if the entity does not exist.

This operation does not replace the existing entity as the update_entity operation does. A property cannot be removed with merge_entity.

Any properties with null values are ignored. All other properties will be updated or added.

query_entities(table_name, filter=None, select=None, num_results=None, marker=None, accept='application/json;odata=minimalmetadata', property_resolver=None, timeout=None)

Returns a generator to list the entities in the table specified. The generator will lazily follow the continuation tokens returned by the service and stop when all entities have been returned or num_results is reached.

If num_results is specified and the account has more than that number of entities, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired.

set_table_acl(table_name, signed_identifiers=None, timeout=None)

Sets stored access policies for the table that may be used with Shared Access Signatures.

When you set permissions for a table, the existing permissions are replaced. To update the table's permissions, call get_table_acl(table_name, timeout=None) to fetch all access policies associated with the table, modify the access policy that you wish to change, and then call this function with the complete set of data to perform the update.

When you establish a stored access policy on a table, it may take up to 30 seconds to take effect. During this interval, a shared access signature that is associated with the stored access policy will throw an <xref:azure.cosmosdb.table.tableservice.AzureHttpError> until the access policy becomes active.

set_table_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

Sets the properties of a storage account's Table service, including Azure Storage Analytics. If an element (ex Logging) is left as None, the existing settings on the service for that functionality are preserved. For more information on Azure Storage Analytics, see https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx.

update_entity(table_name, entity, if_match='*', timeout=None)

Updates an existing entity in a table. Throws if the entity does not exist. The update_entity operation replaces the entire entity and can be used to remove properties.

batch(table_name, timeout=None)

Creates a batch object which can be used as a context manager. Commits the batch on exit.

batch(table_name, timeout=None)

Parameters

table_name
str

The name of the table to commit the batch to.

timeout
int

The server timeout, expressed in seconds.

commit_batch(table_name, batch, timeout=None)

Commits a <xref:azure.storage.table.TableBatch> request.

commit_batch(table_name, batch, timeout=None)

Parameters

table_name
str

The name of the table to commit the batch to.

batch
TableBatch

The batch to commit.

timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

A list of the batch responses corresponding to the requests in the batch. The items could either be an etag, in case of success, or an error object in case of failure.

Return type

list(<xref:azure.storage.table.models.AzureBatchOperationError>, str)

create_table(table_name, fail_on_exist=False, timeout=None)

Creates a new table in the storage account.

create_table(table_name, fail_on_exist=False, timeout=None)

Parameters

table_name
str

The name of the table to create. The table name may contain only alphanumeric characters and cannot begin with a numeric character. It is case-insensitive and must be from 3 to 63 characters long.

fail_on_exist
bool

Specifies whether to throw an exception if the table already exists.

default value: False
timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

A boolean indicating whether the table was created. If fail_on_exist was set to True, this will throw instead of returning false.

Return type

delete_entity(table_name, partition_key, row_key, if_match='*', timeout=None)

Deletes an existing entity in a table. Throws if the entity does not exist.

When an entity is successfully deleted, the entity is immediately marked for deletion and is no longer accessible to clients. The entity is later removed from the Table service during garbage collection.

delete_entity(table_name, partition_key, row_key, if_match='*', timeout=None)

Parameters

table_name
str

The name of the table containing the entity to delete.

partition_key
str

The PartitionKey of the entity.

row_key
str

The RowKey of the entity.

if_match
str

The client may specify the ETag for the entity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation will be performed only if the ETag sent by the client matches the value maintained by the server, indicating that the entity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*).

default value: *
timeout
int

The server timeout, expressed in seconds.

default value: None

delete_table(table_name, fail_not_exist=False, timeout=None)

Deletes the specified table and any data it contains.

When a table is successfully deleted, it is immediately marked for deletion and is no longer accessible to clients. The table is later removed from the Table service during garbage collection.

Note that deleting a table is likely to take at least 40 seconds to complete. If an operation is attempted against the table while it was being deleted, an <xref:azure.cosmosdb.table.tableservice.AzureConflictHttpError> will be thrown.

delete_table(table_name, fail_not_exist=False, timeout=None)

Parameters

table_name
str

The name of the table to delete.

fail_not_exist
bool

Specifies whether to throw an exception if the table doesn't exist.

default value: False
timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

A boolean indicating whether the table was deleted. If fail_not_exist was set to True, this will throw instead of returning false.

Return type

exists(table_name, timeout=None)

Returns a boolean indicating whether the table exists.

exists(table_name, timeout=None)

Parameters

table_name
str

The name of table to check for existence.

timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

A boolean indicating whether the table exists.

Return type

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

Generates a shared access signature for the table service. Use the returned signature with the sas_token parameter of TableService.

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

Parameters

resource_types
ResourceTypes

Specifies the resource types that are accessible with the account SAS.

permission
AccountPermissions

The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy.

expiry
datetime or str

The time at which the shared access signature becomes invalid. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.

start
datetime or str

The time at which the shared access signature becomes valid. If omitted, start time for this call is assumed to be the time when the storage service receives the request. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.

default value: None
ip
str

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. For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses.

default value: None
protocol
str

Specifies the protocol permitted for a request made. The default value is https,http. See Protocol for possible values.

default value: None

Returns

A Shared Access Signature (sas) token.

Return type

str

generate_table_shared_access_signature(table_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, start_pk=None, start_rk=None, end_pk=None, end_rk=None)

Generates a shared access signature for the table. Use the returned signature with the sas_token parameter of TableService.

generate_table_shared_access_signature(table_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, start_pk=None, start_rk=None, end_pk=None, end_rk=None)

Parameters

table_name
str

The name of the table to create a SAS token for.

permission
TablePermissions

The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy.

default value: None
expiry
datetime or str

The time at which the shared access signature becomes invalid. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.

default value: None
start
datetime or str

The time at which the shared access signature becomes valid. If omitted, start time for this call is assumed to be the time when the storage service receives the request. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.

default value: None
id
str

A unique value up to 64 characters in length that correlates to a stored access policy. To create a stored access policy, use <xref:azure.cosmosdb.table.tableservice.set_table_acl>.

default value: None
ip
str

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. For example, specifying sip='168.1.5.65' or sip='168.1.5.60-168.1.5.70' on the SAS restricts the request to those IP addresses.

default value: None
protocol
str

Specifies the protocol permitted for a request made. The default value is https,http. See Protocol for possible values.

default value: None
start_pk
str

The minimum partition key accessible with this shared access signature. startpk must accompany startrk. Key values are inclusive. If omitted, there is no lower bound on the table entities that can be accessed.

default value: None
start_rk
str

The minimum row key accessible with this shared access signature. startpk must accompany startrk. Key values are inclusive. If omitted, there is no lower bound on the table entities that can be accessed.

default value: None
end_pk
str

The maximum partition key accessible with this shared access signature. endpk must accompany endrk. Key values are inclusive. If omitted, there is no upper bound on the table entities that can be accessed.

default value: None
end_rk
str

The maximum row key accessible with this shared access signature. endpk must accompany endrk. Key values are inclusive. If omitted, there is no upper bound on the table entities that can be accessed.

default value: None

Returns

A Shared Access Signature (sas) token.

Return type

str

get_entity(table_name, partition_key, row_key, select=None, accept='application/json;odata=minimalmetadata', property_resolver=None, timeout=None)

Get an entity from the specified table. Throws if the entity does not exist.

get_entity(table_name, partition_key, row_key, select=None, accept='application/json;odata=minimalmetadata', property_resolver=None, timeout=None)

Parameters

table_name
str

The name of the table to get the entity from.

partition_key
str

The PartitionKey of the entity.

row_key
str

The RowKey of the entity.

select
str

Returns only the desired properties of an entity from the set.

default value: None
accept
str

Specifies the accepted content type of the response payload. See <xref:azure.storage.table.models.TablePayloadFormat> for possible values.

default value: application/json;odata=minimalmetadata
property_resolver
func(pk or rk or prop_name or prop_value or service_edm_type)

A function which given the partition key, row key, property name, property value, and the property EdmType if returned by the service, returns the EdmType of the property. Generally used if accept is set to JSON_NO_METADATA.

default value: None
timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

The retrieved entity.

Return type

<xref:azure.storage.table.models.Entity>

get_table_acl(table_name, timeout=None)

Returns details about any stored access policies specified on the table that may be used with Shared Access Signatures.

get_table_acl(table_name, timeout=None)

Parameters

table_name
str

The name of an existing table.

timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

A dictionary of access policies associated with the table.

Return type

dict(str, <xref:azure.storage.common.models.AccessPolicy>)

get_table_service_properties(timeout=None)

Gets the properties of a storage account's Table service, including logging, analytics and CORS rules.

get_table_service_properties(timeout=None)

Parameters

timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

The table service properties.

Return type

<xref:azure.storage.common.models.ServiceProperties>

get_table_service_stats(timeout=None)

Retrieves statistics related to replication for the Table service. It is only available when read-access geo-redundant replication is enabled for the storage account.

With geo-redundant replication, Azure Storage maintains your data durable in two locations. In both locations, Azure Storage constantly maintains multiple healthy replicas of your data. The location where you read, create, update, or delete data is the primary storage account location. The primary location exists in the region you choose at the time you create an account via the Azure Management Azure classic portal, for example, North Central US. The location to which your data is replicated is the secondary location. The secondary location is automatically determined based on the location of the primary; it is in a second data center that resides in the same region as the primary location. Read-only access is available from the secondary location, if read-access geo-redundant replication is enabled for your storage account.

get_table_service_stats(timeout=None)

Parameters

timeout
int

The timeout parameter is expressed in seconds.

default value: None

Returns

The table service stats.

Return type

<xref:azure.storage.common.models.ServiceStats>

insert_entity(table_name, entity, timeout=None)

Inserts a new entity into the table. Throws if an entity with the same PartitionKey and RowKey already exists.

When inserting an entity into a table, you must specify values for the PartitionKey and RowKey system properties. Together, these properties form the primary key and must be unique within the table. Both the PartitionKey and RowKey values must be string values; each key value may be up to 64 KB in size. If you are using an integer value for the key value, you should convert the integer to a fixed-width string, because they are canonically sorted. For example, you should convert the value 1 to 0000001 to ensure proper sorting.

insert_entity(table_name, entity, timeout=None)

Parameters

table_name
str

The name of the table to insert the entity into.

entity
dict or <xref:azure.storage.table.models.Entity>

The entity to insert. Could be a dict or an entity object. Must contain a PartitionKey and a RowKey.

timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

The etag of the inserted entity.

Return type

str

insert_or_merge_entity(table_name, entity, timeout=None)

Merges an existing entity or inserts a new entity if it does not exist in the table.

If insert_or_merge_entity is used to merge an entity, any properties from the previous entity will be retained if the request does not define or include them.

insert_or_merge_entity(table_name, entity, timeout=None)

Parameters

table_name
str

The name of the table in which to insert or merge the entity.

entity
dict or <xref:azure.storage.table.models.Entity>

The entity to insert or merge. Could be a dict or an entity object. Must contain a PartitionKey and a RowKey.

timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

The etag of the entity.

Return type

str

insert_or_replace_entity(table_name, entity, timeout=None)

Replaces an existing entity or inserts a new entity if it does not exist in the table. Because this operation can insert or update an entity, it is also known as an "upsert" operation.

If insert_or_replace_entity is used to replace an entity, any properties from the previous entity will be removed if the new entity does not define them.

insert_or_replace_entity(table_name, entity, timeout=None)

Parameters

table_name
str

The name of the table in which to insert or replace the entity.

entity
dict or <xref:azure.storage.table.models.Entity>

The entity to insert or replace. Could be a dict or an entity object. Must contain a PartitionKey and a RowKey.

timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

The etag of the entity.

Return type

str

list_tables(num_results=None, marker=None, timeout=None)

Returns a generator to list the tables. The generator will lazily follow the continuation tokens returned by the service and stop when all tables have been returned or num_results is reached.

If num_results is specified and the account has more than that number of tables, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired.

list_tables(num_results=None, marker=None, timeout=None)

Parameters

num_results
int

The maximum number of tables to return.

default value: None
marker
obj

An opaque continuation object. This value can be retrieved from the next_marker field of a previous generator object if num_results was specified and that generator has finished enumerating results. If specified, this generator will begin returning results from the point where the previous generator stopped.

default value: None
timeout
int

The server timeout, expressed in seconds. This function may make multiple calls to the service in which case the timeout value specified will be applied to each individual call.

default value: None

Returns

A generator which produces <xref:azure.storage.common.models.table.Table> objects.

Return type

<xref:azure.storage.common.models.ListGenerator>:

merge_entity(table_name, entity, if_match='*', timeout=None)

Updates an existing entity by merging the entity's properties. Throws if the entity does not exist.

This operation does not replace the existing entity as the update_entity operation does. A property cannot be removed with merge_entity.

Any properties with null values are ignored. All other properties will be updated or added.

merge_entity(table_name, entity, if_match='*', timeout=None)

Parameters

table_name
str

The name of the table containing the entity to merge.

entity
dict or <xref:azure.storage.table.models.Entity>

The entity to merge. Could be a dict or an entity object. Must contain a PartitionKey and a RowKey.

if_match
str

The client may specify the ETag for the entity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The merge operation will be performed only if the ETag sent by the client matches the value maintained by the server, indicating that the entity has not been modified since it was retrieved by the client. To force an unconditional merge, set If-Match to the wildcard character (*).

default value: *
timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

The etag of the entity.

Return type

str

query_entities(table_name, filter=None, select=None, num_results=None, marker=None, accept='application/json;odata=minimalmetadata', property_resolver=None, timeout=None)

Returns a generator to list the entities in the table specified. The generator will lazily follow the continuation tokens returned by the service and stop when all entities have been returned or num_results is reached.

If num_results is specified and the account has more than that number of entities, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired.

query_entities(table_name, filter=None, select=None, num_results=None, marker=None, accept='application/json;odata=minimalmetadata', property_resolver=None, timeout=None)

Parameters

table_name
str

The name of the table to query.

filter
str

Returns only entities that satisfy the specified filter. Note that no more than 15 discrete comparisons are permitted within a $filter string. See http://msdn.microsoft.com/en-us/library/windowsazure/dd894031.aspx for more information on constructing filters.

default value: None
select
str

Returns only the desired properties of an entity from the set.

default value: None
num_results
int

The maximum number of entities to return.

default value: None
marker
obj

An opaque continuation object. This value can be retrieved from the next_marker field of a previous generator object if max_results was specified and that generator has finished enumerating results. If specified, this generator will begin returning results from the point where the previous generator stopped.

default value: None
accept
str

Specifies the accepted content type of the response payload. See <xref:azure.storage.table.models.TablePayloadFormat> for possible values.

default value: application/json;odata=minimalmetadata
property_resolver
func(pk or rk or prop_name or prop_value or service_edm_type)

A function which given the partition key, row key, property name, property value, and the property EdmType if returned by the service, returns the EdmType of the property. Generally used if accept is set to JSON_NO_METADATA.

default value: None
timeout
int

The server timeout, expressed in seconds. This function may make multiple calls to the service in which case the timeout value specified will be applied to each individual call.

default value: None

Returns

A generator which produces <xref:azure.storage.table.models.Entity> objects.

Return type

<xref:azure.storage.common.models.ListGenerator>

set_table_acl(table_name, signed_identifiers=None, timeout=None)

Sets stored access policies for the table that may be used with Shared Access Signatures.

When you set permissions for a table, the existing permissions are replaced. To update the table's permissions, call get_table_acl(table_name, timeout=None) to fetch all access policies associated with the table, modify the access policy that you wish to change, and then call this function with the complete set of data to perform the update.

When you establish a stored access policy on a table, it may take up to 30 seconds to take effect. During this interval, a shared access signature that is associated with the stored access policy will throw an <xref:azure.cosmosdb.table.tableservice.AzureHttpError> until the access policy becomes active.

set_table_acl(table_name, signed_identifiers=None, timeout=None)

Parameters

table_name
str

The name of an existing table.

signed_identifiers
dict(str or <xref:azure.storage.common.models.AccessPolicy>)

A dictionary of access policies to associate with the table. The dictionary may contain up to 5 elements. An empty dictionary will clear the access policies set on the service.

default value: None
timeout
int

The server timeout, expressed in seconds.

default value: None

set_table_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

Sets the properties of a storage account's Table service, including Azure Storage Analytics. If an element (ex Logging) is left as None, the existing settings on the service for that functionality are preserved. For more information on Azure Storage Analytics, see https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx.

set_table_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

Parameters

logging
Logging

The logging settings provide request logs.

default value: None
hour_metrics
Metrics

The hour metrics settings provide a summary of request statistics grouped by API in hourly aggregates for tables.

default value: None
minute_metrics
Metrics

The minute metrics settings provide request statistics for each minute for tables.

default value: None
cors
list(<xref:azure.storage.common.models.CorsRule>)

You can include up to five CorsRule elements in the list. If an empty list is specified, all CORS rules will be deleted, and CORS will be disabled for the service. For detailed information about CORS rules and evaluation logic, see https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx.

default value: None
timeout
int

The server timeout, expressed in seconds.

default value: None

update_entity(table_name, entity, if_match='*', timeout=None)

Updates an existing entity in a table. Throws if the entity does not exist. The update_entity operation replaces the entire entity and can be used to remove properties.

update_entity(table_name, entity, if_match='*', timeout=None)

Parameters

table_name
str

The name of the table containing the entity to update.

entity
dict or <xref:azure.storage.table.models.Entity>

The entity to update. Could be a dict or an entity object. Must contain a PartitionKey and a RowKey.

if_match
str

The client may specify the ETag for the entity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The update operation will be performed only if the ETag sent by the client matches the value maintained by the server, indicating that the entity has not been modified since it was retrieved by the client. To force an unconditional update, set If-Match to the wildcard character (*).

default value: *
timeout
int

The server timeout, expressed in seconds.

default value: None

Returns

The etag of the entity.

Return type

str