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

Successfully retrieved database column.

Name	Datatype	Description
properties	object	Resource properties.

list_by_table

Successfully retrieved database columns.

Name	Datatype	Description
properties	object	Resource properties.

list_by_database

Successfully retrieved database columns.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, databaseName, schemaName, tableName, columnName, subscriptionId		Get database column
list_by_table	select	resourceGroupName, serverName, databaseName, schemaName, tableName, subscriptionId	$filter	List database columns
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId	schema, table, column, orderBy, $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
columnName	string	The name of the column.
databaseName	string	The name of the database.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
schemaName	string	The name of the schema.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
tableName	string	The name of the table.
$filter	string	An OData filter expression that filters elements in the collection.
$skiptoken	string	An opaque token that identifies a starting point in the collection.
column	array
orderBy	array
schema	array
table	array

SELECT examples

get

Get database column

SELECT
properties
FROM azure.sql.database_columns
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND schemaName = '{{ schemaName }}' -- required
AND tableName = '{{ tableName }}' -- required
AND columnName = '{{ columnName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_table

List database columns

SELECT
properties
FROM azure.sql.database_columns
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND schemaName = '{{ schemaName }}' -- required
AND tableName = '{{ tableName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;

list_by_database

List database columns

SELECT
properties
FROM azure.sql.database_columns
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND schema = '{{ schema }}'
AND table = '{{ table }}'
AND column = '{{ column }}'
AND orderBy = '{{ orderBy }}'
AND $skiptoken = '{{ $skiptoken }}'
;