azure.synapse.artifacts.aio.operations_async package¶

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

LinkedServiceOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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_or_update_linked_service(linked_service_name: str, properties: azure.synapse.artifacts.models._models_py3.LinkedService, if_match: Optional[str] = None, **kwargs) → azure.synapse.artifacts.models._models_py3.LinkedServiceResource[source]¶

Creates or updates a linked service.

Parameters

linked_service_name (str) – The linked service name.
properties (LinkedService) – Properties of linked service.
if_match (str) – ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Keyword Arguments

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

Returns

LinkedServiceResource, or the result of cls(response)

Return type

LinkedServiceResource

Raises

~azure.core.exceptions.HttpResponseError

async delete_linked_service(linked_service_name: str, **kwargs) → None [source]¶

Deletes a linked service.

Parameters: linked_service_name (str) – The linked service name.
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_linked_service(linked_service_name: str, if_none_match: Optional[str] = None, **kwargs) → Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceResource][source]¶

Gets a linked service.

Parameters

linked_service_name (str) – The linked service name.
if_none_match (str) – ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Keyword Arguments

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

Returns

LinkedServiceResource, or the result of cls(response)

Return type

LinkedServiceResource or None

Raises

~azure.core.exceptions.HttpResponseError

get_linked_services_by_workspace(**kwargs) → AsyncIterable[azure.synapse.artifacts.models._models_py3.LinkedServiceListResponse][source]¶

Lists linked services.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either LinkedServiceListResponse or the result of cls(response)
Return type: AsyncItemPaged[LinkedServiceListResponse]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

DatasetOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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_or_update_dataset(dataset_name: str, properties: azure.synapse.artifacts.models._models_py3.Dataset, if_match: Optional[str] = None, **kwargs) → azure.synapse.artifacts.models._models_py3.DatasetResource[source]¶

Creates or updates a dataset.

Parameters

dataset_name (str) – The dataset name.
properties (Dataset) – Dataset properties.
if_match (str) – ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Keyword Arguments

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

Returns

DatasetResource, or the result of cls(response)

Return type

DatasetResource

Raises

~azure.core.exceptions.HttpResponseError

async delete_dataset(dataset_name: str, **kwargs) → None [source]¶

Deletes a dataset.

Parameters: dataset_name (str) – The dataset name.
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_dataset(dataset_name: str, if_none_match: Optional[str] = None, **kwargs) → Optional[azure.synapse.artifacts.models._models_py3.DatasetResource][source]¶

Gets a dataset.

Parameters

dataset_name (str) – The dataset name.
if_none_match (str) – ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Keyword Arguments

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

Returns

DatasetResource, or the result of cls(response)

Return type

DatasetResource or None

Raises

~azure.core.exceptions.HttpResponseError

get_datasets_by_workspace(**kwargs) → AsyncIterable[azure.synapse.artifacts.models._models_py3.DatasetListResponse][source]¶

Lists datasets.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DatasetListResponse or the result of cls(response)
Return type: AsyncItemPaged[DatasetListResponse]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

PipelineOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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_or_update_pipeline(pipeline_name: str, pipeline: azure.synapse.artifacts.models._models_py3.PipelineResource, if_match: Optional[str] = None, **kwargs) → azure.synapse.artifacts.models._models_py3.PipelineResource[source]¶

Creates or updates a pipeline.

Parameters

pipeline_name (str) – The pipeline name.
pipeline (PipelineResource) – Pipeline resource definition.
if_match (str) – ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Keyword Arguments

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

Returns

PipelineResource, or the result of cls(response)

Return type

PipelineResource

Raises

~azure.core.exceptions.HttpResponseError

async create_pipeline_run(pipeline_name: str, reference_pipeline_run_id: Optional[str] = None, is_recovery: Optional[bool] = None, start_activity_name: Optional[str] = None, parameters: Optional[Dict[str, object]] = None, **kwargs) → azure.synapse.artifacts.models._models_py3.CreateRunResponse[source]¶

Creates a run of a pipeline.

Parameters

pipeline_name (str) – The pipeline name.
reference_pipeline_run_id (str) – The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.
is_recovery (bool) – Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.
start_activity_name (str) – In recovery mode, the rerun will start from this activity. If not specified, all activities will run.
parameters (dict[str, object]) – Parameters of the pipeline run. These parameters will be used only if the runId is not specified.

