synapse_link_workspaces

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

Overview

Name	synapse_link_workspaces
Type	Resource
Id	azure.sql.synapse_link_workspaces

Fields

The following fields are returned by SELECT queries:

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.
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".
workspaces	array	List of all synapselink workspaces.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_database	select	resource_group_name, server_name, database_name, subscription_id		Gets all synapselink workspaces for a database.

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.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

list_by_database

Gets all synapselink workspaces for a database.

SELECT
id,
name,
systemData,
type,
workspaces
FROM azure.sql.synapse_link_workspaces
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
;