azure.synapse.artifacts.aio.operations package¶

AsyncLROPoller[CreateDataFlowDebugSessionResponse]

async begin_create_data_flow_debug_session(request: _models.CreateDataFlowDebugSessionRequest, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.CreateDataFlowDebugSessionResponse][source]¶

async begin_create_data_flow_debug_session(request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.CreateDataFlowDebugSessionResponse]

Creates a data flow debug session.

Parameters

request (CreateDataFlowDebugSessionRequest or IO) – Data flow debug session definition. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

Raises

AsyncLROPoller[DataFlowDebugCommandResponse]

async begin_execute_command(request: _models.DataFlowDebugCommandRequest, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.DataFlowDebugCommandResponse][source]¶

async begin_execute_command(request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.DataFlowDebugCommandResponse]

Execute a data flow debug command.

Parameters

request (DataFlowDebugCommandRequest or IO) – Data flow debug command definition. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

Raises

async delete_data_flow_debug_session(request: _models.DeleteDataFlowDebugSessionRequest, *, content_type: str = "'application/json'", **kwargs: Any) → None [source]¶

async delete_data_flow_debug_session(request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

Deletes a data flow debug session.

Parameters

request (DeleteDataFlowDebugSessionRequest or IO) – Data flow debug session definition for deletion. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

AsyncLROPoller[DataFlowResource]

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

Query all active data flow debug sessions.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DataFlowDebugSessionInfo or the result of cls(response)
Return type: AsyncItemPaged[DataFlowDebugSessionInfo]
Raises: 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)[source]¶

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][source]¶

Creates or updates a data flow.

Parameters

data_flow_name (str) – The data flow name. Required.
properties (DataFlow) – Data flow properties. Required.
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

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

Raises

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

Deletes a data flow.

Parameters

data_flow_name (str) – The data flow name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Renames a dataflow.

Parameters

data_flow_name (str) – The data flow name. Required.
new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Gets a data flow.

Parameters

data_flow_name (str) – The data flow name. Required.
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

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

AsyncLROPoller[DatasetResource]

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

Lists data flows.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DataFlowResource or the result of cls(response)
Return type: AsyncItemPaged[DataFlowResource]
Raises: 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)[source]¶

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][source]¶

Creates or updates a dataset.

Parameters

dataset_name (str) – The dataset name. Required.
properties (Dataset) – Dataset properties. Required.
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

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

Raises

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

Deletes a dataset.

Parameters

dataset_name (str) – The dataset name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Renames a dataset.

Parameters

dataset_name (str) – The dataset name. Required.
new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Gets a dataset.

Parameters

dataset_name (str) – The dataset name. Required.
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

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

Returns

DatasetResource or None or the result of cls(response)

Return type

DatasetResource or None

Raises

AsyncLROPoller[KqlScriptResource]

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

Lists datasets.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DatasetResource or the result of cls(response)
Return type: AsyncItemPaged[DatasetResource]
Raises: 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)[source]¶

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[source]¶

Get Integration Runtime.

Parameters: integration_runtime_name (str) – The Integration Runtime name. Required.
Keyword Arguments: 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: HttpResponseError –

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

List Integration Runtimes.

Keyword Arguments: 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: 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)[source]¶

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: _models.KqlScriptResource, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.KqlScriptResource][source]¶

async begin_create_or_update(kql_script_name: str, kql_script: IO, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.KqlScriptResource]

Creates or updates a KQL Script.

Parameters

kql_script_name (str) – KQL script name. Required.
kql_script (KqlScriptResource or IO) – KQL script. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

Raises

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

Delete KQL script by name.

Parameters

kql_script_name (str) – KQL script name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Rename KQL script.

Parameters

kql_script_name (str) – KQL script name. Required.
new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Get KQL script by name.

Parameters: kql_script_name (str) – KQL script name. Required.
Keyword Arguments: 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: 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)[source]¶

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.KqlScriptResource][source]¶

