azure.synapse.aio.operations_async package

class azure.synapse.aio.operations_async.MonitoringOperations(client, config, serializer, deserializer)[source]

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.

Variables

models – Alias to model classes used in this operation group.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

async get_application_details(workspace_name: str, pool_name: str, livy_id: str, **kwargs) → azure.synapse.models._models_py3.SparkJobListViewResponse[source]

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

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • pool_name (str) – The spark pool name.

  • livy_id (str) – The livy id.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SparkJobListViewResponse or or the result of cls(response)

Return type

SparkJobListViewResponse or None

Raises

~azure.core.exceptions.HttpResponseError

async get_history_server_data(workspace_name: str, pool_name: str, livy_id: str, app_id: str, attempt_id: str, **kwargs) → azure.synapse.models._models_py3.HistoryServerDataResponse[source]

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

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • pool_name (str) – The spark pool name.

  • livy_id (str) – The livy id.

  • app_id (str) – The application id.

  • attempt_id (str) – The attempt id.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

HistoryServerDataResponse or or the result of cls(response)

Return type

HistoryServerDataResponse or None

Raises

~azure.core.exceptions.HttpResponseError

async get_history_server_diagnostic(workspace_name: str, pool_name: str, livy_id: str, app_id: str, attempt_id: str, **kwargs) → azure.synapse.models._models_py3.HistoryServerDiagnosticResponse[source]

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

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • pool_name (str) – The spark pool name.

  • livy_id (str) – The livy id.

  • app_id (str) – The application id.

  • attempt_id (str) – The attempt id.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

HistoryServerDiagnosticResponse or or the result of cls(response)

Return type

HistoryServerDiagnosticResponse or None

Raises

~azure.core.exceptions.HttpResponseError

async get_history_server_graph(workspace_name: str, pool_name: str, livy_id: str, app_id: str, attempt_id: str, **kwargs) → azure.synapse.models._models_py3.HistoryServerGraphResponse[source]

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

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • pool_name (str) – The spark pool name.

  • livy_id (str) – The livy id.

  • app_id (str) – The application id.

  • attempt_id (str) – The attempt id.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

HistoryServerGraphResponse or or the result of cls(response)

Return type

HistoryServerGraphResponse or None

Raises

~azure.core.exceptions.HttpResponseError

async get_history_server_properties(workspace_name: str, **kwargs) → azure.synapse.models._models_py3.HistoryServerPropertiesResponse[source]

Get History server properties.

Parameters

workspace_name (str) – The name of the workspace to execute operations on.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

HistoryServerPropertiesResponse or or the result of cls(response)

Return type

HistoryServerPropertiesResponse or None

Raises

~azure.core.exceptions.HttpResponseError

async get_spark_job_list(workspace_name: str, **kwargs) → azure.synapse.models._models_py3.SparkJobListViewResponse[source]

Get list of spark applications for the workspace.

Parameters

workspace_name (str) – The name of the workspace to execute operations on.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SparkJobListViewResponse or or the result of cls(response)

Return type

SparkJobListViewResponse or None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.synapse.models' from '/mnt/vss/_work/1/s/sdk/synapse/azure-synapse/.tox/sphinx/lib/python3.6/site-packages/azure/synapse/models/__init__.py'>
class azure.synapse.aio.operations_async.SparkBatchOperations(client, config, serializer, deserializer)[source]

SparkBatchOperations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

async create(workspace_name: str, spark_pool_name: str, livy_request: azure.synapse.models._models_py3.ExtendedLivyBatchRequest, detailed: Optional[bool] = None, **kwargs) → azure.synapse.models._models_py3.ExtendedLivyBatchResponse[source]

Create new spark batch job.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • livy_request (ExtendedLivyBatchRequest) – Livy compatible batch job request payload.

  • detailed (bool) – Optional query param specifying whether detailed response is returned beyond plain livy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExtendedLivyBatchResponse or the result of cls(response)

Return type

ExtendedLivyBatchResponse

Raises

~azure.core.exceptions.HttpResponseError

async delete(workspace_name: str, spark_pool_name: str, batch_id: int, **kwargs)None[source]

Cancels a running spark batch job.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • batch_id (int) – Identifier for the batch job.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

async get(workspace_name: str, spark_pool_name: str, batch_id: int, detailed: Optional[bool] = None, **kwargs) → azure.synapse.models._models_py3.ExtendedLivyBatchResponse[source]

Gets a single spark batch job.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • batch_id (int) – Identifier for the batch job.

  • detailed (bool) – Optional query param specifying whether detailed response is returned beyond plain livy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExtendedLivyBatchResponse or the result of cls(response)

Return type

ExtendedLivyBatchResponse

Raises

~azure.core.exceptions.HttpResponseError

async list(workspace_name: str, spark_pool_name: str, from_parameter: Optional[int] = None, size: Optional[int] = None, detailed: Optional[bool] = None, **kwargs) → azure.synapse.models._models_py3.ExtendedLivyListBatchResponse[source]

List all spark batch jobs which are running under a particular spark pool.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • from_parameter (int) – Optional param specifying which index the list should begin from.

  • size (int) – Optional param specifying the size of the returned list. By default it is 20 and that is the maximum.

  • detailed (bool) – Optional query param specifying whether detailed response is returned beyond plain livy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExtendedLivyListBatchResponse or the result of cls(response)

Return type

ExtendedLivyListBatchResponse

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.synapse.models' from '/mnt/vss/_work/1/s/sdk/synapse/azure-synapse/.tox/sphinx/lib/python3.6/site-packages/azure/synapse/models/__init__.py'>
class azure.synapse.aio.operations_async.SparkSessionOperations(client, config, serializer, deserializer)[source]

