azure.synapse.artifacts.operations package

class azure.synapse.artifacts.operations.BigDataPoolsOperations(client, config, serializer, deserializer)[source]

BigDataPoolsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

get(big_data_pool_name: str, **kwargs: Any)_models.BigDataPoolResourceInfo[source]

Get Big Data Pool.

Parameters

big_data_pool_name (str) – The Big Data Pool name.

Keyword Arguments
  • api_version (str) – Api Version. The 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

list(**kwargs: Any)_models.BigDataPoolResourceInfoListResult[source]

List Big Data Pools.

Keyword Arguments
  • api_version (str) – Api Version. The 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.operations.DataFlowDebugSessionOperations(client, config, serializer, deserializer)[source]

DataFlowDebugSessionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

add_data_flow(request: _models.DataFlowDebugPackage, **kwargs: Any)_models.AddDataFlowToDebugSessionResponse[source]

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

begin_create_data_flow_debug_session(request: _models.CreateDataFlowDebugSessionRequest, **kwargs: Any)LROPoller[_models.CreateDataFlowDebugSessionResponse][source]

Creates a data flow debug session.

Parameters

request (CreateDataFlowDebugSessionRequest) – Data flow debug session definition.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either CreateDataFlowDebugSessionResponse or the result of cls(response)

Return type

LROPoller[CreateDataFlowDebugSessionResponse]

Raises

~azure.core.exceptions.HttpResponseError

begin_execute_command(request: _models.DataFlowDebugCommandRequest, **kwargs: Any)LROPoller[_models.DataFlowDebugCommandResponse][source]

Execute a data flow debug command.

Parameters

request (DataFlowDebugCommandRequest) – Data flow debug command definition.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either DataFlowDebugCommandResponse or the result of cls(response)

Return type

LROPoller[DataFlowDebugCommandResponse]

Raises

~azure.core.exceptions.HttpResponseError

delete_data_flow_debug_session(request: _models.DeleteDataFlowDebugSessionRequest, **kwargs: Any)None[source]

Deletes a data flow debug session.

Parameters

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

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.QueryDataFlowDebugSessionsResponse][source]

Query all active data flow debug sessions.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.DataFlowOperations(client, config, serializer, deserializer)[source]

DataFlowOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update_data_flow(data_flow_name: str, properties: _models.DataFlow, if_match: Optional[str] = None, **kwargs: Any)LROPoller[_models.DataFlowResource][source]

Creates or updates a data flow.

Parameters
  • data_flow_name (str) – The data flow name.

  • properties (DataFlow) – Data flow properties.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either DataFlowResource or the result of cls(response)

Return type

LROPoller[DataFlowResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_data_flow(data_flow_name: str, **kwargs: Any)LROPoller[None][source]

Deletes a data flow.

Parameters

data_flow_name (str) – The data flow name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_rename_data_flow(data_flow_name: str, new_name: Optional[str] = None, **kwargs: Any)LROPoller[None][source]

Renames a dataflow.

Parameters
  • data_flow_name (str) – The data flow name.

  • new_name (str) – New name of the artifact.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get_data_flow(data_flow_name: str, if_none_match: Optional[str] = None, **kwargs: Any)_models.DataFlowResource[source]

Gets a data flow.

Parameters
  • data_flow_name (str) – The data flow name.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.DataFlowListResponse][source]

Lists data flows.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.DatasetOperations(client, config, serializer, deserializer)[source]

DatasetOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update_dataset(dataset_name: str, properties: _models.Dataset, if_match: Optional[str] = None, **kwargs: Any)LROPoller[_models.DatasetResource][source]

Creates or updates a dataset.

Parameters
  • dataset_name (str) – The dataset name.

  • properties (Dataset) – Dataset properties.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either DatasetResource or the result of cls(response)

Return type

LROPoller[DatasetResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_dataset(dataset_name: str, **kwargs: Any)LROPoller[None][source]

Deletes a dataset.

Parameters

dataset_name (str) – The dataset name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_rename_dataset(dataset_name: str, new_name: Optional[str] = None, **kwargs: Any)LROPoller[None][source]

Renames a dataset.

Parameters
  • dataset_name (str) – The dataset name.

  • new_name (str) – New name of the artifact.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get_dataset(dataset_name: str, if_none_match: Optional[str] = None, **kwargs: Any)Optional[_models.DatasetResource][source]

Gets a dataset.

Parameters
  • dataset_name (str) – The dataset name.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.DatasetListResponse][source]

