Share via


Monitoring class

Class representing a Monitoring.

Constructors

Monitoring(SynapseClientContext)

Create a Monitoring.

Methods

getApplicationDetails(string, string, string, RequestOptionsBase)

Get one spark application details given the workspace name, pool name and livyid.

getApplicationDetails(string, string, string, RequestOptionsBase, ServiceCallback<SparkJobListViewResponse>)
getApplicationDetails(string, string, string, ServiceCallback<SparkJobListViewResponse>)
getHistoryServerData(string, string, string, string, string, RequestOptionsBase)

Get History Server Data for a given workspace, pool, livyid, appid and attemptId

getHistoryServerData(string, string, string, string, string, RequestOptionsBase, ServiceCallback<HistoryServerDataResponse>)
getHistoryServerData(string, string, string, string, string, ServiceCallback<HistoryServerDataResponse>)
getHistoryServerDiagnostic(string, string, string, string, string, RequestOptionsBase)

Get History Server Diagnostic Data for a given workspace, pool, livyid, appid and attemptId

getHistoryServerDiagnostic(string, string, string, string, string, RequestOptionsBase, ServiceCallback<HistoryServerDiagnosticResponse>)
getHistoryServerDiagnostic(string, string, string, string, string, ServiceCallback<HistoryServerDiagnosticResponse>)
getHistoryServerGraph(string, string, string, string, string, RequestOptionsBase)

Get History Server Graph Data for a given workspace, pool, livyid, appid and attemptId

getHistoryServerGraph(string, string, string, string, string, RequestOptionsBase, ServiceCallback<HistoryServerGraphResponse>)
getHistoryServerGraph(string, string, string, string, string, ServiceCallback<HistoryServerGraphResponse>)
getHistoryServerProperties(string, RequestOptionsBase)

Get History server properties.

getHistoryServerProperties(string, RequestOptionsBase, ServiceCallback<HistoryServerPropertiesResponse>)
getHistoryServerProperties(string, ServiceCallback<HistoryServerPropertiesResponse>)
getSparkJobList(string, RequestOptionsBase)

Get list of spark applications for the workspace.

getSparkJobList(string, RequestOptionsBase, ServiceCallback<SparkJobListViewResponse>)
getSparkJobList(string, ServiceCallback<SparkJobListViewResponse>)

Constructor Details

Monitoring(SynapseClientContext)

Create a Monitoring.

new Monitoring(client: SynapseClientContext)

Parameters

client
SynapseClientContext

Reference to the service client.

Method Details

getApplicationDetails(string, string, string, RequestOptionsBase)

Get one spark application details given the workspace name, pool name and livyid.

function getApplicationDetails(workspaceName: string, poolName: string, livyId: string, options?: RequestOptionsBase): Promise<MonitoringGetApplicationDetailsResponse>

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.MonitoringGetApplicationDetailsResponse>

getApplicationDetails(string, string, string, RequestOptionsBase, ServiceCallback<SparkJobListViewResponse>)

