tables

Creates, updates, deletes, gets or lists a tables resource.

Overview

Name	tables
Type	Resource
Id	azure.storage.tables

Fields

The following fields are returned by SELECT queries:

get

OK -- returned table with the specified table name successfully.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Table resource properties. (x-ms-client-name: TableProperties)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

OK -- returned a list of tables successfully.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Table resource properties. (x-ms-client-name: TableProperties)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, accountName, subscriptionId, tableName		Gets the table with the specified table name, under the specified account if it exists.
list	select	resourceGroupName, accountName, subscriptionId		Gets a list of all the tables under the specified storage account
create	insert	resourceGroupName, accountName, subscriptionId, tableName		Creates a new table with the specified table name, under the specified account.
update	update	resourceGroupName, accountName, subscriptionId, tableName		Creates a new table with the specified table name, under the specified account.
delete	delete	resourceGroupName, accountName, subscriptionId, tableName		Deletes the table with the specified table name, under the specified account if it exists.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
tableName	string	A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character.

SELECT examples

get

Gets the table with the specified table name, under the specified account if it exists.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.tables
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND tableName = '{{ tableName }}' -- required
;

list

Gets a list of all the tables under the specified storage account

SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.tables
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new table with the specified table name, under the specified account.

INSERT INTO azure.storage.tables (
data__properties,
resourceGroupName,
accountName,
subscriptionId,
tableName
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ subscriptionId }}',
'{{ tableName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: tables
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the tables resource.
    - name: accountName
      value: string
      description: Required parameter for the tables resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the tables resource.
    - name: tableName
      value: string
      description: Required parameter for the tables resource.
    - name: properties
      value: object
      description: |
        Table resource properties.

UPDATE examples

update

Creates a new table with the specified table name, under the specified account.

UPDATE azure.storage.tables
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND tableName = '{{ tableName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the table with the specified table name, under the specified account if it exists.

DELETE FROM azure.storage.tables
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND tableName = '{{ tableName }}' --required
;