Lists datasets.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.IntegrationRuntimesOperations(client, config, serializer, deserializer)[source]

IntegrationRuntimesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

get(integration_runtime_name: str, **kwargs: Any)_models.IntegrationRuntimeResource[source]

Get Integration Runtime.

Parameters

integration_runtime_name (str) – The Integration Runtime name.

Keyword Arguments
  • api_version (str) – Api Version. The 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

list(**kwargs: Any)_models.IntegrationRuntimeListResponse[source]

List Integration Runtimes.

Keyword Arguments
  • api_version (str) – Api Version. The 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.operations.KqlScriptOperations(client, config, serializer, deserializer)[source]

KqlScriptOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update(kql_script_name: str, kql_script: _models.KqlScriptResource, **kwargs: Any)LROPoller[_models.KqlScriptResource][source]

Creates or updates a KQL Script.

Parameters
Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either KqlScriptResource or the result of cls(response)

Return type

LROPoller[KqlScriptResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_by_name(kql_script_name: str, **kwargs: Any)LROPoller[None][source]

Delete KQL script by name.

Parameters

kql_script_name (str) – KQL script name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_rename(kql_script_name: str, new_name: Optional[str] = None, **kwargs: Any)LROPoller[None][source]

Rename KQL script.

Parameters
  • kql_script_name (str) – KQL script name.

  • new_name (str) – New name of the artifact.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get_by_name(kql_script_name: str, **kwargs: Any)_models.KqlScriptResource[source]

Get KQL script by name.

Parameters

kql_script_name (str) – KQL script name.

Keyword Arguments
  • api_version (str) – Api Version. The 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.operations.KqlScriptsOperations(client, config, serializer, deserializer)[source]

KqlScriptsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

get_all(**kwargs: Any)Iterable[_models.KqlScriptsResourceCollectionResponse][source]

Get all KQL scripts.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.LibraryOperations(client, config, serializer, deserializer)[source]

LibraryOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

append(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
  • 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).

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

  • api_version (str) – Api Version. The 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

begin_create(library_name: str, **kwargs: Any)LROPoller[_models.LibraryResourceInfo][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.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either LibraryResourceInfo or the result of cls(response)

Return type

LROPoller[LibraryResourceInfo]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(library_name: str, **kwargs: Any)LROPoller[_models.LibraryResourceInfo][source]

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. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either LibraryResourceInfo or the result of cls(response)

Return type

LROPoller[LibraryResourceInfo]

Raises

~azure.core.exceptions.HttpResponseError

begin_flush(library_name: str, **kwargs: Any)LROPoller[_models.LibraryResourceInfo][source]

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. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either LibraryResourceInfo or the result of cls(response)

Return type

LROPoller[LibraryResourceInfo]

Raises

~azure.core.exceptions.HttpResponseError

get(library_name: str, **kwargs: Any)Optional[_models.LibraryResource][source]

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

get_operation_result(operation_id: str, **kwargs: Any)Union[_models.LibraryResource, _models.OperationResult][source]

Get Operation result for Library.

Parameters

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

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.LibraryListResponse][source]

Lists Library.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.LinkedServiceOperations(client, config, serializer, deserializer)[source]

LinkedServiceOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update_linked_service(linked_service_name: str, properties: _models.LinkedService, if_match: Optional[str] = None, **kwargs: Any)LROPoller[_models.LinkedServiceResource][source]

Creates or updates a linked service.

Parameters
  • linked_service_name (str) – The linked service name.

  • properties (LinkedService) – Properties of linked service.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either LinkedServiceResource or the result of cls(response)

Return type

LROPoller[LinkedServiceResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_linked_service(linked_service_name: str, **kwargs: Any)LROPoller[None][source]

Deletes a linked service.

Parameters

linked_service_name (str) – The linked service name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_rename_linked_service(linked_service_name: str, new_name: Optional[str] = None, **kwargs: Any)LROPoller[None][source]

Renames a linked service.

Parameters
  • linked_service_name (str) – The linked service name.

  • new_name (str) – New name of the artifact.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get_linked_service(linked_service_name: str, if_none_match: Optional[str] = None, **kwargs: Any)Optional[_models.LinkedServiceResource][source]

Gets a linked service.

Parameters
  • linked_service_name (str) – The linked service name.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.LinkedServiceListResponse][source]

Lists linked services.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.MetastoreOperations(client, config, serializer, deserializer)[source]

MetastoreOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

delete(id: str, **kwargs: Any)None[source]

Remove files in Syms.

Parameters

id (str) –

Keyword Arguments
  • api_version (str) – Api Version. The 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

get_database_operations(id: str, **kwargs: Any)_models.MetastoreRequestSuccessResponse[source]

Gets status of the database.

Parameters

id (str) –

Keyword Arguments
  • api_version (str) – Api Version. The 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

register(id: str, input_folder: str, **kwargs: Any)_models.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.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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

update(id: str, input_folder: str, **kwargs: Any)_models.MetastoreUpdationResponse[source]

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. The 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.operations.NotebookOperationResultOperations(client, config, serializer, deserializer)[source]

NotebookOperationResultOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

get(operation_id: str, **kwargs: Any)None[source]

Get notebook operation result.

Parameters

operation_id (str) – Operation ID.

Keyword Arguments
  • api_version (str) – Api Version. The 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.operations.NotebookOperations(client, config, serializer, deserializer)[source]

NotebookOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update_notebook(notebook_name: str, notebook: _models.NotebookResource, if_match: Optional[str] = None, **kwargs: Any)LROPoller[_models.NotebookResource][source]

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.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either NotebookResource or the result of cls(response)

Return type

LROPoller[NotebookResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_notebook(notebook_name: str, **kwargs: Any)LROPoller[None][source]

Deletes a Note book.

Parameters

notebook_name (str) – The notebook name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_rename_notebook(notebook_name: str, new_name: Optional[str] = None, **kwargs: Any)LROPoller[None][source]

Renames a notebook.

Parameters
  • notebook_name (str) – The notebook name.

  • new_name (str) – New name of the artifact.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get_notebook(notebook_name: str, if_none_match: Optional[str] = None, **kwargs: Any)Optional[_models.NotebookResource][source]

Gets a Note Book.

Parameters
  • notebook_name (str) – The notebook name.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.NotebookListResponse][source]

Lists a summary of Notebooks.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[NotebookListResponse]

Raises

~azure.core.exceptions.HttpResponseError

get_notebooks_by_workspace(**kwargs: Any)Iterable[_models.NotebookListResponse][source]

Lists Notebooks.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.PipelineOperations(client, config, serializer, deserializer)[source]

PipelineOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update_pipeline(pipeline_name: str, pipeline: _models.PipelineResource, if_match: Optional[str] = None, **kwargs: Any)LROPoller[_models.PipelineResource][source]

Creates or updates a pipeline.

Parameters
  • pipeline_name (str) – The pipeline name.

  • pipeline (PipelineResource) – Pipeline resource definition.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either PipelineResource or the result of cls(response)

Return type

LROPoller[PipelineResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_pipeline(pipeline_name: str, **kwargs: Any)LROPoller[None][source]

Deletes a pipeline.

Parameters

pipeline_name (str) – The pipeline name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_rename_pipeline(pipeline_name: str, new_name: Optional[str] = None, **kwargs: Any)LROPoller[None][source]

Renames a pipeline.

Parameters
  • pipeline_name (str) – The pipeline name.

  • new_name (str) – New name of the artifact.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

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)_models.CreateRunResponse[source]

Creates a run of a pipeline.

Parameters
  • pipeline_name (str) – The pipeline name.

  • reference_pipeline_run_id (str) – The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.

  • is_recovery (bool) – Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.

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

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

Keyword Arguments
  • api_version (str) – Api Version. The 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

get_pipeline(pipeline_name: str, if_none_match: Optional[str] = None, **kwargs: Any)Optional[_models.PipelineResource][source]

Gets a pipeline.

Parameters
  • pipeline_name (str) – The pipeline name.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.PipelineListResponse][source]

