database_tables

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

Overview

Name	database_tables
Type	Resource
Id	azure.sql.database_tables

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
memoryOptimized	boolean	Whether or not the table is memory optimized.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
temporalType	string	The table temporal type. Known values are: "NonTemporalTable", "HistoryTable", and "SystemVersionedTemporalTable". (NonTemporalTable, HistoryTable, SystemVersionedTemporalTable)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_schema

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
memoryOptimized	boolean	Whether or not the table is memory optimized.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
temporalType	string	The table temporal type. Known values are: "NonTemporalTable", "HistoryTable", and "SystemVersionedTemporalTable". (NonTemporalTable, HistoryTable, SystemVersionedTemporalTable)
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	resource_group_name, server_name, database_name, schema_name, table_name, subscription_id		Get database table.
list_by_schema	select	resource_group_name, server_name, database_name, schema_name, subscription_id	$filter	List database tables.

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
database_name	string	The name of the database. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
schema_name	string	The name of the schema. Required.
server_name	string	The name of the server. Required.
subscription_id	string
table_name	string	The name of the table. Required.
$filter	string	An OData filter expression that filters elements in the collection. Default value is None.

SELECT examples

get

Get database table.

SELECT
id,
name,
memoryOptimized,
systemData,
temporalType,
type
FROM azure.sql.database_tables
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND table_name = '{{ table_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_schema

List database tables.

SELECT
id,
name,
memoryOptimized,
systemData,
temporalType,
type
FROM azure.sql.database_tables
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;