Get all KQL scripts.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either KqlScriptResource or the result of cls(response)
Return type: AsyncItemPaged[KqlScriptResource]
Raises: 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)[source]¶

Warning

DO NOT instantiate this class directly.

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

async append(comp: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.Enum9], library_name: str, content: IO, blob_condition_append_position: Optional[int] = None, **kwargs: Any) → None [source]¶

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

comp (str or Enum9) – “appendblock” Required.
library_name (str) – file name to upload. Minimum length of the filename should be 1 excluding the extension length. Required.
content (IO) – Library file chunk. Required.
blob_condition_append_position (int) – 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

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

Returns

None or the result of cls(response)

Return type

Raises

AsyncLROPoller[LibraryResourceInfo]

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

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

AsyncLROPoller[LibraryResourceInfo]

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

Delete Library.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

AsyncLROPoller[LibraryResourceInfo]

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

Flush Library.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Get Library.

Parameters: library_name (str) – file name to upload. Minimum length of the filename should be 1 excluding the extension length. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: LibraryResource or None or the result of cls(response)
Return type: LibraryResource or None
Raises: 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][source]¶

Get Operation result for Library.

Parameters: operation_id (str) – operation id for which status is requested. Required.
Keyword Arguments: 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: HttpResponseError –

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

Lists Library.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either LibraryResource or the result of cls(response)
Return type: AsyncItemPaged[LibraryResource]
Raises: 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)[source]¶

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: _models.LinkConnectionResource, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LinkConnectionResource[source]¶