Lists pipelines.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.PipelineRunOperations(client, config, serializer, deserializer)[source]

PipelineRunOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

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.

  • is_recursive (bool) – If true, cancel all the Child pipelines that are triggered by the current pipeline.

Keyword Arguments
  • api_version (str) – Api Version. The 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

get_pipeline_run(run_id: str, **kwargs: Any)_models.PipelineRun[source]

Get a pipeline run by its run ID.

Parameters

run_id (str) – The pipeline run identifier.

Keyword Arguments
  • api_version (str) – Api Version. The 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

query_activity_runs(pipeline_name: str, run_id: str, filter_parameters: _models.RunFilterParameters, **kwargs: Any)_models.ActivityRunsQueryResponse[source]

Query activity runs based on input filter conditions.

Parameters
  • pipeline_name (str) – The pipeline name.

  • run_id (str) – The pipeline run identifier.

  • filter_parameters (RunFilterParameters) – Parameters to filter the activity runs.

Keyword Arguments
  • api_version (str) – Api Version. The 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

query_pipeline_runs_by_workspace(filter_parameters: _models.RunFilterParameters, **kwargs: Any)_models.PipelineRunsQueryResponse[source]

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

Parameters

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

Keyword Arguments
  • api_version (str) – Api Version. The 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.operations.SparkConfigurationOperations(client, config, serializer, deserializer)[source]

SparkConfigurationOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update_spark_configuration(spark_configuration_name: str, properties: _models.SparkConfiguration, if_match: Optional[str] = None, **kwargs: Any)LROPoller[_models.SparkConfigurationResource][source]

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.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either SparkConfigurationResource or the result of cls(response)

Return type

LROPoller[SparkConfigurationResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_spark_configuration(spark_configuration_name: str, **kwargs: Any)LROPoller[None][source]

Deletes a sparkConfiguration.

Parameters

spark_configuration_name (str) – The spark Configuration name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_rename_spark_configuration(spark_configuration_name: str, new_name: Optional[str] = None, **kwargs: Any)LROPoller[None][source]

Renames a sparkConfiguration.

Parameters
  • spark_configuration_name (str) – The spark Configuration name.

  • new_name (str) – New name of the artifact.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get_spark_configuration(spark_configuration_name: str, if_none_match: Optional[str] = None, **kwargs: Any)Optional[_models.SparkConfigurationResource][source]

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.

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.SparkConfigurationListResponse][source]

Lists sparkconfigurations.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.SparkJobDefinitionOperations(client, config, serializer, deserializer)[source]

SparkJobDefinitionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update_spark_job_definition(spark_job_definition_name: str, properties: _models.SparkJobDefinition, if_match: Optional[str] = None, **kwargs: Any)LROPoller[_models.SparkJobDefinitionResource][source]

Creates or updates a Spark Job Definition.

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

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

  • if_match (str) – ETag of the Spark Job Definition entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either SparkJobDefinitionResource or the result of cls(response)

Return type

LROPoller[SparkJobDefinitionResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_debug_spark_job_definition(properties: _models.SparkJobDefinition, **kwargs: Any)LROPoller[_models.SparkBatchJob][source]

Debug the spark job definition.

Parameters

properties (SparkJobDefinition) – Properties of spark job definition.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either SparkBatchJob or the result of cls(response)

Return type

LROPoller[SparkBatchJob]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_spark_job_definition(spark_job_definition_name: str, **kwargs: Any)LROPoller[None][source]

Deletes a Spark Job Definition.

Parameters

spark_job_definition_name (str) – The spark job definition name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_execute_spark_job_definition(spark_job_definition_name: str, **kwargs: Any)LROPoller[_models.SparkBatchJob][source]

Executes the spark job definition.

Parameters

spark_job_definition_name (str) – The spark job definition name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either SparkBatchJob or the result of cls(response)

Return type

LROPoller[SparkBatchJob]

Raises

~azure.core.exceptions.HttpResponseError

begin_rename_spark_job_definition(spark_job_definition_name: str, new_name: Optional[str] = None, **kwargs: Any)LROPoller[None][source]

Renames a sparkJobDefinition.

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

  • new_name (str) – New name of the artifact.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get_spark_job_definition(spark_job_definition_name: str, if_none_match: Optional[str] = None, **kwargs: Any)Optional[_models.SparkJobDefinitionResource][source]

Gets a Spark Job Definition.

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

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

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.SparkJobDefinitionsListResponse][source]

Lists spark job definitions.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.SqlPoolsOperations(client, config, serializer, deserializer)[source]

SqlPoolsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

get(sql_pool_name: str, **kwargs: Any)_models.SqlPool[source]

Get Sql Pool.

Parameters

sql_pool_name (str) – The Sql Pool name.

Keyword Arguments
  • api_version (str) – Api Version. The 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

list(**kwargs: Any)_models.SqlPoolInfoListResult[source]

List Sql Pools.

Keyword Arguments
  • api_version (str) – Api Version. The 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.operations.SqlScriptOperations(client, config, serializer, deserializer)[source]

SqlScriptOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update_sql_script(sql_script_name: str, sql_script: _models.SqlScriptResource, if_match: Optional[str] = None, **kwargs: Any)LROPoller[_models.SqlScriptResource][source]

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.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either SqlScriptResource or the result of cls(response)

Return type