SparkSessionOperations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

async create(workspace_name: str, spark_pool_name: str, livy_request: azure.synapse.models._models_py3.ExtendedLivySessionRequest, detailed: Optional[bool] = None, **kwargs) → azure.synapse.models._models_py3.ExtendedLivySessionResponse[source]

Create new spark session.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • livy_request (ExtendedLivySessionRequest) – Livy compatible batch job request payload.

  • detailed (bool) – Optional query param specifying whether detailed response is returned beyond plain livy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExtendedLivySessionResponse or the result of cls(response)

Return type

ExtendedLivySessionResponse

Raises

~azure.core.exceptions.HttpResponseError

async create_statement(workspace_name: str, spark_pool_name: str, session_id: int, livy_request: azure.synapse.models._models_py3.LivyStatementRequestBody, **kwargs) → azure.synapse.models._models_py3.LivyStatementResponseBody[source]

Create statement within a spark session.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • session_id (int) – Identifier for the session.

  • livy_request (LivyStatementRequestBody) – Livy compatible batch job request payload.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LivyStatementResponseBody or the result of cls(response)

Return type

LivyStatementResponseBody

Raises

~azure.core.exceptions.HttpResponseError

async delete(workspace_name: str, spark_pool_name: str, session_id: int, **kwargs)None[source]

Cancels a running spark session.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • session_id (int) – Identifier for the session.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

async delete_statement(workspace_name: str, spark_pool_name: str, session_id: int, statement_id: int, **kwargs) → azure.synapse.models._models_py3.LivyStatementCancellationResponse[source]

Kill a statement within a session.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • session_id (int) – Identifier for the session.

  • statement_id (int) – Identifier for the statement.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LivyStatementCancellationResponse or the result of cls(response)

Return type

LivyStatementCancellationResponse

Raises

~azure.core.exceptions.HttpResponseError

async get(workspace_name: str, spark_pool_name: str, session_id: int, detailed: Optional[bool] = None, **kwargs) → azure.synapse.models._models_py3.ExtendedLivySessionResponse[source]

Gets a single spark session.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • session_id (int) – Identifier for the session.

  • detailed (bool) – Optional query param specifying whether detailed response is returned beyond plain livy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExtendedLivySessionResponse or the result of cls(response)

Return type

ExtendedLivySessionResponse

Raises

~azure.core.exceptions.HttpResponseError

async get_statement(workspace_name: str, spark_pool_name: str, session_id: int, statement_id: int, **kwargs) → azure.synapse.models._models_py3.LivyStatementResponseBody[source]

Gets a single statement within a spark session.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • session_id (int) – Identifier for the session.

  • statement_id (int) – Identifier for the statement.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LivyStatementResponseBody or the result of cls(response)

Return type

LivyStatementResponseBody

Raises

~azure.core.exceptions.HttpResponseError

async list(workspace_name: str, spark_pool_name: str, from_parameter: Optional[int] = None, size: Optional[int] = None, detailed: Optional[bool] = None, **kwargs) → azure.synapse.models._models_py3.ExtendedLivyListSessionResponse[source]

List all spark sessions which are running under a particular spark pool.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • from_parameter (int) – Optional param specifying which index the list should begin from.

  • size (int) – Optional param specifying the size of the returned list. By default it is 20 and that is the maximum.

  • detailed (bool) – Optional query param specifying whether detailed response is returned beyond plain livy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExtendedLivyListSessionResponse or the result of cls(response)

Return type

ExtendedLivyListSessionResponse

Raises

~azure.core.exceptions.HttpResponseError

async list_statements(workspace_name: str, spark_pool_name: str, session_id: int, **kwargs) → azure.synapse.models._models_py3.LivyStatementsResponseBody[source]

Gets a list of statements within a spark session.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • session_id (int) – Identifier for the session.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LivyStatementsResponseBody or the result of cls(response)

Return type

LivyStatementsResponseBody

Raises

~azure.core.exceptions.HttpResponseError

async reset_timeout(workspace_name: str, spark_pool_name: str, session_id: int, **kwargs)None[source]

Sends a keep alive call to the current session to reset the session timeout.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • spark_pool_name (str) – Name of the spark pool. “ondemand” targets the ondemand pool.

  • session_id (int) – Identifier for the session.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.synapse.models' from '/mnt/vss/_work/1/s/sdk/synapse/azure-synapse/.tox/sphinx/lib/python3.6/site-packages/azure/synapse/models/__init__.py'>
class azure.synapse.aio.operations_async.WorkspaceAclOperations(client, config, serializer, deserializer)[source]

WorkspaceAclOperations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

async get_access_control_info(workspace_name: str, artifact_name: Optional[str] = None, **kwargs) → azure.synapse.models._models_py3.WorkspaceAccessControlResponse[source]

Get access control info.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • artifact_name (str) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

WorkspaceAccessControlResponse or the result of cls(response)

Return type

WorkspaceAccessControlResponse

Raises

~azure.core.exceptions.HttpResponseError

async set_workspace_administrators(workspace_name: str, administrators: Optional[List[str]] = None, **kwargs) → azure.synapse.models._models_py3.WorkspaceAccessControlResponse[source]

Replace Admins of the Workspace.

Parameters
  • workspace_name (str) – The name of the workspace to execute operations on.

  • administrators (list[str]) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

WorkspaceAccessControlResponse or the result of cls(response)

Return type

WorkspaceAccessControlResponse

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.synapse.models' from '/mnt/vss/_work/1/s/sdk/synapse/azure-synapse/.tox/sphinx/lib/python3.6/site-packages/azure/synapse/models/__init__.py'>