async create_or_update_link_connection(link_connection_name: str, link_connection: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LinkConnectionResource

Creates or updates a link connection.

Parameters

link_connection_name (str) – The link connection name. Required.
link_connection (LinkConnectionResource or IO) – Link connection resource definition. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

async delete_link_connection(link_connection_name: str, **kwargs: Any) → None [source]¶

Delete a link connection.

Parameters: link_connection_name (str) – The link connection name. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None or the result of cls(response)
Return type: None
Raises: HttpResponseError –

async edit_tables(link_connection_name: str, link_tables: Optional[List[azure.synapse.artifacts.models._models_py3.LinkTableRequest]] = None, **kwargs: Any) → None [source]¶

Edit tables for a link connection.

Parameters

link_connection_name (str) – The link connection name. Required.
link_tables (list[LinkTableRequest]) – Edit link tables request. Default value is None.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

LinkConnectionQueryTableStatus

async get_detailed_status(link_connection_name: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.LinkConnectionDetailedStatus[source]¶

Get the detailed status of a link connection.

Parameters: link_connection_name (str) – The link connection name. Required.
Keyword Arguments: 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: HttpResponseError –

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

Get a link connection.

Parameters: link_connection_name (str) – The link connection name. Required.
Keyword Arguments: 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: HttpResponseError –

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

List link connections.

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

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

List the link tables of a link connection.

Parameters: link_connection_name (str) – The link connection name. Required.
Keyword Arguments: 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: HttpResponseError –

async query_table_status(link_connection_name: str, query_table_status_request: _models.QueryTableStatusRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LinkConnectionQueryTableStatus[source]¶

async query_table_status(link_connection_name: str, query_table_status_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LinkConnectionQueryTableStatus

Query the link table status of a link connection.

Parameters

link_connection_name (str) – The link connection name. Required.
query_table_status_request (QueryTableStatusRequest or IO) – Query table status request. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LinkConnectionQueryTableStatus or the result of cls(response)

Return type

Raises

async start(link_connection_name: str, **kwargs: Any) → None [source]¶

Start a link connection.

Parameters: link_connection_name (str) – The link connection name. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None or the result of cls(response)
Return type: None
Raises: HttpResponseError –

async stop(link_connection_name: str, **kwargs: Any) → None [source]¶

Stop a link connection.

Parameters: link_connection_name (str) – The link connection name. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None or the result of cls(response)
Return type: None
Raises: HttpResponseError –

async update_landing_zone_credential(link_connection_name: str, sas_token: Optional[azure.synapse.artifacts.models._models_py3.SecureString] = None, **kwargs: Any) → None [source]¶

Update landing zone credential of a link connection.

Parameters

link_connection_name (str) – The link connection name. Required.
sas_token (SecureString) – Landing zone’s sas token. Default value is None.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

AsyncLROPoller[LinkedServiceResource]

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)[source]¶

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][source]¶

Creates or updates a linked service.

Parameters

linked_service_name (str) – The linked service name. Required.
properties (LinkedService) – Properties of linked service. Required.
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

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

Raises

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

Deletes a linked service.

Parameters

linked_service_name (str) – The linked service name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Renames a linked service.

Parameters

linked_service_name (str) – The linked service name. Required.
new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Gets a linked service.

Parameters

linked_service_name (str) – The linked service name. Required.
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

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

Returns

LinkedServiceResource or None or the result of cls(response)

Return type

LinkedServiceResource or None

Raises

MetastoreRegistrationResponse

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

Lists linked services.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either LinkedServiceResource or the result of cls(response)
Return type: AsyncItemPaged[LinkedServiceResource]
Raises: 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)[source]¶

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 [source]¶

Remove files in Syms.

Parameters: id (str) – Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None or the result of cls(response)
Return type: None
Raises: HttpResponseError –

async get_database_operations(id: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.MetastoreRequestSuccessResponse[source]¶

Gets status of the database.

Parameters: id (str) – Required.
Keyword Arguments: 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: HttpResponseError –

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

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. Required.
input_folder (str) – The input folder containing CDM files. Required.

Keyword Arguments

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

Returns

MetastoreRegistrationResponse or the result of cls(response)

Return type

Raises

MetastoreUpdationResponse

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

Update files in Syms.

Parameters

id (str) – The name of the database to be updated. Required.
input_folder (str) – The input folder containing CDM files. Required.

Keyword Arguments

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

Returns

MetastoreUpdationResponse or the result of cls(response)

Return type

Raises

AsyncLROPoller[NotebookResource]

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)[source]¶

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 [source]¶

Get notebook operation result.

Parameters: operation_id (str) – Operation ID. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None or the result of cls(response)
Return type: None
Raises: 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)[source]¶

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: _models.NotebookResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.NotebookResource][source]¶

async begin_create_or_update_notebook(notebook_name: str, notebook: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.NotebookResource]

Creates or updates a Note Book.

Parameters

notebook_name (str) – The notebook name. Required.
notebook (NotebookResource or IO) – Note book resource definition. Is either a model type or a IO type. Required.
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

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

Raises

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

Deletes a Note book.

Parameters

notebook_name (str) – The notebook name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Renames a notebook.

Parameters

notebook_name (str) – The notebook name. Required.
new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Gets a Note Book.

Parameters

notebook_name (str) – The notebook name. Required.
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

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

Returns

NotebookResource or None or the result of cls(response)

Return type

NotebookResource or None

Raises

AsyncLROPoller[PipelineResource]

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

Lists a summary of Notebooks.

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

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

Lists Notebooks.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either NotebookResource or the result of cls(response)
Return type: AsyncItemPaged[NotebookResource]
Raises: 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)[source]¶

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: _models.PipelineResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.PipelineResource][source]¶

async begin_create_or_update_pipeline(pipeline_name: str, pipeline: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.PipelineResource]

Creates or updates a pipeline.

Parameters

pipeline_name (str) – The pipeline name. Required.
pipeline (PipelineResource or IO) – Pipeline resource definition. Is either a model type or a IO type. Required.
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

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

Raises

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

Deletes a pipeline.

Parameters

pipeline_name (str) – The pipeline name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Renames a pipeline.

Parameters

