database_columns

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

Overview

Name	database_columns
Type	Resource
Id	azure.sql.database_columns

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.
columnType	string	The column data type. Known values are: "image", "text", "uniqueidentifier", "date", "time", "datetime2", "datetimeoffset", "tinyint", "smallint", "int", "smalldatetime", "real", "money", "datetime", "float", "sql_variant", "ntext", "bit", "decimal", "numeric", "smallmoney", "bigint", "hierarchyid", "geometry", "geography", "varbinary", "varchar", "binary", "char", "timestamp", "nvarchar", "nchar", "xml", and "sysname". (image, text, uniqueidentifier, date, time, datetime2, datetimeoffset, tinyint, smallint, int, smalldatetime, real, money, datetime, float, sql_variant, ntext, bit, decimal, numeric, smallmoney, bigint, hierarchyid, geometry, geography, varbinary, varchar, binary, char, timestamp, nvarchar, nchar, xml, sysname)
isComputed	boolean	Whether or not the column is computed.
memoryOptimized	boolean	Whether or not the column belongs to a memory optimized table.
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_table

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.
columnType	string	The column data type. Known values are: "image", "text", "uniqueidentifier", "date", "time", "datetime2", "datetimeoffset", "tinyint", "smallint", "int", "smalldatetime", "real", "money", "datetime", "float", "sql_variant", "ntext", "bit", "decimal", "numeric", "smallmoney", "bigint", "hierarchyid", "geometry", "geography", "varbinary", "varchar", "binary", "char", "timestamp", "nvarchar", "nchar", "xml", and "sysname". (image, text, uniqueidentifier, date, time, datetime2, datetimeoffset, tinyint, smallint, int, smalldatetime, real, money, datetime, float, sql_variant, ntext, bit, decimal, numeric, smallmoney, bigint, hierarchyid, geometry, geography, varbinary, varchar, binary, char, timestamp, nvarchar, nchar, xml, sysname)
isComputed	boolean	Whether or not the column is computed.
memoryOptimized	boolean	Whether or not the column belongs to a memory optimized table.
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_database

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.
columnType	string	The column data type. Known values are: "image", "text", "uniqueidentifier", "date", "time", "datetime2", "datetimeoffset", "tinyint", "smallint", "int", "smalldatetime", "real", "money", "datetime", "float", "sql_variant", "ntext", "bit", "decimal", "numeric", "smallmoney", "bigint", "hierarchyid", "geometry", "geography", "varbinary", "varchar", "binary", "char", "timestamp", "nvarchar", "nchar", "xml", and "sysname". (image, text, uniqueidentifier, date, time, datetime2, datetimeoffset, tinyint, smallint, int, smalldatetime, real, money, datetime, float, sql_variant, ntext, bit, decimal, numeric, smallmoney, bigint, hierarchyid, geometry, geography, varbinary, varchar, binary, char, timestamp, nvarchar, nchar, xml, sysname)
isComputed	boolean	Whether or not the column is computed.
memoryOptimized	boolean	Whether or not the column belongs to a memory optimized table.
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, column_name, subscription_id		Get database column.
list_by_table	select	resource_group_name, server_name, database_name, schema_name, table_name, subscription_id	$filter	List database columns.
list_by_database	select	resource_group_name, server_name, database_name, subscription_id	$skiptoken	List database columns.

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
column_name	string	The name of the column. Required.
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.
$skiptoken	string	An opaque token that identifies a starting point in the collection. Default value is None.

SELECT examples

get

Get database column.

SELECT
id,
name,
columnType,
isComputed,
memoryOptimized,
systemData,
temporalType,
type
FROM azure.sql.database_columns
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 column_name = '{{ column_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_table

List database columns.

SELECT
id,
name,
columnType,
isComputed,
memoryOptimized,
systemData,
temporalType,
type
FROM azure.sql.database_columns
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
AND $filter = '{{ $filter }}'
;

list_by_database

List database columns.

SELECT
id,
name,
columnType,
isComputed,
memoryOptimized,
systemData,
temporalType,
type
FROM azure.sql.database_columns
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;