Keyword Arguments

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

Returns

CreateRunResponse, or the result of cls(response)

Return type

CreateRunResponse

Raises

~azure.core.exceptions.HttpResponseError

async delete_pipeline(pipeline_name: str, **kwargs) → None [source]¶

Deletes a pipeline.

Parameters: pipeline_name (str) – The pipeline name.
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_pipeline(pipeline_name: str, if_none_match: Optional[str] = None, **kwargs) → Optional[azure.synapse.artifacts.models._models_py3.PipelineResource][source]¶

Gets a pipeline.

Parameters

pipeline_name (str) – The pipeline name.
if_none_match (str) – ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Keyword Arguments

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

Returns

PipelineResource, or the result of cls(response)

Return type

PipelineResource or None

Raises

~azure.core.exceptions.HttpResponseError

get_pipelines_by_workspace(**kwargs) → AsyncIterable[azure.synapse.artifacts.models._models_py3.PipelineListResponse][source]¶

Lists pipelines.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either PipelineListResponse or the result of cls(response)
Return type: AsyncItemPaged[PipelineListResponse]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

PipelineRunOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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 cancel_pipeline_run(run_id: str, is_recursive: Optional[bool] = None, **kwargs) → None [source]¶

Cancel a pipeline run by its run ID.

Parameters

run_id (str) – The pipeline run identifier.
is_recursive (bool) – If true, cancel all the Child pipelines that are triggered by the current pipeline.

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_pipeline_run(run_id: str, **kwargs) → azure.synapse.artifacts.models._models_py3.PipelineRun[source]¶

Get a pipeline run by its run ID.

Parameters: run_id (str) – The pipeline run identifier.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: PipelineRun, or the result of cls(response)
Return type: PipelineRun
Raises: ~azure.core.exceptions.HttpResponseError

async query_activity_runs(pipeline_name: str, run_id: str, filter_parameters: azure.synapse.artifacts.models._models_py3.RunFilterParameters, **kwargs) → azure.synapse.artifacts.models._models_py3.ActivityRunsQueryResponse[source]¶

Query activity runs based on input filter conditions.

Parameters

pipeline_name (str) – The pipeline name.
run_id (str) – The pipeline run identifier.
filter_parameters (RunFilterParameters) – Parameters to filter the activity runs.

Keyword Arguments

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

Returns

ActivityRunsQueryResponse, or the result of cls(response)

Return type

ActivityRunsQueryResponse

Raises

~azure.core.exceptions.HttpResponseError

async query_pipeline_runs_by_workspace(filter_parameters: azure.synapse.artifacts.models._models_py3.RunFilterParameters, **kwargs) → azure.synapse.artifacts.models._models_py3.PipelineRunsQueryResponse[source]¶

Query pipeline runs in the workspace based on input filter conditions.

Parameters: filter_parameters (RunFilterParameters) – Parameters to filter the pipeline run.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: PipelineRunsQueryResponse, or the result of cls(response)
Return type: PipelineRunsQueryResponse
Raises: ~azure.core.exceptions.HttpResponseError

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

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

TriggerOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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 begin_start_trigger(trigger_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None][source]¶