pipeline_name (str) – The pipeline name. Required.
new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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, JSON]] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CreateRunResponse[source]¶

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[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CreateRunResponse

Creates a run of a pipeline.

Parameters

pipeline_name (str) – The pipeline name. Required.
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, JSON] or IO) – Parameters of the pipeline run. These parameters will be used only if the runId is not specified. Is either a dict type or a IO type. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

async get_pipeline(pipeline_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.synapse.artifacts.models._models_py3.PipelineResource][source]¶

Gets a pipeline.

Parameters

pipeline_name (str) – The pipeline name. Required.
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

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

Returns

PipelineResource or None or the result of cls(response)

Return type

PipelineResource or None

Raises

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

Lists pipelines.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either PipelineResource or the result of cls(response)
Return type: AsyncItemPaged[PipelineResource]
Raises: 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)[source]¶

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 [source]¶

Cancel a pipeline run by its run ID.

Parameters

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

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

ActivityRunsQueryResponse

async get_pipeline_run(run_id: str, **kwargs: Any) → azure.synapse.artifacts.models._models_py3.PipelineRun[source]¶

Get a pipeline run by its run ID.

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

async query_activity_runs(pipeline_name: str, run_id: str, filter_parameters: _models.RunFilterParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ActivityRunsQueryResponse[source]¶

async query_activity_runs(pipeline_name: str, run_id: str, filter_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ActivityRunsQueryResponse

Query activity runs based on input filter conditions.

Parameters

pipeline_name (str) – The pipeline name. Required.
run_id (str) – The pipeline run identifier. Required.
filter_parameters (RunFilterParameters or IO) – Parameters to filter the activity runs. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ActivityRunsQueryResponse or the result of cls(response)

Return type

Raises

PipelineRunsQueryResponse

async query_pipeline_runs_by_workspace(filter_parameters: _models.RunFilterParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PipelineRunsQueryResponse[source]¶

async query_pipeline_runs_by_workspace(filter_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PipelineRunsQueryResponse

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

Parameters

filter_parameters (RunFilterParameters or IO) – Parameters to filter the pipeline run. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

PipelineRunsQueryResponse or the result of cls(response)

Return type

Raises

AsyncLROPoller[SparkConfigurationResource]

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)[source]¶

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][source]¶

Creates or updates a sparkconfiguration.

Parameters

spark_configuration_name (str) – The spark Configuration name. Required.
properties (SparkConfiguration) – Properties of Spark Configuration. Required.
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

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

Raises

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

Deletes a sparkConfiguration.

Parameters

spark_configuration_name (str) – The spark Configuration name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Renames a sparkConfiguration.

Parameters

spark_configuration_name (str) – The spark Configuration name. Required.
new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Gets a sparkConfiguration.

Parameters

spark_configuration_name (str) – The spark Configuration name. Required.
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

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

Returns

SparkConfigurationResource or None or the result of cls(response)

Return type

SparkConfigurationResource or None

Raises

AsyncLROPoller[SparkJobDefinitionResource]

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

Lists sparkconfigurations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SparkConfigurationResource or the result of cls(response)
Return type: AsyncItemPaged[SparkConfigurationResource]
Raises: 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)[source]¶

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][source]¶

Creates or updates a Spark Job Definition.

Parameters

spark_job_definition_name (str) – The spark job definition name. Required.
properties (SparkJobDefinition) – Properties of spark job definition. Required.
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

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

Raises

AsyncLROPoller[SparkBatchJob]

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][source]¶

Debug the spark job definition.

Parameters

properties (SparkJobDefinition) – Properties of spark job definition. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Deletes a Spark Job Definition.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

AsyncLROPoller[SparkBatchJob]

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][source]¶

Executes the spark job definition.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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][source]¶

Renames a sparkJobDefinition.

Parameters

spark_job_definition_name (str) – The spark job definition name. Required.
new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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][source]¶

Gets a Spark Job Definition.

Parameters

spark_job_definition_name (str) – The spark job definition name. Required.
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

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

