MonitoringOperations Class

MonitoringOperations async operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Inheritance

builtins.object

MonitoringOperations

Constructor

MonitoringOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

Methods

get_application_details	Get one spark application details given the workspace name, pool name and livyid.
get_history_server_data	Get History Server Data for a given workspace, pool, livyid, appid and attemptId.
get_history_server_diagnostic	Get History Server Diagnostic Data for a given workspace, pool, livyid, appid and attemptId.
get_history_server_graph	Get History Server Graph Data for a given workspace, pool, livyid, appid and attemptId.
get_history_server_properties	Get History server properties.
get_spark_job_list	Get list of spark applications for the workspace.

get_application_details

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

async get_application_details(workspace_name: str, pool_name: str, livy_id: str, **kwargs) -> SparkJobListViewResponse

Parameters

Name	Description
workspace_name Required	str The name of the workspace to execute operations on.
pool_name Required	str The spark pool name.
livy_id Required	str The livy id.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
SparkJobListViewResponse, None	SparkJobListViewResponse or or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_history_server_data

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

async get_history_server_data(workspace_name: str, pool_name: str, livy_id: str, app_id: str, attempt_id: str, **kwargs) -> HistoryServerDataResponse

Parameters

Name	Description
workspace_name Required	str The name of the workspace to execute operations on.
pool_name Required	str The spark pool name.
livy_id Required	str The livy id.
app_id Required	str The application id.
attempt_id Required	str The attempt id.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
HistoryServerDataResponse, None	HistoryServerDataResponse or or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_history_server_diagnostic

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

async get_history_server_diagnostic(workspace_name: str, pool_name: str, livy_id: str, app_id: str, attempt_id: str, **kwargs) -> HistoryServerDiagnosticResponse

Parameters

Name	Description
workspace_name Required	str The name of the workspace to execute operations on.
pool_name Required	str The spark pool name.
livy_id Required	str The livy id.
app_id Required	str The application id.
attempt_id Required	str The attempt id.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
HistoryServerDiagnosticResponse, None	HistoryServerDiagnosticResponse or or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_history_server_graph

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

async get_history_server_graph(workspace_name: str, pool_name: str, livy_id: str, app_id: str, attempt_id: str, **kwargs) -> HistoryServerGraphResponse

Parameters

Name	Description
workspace_name Required	str The name of the workspace to execute operations on.
pool_name Required	str The spark pool name.
livy_id Required	str The livy id.
app_id Required	str The application id.
attempt_id Required	str The attempt id.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
HistoryServerGraphResponse, None	HistoryServerGraphResponse or or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_history_server_properties

Get History server properties.

async get_history_server_properties(workspace_name: str, **kwargs) -> HistoryServerPropertiesResponse

Parameters

Name	Description
workspace_name Required	str The name of the workspace to execute operations on.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
HistoryServerPropertiesResponse, None	HistoryServerPropertiesResponse or or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_spark_job_list

Get list of spark applications for the workspace.

async get_spark_job_list(workspace_name: str, **kwargs) -> SparkJobListViewResponse

Parameters

Name	Description
workspace_name Required	str The name of the workspace to execute operations on.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
SparkJobListViewResponse, None	SparkJobListViewResponse or or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.synapse.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\synapse\\models\\__init__.py'>