Starts a trigger.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_stop_trigger(trigger_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[None][source]¶

Stops a trigger.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Raises

HttpResponseError –

async begin_subscribe_trigger_to_events(trigger_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.TriggerSubscriptionOperationStatus][source]¶

Subscribe event trigger to events.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either TriggerSubscriptionOperationStatus or the result of cls(response)

Return type

AsyncLROPoller[TriggerSubscriptionOperationStatus]

Raises

HttpResponseError –

async begin_unsubscribe_trigger_from_events(trigger_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.TriggerSubscriptionOperationStatus][source]¶

Unsubscribe event trigger from events.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either TriggerSubscriptionOperationStatus or the result of cls(response)

Return type

AsyncLROPoller[TriggerSubscriptionOperationStatus]

Raises

HttpResponseError –

async create_or_update_trigger(trigger_name: str, properties: azure.synapse.artifacts.models._models_py3.Trigger, if_match: Optional[str] = None, **kwargs) → azure.synapse.artifacts.models._models_py3.TriggerResource[source]¶

Creates or updates a trigger.

Parameters

trigger_name (str) – The trigger name.
properties (Trigger) – Properties of the trigger.
if_match (str) – ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Keyword Arguments

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

Returns

TriggerResource, or the result of cls(response)

Return type

TriggerResource

Raises

~azure.core.exceptions.HttpResponseError

async delete_trigger(trigger_name: str, **kwargs) → None [source]¶

Deletes a trigger.

Parameters: trigger_name (str) – The trigger name.
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_event_subscription_status(trigger_name: str, **kwargs) → azure.synapse.artifacts.models._models_py3.TriggerSubscriptionOperationStatus[source]¶

Get a trigger’s event subscription status.

Parameters: trigger_name (str) – The trigger name.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: TriggerSubscriptionOperationStatus, or the result of cls(response)
Return type: TriggerSubscriptionOperationStatus
Raises: ~azure.core.exceptions.HttpResponseError

async get_trigger(trigger_name: str, if_none_match: Optional[str] = None, **kwargs) → Optional[azure.synapse.artifacts.models._models_py3.TriggerResource][source]¶

Gets a trigger.

Parameters

trigger_name (str) – The trigger name.
if_none_match (str) – ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Keyword Arguments

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

Returns

TriggerResource, or the result of cls(response)

Return type

TriggerResource or None

Raises

~azure.core.exceptions.HttpResponseError

get_triggers_by_workspace(**kwargs) → AsyncIterable[azure.synapse.artifacts.models._models_py3.TriggerListResponse][source]¶

Lists triggers.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either TriggerListResponse or the result of cls(response)
Return type: AsyncItemPaged[TriggerListResponse]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

TriggerRunOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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 query_trigger_runs_by_workspace(filter_parameters: azure.synapse.artifacts.models._models_py3.RunFilterParameters, **kwargs) → azure.synapse.artifacts.models._models_py3.TriggerRunsQueryResponse[source]¶

Query trigger runs.

Parameters: filter_parameters (RunFilterParameters) – Parameters to filter the pipeline run.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: TriggerRunsQueryResponse, or the result of cls(response)
Return type: TriggerRunsQueryResponse
Raises: ~azure.core.exceptions.HttpResponseError

async rerun_trigger_instance(trigger_name: str, run_id: str, **kwargs) → None [source]¶

Rerun single trigger instance by runId.

Parameters

trigger_name (str) – The trigger name.
run_id (str) – The pipeline run identifier.

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.artifacts.models' from '/mnt/vss/_work/1/s/sdk/synapse/azure-synapse/.tox/sphinx/lib/python3.6/site-packages/azure/synapse/artifacts/models/__init__.py'>¶

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

DataFlowOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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_or_update_data_flow(data_flow_name: str, properties: azure.synapse.artifacts.models._models_py3.DataFlow, if_match: Optional[str] = None, **kwargs) → azure.synapse.artifacts.models._models_py3.DataFlowResource[source]¶

Creates or updates a data flow.

Parameters

data_flow_name (str) – The data flow name.
properties (DataFlow) – Data flow properties.
if_match (str) – ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Keyword Arguments

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

Returns

DataFlowResource, or the result of cls(response)

Return type

DataFlowResource

Raises

~azure.core.exceptions.HttpResponseError

async delete_data_flow(data_flow_name: str, **kwargs) → None [source]¶

Deletes a data flow.

Parameters: data_flow_name (str) – The data flow name.
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_data_flow(data_flow_name: str, if_none_match: Optional[str] = None, **kwargs) → azure.synapse.artifacts.models._models_py3.DataFlowResource[source]¶

Gets a data flow.

Parameters

data_flow_name (str) – The data flow name.
if_none_match (str) – ETag of the data flow entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Keyword Arguments

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

Returns

DataFlowResource, or the result of cls(response)

Return type

DataFlowResource

Raises

~azure.core.exceptions.HttpResponseError

get_data_flows_by_workspace(**kwargs) → AsyncIterable[azure.synapse.artifacts.models._models_py3.DataFlowListResponse][source]¶

Lists data flows.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DataFlowListResponse or the result of cls(response)
Return type: AsyncItemPaged[DataFlowListResponse]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

DataFlowDebugSessionOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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 add_data_flow(request: azure.synapse.artifacts.models._models_py3.DataFlowDebugPackage, **kwargs) → azure.synapse.artifacts.models._models_py3.AddDataFlowToDebugSessionResponse[source]¶

Add a data flow into debug session.

Parameters: request (DataFlowDebugPackage) – Data flow debug session definition with debug content.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: AddDataFlowToDebugSessionResponse, or the result of cls(response)
Return type: AddDataFlowToDebugSessionResponse
Raises: ~azure.core.exceptions.HttpResponseError

async begin_create_data_flow_debug_session(request: azure.synapse.artifacts.models._models_py3.CreateDataFlowDebugSessionRequest, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.CreateDataFlowDebugSessionResponse][source]¶

Creates a data flow debug session.

Parameters

request (CreateDataFlowDebugSessionRequest) – Data flow debug session definition.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either CreateDataFlowDebugSessionResponse or the result of cls(response)

Return type

AsyncLROPoller[CreateDataFlowDebugSessionResponse]

Raises

HttpResponseError –

async begin_execute_command(request: azure.synapse.artifacts.models._models_py3.DataFlowDebugCommandRequest, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.DataFlowDebugCommandResponse][source]¶

Execute a data flow debug command.

Parameters

request (DataFlowDebugCommandRequest) – Data flow debug command definition.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either DataFlowDebugCommandResponse or the result of cls(response)

Return type

AsyncLROPoller[DataFlowDebugCommandResponse]

Raises

HttpResponseError –

async delete_data_flow_debug_session(request: azure.synapse.artifacts.models._models_py3.DeleteDataFlowDebugSessionRequest, **kwargs) → None [source]¶

Deletes a data flow debug session.

Parameters: request (DeleteDataFlowDebugSessionRequest) – Data flow debug session definition for deletion.
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

query_data_flow_debug_sessions_by_workspace(**kwargs) → AsyncIterable[azure.synapse.artifacts.models._models_py3.QueryDataFlowDebugSessionsResponse][source]¶

Query all active data flow debug sessions.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either QueryDataFlowDebugSessionsResponse or the result of cls(response)
Return type: AsyncItemPaged[QueryDataFlowDebugSessionsResponse]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

SqlScriptOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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_or_update_sql_script(sql_script_name: str, properties: azure.synapse.artifacts.models._models_py3.SqlScript, if_match: Optional[str] = None, **kwargs) → azure.synapse.artifacts.models._models_py3.SqlScriptResource[source]¶

Creates or updates a Sql Script.

Parameters

sql_script_name (str) – The sql script name.
properties (SqlScript) – Properties of sql script.
if_match (str) – ETag of the SQL script entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Keyword Arguments

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

Returns

SqlScriptResource, or the result of cls(response)

Return type

SqlScriptResource

Raises

~azure.core.exceptions.HttpResponseError

async delete_sql_script(sql_script_name: str, **kwargs) → None [source]¶

Deletes a Sql Script.

Parameters: sql_script_name (str) – The sql script name.
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_sql_script(sql_script_name: str, if_none_match: Optional[str] = None, **kwargs) → Optional[azure.synapse.artifacts.models._models_py3.SqlScriptResource][source]¶

Gets a sql script.

Parameters

sql_script_name (str) – The sql script name.
if_none_match (str) – ETag of the sql compute entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Keyword Arguments

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

Returns

SqlScriptResource, or the result of cls(response)

Return type

SqlScriptResource or None

Raises

~azure.core.exceptions.HttpResponseError

get_sql_scripts_by_workspace(**kwargs) → AsyncIterable[azure.synapse.artifacts.models._models_py3.SqlScriptsListResponse][source]¶

Lists sql scripts.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SqlScriptsListResponse or the result of cls(response)
Return type: AsyncItemPaged[SqlScriptsListResponse]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

SparkJobDefinitionOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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 begin_debug_spark_job_definition(properties: azure.synapse.artifacts.models._models_py3.SparkJobDefinition, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.SparkBatchJob][source]¶

Debug the spark job definition.

Parameters

properties (SparkJobDefinition) – Properties of spark job definition.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either SparkBatchJob or the result of cls(response)

Return type

AsyncLROPoller[SparkBatchJob]

Raises

HttpResponseError –

async begin_execute_spark_job_definition(spark_job_definition_name: str, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.SparkBatchJob][source]¶

Executes the spark job definition.

Parameters

spark_job_definition_name (str) – The spark job definition name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either SparkBatchJob or the result of cls(response)

Return type

AsyncLROPoller[SparkBatchJob]

Raises

HttpResponseError –

async create_or_update_spark_job_definition(spark_job_definition_name: str, properties: azure.synapse.artifacts.models._models_py3.SparkJobDefinition, if_match: Optional[str] = None, **kwargs) → azure.synapse.artifacts.models._models_py3.SparkJobDefinitionResource[source]¶

Creates or updates a Spark Job Definition.

Parameters

spark_job_definition_name (str) – The spark job definition name.
properties (SparkJobDefinition) – Properties of spark job definition.
if_match (str) – ETag of the Spark Job Definition entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Keyword Arguments

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

Returns

SparkJobDefinitionResource, or the result of cls(response)

Return type

SparkJobDefinitionResource

Raises

~azure.core.exceptions.HttpResponseError

async delete_spark_job_definition(spark_job_definition_name: str, **kwargs) → None [source]¶

Deletes a Spark Job Definition.

Parameters: spark_job_definition_name (str) – The spark job definition name.
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_spark_job_definition(spark_job_definition_name: str, if_none_match: Optional[str] = None, **kwargs) → Optional[azure.synapse.artifacts.models._models_py3.SparkJobDefinitionResource][source]¶

Gets a Spark Job Definition.

Parameters

spark_job_definition_name (str) – The spark job definition name.
if_none_match (str) – ETag of the Spark Job Definition entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Keyword Arguments

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

Returns

SparkJobDefinitionResource, or the result of cls(response)

Return type

SparkJobDefinitionResource or None

Raises

~azure.core.exceptions.HttpResponseError

get_spark_job_definitions_by_workspace(**kwargs) → AsyncIterable[azure.synapse.artifacts.models._models_py3.SparkJobDefinitionsListResponse][source]¶

Lists spark job definitions.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SparkJobDefinitionsListResponse or the result of cls(response)
Return type: AsyncItemPaged[SparkJobDefinitionsListResponse]
Raises: ~azure.core.exceptions.HttpResponseError

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

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

NotebookOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an 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_or_update_notebook(notebook_name: str, properties: azure.synapse.artifacts.models._models_py3.Notebook, if_match: Optional[str] = None, **kwargs) → azure.synapse.artifacts.models._models_py3.NotebookResource[source]¶

Creates or updates a Note Book.

Parameters

notebook_name (str) – The notebook name.
properties (Notebook) – Properties of Notebook.
if_match (str) – ETag of the Note book entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Keyword Arguments

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

Returns

NotebookResource, or the result of cls(response)

Return type

NotebookResource

Raises

~azure.core.exceptions.HttpResponseError

async delete_notebook(notebook_name: str, **kwargs) → None [source]¶

Deletes a Note book.

Parameters: notebook_name (str) – The notebook name.
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_notebook(notebook_name: str, if_none_match: Optional[str] = None, **kwargs) → Optional[azure.synapse.artifacts.models._models_py3.NotebookResource][source]¶

Gets a Note Book.

Parameters

notebook_name (str) – The notebook name.
if_none_match (str) – ETag of the Notebook entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Keyword Arguments

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

Returns

NotebookResource, or the result of cls(response)

Return type

NotebookResource or None

Raises

~azure.core.exceptions.HttpResponseError

get_notebook_summary_by_work_space(**kwargs) → AsyncIterable[azure.synapse.artifacts.models._models_py3.NotebookListResponse][source]¶

Lists a summary of Notebooks.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either NotebookListResponse or the result of cls(response)
Return type: AsyncItemPaged[NotebookListResponse]
Raises: ~azure.core.exceptions.HttpResponseError

get_notebooks_by_workspace(**kwargs) → AsyncIterable[azure.synapse.artifacts.models._models_py3.NotebookListResponse][source]¶

Lists Notebooks.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either NotebookListResponse or the result of cls(response)
Return type: AsyncItemPaged[NotebookListResponse]
Raises: ~azure.core.exceptions.HttpResponseError

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