Returns

SparkJobDefinitionResource or None or the result of cls(response)

Return type

SparkJobDefinitionResource or None

Raises

AsyncLROPoller[SqlScriptResource]

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

Lists spark job definitions.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SparkJobDefinitionResource or the result of cls(response)
Return type: AsyncItemPaged[SparkJobDefinitionResource]
Raises: 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)[source]¶

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[source]¶

Get Sql Pool.

Parameters: sql_pool_name (str) – The Sql Pool name. Required.
Keyword Arguments: 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: HttpResponseError –

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

List Sql Pools.

Keyword Arguments: 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: 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)[source]¶

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: _models.SqlScriptResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.SqlScriptResource][source]¶

async begin_create_or_update_sql_script(sql_script_name: str, sql_script: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → AsyncLROPoller[_models.SqlScriptResource]

Creates or updates a Sql Script.

Parameters

sql_script_name (str) – The sql script name. Required.
sql_script (SqlScriptResource or IO) – Sql Script resource definition. Is either a model type or a IO type. Required.
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

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

Raises

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

Deletes a Sql Script.

Parameters

sql_script_name (str) – The sql script name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Renames a sqlScript.

Parameters

sql_script_name (str) – The sql script name. Required.
new_name (str) – New name of the artifact. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Gets a sql script.

Parameters

sql_script_name (str) – The sql script name. Required.
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

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

Returns

SqlScriptResource or None or the result of cls(response)

Return type

SqlScriptResource or None

Raises

AsyncLROPoller[TriggerResource]

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

Lists sql scripts.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SqlScriptResource or the result of cls(response)
Return type: AsyncItemPaged[SqlScriptResource]
Raises: 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)[source]¶

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][source]¶

Creates or updates a trigger.

Parameters

trigger_name (str) – The trigger name. Required.
properties (Trigger) – Properties of the trigger. Required.
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

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

Raises

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

Deletes a trigger.

Parameters

trigger_name (str) – The trigger name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Starts a trigger.

Parameters

trigger_name (str) – The trigger name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Stops a trigger.

Parameters

trigger_name (str) – The trigger name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

AsyncLROPoller[TriggerSubscriptionOperationStatus]

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

Subscribe event trigger to events.

Parameters

trigger_name (str) – The trigger name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

AsyncLROPoller[TriggerSubscriptionOperationStatus]

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

Unsubscribe event trigger from events.

Parameters

trigger_name (str) – The trigger name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – 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

Raises

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

Get a trigger’s event subscription status.

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

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

Gets a trigger.

Parameters

trigger_name (str) – The trigger name. Required.
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

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

Returns

TriggerResource or None or the result of cls(response)

Return type

TriggerResource or None

Raises

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

Lists triggers.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either TriggerResource or the result of cls(response)
Return type: AsyncItemPaged[TriggerResource]
Raises: 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)[source]¶

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 [source]¶

Cancel single trigger instance by runId.

Parameters

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

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

async query_trigger_runs_by_workspace(filter_parameters: _models.RunFilterParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TriggerRunsQueryResponse[source]¶

async query_trigger_runs_by_workspace(filter_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TriggerRunsQueryResponse

Query trigger runs.

Parameters

filter_parameters (RunFilterParameters or IO) – Parameters to filter the pipeline run. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

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

Rerun single trigger instance by runId.

Parameters

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

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

GitHubAccessTokenResponse

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)[source]¶

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: _models.GitHubAccessTokenRequest, client_request_id: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GitHubAccessTokenResponse[source]¶

async get_git_hub_access_token(git_hub_access_token_request: IO, client_request_id: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GitHubAccessTokenResponse

Get the GitHub access token.

Parameters

git_hub_access_token_request (GitHubAccessTokenRequest or IO) – Is either a model type or a IO type. Required.
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

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

GitHubAccessTokenResponse or the result of cls(response)

Return type

Raises