LROPoller[SqlScriptResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_sql_script(sql_script_name: str, **kwargs: Any)LROPoller[None][source]

Deletes a Sql Script.

Parameters

sql_script_name (str) – The sql script name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_rename_sql_script(sql_script_name: str, new_name: Optional[str] = None, **kwargs: Any)LROPoller[None][source]

Renames a sqlScript.

Parameters
  • sql_script_name (str) – The sql script name.

  • new_name (str) – New name of the artifact.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get_sql_script(sql_script_name: str, if_none_match: Optional[str] = None, **kwargs: Any)Optional[_models.SqlScriptResource][source]

Gets a sql script.

Parameters
  • sql_script_name (str) – The sql script name.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.SqlScriptsListResponse][source]

Lists sql scripts.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.TriggerOperations(client, config, serializer, deserializer)[source]

TriggerOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

begin_create_or_update_trigger(trigger_name: str, properties: _models.Trigger, if_match: Optional[str] = None, **kwargs: Any)LROPoller[_models.TriggerResource][source]

Creates or updates a trigger.

Parameters
  • trigger_name (str) – The trigger name.

  • properties (Trigger) – Properties of the trigger.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either TriggerResource or the result of cls(response)

Return type

LROPoller[TriggerResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_trigger(trigger_name: str, **kwargs: Any)LROPoller[None][source]

Deletes a trigger.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_start_trigger(trigger_name: str, **kwargs: Any)LROPoller[None][source]

Starts a trigger.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_stop_trigger(trigger_name: str, **kwargs: Any)LROPoller[None][source]

Stops a trigger.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_subscribe_trigger_to_events(trigger_name: str, **kwargs: Any)LROPoller[_models.TriggerSubscriptionOperationStatus][source]

Subscribe event trigger to events.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either TriggerSubscriptionOperationStatus or the result of cls(response)

Return type

LROPoller[TriggerSubscriptionOperationStatus]

Raises

~azure.core.exceptions.HttpResponseError

begin_unsubscribe_trigger_from_events(trigger_name: str, **kwargs: Any)LROPoller[_models.TriggerSubscriptionOperationStatus][source]

Unsubscribe event trigger from events.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments
  • api_version (str) – Api Version. The 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 PollingMethod) – By default, your polling method will be LROBasePolling. 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 LROPoller that returns either TriggerSubscriptionOperationStatus or the result of cls(response)

Return type

LROPoller[TriggerSubscriptionOperationStatus]

Raises

~azure.core.exceptions.HttpResponseError

get_event_subscription_status(trigger_name: str, **kwargs: Any)_models.TriggerSubscriptionOperationStatus[source]

Get a trigger’s event subscription status.

Parameters

trigger_name (str) – The trigger name.

Keyword Arguments
  • api_version (str) – Api Version. The 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

get_trigger(trigger_name: str, if_none_match: Optional[str] = None, **kwargs: Any)Optional[_models.TriggerResource][source]

Gets a trigger.

Parameters
  • trigger_name (str) – The trigger name.

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

Keyword Arguments
  • api_version (str) – Api Version. The 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)Iterable[_models.TriggerListResponse][source]

Lists triggers.

Keyword Arguments
  • api_version (str) – Api Version. The 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

ItemPaged[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.operations.TriggerRunOperations(client, config, serializer, deserializer)[source]

TriggerRunOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

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.

  • run_id (str) – The pipeline run identifier.

Keyword Arguments
  • api_version (str) – Api Version. The 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_trigger_runs_by_workspace(filter_parameters: _models.RunFilterParameters, **kwargs: Any)_models.TriggerRunsQueryResponse[source]

Query trigger runs.

Parameters

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

Keyword Arguments
  • api_version (str) – Api Version. The 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

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.

  • run_id (str) – The pipeline run identifier.

Keyword Arguments
  • api_version (str) – Api Version. The 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.operations.WorkspaceGitRepoManagementOperations(client, config, serializer, deserializer)[source]

WorkspaceGitRepoManagementOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

get_git_hub_access_token(git_hub_access_token_request: _models.GitHubAccessTokenRequest, client_request_id: Optional[str] = None, **kwargs: Any)_models.GitHubAccessTokenResponse[source]

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.

Keyword Arguments
  • api_version (str) – Api Version. The 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.operations.WorkspaceOperations(client, config, serializer, deserializer)[source]

WorkspaceOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

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

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

get(**kwargs: Any)_models.Workspace[source]

Get Workspace.

Keyword Arguments
  • api_version (str) – Api Version. The 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'>