database_schemas

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

Overview

Name	database_schemas
Type	Resource
Id	azure.sql.database_schemas

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved database schema.

Name	Datatype	Description

list_by_database

Successfully retrieved database schemas.

Name	Datatype	Description
nextLink	string	Link to retrieve next page of results.
value	array	Array of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, databaseName, schemaName, subscriptionId		Get database schema
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId	$filter	List database schemas

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
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.
$filter	string	An OData filter expression that filters elements in the collection.

SELECT examples

get

Get database schema

SELECT
*
FROM azure.sql.database_schemas
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND schemaName = '{{ schemaName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_database

List database schemas

SELECT
nextLink,
value
FROM azure.sql.database_schemas
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;