azure.synapse.artifacts.aio.operations package

class azure.synapse.artifacts.aio.operations.BigDataPoolsOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s big_data_pools attribute.

async get(big_data_pool_name: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.BigDataPoolResourceInfo

Get Big Data Pool.

Parameters

big_data_pool_name (str) – The Big Data Pool name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

BigDataPoolResourceInfo, or the result of cls(response)

Return type

BigDataPoolResourceInfo

Raises

~azure.core.exceptions.HttpResponseError

async list(**kwargs: Any) → azure.synapse.artifacts.models._models_py3.BigDataPoolResourceInfoListResult

List Big Data Pools.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

BigDataPoolResourceInfoListResult, or the result of cls(response)

Return type

BigDataPoolResourceInfoListResult

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.synapse.artifacts.aio.operations.DataFlowDebugSessionOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s data_flow_debug_session attribute.

async add_data_flow(request: azure.synapse.artifacts.models._models_py3.DataFlowDebugPackage, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.AddDataFlowToDebugSessionResponse

Add a data flow into debug session.

Parameters

request (DataFlowDebugPackage) – Data flow debug session definition with debug content.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.CreateDataFlowDebugSessionResponse]

Creates a data flow debug session.

Parameters

request (CreateDataFlowDebugSessionRequest) – Data flow debug session definition.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

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

Execute a data flow debug command.

Parameters

request (DataFlowDebugCommandRequest) – Data flow debug command definition.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async delete_data_flow_debug_session(request: azure.synapse.artifacts.models._models_py3.DeleteDataFlowDebugSessionRequest, **kwargs: Any) → None

Deletes a data flow debug session.

Parameters

request (DeleteDataFlowDebugSessionRequest) – Data flow debug session definition for deletion.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.QueryDataFlowDebugSessionsResponse]

Query all active data flow debug sessions.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.DataFlowOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s data_flow attribute.

