monitoring

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

Overview

Name	monitoring
Type	Resource
Id	azure.synapse_monitoring.monitoring

Fields

The following fields are returned by SELECT queries:

get_spark_job_list

Name	Datatype	Description
nJobs	integer
sparkJobs	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_spark_job_list	select	endpoint	x-ms-client-request-id	Get list of spark applications for the workspace.
get_sql_job_query_string	exec	endpoint	filter, $orderby, skip, x-ms-client-request-id	Get SQL OD/DW Query for the workspace.

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
endpoint	string	The service endpoint host (no scheme). (default: )
$orderby	string	:type orderby: str
filter	string	:type filter: str
skip	string	:type skip: str
x-ms-client-request-id	string	Can provide a guid, which is helpful for debugging and to provide better customer support.

SELECT examples

get_spark_job_list

Get list of spark applications for the workspace.

SELECT
nJobs,
sparkJobs
FROM azure.synapse_monitoring.monitoring
WHERE endpoint = '{{ endpoint }}' -- required
AND x-ms-client-request-id = '{{ x-ms-client-request-id }}'
;

Lifecycle Methods

get_sql_job_query_string

Get SQL OD/DW Query for the workspace.

EXEC azure.synapse_monitoring.monitoring.get_sql_job_query_string 
@endpoint='{{ endpoint }}' --required, 
@filter='{{ filter }}', 
@$orderby='{{ $orderby }}', 
@skip='{{ skip }}', 
@x-ms-client-request-id='{{ x-ms-client-request-id }}'
;