azure.synapse.operations package¶
-
class
azure.synapse.operations.MonitoringOperations(client, config, serializer, deserializer)[source]¶ MonitoringOperations 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.
-
get_application_details(workspace_name: str, pool_name: str, livy_id: str, **kwargs: Any) → models.SparkJobListViewResponse[source]¶ Get one spark application details given the workspace name, pool name and livyid.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get_history_server_data(workspace_name: str, pool_name: str, livy_id: str, app_id: str, attempt_id: str, **kwargs: Any) → models.HistoryServerDataResponse[source]¶ Get History Server Data for a given workspace, pool, livyid, appid and attemptId.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get_history_server_diagnostic(workspace_name: str, pool_name: str, livy_id: str, app_id: str, attempt_id: str, **kwargs: Any) → models.HistoryServerDiagnosticResponse[source]¶ Get History Server Diagnostic Data for a given workspace, pool, livyid, appid and attemptId.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get_history_server_graph(workspace_name: str, pool_name: str, livy_id: str, app_id: str, attempt_id: str, **kwargs: Any) → models.HistoryServerGraphResponse[source]¶ Get History Server Graph Data for a given workspace, pool, livyid, appid and attemptId.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get_history_server_properties(workspace_name: str, **kwargs: Any) → models.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
- Raises
~azure.core.exceptions.HttpResponseError
-
get_spark_job_list(workspace_name: str, **kwargs: Any) → models.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
- 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.operations.SparkBatchOperations(client, config, serializer, deserializer)[source]¶ SparkBatchOperations 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.
-
create(workspace_name: str, spark_pool_name: str, livy_request: models.ExtendedLivyBatchRequest, detailed: Optional[bool] = None, **kwargs: Any) → models.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
- Raises
~azure.core.exceptions.HttpResponseError
-
delete(workspace_name: str, spark_pool_name: str, batch_id: int, **kwargs: Any) → None[source]¶ Cancels a running spark batch job.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get(workspace_name: str, spark_pool_name: str, batch_id: int, detailed: Optional[bool] = None, **kwargs: Any) → models.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
- Raises
~azure.core.exceptions.HttpResponseError
-
list(workspace_name: str, spark_pool_name: str, from_parameter: Optional[int] = None, size: Optional[int] = None, detailed: Optional[bool] = None, **kwargs: Any) → models.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
- 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.operations.SparkSessionOperations(client, config, serializer, deserializer)[source]¶ SparkSessionOperations 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.
-
create(workspace_name: str, spark_pool_name: str, livy_request: models.ExtendedLivySessionRequest, detailed: Optional[bool] = None, **kwargs: Any) → models.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
- Raises
~azure.core.exceptions.HttpResponseError
-
create_statement(workspace_name: str, spark_pool_name: str, session_id: int, livy_request: models.LivyStatementRequestBody, **kwargs: Any) → models.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
- Raises
~azure.core.exceptions.HttpResponseError
-
delete(workspace_name: str, spark_pool_name: str, session_id: int, **kwargs: Any) → None[source]¶ Cancels a running spark session.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
delete_statement(workspace_name: str, spark_pool_name: str, session_id: int, statement_id: int, **kwargs: Any) → models.LivyStatementCancellationResponse[source]¶ Kill a statement within a session.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get(workspace_name: str, spark_pool_name: str, session_id: int, detailed: Optional[bool] = None, **kwargs: Any) → models.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
- Raises
~azure.core.exceptions.HttpResponseError
-
get_statement(workspace_name: str, spark_pool_name: str, session_id: int, statement_id: int, **kwargs: Any) → models.LivyStatementResponseBody[source]¶ Gets a single statement within a spark session.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list(workspace_name: str, spark_pool_name: str, from_parameter: Optional[int] = None, size: Optional[int] = None, detailed: Optional[bool] = None, **kwargs: Any) → models.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
- Raises
~azure.core.exceptions.HttpResponseError
-
list_statements(workspace_name: str, spark_pool_name: str, session_id: int, **kwargs: Any) → models.LivyStatementsResponseBody[source]¶ Gets a list of statements within a spark session.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
reset_timeout(workspace_name: str, spark_pool_name: str, session_id: int, **kwargs: Any) → None[source]¶ Sends a keep alive call to the current session to reset the session timeout.
- Parameters
- 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
- 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.operations.WorkspaceAclOperations(client, config, serializer, deserializer)[source]¶ WorkspaceAclOperations 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.
-
get_access_control_info(workspace_name: str, artifact_name: Optional[str] = None, **kwargs: Any) → models.WorkspaceAccessControlResponse[source]¶ Get access control info.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
set_workspace_administrators(workspace_name: str, administrators: Optional[List[str]] = None, **kwargs: Any) → models.WorkspaceAccessControlResponse[source]¶ Replace Admins of the Workspace.
- Parameters
- 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
- 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'>¶