async begin_create_or_update_data_flow(data_flow_name: str, properties: azure.synapse.artifacts.models._models_py3.DataFlow, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.DataFlowResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 DataFlowResource or the result of cls(response)

Return type

AsyncLROPoller[DataFlowResource]

Raises

~azure.core.exceptions.HttpResponseError

async begin_delete_data_flow(data_flow_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a data flow.

Parameters

data_flow_name (str) – The data flow name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_rename_data_flow(data_flow_name: str, new_name: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Renames a dataflow.

Parameters

• data_flow_name (str) – The data flow name.

• new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async get_data_flow(data_flow_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.DataFlowResource

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.DataFlowListResponse]

Lists data flows.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.DatasetOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s dataset attribute.

async begin_create_or_update_dataset(dataset_name: str, properties: azure.synapse.artifacts.models._models_py3.Dataset, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.DatasetResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 DatasetResource or the result of cls(response)

Return type

AsyncLROPoller[DatasetResource]

Raises

~azure.core.exceptions.HttpResponseError

async begin_delete_dataset(dataset_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a dataset.

Parameters

dataset_name (str) – The dataset name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_rename_dataset(dataset_name: str, new_name: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Renames a dataset.

Parameters

• dataset_name (str) – The dataset name.

• new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async get_dataset(dataset_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.synapse.artifacts.models._models_py3.DatasetResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.DatasetListResponse]

Lists datasets.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.IntegrationRuntimesOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s integration_runtimes attribute.

async get(integration_runtime_name: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.IntegrationRuntimeResource

Get Integration Runtime.

Parameters

integration_runtime_name (str) – The Integration Runtime name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

IntegrationRuntimeResource, or the result of cls(response)

Return type

IntegrationRuntimeResource

Raises

~azure.core.exceptions.HttpResponseError

async list(**kwargs: Any) → azure.synapse.artifacts.models._models_py3.IntegrationRuntimeListResponse

List Integration Runtimes.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

IntegrationRuntimeListResponse, or the result of cls(response)

Return type

IntegrationRuntimeListResponse

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.synapse.artifacts.aio.operations.KqlScriptOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s kql_script attribute.

async begin_create_or_update(kql_script_name: str, kql_script: azure.synapse.artifacts.models._models_py3.KqlScriptResource, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.KqlScriptResource]

Creates or updates a KQL Script.

Parameters

• kql_script_name (str) – KQL script name.

• kql_script (KqlScriptResource) – KQL script.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-11-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 KqlScriptResource or the result of cls(response)

Return type

AsyncLROPoller[KqlScriptResource]

Raises

~azure.core.exceptions.HttpResponseError

async begin_delete_by_name(kql_script_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Delete KQL script by name.

Parameters

kql_script_name (str) – KQL script name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-11-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_rename(kql_script_name: str, new_name: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Rename KQL script.

Parameters

• kql_script_name (str) – KQL script name.

• new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-11-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async get_by_name(kql_script_name: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.KqlScriptResource

Get KQL script by name.

Parameters

kql_script_name (str) – KQL script name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-11-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

KqlScriptResource, or the result of cls(response)

Return type

KqlScriptResource

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.synapse.artifacts.aio.operations.KqlScriptsOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s kql_scripts attribute.

get_all(**kwargs: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.KqlScriptsResourceCollectionResponse]

Get all KQL scripts.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-11-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

An iterator like instance of either KqlScriptsResourceCollectionResponse or the result of cls(response)

Return type

AsyncItemPaged[KqlScriptsResourceCollectionResponse]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.synapse.artifacts.aio.operations.LibraryOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s library attribute.

async append(library_name: str, content: IO, blob_condition_append_position: Optional[int] = None, **kwargs: Any) → None

Append the content to the library resource created using the create operation. The maximum content size is 4MiB. Content larger than 4MiB must be appended in 4MiB chunks.

Parameters

• library_name (str) – file name to upload. Minimum length of the filename should be 1 excluding the extension length.

• content (IO) – Library file chunk.

• blob_condition_append_position (long) – Set this header to a byte offset at which the block is expected to be appended. The request succeeds only if the current offset matches this value. Otherwise, the request fails with the AppendPositionConditionNotMet error (HTTP status code 412 – Precondition Failed). Default value is None.

Keyword Arguments

• comp (str) – Default value is “appendblock”. Note that overriding this default value may result in unsupported behavior.

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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 begin_create(library_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.LibraryResourceInfo]

Creates a library with the library name.

Parameters

library_name (str) – file name to upload. Minimum length of the filename should be 1 excluding the extension length.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 LibraryResourceInfo or the result of cls(response)

Return type

AsyncLROPoller[LibraryResourceInfo]

Raises

~azure.core.exceptions.HttpResponseError

async begin_delete(library_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.LibraryResourceInfo]

Delete Library.

Parameters

library_name (str) – file name to upload. Minimum length of the filename should be 1 excluding the extension length.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 LibraryResourceInfo or the result of cls(response)

Return type

AsyncLROPoller[LibraryResourceInfo]

Raises

~azure.core.exceptions.HttpResponseError

async begin_flush(library_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.LibraryResourceInfo]

Flush Library.

Parameters

library_name (str) – file name to upload. Minimum length of the filename should be 1 excluding the extension length.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 LibraryResourceInfo or the result of cls(response)

Return type

AsyncLROPoller[LibraryResourceInfo]

Raises

~azure.core.exceptions.HttpResponseError

async get(library_name: str, **kwargs: Any) → Optional[azure.synapse.artifacts.models._models_py3.LibraryResource]

Get Library.

Parameters

library_name (str) – file name to upload. Minimum length of the filename should be 1 excluding the extension length.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

LibraryResource, or the result of cls(response)

Return type

LibraryResource or None

Raises

~azure.core.exceptions.HttpResponseError

async get_operation_result(operation_id: str, **kwargs: Any) → Union[azure.synapse.artifacts.models._models_py3.LibraryResource, azure.synapse.artifacts.models._models_py3.OperationResult]

Get Operation result for Library.

Parameters

operation_id (str) – operation id for which status is requested.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

LibraryResource or OperationResult, or the result of cls(response)

Return type

LibraryResource or OperationResult

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.LibraryListResponse]

Lists Library.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

An iterator like instance of either LibraryListResponse or the result of cls(response)

Return type

AsyncItemPaged[LibraryListResponse]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.synapse.artifacts.aio.operations.LinkConnectionOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s link_connection attribute.

async create_or_update_link_connection(link_connection_name: str, link_connection: azure.synapse.artifacts.models._models_py3.LinkConnectionResource, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.LinkConnectionResource

Creates or updates a link connection.

Parameters

• link_connection_name (str) – The link connection name.

• link_connection (LinkConnectionResource) – Link connection resource definition.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

LinkConnectionResource, or the result of cls(response)

Return type

LinkConnectionResource

Raises

~azure.core.exceptions.HttpResponseError

async delete_link_connection(link_connection_name: str, **kwargs: Any) → None

Delete a link connection.

Parameters

link_connection_name (str) – The link connection name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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 edit_tables(link_connection_name: str, link_tables: Optional[List[azure.synapse.artifacts.models._models_py3.LinkTableRequest]] = None, **kwargs: Any) → None

Edit tables for a link connection.

Parameters

• link_connection_name (str) – The link connection name.

• link_tables (list[LinkTableRequest]) – Edit link tables request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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_detailed_status(link_connection_name: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.LinkConnectionDetailedStatus

Get the detailed status of a link connection.

Parameters

link_connection_name (str) – The link connection name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

LinkConnectionDetailedStatus, or the result of cls(response)

Return type

LinkConnectionDetailedStatus

Raises

~azure.core.exceptions.HttpResponseError

async get_link_connection(link_connection_name: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.LinkConnectionResource

Get a link connection.

Parameters

link_connection_name (str) – The link connection name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

LinkConnectionResource, or the result of cls(response)

Return type

LinkConnectionResource

Raises

~azure.core.exceptions.HttpResponseError

list_link_connections_by_workspace(**kwargs: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.LinkConnectionListResponse]

List link connections.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

An iterator like instance of either LinkConnectionListResponse or the result of cls(response)

Return type

AsyncItemPaged[LinkConnectionListResponse]

Raises

~azure.core.exceptions.HttpResponseError

async list_link_tables(link_connection_name: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.LinkTableListResponse

List the link tables of a link connection.

Parameters

link_connection_name (str) – The link connection name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

LinkTableListResponse, or the result of cls(response)

Return type

LinkTableListResponse

Raises

~azure.core.exceptions.HttpResponseError

async query_table_status(link_connection_name: str, query_table_status_request: azure.synapse.artifacts.models._models_py3.QueryTableStatusRequest, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.LinkConnectionQueryTableStatus

Query the link table status of a link connection.

Parameters

• link_connection_name (str) – The link connection name.

• query_table_status_request (QueryTableStatusRequest) – Query table status request.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

LinkConnectionQueryTableStatus, or the result of cls(response)

Return type

LinkConnectionQueryTableStatus

Raises

~azure.core.exceptions.HttpResponseError

async start(link_connection_name: str, **kwargs: Any) → None

Start a link connection.

Parameters

link_connection_name (str) – The link connection name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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 stop(link_connection_name: str, **kwargs: Any) → None

Stop a link connection.

Parameters

link_connection_name (str) – The link connection name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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 update_landing_zone_credential(link_connection_name: str, sas_token: Optional[azure.synapse.artifacts.models._models_py3.SecureString] = None, **kwargs: Any) → None

Update landing zone credential of a link connection.

Parameters

• link_connection_name (str) – The link connection name.

• sas_token (SecureString) – Landing zone’s sas token. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-12-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.LinkedServiceOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s linked_service attribute.

async begin_create_or_update_linked_service(linked_service_name: str, properties: azure.synapse.artifacts.models._models_py3.LinkedService, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.LinkedServiceResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 LinkedServiceResource or the result of cls(response)

Return type

AsyncLROPoller[LinkedServiceResource]

Raises

~azure.core.exceptions.HttpResponseError

async begin_delete_linked_service(linked_service_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a linked service.

Parameters

linked_service_name (str) – The linked service name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_rename_linked_service(linked_service_name: str, new_name: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Renames a linked service.

Parameters

• linked_service_name (str) – The linked service name.

• new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async get_linked_service(linked_service_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.LinkedServiceListResponse]

Lists linked services.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.MetastoreOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s metastore attribute.

async delete(id: str, **kwargs: Any) → None

Remove files in Syms.

Parameters

id (str) –

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-07-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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_database_operations(id: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.MetastoreRequestSuccessResponse

Gets status of the database.

Parameters

id (str) –

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-07-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

MetastoreRequestSuccessResponse, or the result of cls(response)

Return type

MetastoreRequestSuccessResponse

Raises

~azure.core.exceptions.HttpResponseError

async register(id: str, input_folder: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.MetastoreRegistrationResponse

Register files in Syms.

Parameters

• id (str) – The name of the database to be created. The name can contain only alphanumeric characters and should not exceed 24 characters.

• input_folder (str) – The input folder containing CDM files.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-07-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

MetastoreRegistrationResponse, or the result of cls(response)

Return type

MetastoreRegistrationResponse

Raises

~azure.core.exceptions.HttpResponseError

async update(id: str, input_folder: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.MetastoreUpdationResponse

Update files in Syms.

Parameters

• id (str) – The name of the database to be updated.

• input_folder (str) – The input folder containing CDM files.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-07-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

MetastoreUpdationResponse, or the result of cls(response)

Return type

MetastoreUpdationResponse

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.synapse.artifacts.aio.operations.NotebookOperationResultOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s notebook_operation_result attribute.

async get(operation_id: str, **kwargs: Any) → None

Get notebook operation result.

Parameters

operation_id (str) – Operation ID.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.NotebookOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s notebook attribute.

async begin_create_or_update_notebook(notebook_name: str, notebook: azure.synapse.artifacts.models._models_py3.NotebookResource, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.NotebookResource]

Creates or updates a Note Book.

Parameters

• notebook_name (str) – The notebook name.

• notebook (NotebookResource) – Note book resource definition.

• 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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 NotebookResource or the result of cls(response)

Return type

AsyncLROPoller[NotebookResource]

Raises

~azure.core.exceptions.HttpResponseError

async begin_delete_notebook(notebook_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a Note book.

Parameters

notebook_name (str) – The notebook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_rename_notebook(notebook_name: str, new_name: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Renames a notebook.

Parameters

• notebook_name (str) – The notebook name.

• new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async get_notebook(notebook_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.synapse.artifacts.models._models_py3.NotebookResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.NotebookListResponse]

Lists a summary of Notebooks.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.NotebookListResponse]

Lists Notebooks.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.PipelineOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s pipeline attribute.

async begin_create_or_update_pipeline(pipeline_name: str, pipeline: azure.synapse.artifacts.models._models_py3.PipelineResource, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.PipelineResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 PipelineResource or the result of cls(response)

Return type

AsyncLROPoller[PipelineResource]

Raises

~azure.core.exceptions.HttpResponseError

async begin_delete_pipeline(pipeline_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a pipeline.

Parameters

pipeline_name (str) – The pipeline name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_rename_pipeline(pipeline_name: str, new_name: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Renames a pipeline.

Parameters

• pipeline_name (str) – The pipeline name.

• new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~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, Any]] = None, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.CreateRunResponse

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. Default value is None.

• 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. Default value is None.

• start_activity_name (str) – In recovery mode, the rerun will start from this activity. If not specified, all activities will run. Default value is None.

• parameters (dict[str, any]) – Parameters of the pipeline run. These parameters will be used only if the runId is not specified. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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 get_pipeline(pipeline_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.synapse.artifacts.models._models_py3.PipelineResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.PipelineListResponse]

Lists pipelines.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.PipelineRunOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s pipeline_run attribute.

async cancel_pipeline_run(run_id: str, is_recursive: Optional[bool] = None, **kwargs: Any) → None

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → azure.synapse.artifacts.models._models_py3.PipelineRun

Get a pipeline run by its run ID.

Parameters

run_id (str) – The pipeline run identifier.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → azure.synapse.artifacts.models._models_py3.ActivityRunsQueryResponse

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

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → azure.synapse.artifacts.models._models_py3.PipelineRunsQueryResponse

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

Parameters

filter_parameters (RunFilterParameters) – Parameters to filter the pipeline run.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.SparkConfigurationOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s spark_configuration attribute.

async begin_create_or_update_spark_configuration(spark_configuration_name: str, properties: azure.synapse.artifacts.models._models_py3.SparkConfiguration, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.SparkConfigurationResource]

Creates or updates a sparkconfiguration.

Parameters

• spark_configuration_name (str) – The spark Configuration name.

• properties (SparkConfiguration) – Properties of Spark Configuration.

• if_match (str) – ETag of the sparkConfiguration entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 SparkConfigurationResource or the result of cls(response)

Return type

AsyncLROPoller[SparkConfigurationResource]

Raises

~azure.core.exceptions.HttpResponseError

async begin_delete_spark_configuration(spark_configuration_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a sparkConfiguration.

Parameters

spark_configuration_name (str) – The spark Configuration name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_rename_spark_configuration(spark_configuration_name: str, new_name: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Renames a sparkConfiguration.

Parameters

• spark_configuration_name (str) – The spark Configuration name.

• new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-01-preview”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async get_spark_configuration(spark_configuration_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.synapse.artifacts.models._models_py3.SparkConfigurationResource]

Gets a sparkConfiguration.

Parameters

• spark_configuration_name (str) – The spark Configuration name.

• if_none_match (str) – ETag of the sparkConfiguration 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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

SparkConfigurationResource, or the result of cls(response)

Return type

SparkConfigurationResource or None

Raises

~azure.core.exceptions.HttpResponseError

get_spark_configurations_by_workspace(**kwargs: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.SparkConfigurationListResponse]

Lists sparkconfigurations.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-01-preview”. Note that overriding this default value may result in unsupported behavior.

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

Returns

An iterator like instance of either SparkConfigurationListResponse or the result of cls(response)

Return type

AsyncItemPaged[SparkConfigurationListResponse]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.synapse.artifacts.aio.operations.SparkJobDefinitionOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s spark_job_definition attribute.

async begin_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: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.SparkJobDefinitionResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 SparkJobDefinitionResource or the result of cls(response)

Return type

AsyncLROPoller[SparkJobDefinitionResource]

Raises

~azure.core.exceptions.HttpResponseError

async begin_debug_spark_job_definition(properties: azure.synapse.artifacts.models._models_py3.SparkJobDefinition, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.SparkBatchJob]

Debug the spark job definition.

Parameters

properties (SparkJobDefinition) – Properties of spark job definition.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_delete_spark_job_definition(spark_job_definition_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a Spark Job Definition.

Parameters

spark_job_definition_name (str) – The spark job definition name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

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

Executes the spark job definition.

Parameters

spark_job_definition_name (str) – The spark job definition name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_rename_spark_job_definition(spark_job_definition_name: str, new_name: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Renames a sparkJobDefinition.

Parameters

• spark_job_definition_name (str) – The spark job definition name.

• new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async get_spark_job_definition(spark_job_definition_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.synapse.artifacts.models._models_py3.SparkJobDefinitionResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.SparkJobDefinitionsListResponse]

Lists spark job definitions.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.SqlPoolsOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s sql_pools attribute.

async get(sql_pool_name: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.SqlPool

Get Sql Pool.

Parameters

sql_pool_name (str) – The Sql Pool name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

SqlPool, or the result of cls(response)

Return type

SqlPool

Raises

~azure.core.exceptions.HttpResponseError

async list(**kwargs: Any) → azure.synapse.artifacts.models._models_py3.SqlPoolInfoListResult

List Sql Pools.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

SqlPoolInfoListResult, or the result of cls(response)

Return type

SqlPoolInfoListResult

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.synapse.artifacts.aio.operations.SqlScriptOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s sql_script attribute.

async begin_create_or_update_sql_script(sql_script_name: str, sql_script: azure.synapse.artifacts.models._models_py3.SqlScriptResource, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.SqlScriptResource]

Creates or updates a Sql Script.

Parameters

• sql_script_name (str) – The sql script name.

• sql_script (SqlScriptResource) – Sql Script resource definition.

• 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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 SqlScriptResource or the result of cls(response)

Return type

AsyncLROPoller[SqlScriptResource]

Raises

~azure.core.exceptions.HttpResponseError

async begin_delete_sql_script(sql_script_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a Sql Script.

Parameters

sql_script_name (str) – The sql script name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_rename_sql_script(sql_script_name: str, new_name: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Renames a sqlScript.

Parameters

• sql_script_name (str) – The sql script name.

• new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async get_sql_script(sql_script_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.synapse.artifacts.models._models_py3.SqlScriptResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.SqlScriptsListResponse]

Lists sql scripts.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.TriggerOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s trigger attribute.

async begin_create_or_update_trigger(trigger_name: str, properties: azure.synapse.artifacts.models._models_py3.Trigger, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.synapse.artifacts.models._models_py3.TriggerResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 TriggerResource or the result of cls(response)

Return type

AsyncLROPoller[TriggerResource]

Raises

~azure.core.exceptions.HttpResponseError

async begin_delete_trigger(trigger_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Deletes a trigger.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async begin_start_trigger(trigger_name: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[None]

Starts a trigger.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

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

Stops a trigger.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

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

Subscribe event trigger to events.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

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

Unsubscribe event trigger from events.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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

~azure.core.exceptions.HttpResponseError

async get_event_subscription_status(trigger_name: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.TriggerSubscriptionOperationStatus

Get a trigger’s event subscription status.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → Optional[azure.synapse.artifacts.models._models_py3.TriggerResource]

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. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → AsyncIterable[azure.synapse.artifacts.models._models_py3.TriggerListResponse]

Lists triggers.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.TriggerRunOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s trigger_run attribute.

async cancel_trigger_instance(trigger_name: str, run_id: str, **kwargs: Any) → None

Cancel single trigger instance by runId.

Parameters

• trigger_name (str) – The trigger name.

• run_id (str) – The pipeline run identifier.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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 query_trigger_runs_by_workspace(filter_parameters: azure.synapse.artifacts.models._models_py3.RunFilterParameters, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.TriggerRunsQueryResponse

Query trigger runs.

Parameters

filter_parameters (RunFilterParameters) – Parameters to filter the pipeline run.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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: Any) → None

Rerun single trigger instance by runId.

Parameters

• trigger_name (str) – The trigger name.

• run_id (str) – The pipeline run identifier.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

• 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-artifacts/.tox/sphinx/lib/python3.9/site-packages/azure/synapse/artifacts/models/__init__.py'>

class azure.synapse.artifacts.aio.operations.WorkspaceGitRepoManagementOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s workspace_git_repo_management attribute.

async get_git_hub_access_token(git_hub_access_token_request: azure.synapse.artifacts.models._models_py3.GitHubAccessTokenRequest, client_request_id: Optional[str] = None, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.GitHubAccessTokenResponse

Get the GitHub access token.

Parameters

• git_hub_access_token_request (GitHubAccessTokenRequest) –

• client_request_id (str) – Can provide a guid, which is helpful for debugging and to provide better customer support. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

GitHubAccessTokenResponse, or the result of cls(response)

Return type

GitHubAccessTokenResponse

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.synapse.artifacts.aio.operations.WorkspaceOperations(*args, **kwargs)

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ArtifactsClient’s workspace attribute.

async get(**kwargs: Any) → azure.synapse.artifacts.models._models_py3.Workspace

Get Workspace.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-12-01”. Note that overriding this default value may result in unsupported behavior.

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

Returns

Workspace, or the result of cls(response)

Return type

Workspace

Raises

~azure.core.exceptions.HttpResponseError

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