function getApplicationDetails(workspaceName: string, poolName: string, livyId: string, options: RequestOptionsBase, callback: ServiceCallback<SparkJobListViewResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<SparkJobListViewResponse>

The callback

getApplicationDetails(string, string, string, ServiceCallback<SparkJobListViewResponse>)

function getApplicationDetails(workspaceName: string, poolName: string, livyId: string, callback: ServiceCallback<SparkJobListViewResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

callback

ServiceCallback<SparkJobListViewResponse>

The callback

getHistoryServerData(string, string, string, string, string, RequestOptionsBase)

Get History Server Data for a given workspace, pool, livyid, appid and attemptId

function getHistoryServerData(workspaceName: string, poolName: string, livyId: string, appId: string, attemptId: string, options?: RequestOptionsBase): Promise<MonitoringGetHistoryServerDataResponse>

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

appId

string

The application id.

attemptId

string

The attempt id.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.MonitoringGetHistoryServerDataResponse>

getHistoryServerData(string, string, string, string, string, RequestOptionsBase, ServiceCallback<HistoryServerDataResponse>)

function getHistoryServerData(workspaceName: string, poolName: string, livyId: string, appId: string, attemptId: string, options: RequestOptionsBase, callback: ServiceCallback<HistoryServerDataResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

appId

string

The application id.

attemptId

string

The attempt id.

options
RequestOptionsBase

The optional parameters

getHistoryServerData(string, string, string, string, string, ServiceCallback<HistoryServerDataResponse>)

function getHistoryServerData(workspaceName: string, poolName: string, livyId: string, appId: string, attemptId: string, callback: ServiceCallback<HistoryServerDataResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

appId

string

The application id.

attemptId

string

The attempt id.

getHistoryServerDiagnostic(string, string, string, string, string, RequestOptionsBase)

Get History Server Diagnostic Data for a given workspace, pool, livyid, appid and attemptId

function getHistoryServerDiagnostic(workspaceName: string, poolName: string, livyId: string, appId: string, attemptId: string, options?: RequestOptionsBase): Promise<MonitoringGetHistoryServerDiagnosticResponse>

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

appId

string

The application id.

attemptId

string

The attempt id.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.MonitoringGetHistoryServerDiagnosticResponse>

getHistoryServerDiagnostic(string, string, string, string, string, RequestOptionsBase, ServiceCallback<HistoryServerDiagnosticResponse>)

function getHistoryServerDiagnostic(workspaceName: string, poolName: string, livyId: string, appId: string, attemptId: string, options: RequestOptionsBase, callback: ServiceCallback<HistoryServerDiagnosticResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

appId

string

The application id.

attemptId

string

The attempt id.

options
RequestOptionsBase

The optional parameters

getHistoryServerDiagnostic(string, string, string, string, string, ServiceCallback<HistoryServerDiagnosticResponse>)

function getHistoryServerDiagnostic(workspaceName: string, poolName: string, livyId: string, appId: string, attemptId: string, callback: ServiceCallback<HistoryServerDiagnosticResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

appId

string

The application id.

attemptId

string

The attempt id.

getHistoryServerGraph(string, string, string, string, string, RequestOptionsBase)

Get History Server Graph Data for a given workspace, pool, livyid, appid and attemptId

function getHistoryServerGraph(workspaceName: string, poolName: string, livyId: string, appId: string, attemptId: string, options?: RequestOptionsBase): Promise<MonitoringGetHistoryServerGraphResponse>

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

appId

string

The application id.

attemptId

string

The attempt id.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.MonitoringGetHistoryServerGraphResponse>

getHistoryServerGraph(string, string, string, string, string, RequestOptionsBase, ServiceCallback<HistoryServerGraphResponse>)

function getHistoryServerGraph(workspaceName: string, poolName: string, livyId: string, appId: string, attemptId: string, options: RequestOptionsBase, callback: ServiceCallback<HistoryServerGraphResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

appId

string

The application id.

attemptId

string

The attempt id.

options
RequestOptionsBase

The optional parameters

getHistoryServerGraph(string, string, string, string, string, ServiceCallback<HistoryServerGraphResponse>)

function getHistoryServerGraph(workspaceName: string, poolName: string, livyId: string, appId: string, attemptId: string, callback: ServiceCallback<HistoryServerGraphResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

poolName

string

The spark pool name.

livyId

string

The livy id.

appId

string

The application id.

attemptId

string

The attempt id.

getHistoryServerProperties(string, RequestOptionsBase)

Get History server properties.

function getHistoryServerProperties(workspaceName: string, options?: RequestOptionsBase): Promise<MonitoringGetHistoryServerPropertiesResponse>

Parameters

workspaceName

string

The name of the workspace to execute operations on.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.MonitoringGetHistoryServerPropertiesResponse>

getHistoryServerProperties(string, RequestOptionsBase, ServiceCallback<HistoryServerPropertiesResponse>)

function getHistoryServerProperties(workspaceName: string, options: RequestOptionsBase, callback: ServiceCallback<HistoryServerPropertiesResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

options
RequestOptionsBase

The optional parameters

getHistoryServerProperties(string, ServiceCallback<HistoryServerPropertiesResponse>)

function getHistoryServerProperties(workspaceName: string, callback: ServiceCallback<HistoryServerPropertiesResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

getSparkJobList(string, RequestOptionsBase)

Get list of spark applications for the workspace.

function getSparkJobList(workspaceName: string, options?: RequestOptionsBase): Promise<MonitoringGetSparkJobListResponse>

Parameters

workspaceName

string

The name of the workspace to execute operations on.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.MonitoringGetSparkJobListResponse>

getSparkJobList(string, RequestOptionsBase, ServiceCallback<SparkJobListViewResponse>)

function getSparkJobList(workspaceName: string, options: RequestOptionsBase, callback: ServiceCallback<SparkJobListViewResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<SparkJobListViewResponse>

The callback

getSparkJobList(string, ServiceCallback<SparkJobListViewResponse>)

function getSparkJobList(workspaceName: string, callback: ServiceCallback<SparkJobListViewResponse>)

Parameters

workspaceName

string

The name of the workspace to execute operations on.

callback

ServiceCallback<SparkJobListViewResponse>

The callback