azure.synapse.artifacts.models package

class azure.synapse.artifacts.models.Activity(*, name: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, **kwargs)

A pipeline activity.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ControlActivity, ExecutionActivity, SqlPoolStoredProcedureActivity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ActivityDependency(*, activity: str, dependency_conditions: List[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DependencyCondition]], additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

Activity dependency information.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• activity (str) – Required. Activity name.

• dependency_conditions (list[str or DependencyCondition]) – Required. Match-Condition for the dependency.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• activity (str) – Required. Activity name.

• dependency_conditions (list[str or DependencyCondition]) – Required. Match-Condition for the dependency.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ActivityPolicy(*, additional_properties: Optional[Dict[str, Any]] = None, timeout: Optional[Any] = None, retry: Optional[Any] = None, retry_interval_in_seconds: Optional[int] = None, secure_input: Optional[bool] = None, secure_output: Optional[bool] = None, **kwargs)

Execution policy for an activity.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• timeout (any) – Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• retry (any) – Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.

• retry_interval_in_seconds (int) – Interval between each retry attempt (in seconds). The default is 30 sec.

• secure_input (bool) – When set to true, Input from activity is considered as secure and will not be logged to monitoring.

• secure_output (bool) – When set to true, Output from activity is considered as secure and will not be logged to monitoring.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• timeout (any) – Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• retry (any) – Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.

• retry_interval_in_seconds (int) – Interval between each retry attempt (in seconds). The default is 30 sec.

• secure_input (bool) – When set to true, Input from activity is considered as secure and will not be logged to monitoring.

• secure_output (bool) – When set to true, Output from activity is considered as secure and will not be logged to monitoring.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ActivityRun(*, additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

Information about an activity run in a pipeline.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• pipeline_name (str) – The name of the pipeline.

• pipeline_run_id (str) – The id of the pipeline run.

• activity_name (str) – The name of the activity.

• activity_type (str) – The type of the activity.

• activity_run_id (str) – The id of the activity run.

• linked_service_name (str) – The name of the compute linked service.

• status (str) – The status of the activity run.

• activity_run_start (datetime) – The start time of the activity run in ‘ISO 8601’ format.

• activity_run_end (datetime) – The end time of the activity run in ‘ISO 8601’ format.

• duration_in_ms (int) – The duration of the activity run.

• input (any) – The input for the activity.

• output (any) – The output for the activity.

• error (any) – The error if any from the activity run.

Keyword Arguments

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ActivityRunsQueryResponse(*, value: List[azure.synapse.artifacts.models._models_py3.ActivityRun], continuation_token: Optional[str] = None, **kwargs)

A list activity runs.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[ActivityRun]) – Required. List of activity runs.

• continuation_token (str) – The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

Keyword Arguments

• value (list[ActivityRun]) – Required. List of activity runs.

• continuation_token (str) – The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse(*, job_version: Optional[str] = None, **kwargs)

Response body structure for starting data flow debug session.

Variables

job_version (str) – The ID of data flow debug job version.

Keyword Arguments

job_version (str) – The ID of data flow debug job version.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AdditionalColumns(*, name: Optional[Any] = None, value: Optional[Any] = None, **kwargs)

Specify the column name and value of additional columns.

Variables

• name (any) – Additional column name. Type: string (or Expression with resultType string).

• value (any) – Additional column value. Type: string (or Expression with resultType string).

Keyword Arguments

• name (any) – Additional column name. Type: string (or Expression with resultType string).

• value (any) – Additional column value. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonMWSLinkedService(*, endpoint: Any, marketplace_id: Any, seller_id: Any, access_key_id: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, mws_auth_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, secret_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Amazon Marketplace Web Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com).

• marketplace_id (any) – Required. The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2).

• seller_id (any) – Required. The Amazon seller ID.

• mws_auth_token (SecretBase) – The Amazon MWS authentication token.

• access_key_id (any) – Required. The access key id used to access data.

• secret_key (SecretBase) – The secret key used to access data.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com).

• marketplace_id (any) – Required. The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2).

• seller_id (any) – Required. The Amazon seller ID.

• mws_auth_token (SecretBase) – The Amazon MWS authentication token.

• access_key_id (any) – Required. The access key id used to access data.

• secret_key (SecretBase) – The secret key used to access data.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonMWSObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Amazon Marketplace Web Service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonMWSSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Amazon Marketplace Web Service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonRdsForOracleLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

AmazonRdsForOracle database.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (SecretBase) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (SecretBase) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonRdsForOraclePartitionOption(value)

An enumeration.

DYNAMIC_RANGE = 'DynamicRange'

NONE = 'None'

PHYSICAL_PARTITIONS_OF_TABLE = 'PhysicalPartitionsOfTable'

class azure.synapse.artifacts.models.AmazonRdsForOraclePartitionSettings(*, partition_names: Optional[Any] = None, partition_column_name: Optional[Any] = None, partition_upper_bound: Optional[Any] = None, partition_lower_bound: Optional[Any] = None, **kwargs)

The settings that will be leveraged for AmazonRdsForOracle source partitioning.

Variables

• partition_names (any) – Names of the physical partitions of AmazonRdsForOracle table.

• partition_column_name (any) – The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

Keyword Arguments

• partition_names (any) – Names of the physical partitions of AmazonRdsForOracle table.

• partition_column_name (any) – The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonRdsForOracleSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, oracle_reader_query: Optional[Any] = None, query_timeout: Optional[Any] = None, partition_option: Optional[Any] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.AmazonRdsForOraclePartitionSettings] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity AmazonRdsForOracle source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• oracle_reader_query (any) – AmazonRdsForOracle reader query. Type: string (or Expression with resultType string).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• partition_option (any) – The partition mechanism that will be used for AmazonRdsForOracle read in parallel. Type: string (or Expression with resultType string).

• partition_settings (AmazonRdsForOraclePartitionSettings) – The settings that will be leveraged for AmazonRdsForOracle source partitioning.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• oracle_reader_query (any) – AmazonRdsForOracle reader query. Type: string (or Expression with resultType string).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• partition_option (any) – The partition mechanism that will be used for AmazonRdsForOracle read in parallel. Type: string (or Expression with resultType string).

• partition_settings (AmazonRdsForOraclePartitionSettings) – The settings that will be leveraged for AmazonRdsForOracle source partitioning.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonRdsForOracleTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, schema_type_properties_schema: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The AmazonRdsForOracle database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• schema_type_properties_schema (any) – The schema name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).

• table (any) – The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• schema_type_properties_schema (any) – The schema name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).

• table (any) – The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonRdsForSqlServerLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Amazon RDS for SQL Server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• user_name (any) – The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

• password (SecretBase) – The on-premises Windows authentication password.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• user_name (any) – The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

• password (SecretBase) – The on-premises Windows authentication password.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonRdsForSqlServerSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, sql_reader_query: Optional[Any] = None, sql_reader_stored_procedure_name: Optional[Any] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, produce_additional_types: Optional[Any] = None, partition_option: Optional[Any] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.SqlPartitionSettings] = None, **kwargs)

A copy activity Amazon RDS for SQL Server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

• produce_additional_types (any) – Which additional types to produce.

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

• produce_additional_types (any) – Which additional types to produce.

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonRdsForSqlServerTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, schema_type_properties_schema: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The Amazon RDS for SQL Server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• schema_type_properties_schema (any) – The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).

• table (any) – The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• schema_type_properties_schema (any) – The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).

• table (any) – The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonRedshiftLinkedService(*, server: Any, database: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, port: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for Amazon Redshift.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Required. The name of the Amazon Redshift server. Type: string (or Expression with resultType string).

• username (any) – The username of the Amazon Redshift source. Type: string (or Expression with resultType string).

• password (SecretBase) – The password of the Amazon Redshift source.

• database (any) – Required. The database name of the Amazon Redshift source. Type: string (or Expression with resultType string).

• port (any) – The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Required. The name of the Amazon Redshift server. Type: string (or Expression with resultType string).

• username (any) – The username of the Amazon Redshift source. Type: string (or Expression with resultType string).

• password (SecretBase) – The password of the Amazon Redshift source.

• database (any) – Required. The database name of the Amazon Redshift source. Type: string (or Expression with resultType string).

• port (any) – The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonRedshiftSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, redshift_unload_settings: Optional[azure.synapse.artifacts.models._models_py3.RedshiftUnloadSettings] = None, **kwargs)

A copy activity source for Amazon Redshift Source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

• redshift_unload_settings (RedshiftUnloadSettings) – The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

• redshift_unload_settings (RedshiftUnloadSettings) – The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonRedshiftTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

The Amazon Redshift table dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The Amazon Redshift table name. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The Amazon Redshift schema name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The Amazon Redshift table name. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The Amazon Redshift schema name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonS3Dataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, bucket_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, key: Optional[Any] = None, prefix: Optional[Any] = None, version: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, format: Optional[azure.synapse.artifacts.models._models_py3.DatasetStorageFormat] = None, compression: Optional[azure.synapse.artifacts.models._models_py3.DatasetCompression] = None, **kwargs)

A single Amazon Simple Storage Service (S3) object or a set of S3 objects.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• bucket_name (any) – Required. The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).

• key (any) – The key of the Amazon S3 object. Type: string (or Expression with resultType string).

• prefix (any) – The prefix filter for the S3 object name. Type: string (or Expression with resultType string).

• version (any) – The version for the S3 object. Type: string (or Expression with resultType string).

• modified_datetime_start (any) – The start of S3 object’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of S3 object’s modified datetime. Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of files.

• compression (DatasetCompression) – The data compression method used for the Amazon S3 object.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• bucket_name (any) – Required. The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).

• key (any) – The key of the Amazon S3 object. Type: string (or Expression with resultType string).

• prefix (any) – The prefix filter for the S3 object name. Type: string (or Expression with resultType string).

• version (any) – The version for the S3 object. Type: string (or Expression with resultType string).

• modified_datetime_start (any) – The start of S3 object’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of S3 object’s modified datetime. Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of files.

• compression (DatasetCompression) – The data compression method used for the Amazon S3 object.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonS3LinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, authentication_type: Optional[Any] = None, access_key_id: Optional[Any] = None, secret_access_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_url: Optional[Any] = None, session_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for Amazon S3.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• authentication_type (any) – The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string).

• access_key_id (any) – The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).

• secret_access_key (SecretBase) – The secret access key of the Amazon S3 Identity and Access Management (IAM) user.

• service_url (any) – This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

• session_token (SecretBase) – The session token for the S3 temporary security credential.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• authentication_type (any) – The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string).

• access_key_id (any) – The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).

• secret_access_key (SecretBase) – The secret access key of the Amazon S3 Identity and Access Management (IAM) user.

• service_url (any) – This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

• session_token (SecretBase) – The session token for the S3 temporary security credential.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonS3Location(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, bucket_name: Optional[Any] = None, version: Optional[Any] = None, **kwargs)

The location of amazon S3 dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

• bucket_name (any) – Specify the bucketName of amazon S3. Type: string (or Expression with resultType string).

• version (any) – Specify the version of amazon S3. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

• bucket_name (any) – Specify the bucketName of amazon S3. Type: string (or Expression with resultType string).

• version (any) – Specify the version of amazon S3. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AmazonS3ReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, prefix: Optional[Any] = None, file_list_path: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, delete_files_after_completion: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, **kwargs)

Azure data lake store read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – AmazonS3 wildcardFileName. Type: string (or Expression with resultType string).

• prefix (any) – The prefix filter for the S3 object name. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – AmazonS3 wildcardFileName. Type: string (or Expression with resultType string).

• prefix (any) – The prefix filter for the S3 object name. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AppendVariableActivity(*, name: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, variable_name: Optional[str] = None, value: Optional[Any] = None, **kwargs)

Append value for a Variable of type Array.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• variable_name (str) – Name of the variable whose value needs to be appended to.

• value (any) – Value to be appended. Could be a static value or Expression.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• variable_name (str) – Name of the variable whose value needs to be appended to.

• value (any) – Value to be appended. Could be a static value or Expression.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ArtifactRenameRequest(*, new_name: Optional[str] = None, **kwargs)

Request body structure for rename artifact.

Variables

new_name (str) – New name of the artifact.

Keyword Arguments

new_name (str) – New name of the artifact.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AutoPauseProperties(*, delay_in_minutes: Optional[int] = None, enabled: Optional[bool] = None, **kwargs)

Auto-pausing properties of a Big Data pool powered by Apache Spark.

Variables

• delay_in_minutes (int) – Number of minutes of idle time before the Big Data pool is automatically paused.

• enabled (bool) – Whether auto-pausing is enabled for the Big Data pool.

Keyword Arguments

• delay_in_minutes (int) – Number of minutes of idle time before the Big Data pool is automatically paused.

• enabled (bool) – Whether auto-pausing is enabled for the Big Data pool.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AutoScaleProperties(*, min_node_count: Optional[int] = None, enabled: Optional[bool] = None, max_node_count: Optional[int] = None, **kwargs)

Auto-scaling properties of a Big Data pool powered by Apache Spark.

Variables

• min_node_count (int) – The minimum number of nodes the Big Data pool can support.

• enabled (bool) – Whether automatic scaling is enabled for the Big Data pool.

• max_node_count (int) – The maximum number of nodes the Big Data pool can support.

Keyword Arguments

• min_node_count (int) – The minimum number of nodes the Big Data pool can support.

• enabled (bool) – Whether automatic scaling is enabled for the Big Data pool.

• max_node_count (int) – The maximum number of nodes the Big Data pool can support.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AvroCompressionCodec(value)

An enumeration.

BZIP2 = 'bzip2'

DEFLATE = 'deflate'

NONE = 'none'

SNAPPY = 'snappy'

XZ = 'xz'

class azure.synapse.artifacts.models.AvroDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, location: Optional[azure.synapse.artifacts.models._models_py3.DatasetLocation] = None, avro_compression_codec: Optional[Any] = None, avro_compression_level: Optional[int] = None, **kwargs)

Avro dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the avro storage.

• avro_compression_codec (any) – A string from AvroCompressionCodecEnum or an expression.

• avro_compression_level (int) –

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the avro storage.

• avro_compression_codec (any) – A string from AvroCompressionCodecEnum or an expression.

• avro_compression_level (int) –

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AvroFormat(*, additional_properties: Optional[Dict[str, Any]] = None, serializer: Optional[Any] = None, deserializer: Optional[Any] = None, **kwargs)

The data stored in Avro format.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage format.Constant filled by server.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AvroSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreWriteSettings] = None, format_settings: Optional[azure.synapse.artifacts.models._models_py3.AvroWriteSettings] = None, **kwargs)

A copy activity Avro sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – Avro store settings.

• format_settings (AvroWriteSettings) – Avro format settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – Avro store settings.

• format_settings (AvroWriteSettings) – Avro format settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AvroSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreReadSettings] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Avro source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Avro store settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Avro store settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AvroWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, record_name: Optional[str] = None, record_namespace: Optional[str] = None, max_rows_per_file: Optional[Any] = None, file_name_prefix: Optional[Any] = None, **kwargs)

Avro write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• record_name (str) – Top level record name in write result, which is required in AVRO spec.

• record_namespace (str) – Record namespace in the write result.

• max_rows_per_file (any) – Limit the written file’s row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).

• file_name_prefix (any) – Specifies the file name pattern :code:`<fileNamePrefix>`_<fileIndex>.:code:<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• record_name (str) – Top level record name in write result, which is required in AVRO spec.

• record_namespace (str) – Record namespace in the write result.

• max_rows_per_file (any) – Limit the written file’s row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).

• file_name_prefix (any) – Specifies the file name pattern :code:`<fileNamePrefix>`_<fileIndex>.:code:<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBatchLinkedService(*, account_name: Any, batch_uri: Any, pool_name: Any, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, access_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure Batch linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• account_name (any) – Required. The Azure Batch account name. Type: string (or Expression with resultType string).

• access_key (SecretBase) – The Azure Batch account access key.

• batch_uri (any) – Required. The Azure Batch URI. Type: string (or Expression with resultType string).

• pool_name (any) – Required. The Azure Batch pool name. Type: string (or Expression with resultType string).

• linked_service_name (LinkedServiceReference) – Required. The Azure Storage linked service reference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• account_name (any) – Required. The Azure Batch account name. Type: string (or Expression with resultType string).

• access_key (SecretBase) – The Azure Batch account access key.

• batch_uri (any) – Required. The Azure Batch URI. Type: string (or Expression with resultType string).

• pool_name (any) – Required. The Azure Batch pool name. Type: string (or Expression with resultType string).

• linked_service_name (LinkedServiceReference) – Required. The Azure Storage linked service reference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, folder_path: Optional[Any] = None, table_root_location: Optional[Any] = None, file_name: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, format: Optional[azure.synapse.artifacts.models._models_py3.DatasetStorageFormat] = None, compression: Optional[azure.synapse.artifacts.models._models_py3.DatasetCompression] = None, **kwargs)

The Azure Blob storage.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• folder_path (any) – The path of the Azure Blob storage. Type: string (or Expression with resultType string).

• table_root_location (any) – The root of blob path. Type: string (or Expression with resultType string).

• file_name (any) – The name of the Azure Blob. Type: string (or Expression with resultType string).

• modified_datetime_start (any) – The start of Azure Blob’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of Azure Blob’s modified datetime. Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of the Azure Blob storage.

• compression (DatasetCompression) – The data compression method used for the blob storage.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• folder_path (any) – The path of the Azure Blob storage. Type: string (or Expression with resultType string).

• table_root_location (any) – The root of blob path. Type: string (or Expression with resultType string).

• file_name (any) – The name of the Azure Blob. Type: string (or Expression with resultType string).

• modified_datetime_start (any) – The start of Azure Blob’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of Azure Blob’s modified datetime. Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of the Azure Blob storage.

• compression (DatasetCompression) – The data compression method used for the blob storage.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobFSDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, format: Optional[azure.synapse.artifacts.models._models_py3.DatasetStorageFormat] = None, compression: Optional[azure.synapse.artifacts.models._models_py3.DatasetCompression] = None, **kwargs)

The Azure Data Lake Storage Gen2 storage.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• folder_path (any) – The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string).

• file_name (any) – The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of the Azure Data Lake Storage Gen2 storage.

• compression (DatasetCompression) – The data compression method used for the blob storage.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• folder_path (any) – The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string).

• file_name (any) – The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of the Azure Data Lake Storage Gen2 storage.

• compression (DatasetCompression) – The data compression method used for the blob storage.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobFSLinkedService(*, url: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, account_key: Optional[Any] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, azure_cloud_type: Optional[Any] = None, service_principal_credential_type: Optional[Any] = None, service_principal_credential: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure Data Lake Storage Gen2 linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).

• account_key (any) – Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• service_principal_credential_type (any) – The service principal credential type to use in Server-To-Server authentication. ‘ServicePrincipalKey’ for key/secret, ‘ServicePrincipalCert’ for certificate. Type: string (or Expression with resultType string).

• service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).

• account_key (any) – Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• service_principal_credential_type (any) – The service principal credential type to use in Server-To-Server authentication. ‘ServicePrincipalKey’ for key/secret, ‘ServicePrincipalCert’ for certificate. Type: string (or Expression with resultType string).

• service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobFSLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, file_system: Optional[Any] = None, **kwargs)

The location of azure blobFS dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

• file_system (any) – Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

• file_system (any) – Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobFSReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, file_list_path: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, delete_files_after_completion: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, **kwargs)

Azure blobFS read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Azure blobFS wildcardFileName. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Azure blobFS wildcardFileName. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobFSSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, copy_behavior: Optional[Any] = None, **kwargs)

A copy activity Azure Data Lake Storage Gen2 sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobFSSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, treat_empty_as_null: Optional[Any] = None, skip_header_line_count: Optional[Any] = None, recursive: Optional[Any] = None, **kwargs)

A copy activity Azure BlobFS source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• treat_empty_as_null (any) – Treat empty as null. Type: boolean (or Expression with resultType boolean).

• skip_header_line_count (any) – Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• treat_empty_as_null (any) – Treat empty as null. Type: boolean (or Expression with resultType boolean).

• skip_header_line_count (any) – Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobFSWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, copy_behavior: Optional[Any] = None, block_size_in_mb: Optional[Any] = None, **kwargs)

Azure blobFS write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

• block_size_in_mb (any) – Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

• block_size_in_mb (any) – Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobStorageLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, account_key: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, sas_uri: Optional[Any] = None, sas_token: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, service_endpoint: Optional[str] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, azure_cloud_type: Optional[Any] = None, account_kind: Optional[str] = None, encrypted_credential: Optional[str] = None, **kwargs)

The azure blob storage linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.

• account_key (AzureKeyVaultSecretReference) – The Azure key vault secret reference of accountKey in connection string.

• sas_uri (any) – SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.

• sas_token (AzureKeyVaultSecretReference) – The Azure key vault secret reference of sasToken in sas uri.

• service_endpoint (str) – Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property.

• service_principal_id (any) – The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against Azure SQL Data Warehouse.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• account_kind (str) – Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string).

• encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.

• account_key (AzureKeyVaultSecretReference) – The Azure key vault secret reference of accountKey in connection string.

• sas_uri (any) – SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.

• sas_token (AzureKeyVaultSecretReference) – The Azure key vault secret reference of sasToken in sas uri.

• service_endpoint (str) – Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property.

• service_principal_id (any) – The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against Azure SQL Data Warehouse.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• account_kind (str) – Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string).

• encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobStorageLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, container: Optional[Any] = None, **kwargs)

The location of azure blob dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

• container (any) – Specify the container of azure blob. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

• container (any) – Specify the container of azure blob. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobStorageReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, prefix: Optional[Any] = None, file_list_path: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, delete_files_after_completion: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, **kwargs)

Azure blob read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Azure blob wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Azure blob wildcardFileName. Type: string (or Expression with resultType string).

• prefix (any) – The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Azure blob wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Azure blob wildcardFileName. Type: string (or Expression with resultType string).

• prefix (any) – The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureBlobStorageWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, copy_behavior: Optional[Any] = None, block_size_in_mb: Optional[Any] = None, **kwargs)

Azure blob write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

• block_size_in_mb (any) – Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

• block_size_in_mb (any) – Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataExplorerCommandActivity(*, name: str, command: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, command_timeout: Optional[Any] = None, **kwargs)

Azure Data Explorer command activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• command (any) – Required. A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string).

• command_timeout (any) – Control command timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9]))..).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• command (any) – Required. A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string).

• command_timeout (any) – Control command timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9]))..).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataExplorerLinkedService(*, endpoint: Any, database: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, **kwargs)

Azure Data Explorer (Kusto) linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of Azure Data Explorer (the engine’s endpoint). URL will be in the format https://<clusterName>.:code:<regionName>.kusto.windows.net. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against Kusto.

• database (any) – Required. Database name for connection. Type: string (or Expression with resultType string).

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of Azure Data Explorer (the engine’s endpoint). URL will be in the format https://<clusterName>.:code:<regionName>.kusto.windows.net. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against Kusto.

• database (any) – Required. Database name for connection. Type: string (or Expression with resultType string).

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataExplorerSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, ingestion_mapping_name: Optional[Any] = None, ingestion_mapping_as_json: Optional[Any] = None, flush_immediately: Optional[Any] = None, **kwargs)

A copy activity Azure Data Explorer sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• ingestion_mapping_name (any) – A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string.

• ingestion_mapping_as_json (any) – An explicit column mapping description provided in a json format. Type: string.

• flush_immediately (any) – If set to true, any aggregation will be skipped. Default is false. Type: boolean.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• ingestion_mapping_name (any) – A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string.

• ingestion_mapping_as_json (any) – An explicit column mapping description provided in a json format. Type: string.

• flush_immediately (any) – If set to true, any aggregation will be skipped. Default is false. Type: boolean.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataExplorerSource(*, query: Any, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, no_truncation: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Azure Data Explorer (Kusto) source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Required. Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string).

• no_truncation (any) – The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit.

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9]))..

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Required. Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string).

• no_truncation (any) – The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit.

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9]))..

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataExplorerTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table: Optional[Any] = None, **kwargs)

The Azure Data Explorer (Kusto) dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table (any) – The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table (any) – The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService(*, account_name: Any, tenant: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, subscription_id: Optional[Any] = None, resource_group_name: Optional[Any] = None, data_lake_analytics_uri: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure Data Lake Analytics linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• account_name (any) – Required. The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The Key of the application used to authenticate against the Azure Data Lake Analytics account.

• tenant (any) – Required. The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• subscription_id (any) – Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).

• resource_group_name (any) – Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).

• data_lake_analytics_uri (any) – Azure Data Lake Analytics URI Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• account_name (any) – Required. The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The Key of the application used to authenticate against the Azure Data Lake Analytics account.

• tenant (any) – Required. The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• subscription_id (any) – Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).

• resource_group_name (any) – Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).

• data_lake_analytics_uri (any) – Azure Data Lake Analytics URI Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataLakeStoreDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, format: Optional[azure.synapse.artifacts.models._models_py3.DatasetStorageFormat] = None, compression: Optional[azure.synapse.artifacts.models._models_py3.DatasetCompression] = None, **kwargs)

Azure Data Lake Store dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• folder_path (any) – Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).

• file_name (any) – The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of the Data Lake Store.

• compression (DatasetCompression) – The data compression method used for the item(s) in the Azure Data Lake Store.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• folder_path (any) – Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).

• file_name (any) – The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of the Data Lake Store.

• compression (DatasetCompression) – The data compression method used for the item(s) in the Azure Data Lake Store.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService(*, data_lake_store_uri: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, azure_cloud_type: Optional[Any] = None, account_name: Optional[Any] = None, subscription_id: Optional[Any] = None, resource_group_name: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure Data Lake Store linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• data_lake_store_uri (any) – Required. Data Lake Store service URI. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The Key of the application used to authenticate against the Azure Data Lake Store account.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• account_name (any) – Data Lake Store account name. Type: string (or Expression with resultType string).

• subscription_id (any) – Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).

• resource_group_name (any) – Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• data_lake_store_uri (any) – Required. Data Lake Store service URI. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The Key of the application used to authenticate against the Azure Data Lake Store account.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• account_name (any) – Data Lake Store account name. Type: string (or Expression with resultType string).

• subscription_id (any) – Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).

• resource_group_name (any) – Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataLakeStoreLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, **kwargs)

The location of azure data lake store dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataLakeStoreReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, file_list_path: Optional[Any] = None, list_after: Optional[Any] = None, list_before: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, delete_files_after_completion: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, **kwargs)

Azure data lake store read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – ADLS wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – ADLS wildcardFileName. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• list_after (any) – Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).

• list_before (any) – Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – ADLS wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – ADLS wildcardFileName. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• list_after (any) – Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).

• list_before (any) – Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataLakeStoreSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, copy_behavior: Optional[Any] = None, enable_adls_single_file_parallel: Optional[Any] = None, **kwargs)

A copy activity Azure Data Lake Store sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

• enable_adls_single_file_parallel (any) – Single File Parallel.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

• enable_adls_single_file_parallel (any) – Single File Parallel.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataLakeStoreSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, **kwargs)

A copy activity Azure Data Lake source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDataLakeStoreWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, copy_behavior: Optional[Any] = None, expiry_date_time: Optional[Any] = None, **kwargs)

Azure data lake store write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

• expiry_date_time (any) – Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of “2018-12-01T05:00:00Z”. Default value is NULL. Type: integer (or Expression with resultType integer).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

• expiry_date_time (any) – Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of “2018-12-01T05:00:00Z”. Default value is NULL. Type: integer (or Expression with resultType integer).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDatabricksDeltaLakeDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table: Optional[Any] = None, database: Optional[Any] = None, **kwargs)

Azure Databricks Delta Lake dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table (any) – The name of delta table. Type: string (or Expression with resultType string).

• database (any) – The database name of delta table. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table (any) – The name of delta table. Type: string (or Expression with resultType string).

• database (any) – The database name of delta table. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDatabricksDeltaLakeExportCommand(*, additional_properties: Optional[Dict[str, Any]] = None, date_format: Optional[Any] = None, timestamp_format: Optional[Any] = None, **kwargs)

Azure Databricks Delta Lake export command settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The export setting type.Constant filled by server.

• date_format (any) – Specify the date format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).

• timestamp_format (any) – Specify the timestamp format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• date_format (any) – Specify the date format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).

• timestamp_format (any) – Specify the timestamp format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDatabricksDeltaLakeImportCommand(*, additional_properties: Optional[Dict[str, Any]] = None, date_format: Optional[Any] = None, timestamp_format: Optional[Any] = None, **kwargs)

Azure Databricks Delta Lake import command settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The import setting type.Constant filled by server.

• date_format (any) – Specify the date format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).

• timestamp_format (any) – Specify the timestamp format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• date_format (any) – Specify the date format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).

• timestamp_format (any) – Specify the timestamp format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDatabricksDeltaLakeLinkedService(*, domain: Any, access_token: azure.synapse.artifacts.models._models_py3.SecretBase, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, cluster_id: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure Databricks Delta Lake linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• domain (any) – Required. <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).

• access_token (SecretBase) – Required. Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference.

• cluster_id (any) – The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• domain (any) – Required. <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).

• access_token (SecretBase) – Required. Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference.

• cluster_id (any) – The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, pre_copy_script: Optional[Any] = None, import_settings: Optional[azure.synapse.artifacts.models._models_py3.AzureDatabricksDeltaLakeImportCommand] = None, **kwargs)

A copy activity Azure Databricks Delta Lake sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• import_settings (AzureDatabricksDeltaLakeImportCommand) – Azure Databricks Delta Lake import settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• import_settings (AzureDatabricksDeltaLakeImportCommand) – Azure Databricks Delta Lake import settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDatabricksDeltaLakeSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, export_settings: Optional[azure.synapse.artifacts.models._models_py3.AzureDatabricksDeltaLakeExportCommand] = None, **kwargs)

A copy activity Azure Databricks Delta Lake source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Azure Databricks Delta Lake Sql query. Type: string (or Expression with resultType string).

• export_settings (AzureDatabricksDeltaLakeExportCommand) – Azure Databricks Delta Lake export settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Azure Databricks Delta Lake Sql query. Type: string (or Expression with resultType string).

• export_settings (AzureDatabricksDeltaLakeExportCommand) – Azure Databricks Delta Lake export settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureDatabricksLinkedService(*, domain: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, access_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, authentication: Optional[Any] = None, workspace_resource_id: Optional[Any] = None, existing_cluster_id: Optional[Any] = None, instance_pool_id: Optional[Any] = None, new_cluster_version: Optional[Any] = None, new_cluster_num_of_worker: Optional[Any] = None, new_cluster_node_type: Optional[Any] = None, new_cluster_spark_conf: Optional[Dict[str, Any]] = None, new_cluster_spark_env_vars: Optional[Dict[str, Any]] = None, new_cluster_custom_tags: Optional[Dict[str, Any]] = None, new_cluster_log_destination: Optional[Any] = None, new_cluster_driver_node_type: Optional[Any] = None, new_cluster_init_scripts: Optional[Any] = None, new_cluster_enable_elastic_disk: Optional[Any] = None, encrypted_credential: Optional[Any] = None, policy_id: Optional[Any] = None, **kwargs)

Azure Databricks linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• domain (any) – Required. <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).

• access_token (SecretBase) – Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).

• authentication (any) – Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).

• workspace_resource_id (any) – Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).

• existing_cluster_id (any) – The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string).

• instance_pool_id (any) – The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string).

• new_cluster_version (any) – If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string).

• new_cluster_num_of_worker (any) – If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like ‘1’ means numOfWorker is 1 or ‘1:10’ means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as ‘2’. Required if newClusterVersion is specified. Type: string (or Expression with resultType string).

• new_cluster_node_type (any) – The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string).

• new_cluster_spark_conf (dict[str, any]) – A set of optional, user-specified Spark configuration key-value pairs.

• new_cluster_spark_env_vars (dict[str, any]) – A set of optional, user-specified Spark environment variables key-value pairs.

• new_cluster_custom_tags (dict[str, any]) – Additional tags for cluster resources. This property is ignored in instance pool configurations.

• new_cluster_log_destination (any) – Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).

• new_cluster_driver_node_type (any) – The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string).

• new_cluster_init_scripts (any) – User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings).

• new_cluster_enable_elastic_disk (any) – Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• policy_id (any) – The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• domain (any) – Required. <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).

• access_token (SecretBase) – Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).

• authentication (any) – Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).

• workspace_resource_id (any) – Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).

• existing_cluster_id (any) – The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string).

• instance_pool_id (any) – The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string).

• new_cluster_version (any) – If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string).

• new_cluster_num_of_worker (any) – If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like ‘1’ means numOfWorker is 1 or ‘1:10’ means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as ‘2’. Required if newClusterVersion is specified. Type: string (or Expression with resultType string).

• new_cluster_node_type (any) – The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string).

• new_cluster_spark_conf (dict[str, any]) – A set of optional, user-specified Spark configuration key-value pairs.

• new_cluster_spark_env_vars (dict[str, any]) – A set of optional, user-specified Spark environment variables key-value pairs.

• new_cluster_custom_tags (dict[str, any]) – Additional tags for cluster resources. This property is ignored in instance pool configurations.

• new_cluster_log_destination (any) – Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).

• new_cluster_driver_node_type (any) – The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string).

• new_cluster_init_scripts (any) – User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings).

• new_cluster_enable_elastic_disk (any) – Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• policy_id (any) – The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureEntityResource(**kwargs)

The resource model definition for an Azure Resource Manager resource with an etag.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureFileStorageLinkedService(*, host: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, user_id: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, connection_string: Optional[Any] = None, account_key: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, sas_uri: Optional[Any] = None, sas_token: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, file_share: Optional[Any] = None, snapshot: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure File Storage linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. Host name of the server. Type: string (or Expression with resultType string).

• user_id (any) – User ID to logon the server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to logon the server.

• connection_string (any) – The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.

• account_key (AzureKeyVaultSecretReference) – The Azure key vault secret reference of accountKey in connection string.

• sas_uri (any) – SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

• sas_token (AzureKeyVaultSecretReference) – The Azure key vault secret reference of sasToken in sas uri.

• file_share (any) – The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).

• snapshot (any) – The azure file share snapshot version. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. Host name of the server. Type: string (or Expression with resultType string).

• user_id (any) – User ID to logon the server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to logon the server.

• connection_string (any) – The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.

• account_key (AzureKeyVaultSecretReference) – The Azure key vault secret reference of accountKey in connection string.

• sas_uri (any) – SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

• sas_token (AzureKeyVaultSecretReference) – The Azure key vault secret reference of sasToken in sas uri.

• file_share (any) – The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).

• snapshot (any) – The azure file share snapshot version. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureFileStorageLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, **kwargs)

The location of file server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureFileStorageReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, prefix: Optional[Any] = None, file_list_path: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, delete_files_after_completion: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, **kwargs)

Azure File Storage read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Azure File Storage wildcardFileName. Type: string (or Expression with resultType string).

• prefix (any) – The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Azure File Storage wildcardFileName. Type: string (or Expression with resultType string).

• prefix (any) – The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureFileStorageWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, copy_behavior: Optional[Any] = None, **kwargs)

Azure File Storage write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureFunctionActivity(*, name: str, method: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.AzureFunctionActivityMethod], function_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, headers: Optional[Any] = None, body: Optional[Any] = None, **kwargs)

Azure Function activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• method (str or AzureFunctionActivityMethod) – Required. Rest API method for target endpoint. Possible values include: “GET”, “POST”, “PUT”, “DELETE”, “OPTIONS”, “HEAD”, “TRACE”.

• function_name (any) – Required. Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string).

• headers (any) – Represents the headers that will be sent to the request. For example, to set the language and type on a request: “headers” : { “Accept-Language”: “en-us”, “Content-Type”: “application/json” }. Type: string (or Expression with resultType string).

• body (any) – Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• method (str or AzureFunctionActivityMethod) – Required. Rest API method for target endpoint. Possible values include: “GET”, “POST”, “PUT”, “DELETE”, “OPTIONS”, “HEAD”, “TRACE”.

• function_name (any) – Required. Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string).

• headers (any) – Represents the headers that will be sent to the request. For example, to set the language and type on a request: “headers” : { “Accept-Language”: “en-us”, “Content-Type”: “application/json” }. Type: string (or Expression with resultType string).

• body (any) – Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureFunctionActivityMethod(value)

The list of HTTP methods supported by a AzureFunctionActivity.

DELETE = 'DELETE'

GET = 'GET'

HEAD = 'HEAD'

OPTIONS = 'OPTIONS'

POST = 'POST'

PUT = 'PUT'

TRACE = 'TRACE'

class azure.synapse.artifacts.models.AzureFunctionLinkedService(*, function_app_url: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, function_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure Function linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• function_app_url (any) – Required. The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net.

• function_key (SecretBase) – Function or Host key for Azure Function App.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• function_app_url (any) – Required. The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net.

• function_key (SecretBase) – Function or Host key for Azure Function App.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureKeyVaultLinkedService(*, base_url: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, **kwargs)

Azure Key Vault linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• base_url (any) – Required. The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• base_url (any) – Required. The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureKeyVaultSecretReference(*, store: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, secret_name: Any, secret_version: Optional[Any] = None, **kwargs)

Azure Key Vault secret reference.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – Required. Type of the secret.Constant filled by server.

• store (LinkedServiceReference) – Required. The Azure Key Vault linked service reference.

• secret_name (any) – Required. The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).

• secret_version (any) – The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).

Keyword Arguments

• store (LinkedServiceReference) – Required. The Azure Key Vault linked service reference.

• secret_name (any) – Required. The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).

• secret_version (any) – The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMLBatchExecutionActivity(*, name: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, global_parameters: Optional[Dict[str, Any]] = None, web_service_outputs: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.AzureMLWebServiceFile]] = None, web_service_inputs: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.AzureMLWebServiceFile]] = None, **kwargs)

Azure ML Batch Execution activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• global_parameters (dict[str, any]) – Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.

• web_service_outputs (dict[str, AzureMLWebServiceFile]) – Key,Value pairs, mapping the names of Azure ML endpoint’s Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.

• web_service_inputs (dict[str, AzureMLWebServiceFile]) – Key,Value pairs, mapping the names of Azure ML endpoint’s Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• global_parameters (dict[str, any]) – Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.

• web_service_outputs (dict[str, AzureMLWebServiceFile]) – Key,Value pairs, mapping the names of Azure ML endpoint’s Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.

• web_service_inputs (dict[str, AzureMLWebServiceFile]) – Key,Value pairs, mapping the names of Azure ML endpoint’s Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMLExecutePipelineActivity(*, name: str, ml_pipeline_id: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, experiment_name: Optional[Any] = None, ml_pipeline_parameters: Optional[Any] = None, ml_parent_run_id: Optional[Any] = None, continue_on_step_failure: Optional[Any] = None, **kwargs)

Azure ML Execute Pipeline activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• ml_pipeline_id (any) – Required. ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).

• experiment_name (any) – Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).

• ml_pipeline_parameters (any) – Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).

• ml_parent_run_id (any) – The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).

• continue_on_step_failure (any) – Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• ml_pipeline_id (any) – Required. ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).

• experiment_name (any) – Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).

• ml_pipeline_parameters (any) – Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).

• ml_parent_run_id (any) – The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).

• continue_on_step_failure (any) – Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMLLinkedService(*, ml_endpoint: Any, api_key: azure.synapse.artifacts.models._models_py3.SecretBase, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, update_resource_endpoint: Optional[Any] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure ML Studio Web Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• ml_endpoint (any) – Required. The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).

• api_key (SecretBase) – Required. The API key for accessing the Azure ML model endpoint.

• update_resource_endpoint (any) – The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• ml_endpoint (any) – Required. The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).

• api_key (SecretBase) – Required. The API key for accessing the Azure ML model endpoint.

• update_resource_endpoint (any) – The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMLServiceLinkedService(*, subscription_id: Any, resource_group_name: Any, ml_workspace_name: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure ML Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• subscription_id (any) – Required. Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string).

• resource_group_name (any) – Required. Azure ML Service workspace resource group name. Type: string (or Expression with resultType string).

• ml_workspace_name (any) – Required. Azure ML Service workspace name. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• subscription_id (any) – Required. Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string).

• resource_group_name (any) – Required. Azure ML Service workspace resource group name. Type: string (or Expression with resultType string).

• ml_workspace_name (any) – Required. Azure ML Service workspace name. Type: string (or Expression with resultType string).

• service_principal_id (any) – The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMLUpdateResourceActivity(*, name: str, trained_model_name: Any, trained_model_linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, trained_model_file_path: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, **kwargs)

Azure ML Update Resource management activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• trained_model_name (any) – Required. Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string).

• trained_model_linked_service_name (LinkedServiceReference) – Required. Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.

• trained_model_file_path (any) – Required. The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• trained_model_name (any) – Required. Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string).

• trained_model_linked_service_name (LinkedServiceReference) – Required. Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.

• trained_model_file_path (any) – Required. The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMLWebServiceFile(*, file_path: Any, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, **kwargs)

Azure ML WebService Input/Output file.

All required parameters must be populated in order to send to Azure.

Variables

• file_path (any) – Required. The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string).

• linked_service_name (LinkedServiceReference) – Required. Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.

Keyword Arguments

• file_path (any) – Required. The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string).

• linked_service_name (LinkedServiceReference) – Required. Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMariaDBLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, pwd: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure Database for MariaDB linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMariaDBSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Azure MariaDB source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMariaDBTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Azure Database for MariaDB dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMySqlLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure MySQL database linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMySqlSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, pre_copy_script: Optional[Any] = None, **kwargs)

A copy activity Azure MySql sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMySqlSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Azure MySQL source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureMySqlTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The Azure MySQL database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The Azure MySQL database table name. Type: string (or Expression with resultType string).

• table (any) – The name of Azure MySQL database table. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The Azure MySQL database table name. Type: string (or Expression with resultType string).

• table (any) – The name of Azure MySQL database table. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzurePostgreSqlLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure PostgreSQL linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzurePostgreSqlSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, pre_copy_script: Optional[Any] = None, **kwargs)

A copy activity Azure PostgreSQL sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzurePostgreSqlSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Azure PostgreSQL source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzurePostgreSqlTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

Azure PostgreSQL dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string).

• table (any) – The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string).

• table (any) – The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureQueueSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, **kwargs)

A copy activity Azure Queue sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSearchIndexDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, index_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The Azure Search Index.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• index_name (any) – Required. The name of the Azure Search Index. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• index_name (any) – Required. The name of the Azure Search Index. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSearchIndexSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, write_behavior: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.AzureSearchIndexWriteBehaviorType]] = None, **kwargs)

A copy activity Azure Search Index sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or AzureSearchIndexWriteBehaviorType) – Specify the write behavior when upserting documents into Azure Search Index. Possible values include: “Merge”, “Upload”.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or AzureSearchIndexWriteBehaviorType) – Specify the write behavior when upserting documents into Azure Search Index. Possible values include: “Merge”, “Upload”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSearchIndexWriteBehaviorType(value)

Specify the write behavior when upserting documents into Azure Search Index.

MERGE = 'Merge'

UPLOAD = 'Upload'

class azure.synapse.artifacts.models.AzureSearchLinkedService(*, url: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for Windows Azure Search Service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. URL for Azure Search service. Type: string (or Expression with resultType string).

• key (SecretBase) – Admin Key for Azure Search service.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. URL for Azure Search service. Type: string (or Expression with resultType string).

• key (SecretBase) – Admin Key for Azure Search service.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSqlDWLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, azure_cloud_type: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure SQL Data Warehouse linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• service_principal_id (any) – The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against Azure SQL Data Warehouse.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• service_principal_id (any) – The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against Azure SQL Data Warehouse.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSqlDWTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The Azure SQL Data Warehouse dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

• table (any) – The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

• table (any) – The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, azure_cloud_type: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Microsoft Azure SQL Database linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• service_principal_id (any) – The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against Azure SQL Database.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• service_principal_id (any) – The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against Azure SQL Database.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSqlMILinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, azure_cloud_type: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Azure SQL Managed Instance linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• service_principal_id (any) – The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against Azure SQL Managed Instance.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• service_principal_id (any) – The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key of the service principal used to authenticate against Azure SQL Managed Instance.

• tenant (any) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSqlMITableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The Azure SQL Managed Instance dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string).

• table (any) – The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string).

• table (any) – The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSqlSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, sql_writer_stored_procedure_name: Optional[Any] = None, sql_writer_table_type: Optional[Any] = None, pre_copy_script: Optional[Any] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, stored_procedure_table_type_parameter_name: Optional[Any] = None, table_option: Optional[Any] = None, **kwargs)

A copy activity Azure SQL sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• sql_writer_stored_procedure_name (any) – SQL writer stored procedure name. Type: string (or Expression with resultType string).

• sql_writer_table_type (any) – SQL writer table type. Type: string (or Expression with resultType string).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.

• stored_procedure_table_type_parameter_name (any) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).

• table_option (any) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• sql_writer_stored_procedure_name (any) – SQL writer stored procedure name. Type: string (or Expression with resultType string).

• sql_writer_table_type (any) – SQL writer table type. Type: string (or Expression with resultType string).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.

• stored_procedure_table_type_parameter_name (any) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).

• table_option (any) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSqlSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, sql_reader_query: Optional[Any] = None, sql_reader_stored_procedure_name: Optional[Any] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, produce_additional_types: Optional[Any] = None, partition_option: Optional[Any] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.SqlPartitionSettings] = None, **kwargs)

A copy activity Azure SQL source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

• produce_additional_types (any) – Which additional types to produce.

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

• produce_additional_types (any) – Which additional types to produce.

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureSqlTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The Azure SQL Server database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The schema name of the Azure SQL database. Type: string (or Expression with resultType string).

• table (any) – The table name of the Azure SQL database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The schema name of the Azure SQL database. Type: string (or Expression with resultType string).

• table (any) – The table name of the Azure SQL database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureStorageLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, account_key: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, sas_uri: Optional[Any] = None, sas_token: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[str] = None, **kwargs)

The storage account linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.

• account_key (AzureKeyVaultSecretReference) – The Azure key vault secret reference of accountKey in connection string.

• sas_uri (any) – SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

• sas_token (AzureKeyVaultSecretReference) – The Azure key vault secret reference of sasToken in sas uri.

• encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.

• account_key (AzureKeyVaultSecretReference) – The Azure key vault secret reference of accountKey in connection string.

• sas_uri (any) – SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

• sas_token (AzureKeyVaultSecretReference) – The Azure key vault secret reference of sasToken in sas uri.

• encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, table_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The Azure Table storage dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – Required. The table name of the Azure Table storage. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – Required. The table name of the Azure Table storage. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureTableSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, azure_table_default_partition_key_value: Optional[Any] = None, azure_table_partition_key_name: Optional[Any] = None, azure_table_row_key_name: Optional[Any] = None, azure_table_insert_type: Optional[Any] = None, **kwargs)

A copy activity Azure Table sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• azure_table_default_partition_key_value (any) – Azure Table default partition key value. Type: string (or Expression with resultType string).

• azure_table_partition_key_name (any) – Azure Table partition key name. Type: string (or Expression with resultType string).

• azure_table_row_key_name (any) – Azure Table row key name. Type: string (or Expression with resultType string).

• azure_table_insert_type (any) – Azure Table insert type. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• azure_table_default_partition_key_value (any) – Azure Table default partition key value. Type: string (or Expression with resultType string).

• azure_table_partition_key_name (any) – Azure Table partition key name. Type: string (or Expression with resultType string).

• azure_table_row_key_name (any) – Azure Table row key name. Type: string (or Expression with resultType string).

• azure_table_insert_type (any) – Azure Table insert type. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureTableSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, azure_table_source_query: Optional[Any] = None, azure_table_source_ignore_table_not_found: Optional[Any] = None, **kwargs)

A copy activity Azure Table source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• azure_table_source_query (any) – Azure Table source query. Type: string (or Expression with resultType string).

• azure_table_source_ignore_table_not_found (any) – Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• azure_table_source_query (any) – Azure Table source query. Type: string (or Expression with resultType string).

• azure_table_source_ignore_table_not_found (any) – Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.AzureTableStorageLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, account_key: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, sas_uri: Optional[Any] = None, sas_token: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[str] = None, **kwargs)

The azure table storage linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.

• account_key (AzureKeyVaultSecretReference) – The Azure key vault secret reference of accountKey in connection string.

• sas_uri (any) – SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

• sas_token (AzureKeyVaultSecretReference) – The Azure key vault secret reference of sasToken in sas uri.

• encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.

• account_key (AzureKeyVaultSecretReference) – The Azure key vault secret reference of accountKey in connection string.

• sas_uri (any) – SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

• sas_token (AzureKeyVaultSecretReference) – The Azure key vault secret reference of sasToken in sas uri.

• encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BigDataPoolReference(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.BigDataPoolReferenceType], reference_name: str, **kwargs)

Big data pool reference.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or BigDataPoolReferenceType) – Required. Big data pool reference type. Possible values include: “BigDataPoolReference”.

• reference_name (str) – Required. Reference big data pool name.

Keyword Arguments

• type (str or BigDataPoolReferenceType) – Required. Big data pool reference type. Possible values include: “BigDataPoolReference”.

• reference_name (str) – Required. Reference big data pool name.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BigDataPoolReferenceType(value)

Big data pool reference type.

BIG_DATA_POOL_REFERENCE = 'BigDataPoolReference'

class azure.synapse.artifacts.models.BigDataPoolResourceInfo(*, location: str, tags: Optional[Dict[str, str]] = None, provisioning_state: Optional[str] = None, auto_scale: Optional[azure.synapse.artifacts.models._models_py3.AutoScaleProperties] = None, creation_date: Optional[datetime.datetime] = None, auto_pause: Optional[azure.synapse.artifacts.models._models_py3.AutoPauseProperties] = None, is_compute_isolation_enabled: Optional[bool] = None, session_level_packages_enabled: Optional[bool] = None, cache_size: Optional[int] = None, dynamic_executor_allocation: Optional[azure.synapse.artifacts.models._models_py3.DynamicExecutorAllocation] = None, spark_events_folder: Optional[str] = None, node_count: Optional[int] = None, library_requirements: Optional[azure.synapse.artifacts.models._models_py3.LibraryRequirements] = None, custom_libraries: Optional[List[azure.synapse.artifacts.models._models_py3.LibraryInfo]] = None, spark_config_properties: Optional[azure.synapse.artifacts.models._models_py3.LibraryRequirements] = None, spark_version: Optional[str] = None, default_spark_log_folder: Optional[str] = None, node_size: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.NodeSize]] = None, node_size_family: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.NodeSizeFamily]] = None, **kwargs)

A Big Data pool.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• tags (dict[str, str]) – A set of tags. Resource tags.

• location (str) – Required. The geo-location where the resource lives.

• provisioning_state (str) – The state of the Big Data pool.

• auto_scale (AutoScaleProperties) – Auto-scaling properties.

• creation_date (datetime) – The time when the Big Data pool was created.

• auto_pause (AutoPauseProperties) – Auto-pausing properties.

• is_compute_isolation_enabled (bool) – Whether compute isolation is required or not.

• session_level_packages_enabled (bool) – Whether session level packages enabled.

• cache_size (int) – The cache size.

• dynamic_executor_allocation (DynamicExecutorAllocation) – Dynamic Executor Allocation.

• spark_events_folder (str) – The Spark events folder.

• node_count (int) – The number of nodes in the Big Data pool.

• library_requirements (LibraryRequirements) – Library version requirements.

• custom_libraries (list[LibraryInfo]) – List of custom libraries/packages associated with the spark pool.

• spark_config_properties (LibraryRequirements) – Spark configuration file to specify additional properties.

• spark_version (str) – The Apache Spark version.

• default_spark_log_folder (str) – The default folder where Spark logs will be written.

• node_size (str or NodeSize) – The level of compute power that each node in the Big Data pool has. Possible values include: “None”, “Small”, “Medium”, “Large”, “XLarge”, “XXLarge”, “XXXLarge”.

• node_size_family (str or NodeSizeFamily) – The kind of nodes that the Big Data pool provides. Possible values include: “None”, “MemoryOptimized”.

• last_succeeded_timestamp (datetime) – The time when the Big Data pool was updated successfully.

Keyword Arguments

• tags (dict[str, str]) – A set of tags. Resource tags.

• location (str) – Required. The geo-location where the resource lives.

• provisioning_state (str) – The state of the Big Data pool.

• auto_scale (AutoScaleProperties) – Auto-scaling properties.

• creation_date (datetime) – The time when the Big Data pool was created.

• auto_pause (AutoPauseProperties) – Auto-pausing properties.

• is_compute_isolation_enabled (bool) – Whether compute isolation is required or not.

• session_level_packages_enabled (bool) – Whether session level packages enabled.

• cache_size (int) – The cache size.

• dynamic_executor_allocation (DynamicExecutorAllocation) – Dynamic Executor Allocation.

• spark_events_folder (str) – The Spark events folder.

• node_count (int) – The number of nodes in the Big Data pool.

• library_requirements (LibraryRequirements) – Library version requirements.

• custom_libraries (list[LibraryInfo]) – List of custom libraries/packages associated with the spark pool.

• spark_config_properties (LibraryRequirements) – Spark configuration file to specify additional properties.

• spark_version (str) – The Apache Spark version.

• default_spark_log_folder (str) – The default folder where Spark logs will be written.

• node_size (str or NodeSize) – The level of compute power that each node in the Big Data pool has. Possible values include: “None”, “Small”, “Medium”, “Large”, “XLarge”, “XXLarge”, “XXXLarge”.

• node_size_family (str or NodeSizeFamily) – The kind of nodes that the Big Data pool provides. Possible values include: “None”, “MemoryOptimized”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BigDataPoolResourceInfoListResult(*, next_link: Optional[str] = None, value: Optional[List[azure.synapse.artifacts.models._models_py3.BigDataPoolResourceInfo]] = None, **kwargs)

Collection of Big Data pool information.

Variables

• next_link (str) – Link to the next page of results.

• value (list[BigDataPoolResourceInfo]) – List of Big Data pools.

Keyword Arguments

• next_link (str) – Link to the next page of results.

• value (list[BigDataPoolResourceInfo]) – List of Big Data pools.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BinaryDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, location: Optional[azure.synapse.artifacts.models._models_py3.DatasetLocation] = None, compression: Optional[azure.synapse.artifacts.models._models_py3.DatasetCompression] = None, **kwargs)

Binary dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the Binary storage.

• compression (DatasetCompression) – The data compression method used for the binary dataset.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the Binary storage.

• compression (DatasetCompression) – The data compression method used for the binary dataset.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BinaryReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, compression_properties: Optional[azure.synapse.artifacts.models._models_py3.CompressionReadSettings] = None, **kwargs)

Binary read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• compression_properties (CompressionReadSettings) – Compression settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• compression_properties (CompressionReadSettings) – Compression settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BinarySink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreWriteSettings] = None, **kwargs)

A copy activity Binary sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – Binary store settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – Binary store settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BinarySource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreReadSettings] = None, format_settings: Optional[azure.synapse.artifacts.models._models_py3.BinaryReadSettings] = None, **kwargs)

A copy activity Binary source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Binary store settings.

• format_settings (BinaryReadSettings) – Binary format settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Binary store settings.

• format_settings (BinaryReadSettings) – Binary format settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BlobEventType(value)

An enumeration.

MICROSOFT_STORAGE_BLOB_CREATED = 'Microsoft.Storage.BlobCreated'

MICROSOFT_STORAGE_BLOB_DELETED = 'Microsoft.Storage.BlobDeleted'

class azure.synapse.artifacts.models.BlobEventsTrigger(*, events: List[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.BlobEventType]], scope: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, annotations: Optional[List[Any]] = None, pipelines: Optional[List[azure.synapse.artifacts.models._models_py3.TriggerPipelineReference]] = None, blob_path_begins_with: Optional[str] = None, blob_path_ends_with: Optional[str] = None, ignore_empty_blobs: Optional[bool] = None, **kwargs)

Trigger that runs every time a Blob event occurs.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Trigger type.Constant filled by server.

• description (str) – Trigger description.

• runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: “Started”, “Stopped”, “Disabled”.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

• blob_path_begins_with (str) – The blob path must begin with the pattern provided for trigger to fire. For example, ‘/records/blobs/december/’ will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.

• blob_path_ends_with (str) – The blob path must end with the pattern provided for trigger to fire. For example, ‘december/boxes.csv’ will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.

• ignore_empty_blobs (bool) – If set to true, blobs with zero bytes will be ignored.

• events (list[str or BlobEventType]) – Required. The type of events that cause this trigger to fire.

• scope (str) – Required. The ARM resource ID of the Storage Account.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Trigger description.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

• blob_path_begins_with (str) – The blob path must begin with the pattern provided for trigger to fire. For example, ‘/records/blobs/december/’ will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.

• blob_path_ends_with (str) – The blob path must end with the pattern provided for trigger to fire. For example, ‘december/boxes.csv’ will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.

• ignore_empty_blobs (bool) – If set to true, blobs with zero bytes will be ignored.

• events (list[str or BlobEventType]) – Required. The type of events that cause this trigger to fire.

• scope (str) – Required. The ARM resource ID of the Storage Account.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BlobSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, blob_writer_overwrite_files: Optional[Any] = None, blob_writer_date_time_format: Optional[Any] = None, blob_writer_add_header: Optional[Any] = None, copy_behavior: Optional[Any] = None, **kwargs)

A copy activity Azure Blob sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• blob_writer_overwrite_files (any) – Blob writer overwrite files. Type: boolean (or Expression with resultType boolean).

• blob_writer_date_time_format (any) – Blob writer date time format. Type: string (or Expression with resultType string).

• blob_writer_add_header (any) – Blob writer add header. Type: boolean (or Expression with resultType boolean).

• copy_behavior (any) – The type of copy behavior for copy sink.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• blob_writer_overwrite_files (any) – Blob writer overwrite files. Type: boolean (or Expression with resultType boolean).

• blob_writer_date_time_format (any) – Blob writer date time format. Type: string (or Expression with resultType string).

• blob_writer_add_header (any) – Blob writer add header. Type: boolean (or Expression with resultType boolean).

• copy_behavior (any) – The type of copy behavior for copy sink.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BlobSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, treat_empty_as_null: Optional[Any] = None, skip_header_line_count: Optional[Any] = None, recursive: Optional[Any] = None, **kwargs)

A copy activity Azure Blob source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• treat_empty_as_null (any) – Treat empty as null. Type: boolean (or Expression with resultType boolean).

• skip_header_line_count (any) – Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• treat_empty_as_null (any) – Treat empty as null. Type: boolean (or Expression with resultType boolean).

• skip_header_line_count (any) – Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.BlobTrigger(*, folder_path: str, max_concurrency: int, linked_service: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, annotations: Optional[List[Any]] = None, pipelines: Optional[List[azure.synapse.artifacts.models._models_py3.TriggerPipelineReference]] = None, **kwargs)

Trigger that runs every time the selected Blob container changes.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Trigger type.Constant filled by server.

• description (str) – Trigger description.

• runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: “Started”, “Stopped”, “Disabled”.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

• folder_path (str) – Required. The path of the container/folder that will trigger the pipeline.

• max_concurrency (int) – Required. The max number of parallel files to handle when it is triggered.

• linked_service (LinkedServiceReference) – Required. The Azure Storage linked service reference.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Trigger description.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

• folder_path (str) – Required. The path of the container/folder that will trigger the pipeline.

• max_concurrency (int) – Required. The max number of parallel files to handle when it is triggered.

• linked_service (LinkedServiceReference) – Required. The Azure Storage linked service reference.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CassandraLinkedService(*, host: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, authentication_type: Optional[Any] = None, port: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for Cassandra data source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. Host name for connection. Type: string (or Expression with resultType string).

• authentication_type (any) – AuthenticationType to be used for connection. Type: string (or Expression with resultType string).

• port (any) – The port for the connection. Type: integer (or Expression with resultType integer).

• username (any) – Username for authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. Host name for connection. Type: string (or Expression with resultType string).

• authentication_type (any) – AuthenticationType to be used for connection. Type: string (or Expression with resultType string).

• port (any) – The port for the connection. Type: integer (or Expression with resultType integer).

• username (any) – Username for authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CassandraSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, consistency_level: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.CassandraSourceReadConsistencyLevels]] = None, **kwargs)

A copy activity source for a Cassandra database.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string).

• consistency_level (str or CassandraSourceReadConsistencyLevels) – The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is ‘ONE’. It is case-insensitive. Possible values include: “ALL”, “EACH_QUORUM”, “QUORUM”, “LOCAL_QUORUM”, “ONE”, “TWO”, “THREE”, “LOCAL_ONE”, “SERIAL”, “LOCAL_SERIAL”.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string).

• consistency_level (str or CassandraSourceReadConsistencyLevels) – The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is ‘ONE’. It is case-insensitive. Possible values include: “ALL”, “EACH_QUORUM”, “QUORUM”, “LOCAL_QUORUM”, “ONE”, “TWO”, “THREE”, “LOCAL_ONE”, “SERIAL”, “LOCAL_SERIAL”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CassandraSourceReadConsistencyLevels(value)

The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is ‘ONE’. It is case-insensitive.

ALL = 'ALL'

EACH_QUORUM = 'EACH_QUORUM'

LOCAL_ONE = 'LOCAL_ONE'

LOCAL_QUORUM = 'LOCAL_QUORUM'

LOCAL_SERIAL = 'LOCAL_SERIAL'

ONE = 'ONE'

QUORUM = 'QUORUM'

SERIAL = 'SERIAL'

THREE = 'THREE'

TWO = 'TWO'

class azure.synapse.artifacts.models.CassandraTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, keyspace: Optional[Any] = None, **kwargs)

The Cassandra database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name of the Cassandra database. Type: string (or Expression with resultType string).

• keyspace (any) – The keyspace of the Cassandra database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name of the Cassandra database. Type: string (or Expression with resultType string).

• keyspace (any) – The keyspace of the Cassandra database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CellOutputType(value)

Execution, display, or stream outputs.

DISPLAY_DATA = 'display_data'

ERROR = 'error'

EXECUTE_RESULT = 'execute_result'

STREAM = 'stream'

class azure.synapse.artifacts.models.ChainingTrigger(*, pipeline: azure.synapse.artifacts.models._models_py3.TriggerPipelineReference, depends_on: List[azure.synapse.artifacts.models._models_py3.PipelineReference], run_dimension: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, annotations: Optional[List[Any]] = None, **kwargs)

Trigger that allows the referenced pipeline to depend on other pipeline runs based on runDimension Name/Value pairs. Upstream pipelines should declare the same runDimension Name and their runs should have the values for those runDimensions. The referenced pipeline run would be triggered if the values for the runDimension match for all upstream pipeline runs.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Trigger type.Constant filled by server.

• description (str) – Trigger description.

• runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: “Started”, “Stopped”, “Disabled”.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipeline (TriggerPipelineReference) – Required. Pipeline for which runs are created when all upstream pipelines complete successfully.

• depends_on (list[PipelineReference]) – Required. Upstream Pipelines.

• run_dimension (str) – Required. Run Dimension property that needs to be emitted by upstream pipelines.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Trigger description.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipeline (TriggerPipelineReference) – Required. Pipeline for which runs are created when all upstream pipelines complete successfully.

• depends_on (list[PipelineReference]) – Required. Upstream Pipelines.

• run_dimension (str) – Required. Run Dimension property that needs to be emitted by upstream pipelines.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CloudError(*, code: str, message: str, target: Optional[str] = None, details: Optional[List[azure.synapse.artifacts.models._models_py3.CloudError]] = None, **kwargs)

The object that defines the structure of an Azure Synapse error response.

All required parameters must be populated in order to send to Azure.

Variables

• code (str) – Required. Error code.

• message (str) – Required. Error message.

• target (str) – Property name/path in request associated with error.

• details (list[CloudError]) – Array with additional error details.

Keyword Arguments

• code (str) – Required. Error code.

• message (str) – Required. Error message.

• target (str) – Property name/path in request associated with error.

• details (list[CloudError]) – Array with additional error details.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CloudErrorAutoGenerated(*, code: str, message: str, target: Optional[str] = None, details: Optional[List[azure.synapse.artifacts.models._models_py3.CloudErrorAutoGenerated]] = None, **kwargs)

The object that defines the structure of an Azure Synapse error response.

All required parameters must be populated in order to send to Azure.

Variables

• code (str) – Required. Error code.

• message (str) – Required. Error message.

• target (str) – Property name/path in request associated with error.

• details (list[CloudErrorAutoGenerated]) – Array with additional error details.

Keyword Arguments

• code (str) – Required. Error code.

• message (str) – Required. Error message.

• target (str) – Property name/path in request associated with error.

• details (list[CloudErrorAutoGenerated]) – Array with additional error details.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, entity_name: Optional[Any] = None, **kwargs)

The Common Data Service for Apps entity dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• entity_name (any) – The logical name of the entity. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• entity_name (any) – The logical name of the entity. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService(*, deployment_type: Any, authentication_type: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, host_name: Optional[Any] = None, port: Optional[Any] = None, service_uri: Optional[Any] = None, organization_name: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_principal_id: Optional[Any] = None, service_principal_credential_type: Optional[Any] = None, service_principal_credential: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Common Data Service for Apps linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• deployment_type (any) – Required. The deployment type of the Common Data Service for Apps instance. ‘Online’ for Common Data Service for Apps Online and ‘OnPremisesWithIfd’ for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string).

• host_name (any) – The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).

• port (any) – The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.

• service_uri (any) – The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).

• organization_name (any) – The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string).

• authentication_type (any) – Required. The authentication type to connect to Common Data Service for Apps server. ‘Office365’ for online scenario, ‘Ifd’ for on-premises with Ifd scenario. ‘AADServicePrincipal’ for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).

• username (any) – User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the Common Data Service for Apps instance.

• service_principal_id (any) – The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).

• service_principal_credential_type (any) – A string from ServicePrincipalCredentialEnum or an expression.

• service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• deployment_type (any) – Required. The deployment type of the Common Data Service for Apps instance. ‘Online’ for Common Data Service for Apps Online and ‘OnPremisesWithIfd’ for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string).

• host_name (any) – The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).

• port (any) – The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.

• service_uri (any) – The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).

• organization_name (any) – The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string).

• authentication_type (any) – Required. The authentication type to connect to Common Data Service for Apps server. ‘Office365’ for online scenario, ‘Ifd’ for on-premises with Ifd scenario. ‘AADServicePrincipal’ for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).

• username (any) – User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the Common Data Service for Apps instance.

• service_principal_id (any) – The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).

• service_principal_credential_type (any) – A string from ServicePrincipalCredentialEnum or an expression.

• service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CommonDataServiceForAppsSink(*, write_behavior: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DynamicsSinkWriteBehavior], additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, ignore_null_values: Optional[Any] = None, alternate_key_name: Optional[Any] = None, **kwargs)

A copy activity Common Data Service for Apps sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or DynamicsSinkWriteBehavior) – Required. The write behavior for the operation. Possible values include: “Upsert”.

• ignore_null_values (any) – The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).

• alternate_key_name (any) – The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or DynamicsSinkWriteBehavior) – Required. The write behavior for the operation. Possible values include: “Upsert”.

• ignore_null_values (any) – The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).

• alternate_key_name (any) – The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CommonDataServiceForAppsSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Common Data Service for Apps source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CompressionCodec(value)

All available compressionCodec values.

BZIP2 = 'bzip2'

DEFLATE = 'deflate'

GZIP = 'gzip'

LZ4 = 'lz4'

LZO = 'lzo'

NONE = 'none'

SNAPPY = 'snappy'

TAR = 'tar'

TAR_G_ZIP = 'tarGZip'

ZIP_DEFLATE = 'zipDeflate'

class azure.synapse.artifacts.models.CompressionReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

Compression read settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: TarGZipReadSettings, TarReadSettings, ZipDeflateReadSettings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The Compression setting type.Constant filled by server.

Keyword Arguments

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ConcurLinkedService(*, client_id: Any, username: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_properties: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Concur Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object.

• client_id (any) – Required. Application client_id supplied by Concur App Management.

• username (any) – Required. The user name that you use to access Concur Service.

• password (SecretBase) – The password corresponding to the user name that you provided in the username field.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object.

• client_id (any) – Required. Application client_id supplied by Concur App Management.

• username (any) – Required. The user name that you use to access Concur Service.

• password (SecretBase) – The password corresponding to the user name that you provided in the username field.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ConcurObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Concur Service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ConcurSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Concur Service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ControlActivity(*, name: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, **kwargs)

Base class for all control activities like IfCondition, ForEach , Until.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AppendVariableActivity, ExecutePipelineActivity, FilterActivity, ForEachActivity, IfConditionActivity, SetVariableActivity, SwitchActivity, UntilActivity, ValidationActivity, WaitActivity, WebHookActivity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CopyActivity(*, name: str, source: azure.synapse.artifacts.models._models_py3.CopySource, sink: azure.synapse.artifacts.models._models_py3.CopySink, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, inputs: Optional[List[azure.synapse.artifacts.models._models_py3.DatasetReference]] = None, outputs: Optional[List[azure.synapse.artifacts.models._models_py3.DatasetReference]] = None, translator: Optional[Any] = None, enable_staging: Optional[Any] = None, staging_settings: Optional[azure.synapse.artifacts.models._models_py3.StagingSettings] = None, parallel_copies: Optional[Any] = None, data_integration_units: Optional[Any] = None, enable_skip_incompatible_row: Optional[Any] = None, redirect_incompatible_row_settings: Optional[azure.synapse.artifacts.models._models_py3.RedirectIncompatibleRowSettings] = None, log_storage_settings: Optional[azure.synapse.artifacts.models._models_py3.LogStorageSettings] = None, log_settings: Optional[azure.synapse.artifacts.models._models_py3.LogSettings] = None, preserve_rules: Optional[List[Any]] = None, preserve: Optional[List[Any]] = None, validate_data_consistency: Optional[Any] = None, skip_error_file: Optional[azure.synapse.artifacts.models._models_py3.SkipErrorFile] = None, **kwargs)

Copy activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• inputs (list[DatasetReference]) – List of inputs for the activity.

• outputs (list[DatasetReference]) – List of outputs for the activity.

• source (CopySource) – Required. Copy activity source.

• sink (CopySink) – Required. Copy activity sink.

• translator (any) – Copy activity translator. If not specified, tabular translator is used.

• enable_staging (any) – Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).

• staging_settings (StagingSettings) – Specifies interim staging settings when EnableStaging is true.

• parallel_copies (any) – Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.

• data_integration_units (any) – Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.

• enable_skip_incompatible_row (any) – Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).

• redirect_incompatible_row_settings (RedirectIncompatibleRowSettings) – Redirect incompatible row settings when EnableSkipIncompatibleRow is true.

• log_storage_settings (LogStorageSettings) – (Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.

• log_settings (LogSettings) – Log settings customer needs provide when enabling log.

• preserve_rules (list[any]) – Preserve Rules.

• preserve (list[any]) – Preserve rules.

• validate_data_consistency (any) – Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).

• skip_error_file (SkipErrorFile) – Specify the fault tolerance for data consistency.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• inputs (list[DatasetReference]) – List of inputs for the activity.

• outputs (list[DatasetReference]) – List of outputs for the activity.

• source (CopySource) – Required. Copy activity source.

• sink (CopySink) – Required. Copy activity sink.

• translator (any) – Copy activity translator. If not specified, tabular translator is used.

• enable_staging (any) – Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).

• staging_settings (StagingSettings) – Specifies interim staging settings when EnableStaging is true.

• parallel_copies (any) – Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.

• data_integration_units (any) – Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.

• enable_skip_incompatible_row (any) – Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).

• redirect_incompatible_row_settings (RedirectIncompatibleRowSettings) – Redirect incompatible row settings when EnableSkipIncompatibleRow is true.

• log_storage_settings (LogStorageSettings) – (Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.

• log_settings (LogSettings) – Log settings customer needs provide when enabling log.

• preserve_rules (list[any]) – Preserve Rules.

• preserve (list[any]) – Preserve rules.

• validate_data_consistency (any) – Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).

• skip_error_file (SkipErrorFile) – Specify the fault tolerance for data consistency.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CopyActivityLogSettings(*, log_level: Optional[Any] = None, enable_reliable_logging: Optional[Any] = None, **kwargs)

Settings for copy activity log.

Variables

• log_level (any) – Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string).

• enable_reliable_logging (any) – Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• log_level (any) – Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string).

• enable_reliable_logging (any) – Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CopyBehaviorType(value)

All available types of copy behavior.

FLATTEN_HIERARCHY = 'FlattenHierarchy'

MERGE_FILES = 'MergeFiles'

PRESERVE_HIERARCHY = 'PreserveHierarchy'

class azure.synapse.artifacts.models.CopySink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, **kwargs)

A copy activity sink.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AvroSink, AzureBlobFSSink, AzureDataExplorerSink, AzureDataLakeStoreSink, AzureDatabricksDeltaLakeSink, AzureMySqlSink, AzurePostgreSqlSink, AzureQueueSink, AzureSearchIndexSink, AzureSqlSink, AzureTableSink, BinarySink, BlobSink, CommonDataServiceForAppsSink, CosmosDbMongoDbApiSink, CosmosDbSqlApiSink, DelimitedTextSink, DocumentDbCollectionSink, DynamicsCrmSink, DynamicsSink, FileSystemSink, InformixSink, JsonSink, MicrosoftAccessSink, OdbcSink, OracleSink, OrcSink, ParquetSink, RestSink, SalesforceServiceCloudSink, SalesforceSink, SapCloudForCustomerSink, SnowflakeSink, SqlDWSink, SqlMISink, SqlServerSink, SqlSink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CopySource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, **kwargs)

A copy activity source.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AmazonRdsForOracleSource, AvroSource, AzureBlobFSSource, AzureDataExplorerSource, AzureDataLakeStoreSource, AzureDatabricksDeltaLakeSource, BinarySource, BlobSource, CommonDataServiceForAppsSource, CosmosDbMongoDbApiSource, CosmosDbSqlApiSource, DelimitedTextSource, DocumentDbCollectionSource, DynamicsCrmSource, DynamicsSource, ExcelSource, FileSystemSource, HdfsSource, HttpSource, JsonSource, MicrosoftAccessSource, MongoDbAtlasSource, MongoDbSource, MongoDbV2Source, ODataSource, Office365Source, OracleSource, OrcSource, ParquetSource, RelationalSource, RestSource, SalesforceServiceCloudSource, SharePointOnlineListSource, SnowflakeSource, TabularSource, WebSource, XmlSource.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CopyTranslator(*, additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

A copy activity translator.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: TabularTranslator.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy translator type.Constant filled by server.

Keyword Arguments

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CosmosDbLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, account_endpoint: Optional[Any] = None, database: Optional[Any] = None, account_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Microsoft Azure Cosmos Database (CosmosDB) linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• account_endpoint (any) – The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string).

• database (any) – The name of the database. Type: string (or Expression with resultType string).

• account_key (SecretBase) – The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• account_endpoint (any) – The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string).

• database (any) – The name of the database. Type: string (or Expression with resultType string).

• account_key (SecretBase) – The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, collection: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The CosmosDB (MongoDB API) database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection (any) – Required. The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection (any) – Required. The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService(*, connection_string: Any, database: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, **kwargs)

Linked service for CosmosDB (MongoDB API) data source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

• database (any) – Required. The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

• database (any) – Required. The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CosmosDbMongoDbApiSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, write_behavior: Optional[Any] = None, **kwargs)

A copy activity sink for a CosmosDB (MongoDB API) database.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (any) – Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is “insert”. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (any) – Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is “insert”. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CosmosDbMongoDbApiSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, filter: Optional[Any] = None, cursor_methods: Optional[azure.synapse.artifacts.models._models_py3.MongoDbCursorMethodsProperties] = None, batch_size: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity source for a CosmosDB (MongoDB API) database.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• filter (any) – Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).

• cursor_methods (MongoDbCursorMethodsProperties) – Cursor methods for Mongodb query.

• batch_size (any) – Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property’s main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• filter (any) – Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).

• cursor_methods (MongoDbCursorMethodsProperties) – Cursor methods for Mongodb query.

• batch_size (any) – Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property’s main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, collection_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

Microsoft Azure CosmosDB (SQL API) Collection dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection_name (any) – Required. CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection_name (any) – Required. CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CosmosDbSqlApiSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, write_behavior: Optional[Any] = None, **kwargs)

A copy activity Azure CosmosDB (SQL API) Collection sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (any) – Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (any) – Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CosmosDbSqlApiSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, page_size: Optional[Any] = None, preferred_regions: Optional[Any] = None, detect_datetime: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Azure CosmosDB (SQL API) Collection source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – SQL API query. Type: string (or Expression with resultType string).

• page_size (any) – Page size of the result. Type: integer (or Expression with resultType integer).

• preferred_regions (any) – Preferred regions. Type: array of strings (or Expression with resultType array of strings).

• detect_datetime (any) – Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – SQL API query. Type: string (or Expression with resultType string).

• page_size (any) – Page size of the result. Type: integer (or Expression with resultType integer).

• preferred_regions (any) – Preferred regions. Type: array of strings (or Expression with resultType array of strings).

• detect_datetime (any) – Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CouchbaseLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, cred_string: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Couchbase server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• cred_string (AzureKeyVaultSecretReference) – The Azure key vault secret reference of credString in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• cred_string (AzureKeyVaultSecretReference) – The Azure key vault secret reference of credString in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CouchbaseSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Couchbase server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CouchbaseTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Couchbase server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest(*, compute_type: Optional[str] = None, core_count: Optional[int] = None, time_to_live: Optional[int] = None, integration_runtime: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeDebugResource] = None, **kwargs)

Request body structure for creating data flow debug session.

Variables

• compute_type (str) – Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided.

• core_count (int) – Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided.

• time_to_live (int) – Time to live setting of the cluster in minutes.

• integration_runtime (IntegrationRuntimeDebugResource) – Set to use integration runtime setting for data flow debug session.

Keyword Arguments

• compute_type (str) – Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided.

• core_count (int) – Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided.

• time_to_live (int) – Time to live setting of the cluster in minutes.

• integration_runtime (IntegrationRuntimeDebugResource) – Set to use integration runtime setting for data flow debug session.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse(*, session_id: Optional[str] = None, **kwargs)

Response body structure for creating data flow debug session.

Variables

session_id (str) – The ID of data flow debug session.

Keyword Arguments

session_id (str) – The ID of data flow debug session.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CreateMode(value)

Specifies the mode of sql pool creation.

Default: regular sql pool creation.

PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool’s original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

DEFAULT = 'Default'

POINT_IN_TIME_RESTORE = 'PointInTimeRestore'

RECOVERY = 'Recovery'

RESTORE = 'Restore'

class azure.synapse.artifacts.models.CreateRunResponse(*, run_id: str, **kwargs)

Response body with a run identifier.

All required parameters must be populated in order to send to Azure.

Variables

run_id (str) – Required. Identifier of a run.

Keyword Arguments

run_id (str) – Required. Identifier of a run.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CustomActivity(*, name: str, command: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, resource_linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, folder_path: Optional[Any] = None, reference_objects: Optional[azure.synapse.artifacts.models._models_py3.CustomActivityReferenceObject] = None, extended_properties: Optional[Dict[str, Any]] = None, retention_time_in_days: Optional[Any] = None, auto_user_specification: Optional[Any] = None, **kwargs)

Custom activity type.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• command (any) – Required. Command for custom activity Type: string (or Expression with resultType string).

• resource_linked_service (LinkedServiceReference) – Resource linked service reference.

• folder_path (any) – Folder path for resource files Type: string (or Expression with resultType string).

• reference_objects (CustomActivityReferenceObject) – Reference objects.

• extended_properties (dict[str, any]) – User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.

• retention_time_in_days (any) – The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).

• auto_user_specification (any) – Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• command (any) – Required. Command for custom activity Type: string (or Expression with resultType string).

• resource_linked_service (LinkedServiceReference) – Resource linked service reference.

• folder_path (any) – Folder path for resource files Type: string (or Expression with resultType string).

• reference_objects (CustomActivityReferenceObject) – Reference objects.

• extended_properties (dict[str, any]) – User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.

• retention_time_in_days (any) – The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).

• auto_user_specification (any) – Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CustomActivityReferenceObject(*, linked_services: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceReference]] = None, datasets: Optional[List[azure.synapse.artifacts.models._models_py3.DatasetReference]] = None, **kwargs)

Reference objects for custom activity.

Variables

• linked_services (list[LinkedServiceReference]) – Linked service references.

• datasets (list[DatasetReference]) – Dataset references.

Keyword Arguments

• linked_services (list[LinkedServiceReference]) – Linked service references.

• datasets (list[DatasetReference]) – Dataset references.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CustomDataSourceLinkedService(*, type_properties: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, **kwargs)

Custom linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• type_properties (any) – Required. Custom linked service properties.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• type_properties (any) – Required. Custom linked service properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CustomDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, type_properties: Optional[Any] = None, **kwargs)

The custom dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• type_properties (any) – Custom dataset properties.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• type_properties (any) – Custom dataset properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CustomEventsTrigger(*, events: List[Any], scope: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, annotations: Optional[List[Any]] = None, pipelines: Optional[List[azure.synapse.artifacts.models._models_py3.TriggerPipelineReference]] = None, subject_begins_with: Optional[str] = None, subject_ends_with: Optional[str] = None, **kwargs)

Trigger that runs every time a custom event is received.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Trigger type.Constant filled by server.

• description (str) – Trigger description.

• runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: “Started”, “Stopped”, “Disabled”.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

• subject_begins_with (str) – The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.

• subject_ends_with (str) – The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.

• events (list[any]) – Required. The list of event types that cause this trigger to fire.

• scope (str) – Required. The ARM resource ID of the Azure Event Grid Topic.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Trigger description.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

• subject_begins_with (str) – The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.

• subject_ends_with (str) – The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.

• events (list[any]) – Required. The list of event types that cause this trigger to fire.

• scope (str) – Required. The ARM resource ID of the Azure Event Grid Topic.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CustomSetupBase(**kwargs)

The base definition of the custom setup.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: .

All required parameters must be populated in order to send to Azure.

Variables

type (str) – Required. The type of custom setup.Constant filled by server.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.CustomerManagedKeyDetails(*, key: Optional[azure.synapse.artifacts.models._models_py3.WorkspaceKeyDetails] = None, **kwargs)

Details of the customer managed key associated with the workspace.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• status (str) – The customer managed key status on the workspace.

• key (WorkspaceKeyDetails) – The key object of the workspace.

Keyword Arguments

key (WorkspaceKeyDetails) – The key object of the workspace.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DWCopyCommandDefaultValue(*, column_name: Optional[Any] = None, default_value: Optional[Any] = None, **kwargs)

Default value.

Variables

• column_name (any) – Column name. Type: object (or Expression with resultType string).

• default_value (any) – The default value of the column. Type: object (or Expression with resultType string).

Keyword Arguments

• column_name (any) – Column name. Type: object (or Expression with resultType string).

• default_value (any) – The default value of the column. Type: object (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DWCopyCommandSettings(*, default_values: Optional[List[azure.synapse.artifacts.models._models_py3.DWCopyCommandDefaultValue]] = None, additional_options: Optional[Dict[str, str]] = None, **kwargs)

DW Copy Command settings.

Variables

• default_values (list[DWCopyCommandDefaultValue]) – Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).

• additional_options (dict[str, str]) – Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalOptions”: { “MAXERRORS”: “1000”, “DATEFORMAT”: “‘ymd’” }.

Keyword Arguments

• default_values (list[DWCopyCommandDefaultValue]) – Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).

• additional_options (dict[str, str]) – Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalOptions”: { “MAXERRORS”: “1000”, “DATEFORMAT”: “‘ymd’” }.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlow(*, description: Optional[str] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DataFlowFolder] = None, **kwargs)

Azure Synapse nested object which contains a flow with data movements and transformations.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: Flowlet, MappingDataFlow.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – Required. Type of data flow.Constant filled by server.

• description (str) – The description of the data flow.

• annotations (list[any]) – List of tags that can be used for describing the data flow.

• folder (DataFlowFolder) – The folder that this data flow is in. If not specified, Data flow will appear at the root level.

Keyword Arguments

• description (str) – The description of the data flow.

• annotations (list[any]) – List of tags that can be used for describing the data flow.

• folder (DataFlowFolder) – The folder that this data flow is in. If not specified, Data flow will appear at the root level.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowComputeType(value)

Compute type of the cluster which will execute data flow job.

COMPUTE_OPTIMIZED = 'ComputeOptimized'

GENERAL = 'General'

MEMORY_OPTIMIZED = 'MemoryOptimized'

class azure.synapse.artifacts.models.DataFlowDebugCommandPayload(*, stream_name: str, row_limits: Optional[int] = None, columns: Optional[List[str]] = None, expression: Optional[str] = None, **kwargs)

Structure of command payload.

All required parameters must be populated in order to send to Azure.

Variables

• stream_name (str) – Required. The stream name which is used for preview.

• row_limits (int) – Row limits for preview response.

• columns (list[str]) – Array of column names.

• expression (str) – The expression which is used for preview.

Keyword Arguments

• stream_name (str) – Required. The stream name which is used for preview.

• row_limits (int) – Row limits for preview response.

• columns (list[str]) – Array of column names.

• expression (str) – The expression which is used for preview.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowDebugCommandRequest(*, session_id: Optional[str] = None, command: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DataFlowDebugCommandType]] = None, command_payload: Optional[azure.synapse.artifacts.models._models_py3.DataFlowDebugCommandPayload] = None, **kwargs)

Request body structure for data flow expression preview.

Variables

• session_id (str) – The ID of data flow debug session.

• command (str or DataFlowDebugCommandType) – The command type. Possible values include: “executePreviewQuery”, “executeStatisticsQuery”, “executeExpressionQuery”.

• command_payload (DataFlowDebugCommandPayload) – The command payload object.

Keyword Arguments

• session_id (str) – The ID of data flow debug session.

• command (str or DataFlowDebugCommandType) – The command type. Possible values include: “executePreviewQuery”, “executeStatisticsQuery”, “executeExpressionQuery”.

• command_payload (DataFlowDebugCommandPayload) – The command payload object.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowDebugCommandResponse(*, status: Optional[str] = None, data: Optional[str] = None, **kwargs)

Response body structure of data flow result for data preview, statistics or expression preview.

Variables

• status (str) – The run status of data preview, statistics or expression preview.

• data (str) – The result data of data preview, statistics or expression preview.

Keyword Arguments

• status (str) – The run status of data preview, statistics or expression preview.

• data (str) – The result data of data preview, statistics or expression preview.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowDebugCommandType(value)

The command type.

EXECUTE_EXPRESSION_QUERY = 'executeExpressionQuery'

EXECUTE_PREVIEW_QUERY = 'executePreviewQuery'

EXECUTE_STATISTICS_QUERY = 'executeStatisticsQuery'

class azure.synapse.artifacts.models.DataFlowDebugPackage(*, additional_properties: Optional[Dict[str, Any]] = None, session_id: Optional[str] = None, data_flow: Optional[azure.synapse.artifacts.models._models_py3.DataFlowDebugResource] = None, data_flows: Optional[List[azure.synapse.artifacts.models._models_py3.DataFlowDebugResource]] = None, datasets: Optional[List[azure.synapse.artifacts.models._models_py3.DatasetDebugResource]] = None, linked_services: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceDebugResource]] = None, staging: Optional[azure.synapse.artifacts.models._models_py3.DataFlowStagingInfo] = None, debug_settings: Optional[azure.synapse.artifacts.models._models_py3.DataFlowDebugPackageDebugSettings] = None, **kwargs)

Request body structure for starting data flow debug session.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• session_id (str) – The ID of data flow debug session.

• data_flow (DataFlowDebugResource) – Data flow instance.

• data_flows (list[DataFlowDebugResource]) – List of Data flows.

• datasets (list[DatasetDebugResource]) – List of datasets.

• linked_services (list[LinkedServiceDebugResource]) – List of linked services.

• staging (DataFlowStagingInfo) – Staging info for debug session.

• debug_settings (DataFlowDebugPackageDebugSettings) – Data flow debug settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• session_id (str) – The ID of data flow debug session.

• data_flow (DataFlowDebugResource) – Data flow instance.

• data_flows (list[DataFlowDebugResource]) – List of Data flows.

• datasets (list[DatasetDebugResource]) – List of datasets.

• linked_services (list[LinkedServiceDebugResource]) – List of linked services.

• staging (DataFlowStagingInfo) – Staging info for debug session.

• debug_settings (DataFlowDebugPackageDebugSettings) – Data flow debug settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings(*, source_settings: Optional[List[azure.synapse.artifacts.models._models_py3.DataFlowSourceSetting]] = None, parameters: Optional[Dict[str, Any]] = None, dataset_parameters: Optional[Any] = None, **kwargs)

Data flow debug settings.

Variables

• source_settings (list[DataFlowSourceSetting]) – Source setting for data flow debug.

• parameters (dict[str, any]) – Data flow parameters.

• dataset_parameters (any) – Parameters for dataset.

Keyword Arguments

• source_settings (list[DataFlowSourceSetting]) – Source setting for data flow debug.

• parameters (dict[str, any]) – Data flow parameters.

• dataset_parameters (any) – Parameters for dataset.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest(*, session_id: Optional[str] = None, data_flow_name: Optional[str] = None, stream_name: Optional[str] = None, row_limits: Optional[int] = None, **kwargs)

Request body structure for data flow preview data.

Variables

• session_id (str) – The ID of data flow debug session.

• data_flow_name (str) – The data flow which contains the debug session.

• stream_name (str) – The output stream name.

• row_limits (int) – The row limit for preview request.

Keyword Arguments

• session_id (str) – The ID of data flow debug session.

• data_flow_name (str) – The data flow which contains the debug session.

• stream_name (str) – The output stream name.

• row_limits (int) – The row limit for preview request.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowDebugQueryResponse(*, run_id: Optional[str] = None, **kwargs)

Response body structure of data flow query for data preview, statistics or expression preview.

Variables

run_id (str) – The run ID of data flow debug session.

Keyword Arguments

run_id (str) – The run ID of data flow debug session.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowDebugResource(*, properties: azure.synapse.artifacts.models._models_py3.DataFlow, name: Optional[str] = None, **kwargs)

Data flow debug resource.

All required parameters must be populated in order to send to Azure.

Variables

• name (str) – The resource name.

• properties (DataFlow) – Required. Data flow properties.

Keyword Arguments

• name (str) – The resource name.

• properties (DataFlow) – Required. Data flow properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowDebugResultResponse(*, status: Optional[str] = None, data: Optional[str] = None, **kwargs)

Response body structure of data flow result for data preview, statistics or expression preview.

Variables

• status (str) – The run status of data preview, statistics or expression preview.

• data (str) – The result data of data preview, statistics or expression preview.

Keyword Arguments

• status (str) – The run status of data preview, statistics or expression preview.

• data (str) – The result data of data preview, statistics or expression preview.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowDebugSessionInfo(*, additional_properties: Optional[Dict[str, Any]] = None, data_flow_name: Optional[str] = None, compute_type: Optional[str] = None, core_count: Optional[int] = None, node_count: Optional[int] = None, integration_runtime_name: Optional[str] = None, session_id: Optional[str] = None, start_time: Optional[str] = None, time_to_live_in_minutes: Optional[int] = None, last_activity_time: Optional[str] = None, **kwargs)

Data flow debug session info.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• data_flow_name (str) – The name of the data flow.

• compute_type (str) – Compute type of the cluster.

• core_count (int) – Core count of the cluster.

• node_count (int) – Node count of the cluster. (deprecated property).

• integration_runtime_name (str) – Attached integration runtime name of data flow debug session.

• session_id (str) – The ID of data flow debug session.

• start_time (str) – Start time of data flow debug session.

• time_to_live_in_minutes (int) – Compute type of the cluster.

• last_activity_time (str) – Last activity time of data flow debug session.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• data_flow_name (str) – The name of the data flow.

• compute_type (str) – Compute type of the cluster.

• core_count (int) – Core count of the cluster.

• node_count (int) – Node count of the cluster. (deprecated property).

• integration_runtime_name (str) – Attached integration runtime name of data flow debug session.

• session_id (str) – The ID of data flow debug session.

• start_time (str) – Start time of data flow debug session.

• time_to_live_in_minutes (int) – Compute type of the cluster.

• last_activity_time (str) – Last activity time of data flow debug session.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest(*, session_id: Optional[str] = None, data_flow_name: Optional[str] = None, stream_name: Optional[str] = None, columns: Optional[List[str]] = None, **kwargs)

Request body structure for data flow statistics.

Variables

• session_id (str) – The ID of data flow debug session.

• data_flow_name (str) – The data flow which contains the debug session.

• stream_name (str) – The output stream name.

• columns (list[str]) – List of column names.

Keyword Arguments

• session_id (str) – The ID of data flow debug session.

• data_flow_name (str) – The data flow which contains the debug session.

• stream_name (str) – The output stream name.

• columns (list[str]) – List of column names.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowFolder(*, name: Optional[str] = None, **kwargs)

The folder that this data flow is in. If not specified, Data flow will appear at the root level.

Variables

name (str) – The name of the folder that this data flow is in.

Keyword Arguments

name (str) – The name of the folder that this data flow is in.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.DataFlowResource], next_link: Optional[str] = None, **kwargs)

A list of data flow resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[DataFlowResource]) – Required. List of data flows.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[DataFlowResource]) – Required. List of data flows.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowReference(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DataFlowReferenceType], reference_name: str, additional_properties: Optional[Dict[str, Any]] = None, dataset_parameters: Optional[Any] = None, parameters: Optional[Dict[str, Any]] = None, **kwargs)

Data flow reference type.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str or DataFlowReferenceType) – Required. Data flow reference type. Possible values include: “DataFlowReference”.

• reference_name (str) – Required. Reference data flow name.

• dataset_parameters (any) – Reference data flow parameters from dataset.

• parameters (dict[str, any]) – Data flow parameters.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str or DataFlowReferenceType) – Required. Data flow reference type. Possible values include: “DataFlowReference”.

• reference_name (str) – Required. Reference data flow name.

• dataset_parameters (any) – Reference data flow parameters from dataset.

• parameters (dict[str, any]) – Data flow parameters.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowReferenceType(value)

Data flow reference type.

DATA_FLOW_REFERENCE = 'DataFlowReference'

class azure.synapse.artifacts.models.DataFlowResource(*, properties: azure.synapse.artifacts.models._models_py3.DataFlow, **kwargs)

Data flow resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• properties (DataFlow) – Required. Data flow properties.

Keyword Arguments

properties (DataFlow) – Required. Data flow properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowSink(*, name: str, description: Optional[str] = None, dataset: Optional[azure.synapse.artifacts.models._models_py3.DatasetReference] = None, linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, flowlet: Optional[azure.synapse.artifacts.models._models_py3.DataFlowReference] = None, schema_linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, **kwargs)

Transformation for data flow sink.

All required parameters must be populated in order to send to Azure.

Variables

• name (str) – Required. Transformation name.

• description (str) – Transformation description.

• dataset (DatasetReference) – Dataset reference.

• linked_service (LinkedServiceReference) – Linked service reference.

• flowlet (DataFlowReference) – Flowlet Reference.

• schema_linked_service (LinkedServiceReference) – Schema linked service reference.

Keyword Arguments

• name (str) – Required. Transformation name.

• description (str) – Transformation description.

• dataset (DatasetReference) – Dataset reference.

• linked_service (LinkedServiceReference) – Linked service reference.

• flowlet (DataFlowReference) – Flowlet Reference.

• schema_linked_service (LinkedServiceReference) – Schema linked service reference.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowSource(*, name: str, description: Optional[str] = None, dataset: Optional[azure.synapse.artifacts.models._models_py3.DatasetReference] = None, linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, flowlet: Optional[azure.synapse.artifacts.models._models_py3.DataFlowReference] = None, schema_linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, **kwargs)

Transformation for data flow source.

All required parameters must be populated in order to send to Azure.

Variables

• name (str) – Required. Transformation name.

• description (str) – Transformation description.

• dataset (DatasetReference) – Dataset reference.

• linked_service (LinkedServiceReference) – Linked service reference.

• flowlet (DataFlowReference) – Flowlet Reference.

• schema_linked_service (LinkedServiceReference) – Schema linked service reference.

Keyword Arguments

• name (str) – Required. Transformation name.

• description (str) – Transformation description.

• dataset (DatasetReference) – Dataset reference.

• linked_service (LinkedServiceReference) – Linked service reference.

• flowlet (DataFlowReference) – Flowlet Reference.

• schema_linked_service (LinkedServiceReference) – Schema linked service reference.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowSourceSetting(*, additional_properties: Optional[Dict[str, Any]] = None, source_name: Optional[str] = None, row_limit: Optional[int] = None, **kwargs)

Definition of data flow source setting for debug.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_name (str) – The data flow source name.

• row_limit (int) – Defines the row limit of data flow source in debug.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_name (str) – The data flow source name.

• row_limit (int) – Defines the row limit of data flow source in debug.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataFlowStagingInfo(*, linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, folder_path: Optional[str] = None, **kwargs)

Staging info for execute data flow activity.

Variables

• linked_service (LinkedServiceReference) – Staging linked service reference.

• folder_path (str) – Folder path for staging blob.

Keyword Arguments

• linked_service (LinkedServiceReference) – Staging linked service reference.

• folder_path (str) – Folder path for staging blob.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity(*, name: str, script_path: Any, script_linked_service: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, degree_of_parallelism: Optional[Any] = None, priority: Optional[Any] = None, parameters: Optional[Dict[str, Any]] = None, runtime_version: Optional[Any] = None, compilation_mode: Optional[Any] = None, **kwargs)

Data Lake Analytics U-SQL activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• script_path (any) – Required. Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).

• script_linked_service (LinkedServiceReference) – Required. Script linked service reference.

• degree_of_parallelism (any) – The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1.

• priority (any) – Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1.

• parameters (dict[str, any]) – Parameters for U-SQL job request.

• runtime_version (any) – Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string).

• compilation_mode (any) – Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• script_path (any) – Required. Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).

• script_linked_service (LinkedServiceReference) – Required. Script linked service reference.

• degree_of_parallelism (any) – The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1.

• priority (any) – Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1.

• parameters (dict[str, any]) – Parameters for U-SQL job request.

• runtime_version (any) – Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string).

• compilation_mode (any) – Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DataLakeStorageAccountDetails(*, account_url: Optional[str] = None, filesystem: Optional[str] = None, **kwargs)

Details of the data lake storage account associated with the workspace.

Variables

• account_url (str) – Account URL.

• filesystem (str) – Filesystem name.

Keyword Arguments

• account_url (str) – Account URL.

• filesystem (str) – Filesystem name.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatabricksNotebookActivity(*, name: str, notebook_path: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, base_parameters: Optional[Dict[str, Any]] = None, libraries: Optional[List[Dict[str, Any]]] = None, **kwargs)

DatabricksNotebook activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• notebook_path (any) – Required. The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).

• base_parameters (dict[str, any]) – Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.

• libraries (list[dict[str, any]]) – A list of libraries to be installed on the cluster that will execute the job.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• notebook_path (any) – Required. The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).

• base_parameters (dict[str, any]) – Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.

• libraries (list[dict[str, any]]) – A list of libraries to be installed on the cluster that will execute the job.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatabricksSparkJarActivity(*, name: str, main_class_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, parameters: Optional[List[Any]] = None, libraries: Optional[List[Dict[str, Any]]] = None, **kwargs)

DatabricksSparkJar activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• main_class_name (any) – Required. The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string).

• parameters (list[any]) – Parameters that will be passed to the main method.

• libraries (list[dict[str, any]]) – A list of libraries to be installed on the cluster that will execute the job.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• main_class_name (any) – Required. The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string).

• parameters (list[any]) – Parameters that will be passed to the main method.

• libraries (list[dict[str, any]]) – A list of libraries to be installed on the cluster that will execute the job.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatabricksSparkPythonActivity(*, name: str, python_file: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, parameters: Optional[List[Any]] = None, libraries: Optional[List[Dict[str, Any]]] = None, **kwargs)

DatabricksSparkPython activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• python_file (any) – Required. The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string).

• parameters (list[any]) – Command line parameters that will be passed to the Python file.

• libraries (list[dict[str, any]]) – A list of libraries to be installed on the cluster that will execute the job.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• python_file (any) – Required. The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string).

• parameters (list[any]) – Command line parameters that will be passed to the Python file.

• libraries (list[dict[str, any]]) – A list of libraries to be installed on the cluster that will execute the job.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Dataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AmazonMWSObjectDataset, AmazonRdsForOracleTableDataset, AmazonRdsForSqlServerTableDataset, AmazonRedshiftTableDataset, AmazonS3Dataset, AvroDataset, AzureBlobDataset, AzureBlobFSDataset, AzureDataExplorerTableDataset, AzureDataLakeStoreDataset, AzureDatabricksDeltaLakeDataset, AzureMariaDBTableDataset, AzureMySqlTableDataset, AzurePostgreSqlTableDataset, AzureSearchIndexDataset, AzureSqlDWTableDataset, AzureSqlMITableDataset, AzureSqlTableDataset, AzureTableDataset, BinaryDataset, CassandraTableDataset, CommonDataServiceForAppsEntityDataset, ConcurObjectDataset, CosmosDbMongoDbApiCollectionDataset, CosmosDbSqlApiCollectionDataset, CouchbaseTableDataset, CustomDataset, Db2TableDataset, DelimitedTextDataset, DocumentDbCollectionDataset, DrillTableDataset, DynamicsAXResourceDataset, DynamicsCrmEntityDataset, DynamicsEntityDataset, EloquaObjectDataset, ExcelDataset, FileShareDataset, GoogleAdWordsObjectDataset, GoogleBigQueryObjectDataset, GreenplumTableDataset, HBaseObjectDataset, HiveObjectDataset, HttpDataset, HubspotObjectDataset, ImpalaObjectDataset, InformixTableDataset, JiraObjectDataset, JsonDataset, MagentoObjectDataset, MariaDBTableDataset, MarketoObjectDataset, MicrosoftAccessTableDataset, MongoDbAtlasCollectionDataset, MongoDbCollectionDataset, MongoDbV2CollectionDataset, MySqlTableDataset, NetezzaTableDataset, ODataResourceDataset, OdbcTableDataset, Office365Dataset, OracleServiceCloudObjectDataset, OracleTableDataset, OrcDataset, ParquetDataset, PaypalObjectDataset, PhoenixObjectDataset, PostgreSqlTableDataset, PrestoObjectDataset, QuickBooksObjectDataset, RelationalTableDataset, ResponsysObjectDataset, RestResourceDataset, SalesforceMarketingCloudObjectDataset, SalesforceObjectDataset, SalesforceServiceCloudObjectDataset, SapBwCubeDataset, SapCloudForCustomerResourceDataset, SapEccResourceDataset, SapHanaTableDataset, SapOpenHubTableDataset, SapTableResourceDataset, ServiceNowObjectDataset, SharePointOnlineListResourceDataset, ShopifyObjectDataset, SnowflakeDataset, SparkObjectDataset, SqlServerTableDataset, SquareObjectDataset, SybaseTableDataset, TeradataTableDataset, VerticaTableDataset, WebTableDataset, XeroObjectDataset, XmlDataset, ZohoObjectDataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatasetCompression(*, type: Any, additional_properties: Optional[Dict[str, Any]] = None, level: Optional[Any] = None, **kwargs)

The compression method used on a dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (any) – Required. Type of dataset compression. Type: string (or Expression with resultType string).

• level (any) – The dataset compression level. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (any) – Required. Type of dataset compression. Type: string (or Expression with resultType string).

• level (any) – The dataset compression level. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatasetCompressionLevel(value)

An enumeration.

FASTEST = 'Fastest'

OPTIMAL = 'Optimal'

class azure.synapse.artifacts.models.DatasetDataElement(*, name: Optional[Any] = None, type: Optional[Any] = None, **kwargs)

Columns that define the structure of the dataset.

Variables

• name (any) – Name of the column. Type: string (or Expression with resultType string).

• type (any) – Type of the column. Type: string (or Expression with resultType string).

Keyword Arguments

• name (any) – Name of the column. Type: string (or Expression with resultType string).

• type (any) – Type of the column. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatasetDebugResource(*, properties: azure.synapse.artifacts.models._models_py3.Dataset, name: Optional[str] = None, **kwargs)

Dataset debug resource.

All required parameters must be populated in order to send to Azure.

Variables

• name (str) – The resource name.

• properties (Dataset) – Required. Dataset properties.

Keyword Arguments

• name (str) – The resource name.

• properties (Dataset) – Required. Dataset properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatasetFolder(*, name: Optional[str] = None, **kwargs)

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Variables

name (str) – The name of the folder that this Dataset is in.

Keyword Arguments

name (str) – The name of the folder that this Dataset is in.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatasetListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.DatasetResource], next_link: Optional[str] = None, **kwargs)

A list of dataset resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[DatasetResource]) – Required. List of datasets.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[DatasetResource]) – Required. List of datasets.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatasetLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, **kwargs)

Dataset location.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AmazonS3Location, AzureBlobFSLocation, AzureBlobStorageLocation, AzureDataLakeStoreLocation, AzureFileStorageLocation, FileServerLocation, FtpServerLocation, GoogleCloudStorageLocation, HdfsLocation, HttpServerLocation, SftpLocation.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatasetReference(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DatasetReferenceType], reference_name: str, parameters: Optional[Dict[str, Any]] = None, **kwargs)

Dataset reference type.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or DatasetReferenceType) – Required. Dataset reference type. Possible values include: “DatasetReference”.

• reference_name (str) – Required. Reference dataset name.

• parameters (dict[str, any]) – Arguments for dataset.

Keyword Arguments

• type (str or DatasetReferenceType) – Required. Dataset reference type. Possible values include: “DatasetReference”.

• reference_name (str) – Required. Reference dataset name.

• parameters (dict[str, any]) – Arguments for dataset.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatasetReferenceType(value)

Dataset reference type.

DATASET_REFERENCE = 'DatasetReference'

class azure.synapse.artifacts.models.DatasetResource(*, properties: azure.synapse.artifacts.models._models_py3.Dataset, **kwargs)

Dataset resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• properties (Dataset) – Required. Dataset properties.

Keyword Arguments

properties (Dataset) – Required. Dataset properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatasetSchemaDataElement(*, additional_properties: Optional[Dict[str, Any]] = None, name: Optional[Any] = None, type: Optional[Any] = None, **kwargs)

Columns that define the physical type schema of the dataset.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (any) – Name of the schema column. Type: string (or Expression with resultType string).

• type (any) – Type of the schema column. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (any) – Name of the schema column. Type: string (or Expression with resultType string).

• type (any) – Type of the schema column. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DatasetStorageFormat(*, additional_properties: Optional[Dict[str, Any]] = None, serializer: Optional[Any] = None, deserializer: Optional[Any] = None, **kwargs)

The format definition of a storage.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AvroFormat, JsonFormat, OrcFormat, ParquetFormat, TextFormat.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage format.Constant filled by server.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DayOfWeek(value)

An enumeration.

FRIDAY = 'Friday'

MONDAY = 'Monday'

SATURDAY = 'Saturday'

SUNDAY = 'Sunday'

THURSDAY = 'Thursday'

TUESDAY = 'Tuesday'

WEDNESDAY = 'Wednesday'

class azure.synapse.artifacts.models.Db2AuthenticationType(value)

AuthenticationType to be used for connection. It is mutually exclusive with connectionString property.

BASIC = 'Basic'

class azure.synapse.artifacts.models.Db2LinkedService(*, server: Any, database: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.Db2AuthenticationType]] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, package_collection: Optional[Any] = None, certificate_common_name: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for DB2 data source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference.

• server (any) – Required. Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

• database (any) – Required. Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

• authentication_type (str or Db2AuthenticationType) – AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. Possible values include: “Basic”.

• username (any) – Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for authentication.

• package_collection (any) – Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

• certificate_common_name (any) – Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference.

• server (any) – Required. Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

• database (any) – Required. Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

• authentication_type (str or Db2AuthenticationType) – AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. Possible values include: “Basic”.

• username (any) – Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for authentication.

• package_collection (any) – Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

• certificate_common_name (any) – Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Db2Source(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity source for Db2 databases.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Db2TableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The Db2 table dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The Db2 schema name. Type: string (or Expression with resultType string).

• table (any) – The Db2 table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The Db2 schema name. Type: string (or Expression with resultType string).

• table (any) – The Db2 table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DeleteActivity(*, name: str, dataset: azure.synapse.artifacts.models._models_py3.DatasetReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, recursive: Optional[Any] = None, max_concurrent_connections: Optional[int] = None, enable_logging: Optional[Any] = None, log_storage_settings: Optional[azure.synapse.artifacts.models._models_py3.LogStorageSettings] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreReadSettings] = None, **kwargs)

Delete activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• recursive (any) – If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean).

• max_concurrent_connections (int) – The max concurrent connections to connect data source at the same time.

• enable_logging (any) – Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean).

• log_storage_settings (LogStorageSettings) – Log storage settings customer need to provide when enableLogging is true.

• dataset (DatasetReference) – Required. Delete activity dataset reference.

• store_settings (StoreReadSettings) – Delete activity store settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• recursive (any) – If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean).

• max_concurrent_connections (int) – The max concurrent connections to connect data source at the same time.

• enable_logging (any) – Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean).

• log_storage_settings (LogStorageSettings) – Log storage settings customer need to provide when enableLogging is true.

• dataset (DatasetReference) – Required. Delete activity dataset reference.

• store_settings (StoreReadSettings) – Delete activity store settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest(*, session_id: Optional[str] = None, data_flow_name: Optional[str] = None, **kwargs)

Request body structure for deleting data flow debug session.

Variables

• session_id (str) – The ID of data flow debug session.

• data_flow_name (str) – The data flow which contains the debug session.

Keyword Arguments

• session_id (str) – The ID of data flow debug session.

• data_flow_name (str) – The data flow which contains the debug session.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DelimitedTextDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, location: Optional[azure.synapse.artifacts.models._models_py3.DatasetLocation] = None, column_delimiter: Optional[Any] = None, row_delimiter: Optional[Any] = None, encoding_name: Optional[Any] = None, compression_codec: Optional[Any] = None, compression_level: Optional[Any] = None, quote_char: Optional[Any] = None, escape_char: Optional[Any] = None, first_row_as_header: Optional[Any] = None, null_value: Optional[Any] = None, **kwargs)

Delimited text dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the delimited text storage.

• column_delimiter (any) – The column delimiter. Type: string (or Expression with resultType string).

• row_delimiter (any) – The row delimiter. Type: string (or Expression with resultType string).

• encoding_name (any) – The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

• compression_codec (any) – The data compressionCodec. Type: string (or Expression with resultType string).

• compression_level (any) – The data compression method used for DelimitedText.

• quote_char (any) – The quote character. Type: string (or Expression with resultType string).

• escape_char (any) – The escape character. Type: string (or Expression with resultType string).

• first_row_as_header (any) – When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

• null_value (any) – The null value string. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the delimited text storage.

• column_delimiter (any) – The column delimiter. Type: string (or Expression with resultType string).

• row_delimiter (any) – The row delimiter. Type: string (or Expression with resultType string).

• encoding_name (any) – The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

• compression_codec (any) – The data compressionCodec. Type: string (or Expression with resultType string).

• compression_level (any) – The data compression method used for DelimitedText.

• quote_char (any) – The quote character. Type: string (or Expression with resultType string).

• escape_char (any) – The escape character. Type: string (or Expression with resultType string).

• first_row_as_header (any) – When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

• null_value (any) – The null value string. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DelimitedTextReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, skip_line_count: Optional[Any] = None, compression_properties: Optional[azure.synapse.artifacts.models._models_py3.CompressionReadSettings] = None, **kwargs)

Delimited text read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• skip_line_count (any) – Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer).

• compression_properties (CompressionReadSettings) – Compression settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• skip_line_count (any) – Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer).

• compression_properties (CompressionReadSettings) – Compression settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DelimitedTextSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreWriteSettings] = None, format_settings: Optional[azure.synapse.artifacts.models._models_py3.DelimitedTextWriteSettings] = None, **kwargs)

A copy activity DelimitedText sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – DelimitedText store settings.

• format_settings (DelimitedTextWriteSettings) – DelimitedText format settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – DelimitedText store settings.

• format_settings (DelimitedTextWriteSettings) – DelimitedText format settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DelimitedTextSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreReadSettings] = None, format_settings: Optional[azure.synapse.artifacts.models._models_py3.DelimitedTextReadSettings] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity DelimitedText source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – DelimitedText store settings.

• format_settings (DelimitedTextReadSettings) – DelimitedText format settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – DelimitedText store settings.

• format_settings (DelimitedTextReadSettings) – DelimitedText format settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DelimitedTextWriteSettings(*, file_extension: Any, additional_properties: Optional[Dict[str, Any]] = None, quote_all_text: Optional[Any] = None, max_rows_per_file: Optional[Any] = None, file_name_prefix: Optional[Any] = None, **kwargs)

Delimited text write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• quote_all_text (any) – Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean).

• file_extension (any) – Required. The file extension used to create the files. Type: string (or Expression with resultType string).

• max_rows_per_file (any) – Limit the written file’s row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).

• file_name_prefix (any) – Specifies the file name pattern :code:`<fileNamePrefix>`_<fileIndex>.:code:<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• quote_all_text (any) – Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean).

• file_extension (any) – Required. The file extension used to create the files. Type: string (or Expression with resultType string).

• max_rows_per_file (any) – Limit the written file’s row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).

• file_name_prefix (any) – Specifies the file name pattern :code:`<fileNamePrefix>`_<fileIndex>.:code:<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DependencyCondition(value)

An enumeration.

COMPLETED = 'Completed'

FAILED = 'Failed'

SKIPPED = 'Skipped'

SUCCEEDED = 'Succeeded'

class azure.synapse.artifacts.models.DependencyReference(**kwargs)

Referenced dependency.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SelfDependencyTumblingWindowTriggerReference, TriggerDependencyReference.

All required parameters must be populated in order to send to Azure.

Variables

type (str) – Required. The type of dependency reference.Constant filled by server.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DistcpSettings(*, resource_manager_endpoint: Any, temp_script_path: Any, distcp_options: Optional[Any] = None, **kwargs)

Distcp settings.

All required parameters must be populated in order to send to Azure.

Variables

• resource_manager_endpoint (any) – Required. Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string).

• temp_script_path (any) – Required. Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string).

• distcp_options (any) – Specifies the Distcp options. Type: string (or Expression with resultType string).

Keyword Arguments

• resource_manager_endpoint (any) – Required. Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string).

• temp_script_path (any) – Required. Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string).

• distcp_options (any) – Specifies the Distcp options. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DocumentDbCollectionDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, collection_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

Microsoft Azure Document Database Collection dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection_name (any) – Required. Document Database collection name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection_name (any) – Required. Document Database collection name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DocumentDbCollectionSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, nesting_separator: Optional[Any] = None, write_behavior: Optional[Any] = None, **kwargs)

A copy activity Document Database Collection sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• nesting_separator (any) – Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).

• write_behavior (any) – Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• nesting_separator (any) – Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).

• write_behavior (any) – Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DocumentDbCollectionSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, nesting_separator: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Document Database Collection source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Documents query. Type: string (or Expression with resultType string).

• nesting_separator (any) – Nested properties separator. Type: string (or Expression with resultType string).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Documents query. Type: string (or Expression with resultType string).

• nesting_separator (any) – Nested properties separator. Type: string (or Expression with resultType string).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DrillLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, pwd: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Drill server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DrillSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Drill server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DrillTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

Drill server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Drill. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Drill. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Drill. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Drill. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicExecutorAllocation(*, enabled: Optional[bool] = None, **kwargs)

Dynamic Executor Allocation Properties.

Variables

enabled (bool) – Indicates whether Dynamic Executor Allocation is enabled or not.

Keyword Arguments

enabled (bool) – Indicates whether Dynamic Executor Allocation is enabled or not.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsAXLinkedService(*, url: Any, service_principal_id: Any, service_principal_key: azure.synapse.artifacts.models._models_py3.SecretBase, tenant: Any, aad_resource_id: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Dynamics AX linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint.

• service_principal_id (any) – Required. Specify the application’s client ID. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – Required. Specify the application’s key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string).

• tenant (any) – Required. Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).

• aad_resource_id (any) – Required. Specify the resource you are requesting authorization. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint.

• service_principal_id (any) – Required. Specify the application’s client ID. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – Required. Specify the application’s key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string).

• tenant (any) – Required. Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).

• aad_resource_id (any) – Required. Specify the resource you are requesting authorization. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsAXResourceDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, path: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The path of the Dynamics AX OData entity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• path (any) – Required. The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• path (any) – Required. The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsAXSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, http_request_timeout: Optional[Any] = None, **kwargs)

A copy activity Dynamics AX source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsAuthenticationType(value)

All available dynamicsAuthenticationType values.

AAD_SERVICE_PRINCIPAL = 'AADServicePrincipal'

IFD = 'Ifd'

OFFICE365 = 'Office365'

class azure.synapse.artifacts.models.DynamicsCrmEntityDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, entity_name: Optional[Any] = None, **kwargs)

The Dynamics CRM entity dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• entity_name (any) – The logical name of the entity. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• entity_name (any) – The logical name of the entity. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsCrmLinkedService(*, deployment_type: Any, authentication_type: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, host_name: Optional[Any] = None, port: Optional[Any] = None, service_uri: Optional[Any] = None, organization_name: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_principal_id: Optional[Any] = None, service_principal_credential_type: Optional[Any] = None, service_principal_credential: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Dynamics CRM linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• deployment_type (any) – Required. The deployment type of the Dynamics CRM instance. ‘Online’ for Dynamics CRM Online and ‘OnPremisesWithIfd’ for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string).

• host_name (any) – The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).

• port (any) – The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.

• service_uri (any) – The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).

• organization_name (any) – The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string).

• authentication_type (any) – Required. The authentication type to connect to Dynamics CRM server. ‘Office365’ for online scenario, ‘Ifd’ for on-premises with Ifd scenario, ‘AADServicePrincipal’ for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).

• username (any) – User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the Dynamics CRM instance.

• service_principal_id (any) – The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).

• service_principal_credential_type (any) – A string from ServicePrincipalCredentialEnum or an expression.

• service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• deployment_type (any) – Required. The deployment type of the Dynamics CRM instance. ‘Online’ for Dynamics CRM Online and ‘OnPremisesWithIfd’ for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string).

• host_name (any) – The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).

• port (any) – The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.

• service_uri (any) – The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).

• organization_name (any) – The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string).

• authentication_type (any) – Required. The authentication type to connect to Dynamics CRM server. ‘Office365’ for online scenario, ‘Ifd’ for on-premises with Ifd scenario, ‘AADServicePrincipal’ for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).

• username (any) – User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the Dynamics CRM instance.

• service_principal_id (any) – The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).

• service_principal_credential_type (any) – A string from ServicePrincipalCredentialEnum or an expression.

• service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsCrmSink(*, write_behavior: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DynamicsSinkWriteBehavior], additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, ignore_null_values: Optional[Any] = None, alternate_key_name: Optional[Any] = None, **kwargs)

A copy activity Dynamics CRM sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or DynamicsSinkWriteBehavior) – Required. The write behavior for the operation. Possible values include: “Upsert”.

• ignore_null_values (any) – The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).

• alternate_key_name (any) – The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or DynamicsSinkWriteBehavior) – Required. The write behavior for the operation. Possible values include: “Upsert”.

• ignore_null_values (any) – The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).

• alternate_key_name (any) – The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsCrmSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Dynamics CRM source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsDeploymentType(value)

All available dynamicsDeploymentType values.

ONLINE = 'Online'

ON_PREMISES_WITH_IFD = 'OnPremisesWithIfd'

class azure.synapse.artifacts.models.DynamicsEntityDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, entity_name: Optional[Any] = None, **kwargs)

The Dynamics entity dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• entity_name (any) – The logical name of the entity. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• entity_name (any) – The logical name of the entity. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsLinkedService(*, deployment_type: Any, authentication_type: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, host_name: Optional[Any] = None, port: Optional[Any] = None, service_uri: Optional[Any] = None, organization_name: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_principal_id: Optional[Any] = None, service_principal_credential_type: Optional[Any] = None, service_principal_credential: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Dynamics linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• deployment_type (any) – Required. The deployment type of the Dynamics instance. ‘Online’ for Dynamics Online and ‘OnPremisesWithIfd’ for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string).

• host_name (any) – The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).

• port (any) – The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.

• service_uri (any) – The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).

• organization_name (any) – The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string).

• authentication_type (any) – Required. The authentication type to connect to Dynamics server. ‘Office365’ for online scenario, ‘Ifd’ for on-premises with Ifd scenario, ‘AADServicePrincipal’ for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).

• username (any) – User name to access the Dynamics instance. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the Dynamics instance.

• service_principal_id (any) – The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).

• service_principal_credential_type (any) – The service principal credential type to use in Server-To-Server authentication. ‘ServicePrincipalKey’ for key/secret, ‘ServicePrincipalCert’ for certificate. Type: string (or Expression with resultType string).

• service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• deployment_type (any) – Required. The deployment type of the Dynamics instance. ‘Online’ for Dynamics Online and ‘OnPremisesWithIfd’ for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string).

• host_name (any) – The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).

• port (any) – The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.

• service_uri (any) – The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).

• organization_name (any) – The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string).

• authentication_type (any) – Required. The authentication type to connect to Dynamics server. ‘Office365’ for online scenario, ‘Ifd’ for on-premises with Ifd scenario, ‘AADServicePrincipal’ for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).

• username (any) – User name to access the Dynamics instance. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the Dynamics instance.

• service_principal_id (any) – The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).

• service_principal_credential_type (any) – The service principal credential type to use in Server-To-Server authentication. ‘ServicePrincipalKey’ for key/secret, ‘ServicePrincipalCert’ for certificate. Type: string (or Expression with resultType string).

• service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType(value)

The service principal credential type to use in Server-To-Server authentication. ‘ServicePrincipalKey’ for key/secret, ‘ServicePrincipalCert’ for certificate. Type: string (or Expression with resultType string).

SERVICE_PRINCIPAL_CERT = 'ServicePrincipalCert'

SERVICE_PRINCIPAL_KEY = 'ServicePrincipalKey'

class azure.synapse.artifacts.models.DynamicsSink(*, write_behavior: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DynamicsSinkWriteBehavior], additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, ignore_null_values: Optional[Any] = None, alternate_key_name: Optional[Any] = None, **kwargs)

A copy activity Dynamics sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or DynamicsSinkWriteBehavior) – Required. The write behavior for the operation. Possible values include: “Upsert”.

• ignore_null_values (any) – The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).

• alternate_key_name (any) – The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or DynamicsSinkWriteBehavior) – Required. The write behavior for the operation. Possible values include: “Upsert”.

• ignore_null_values (any) – The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).

• alternate_key_name (any) – The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.DynamicsSinkWriteBehavior(value)

Defines values for DynamicsSinkWriteBehavior.

UPSERT = 'Upsert'

class azure.synapse.artifacts.models.DynamicsSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Dynamics source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.EloquaLinkedService(*, endpoint: Any, username: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Eloqua server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of the Eloqua server. (i.e. eloqua.example.com).

• username (any) – Required. The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice).

• password (SecretBase) – The password corresponding to the user name.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of the Eloqua server. (i.e. eloqua.example.com).

• username (any) – Required. The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice).

• password (SecretBase) – The password corresponding to the user name.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.EloquaObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Eloqua server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.EloquaSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Eloqua server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.EncryptionDetails(*, cmk: Optional[azure.synapse.artifacts.models._models_py3.CustomerManagedKeyDetails] = None, **kwargs)

Details of the encryption associated with the workspace.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• double_encryption_enabled (bool) – Double Encryption enabled.

• cmk (CustomerManagedKeyDetails) – Customer Managed Key Details.

Keyword Arguments

cmk (CustomerManagedKeyDetails) – Customer Managed Key Details.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.EntityReference(*, type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.IntegrationRuntimeEntityReferenceType]] = None, reference_name: Optional[str] = None, **kwargs)

The entity reference.

Variables

• type (str or IntegrationRuntimeEntityReferenceType) – The type of this referenced entity. Possible values include: “IntegrationRuntimeReference”, “LinkedServiceReference”.

• reference_name (str) – The name of this referenced entity.

Keyword Arguments

• type (str or IntegrationRuntimeEntityReferenceType) – The type of this referenced entity. Possible values include: “IntegrationRuntimeReference”, “LinkedServiceReference”.

• reference_name (str) – The name of this referenced entity.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ErrorAdditionalInfo(**kwargs)

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• type (str) – The additional info type.

• info (any) – The additional info.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ErrorContract(*, error: Optional[azure.synapse.artifacts.models._models_py3.ErrorResponse] = None, **kwargs)

Contains details when the response code indicates an error.

Variables

error (ErrorResponse) – The error details.

Keyword Arguments

error (ErrorResponse) – The error details.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ErrorResponse(**kwargs)

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• code (str) – The error code.

• message (str) – The error message.

• target (str) – The error target.

• details (list[ErrorResponse]) – The error details.

• additional_info (list[ErrorAdditionalInfo]) – The error additional info.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest(*, session_id: Optional[str] = None, data_flow_name: Optional[str] = None, stream_name: Optional[str] = None, row_limits: Optional[int] = None, expression: Optional[str] = None, **kwargs)

Request body structure for data flow expression preview.

Variables

• session_id (str) – The ID of data flow debug session.

• data_flow_name (str) – The data flow which contains the debug session.

• stream_name (str) – The output stream name.

• row_limits (int) – The row limit for preview request.

• expression (str) – The expression for preview.

Keyword Arguments

• session_id (str) – The ID of data flow debug session.

• data_flow_name (str) – The data flow which contains the debug session.

• stream_name (str) – The output stream name.

• row_limits (int) – The row limit for preview request.

• expression (str) – The expression for preview.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.EventSubscriptionStatus(value)

Event Subscription Status.

DEPROVISIONING = 'Deprovisioning'

DISABLED = 'Disabled'

ENABLED = 'Enabled'

PROVISIONING = 'Provisioning'

UNKNOWN = 'Unknown'

class azure.synapse.artifacts.models.ExcelDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, location: Optional[azure.synapse.artifacts.models._models_py3.DatasetLocation] = None, sheet_name: Optional[Any] = None, range: Optional[Any] = None, first_row_as_header: Optional[Any] = None, compression: Optional[azure.synapse.artifacts.models._models_py3.DatasetCompression] = None, null_value: Optional[Any] = None, **kwargs)

Excel dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the excel storage.

• sheet_name (any) – The sheet of excel file. Type: string (or Expression with resultType string).

• range (any) – The partial data of one sheet. Type: string (or Expression with resultType string).

• first_row_as_header (any) – When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

• compression (DatasetCompression) – The data compression method used for the json dataset.

• null_value (any) – The null value string. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the excel storage.

• sheet_name (any) – The sheet of excel file. Type: string (or Expression with resultType string).

• range (any) – The partial data of one sheet. Type: string (or Expression with resultType string).

• first_row_as_header (any) – When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

• compression (DatasetCompression) – The data compression method used for the json dataset.

• null_value (any) – The null value string. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ExcelSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreReadSettings] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity excel source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Excel store settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Excel store settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ExecuteDataFlowActivity(*, name: str, dataflow: azure.synapse.artifacts.models._models_py3.DataFlowReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, staging: Optional[azure.synapse.artifacts.models._models_py3.DataFlowStagingInfo] = None, integration_runtime: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, compute: Optional[azure.synapse.artifacts.models._models_py3.ExecuteDataFlowActivityTypePropertiesCompute] = None, trace_level: Optional[Any] = None, continue_on_error: Optional[Any] = None, run_concurrently: Optional[Any] = None, **kwargs)

Execute data flow activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• dataflow (DataFlowReference) – Required. Data flow reference.

• staging (DataFlowStagingInfo) – Staging info for execute data flow activity.

• integration_runtime (IntegrationRuntimeReference) – The integration runtime reference.

• compute (ExecuteDataFlowActivityTypePropertiesCompute) – Compute properties for data flow activity.

• trace_level (any) – Trace level setting used for data flow monitoring output. Supported values are: ‘coarse’, ‘fine’, and ‘none’. Type: string (or Expression with resultType string).

• continue_on_error (any) – Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean).

• run_concurrently (any) – Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• dataflow (DataFlowReference) – Required. Data flow reference.

• staging (DataFlowStagingInfo) – Staging info for execute data flow activity.

• integration_runtime (IntegrationRuntimeReference) – The integration runtime reference.

• compute (ExecuteDataFlowActivityTypePropertiesCompute) – Compute properties for data flow activity.

• trace_level (any) – Trace level setting used for data flow monitoring output. Supported values are: ‘coarse’, ‘fine’, and ‘none’. Type: string (or Expression with resultType string).

• continue_on_error (any) – Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean).

• run_concurrently (any) – Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute(*, compute_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DataFlowComputeType]] = None, core_count: Optional[int] = None, **kwargs)

Compute properties for data flow activity.

Variables

• compute_type (str or DataFlowComputeType) – Compute type of the cluster which will execute data flow job. Possible values include: “General”, “MemoryOptimized”, “ComputeOptimized”.

• core_count (int) – Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.

Keyword Arguments

• compute_type (str or DataFlowComputeType) – Compute type of the cluster which will execute data flow job. Possible values include: “General”, “MemoryOptimized”, “ComputeOptimized”.

• core_count (int) – Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ExecutePipelineActivity(*, name: str, pipeline: azure.synapse.artifacts.models._models_py3.PipelineReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, parameters: Optional[Dict[str, Any]] = None, wait_on_completion: Optional[bool] = None, **kwargs)

Execute pipeline activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• pipeline (PipelineReference) – Required. Pipeline reference.

• parameters (dict[str, any]) – Pipeline parameters.

• wait_on_completion (bool) – Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• pipeline (PipelineReference) – Required. Pipeline reference.

• parameters (dict[str, any]) – Pipeline parameters.

• wait_on_completion (bool) – Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ExecuteSSISPackageActivity(*, name: str, package_location: azure.synapse.artifacts.models._models_py3.SSISPackageLocation, connect_via: azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, runtime: Optional[Any] = None, logging_level: Optional[Any] = None, environment_path: Optional[Any] = None, execution_credential: Optional[azure.synapse.artifacts.models._models_py3.SSISExecutionCredential] = None, project_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.SSISExecutionParameter]] = None, package_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.SSISExecutionParameter]] = None, project_connection_managers: Optional[Dict[str, Dict[str, azure.synapse.artifacts.models._models_py3.SSISExecutionParameter]]] = None, package_connection_managers: Optional[Dict[str, Dict[str, azure.synapse.artifacts.models._models_py3.SSISExecutionParameter]]] = None, property_overrides: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.SSISPropertyOverride]] = None, log_location: Optional[azure.synapse.artifacts.models._models_py3.SSISLogLocation] = None, **kwargs)

Execute SSIS package activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• package_location (SSISPackageLocation) – Required. SSIS package location.

• runtime (any) – Specifies the runtime to execute SSIS package. The value should be “x86” or “x64”. Type: string (or Expression with resultType string).

• logging_level (any) – The logging level of SSIS package execution. Type: string (or Expression with resultType string).

• environment_path (any) – The environment path to execute the SSIS package. Type: string (or Expression with resultType string).

• execution_credential (SSISExecutionCredential) – The package execution credential.

• connect_via (IntegrationRuntimeReference) – Required. The integration runtime reference.

• project_parameters (dict[str, SSISExecutionParameter]) – The project level parameters to execute the SSIS package.

• package_parameters (dict[str, SSISExecutionParameter]) – The package level parameters to execute the SSIS package.

• project_connection_managers (dict[str, dict[str, SSISExecutionParameter]]) – The project level connection managers to execute the SSIS package.

• package_connection_managers (dict[str, dict[str, SSISExecutionParameter]]) – The package level connection managers to execute the SSIS package.

• property_overrides (dict[str, SSISPropertyOverride]) – The property overrides to execute the SSIS package.

• log_location (SSISLogLocation) – SSIS package execution log location.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• package_location (SSISPackageLocation) – Required. SSIS package location.

• runtime (any) – Specifies the runtime to execute SSIS package. The value should be “x86” or “x64”. Type: string (or Expression with resultType string).

• logging_level (any) – The logging level of SSIS package execution. Type: string (or Expression with resultType string).

• environment_path (any) – The environment path to execute the SSIS package. Type: string (or Expression with resultType string).

• execution_credential (SSISExecutionCredential) – The package execution credential.

• connect_via (IntegrationRuntimeReference) – Required. The integration runtime reference.

• project_parameters (dict[str, SSISExecutionParameter]) – The project level parameters to execute the SSIS package.

• package_parameters (dict[str, SSISExecutionParameter]) – The package level parameters to execute the SSIS package.

• project_connection_managers (dict[str, dict[str, SSISExecutionParameter]]) – The project level connection managers to execute the SSIS package.

• package_connection_managers (dict[str, dict[str, SSISExecutionParameter]]) – The package level connection managers to execute the SSIS package.

• property_overrides (dict[str, SSISPropertyOverride]) – The property overrides to execute the SSIS package.

• log_location (SSISLogLocation) – SSIS package execution log location.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ExecutionActivity(*, name: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, **kwargs)

Base class for all execution activities.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureDataExplorerCommandActivity, AzureFunctionActivity, AzureMLBatchExecutionActivity, AzureMLExecutePipelineActivity, AzureMLUpdateResourceActivity, CopyActivity, CustomActivity, DataLakeAnalyticsUSQLActivity, DatabricksNotebookActivity, DatabricksSparkJarActivity, DatabricksSparkPythonActivity, DeleteActivity, ExecuteDataFlowActivity, ExecuteSSISPackageActivity, GetMetadataActivity, HDInsightHiveActivity, HDInsightMapReduceActivity, HDInsightPigActivity, HDInsightSparkActivity, HDInsightStreamingActivity, LookupActivity, SynapseSparkJobDefinitionActivity, SqlServerStoredProcedureActivity, SynapseNotebookActivity, WebActivity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ExportSettings(*, additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

Export command settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureDatabricksDeltaLakeExportCommand, SnowflakeExportCopyCommand.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The export setting type.Constant filled by server.

Keyword Arguments

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ExposureControlRequest(*, feature_name: Optional[str] = None, feature_type: Optional[str] = None, **kwargs)

The exposure control request.

Variables

• feature_name (str) – The feature name.

• feature_type (str) – The feature type.

Keyword Arguments

• feature_name (str) – The feature name.

• feature_type (str) – The feature type.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ExposureControlResponse(**kwargs)

The exposure control response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• feature_name (str) – The feature name.

• value (str) – The feature value.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Expression(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.ExpressionType], value: str, **kwargs)

Azure Synapse expression definition.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or ExpressionType) – Required. Expression type. Possible values include: “Expression”.

• value (str) – Required. Expression value.

Keyword Arguments

• type (str or ExpressionType) – Required. Expression type. Possible values include: “Expression”.

• value (str) – Required. Expression value.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ExpressionType(value)

Expression type.

EXPRESSION = 'Expression'

class azure.synapse.artifacts.models.FileServerLinkedService(*, host: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, user_id: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

File system linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. Host name of the server. Type: string (or Expression with resultType string).

• user_id (any) – User ID to logon the server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to logon the server.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. Host name of the server. Type: string (or Expression with resultType string).

• user_id (any) – User ID to logon the server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to logon the server.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FileServerLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, **kwargs)

The location of file server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FileServerReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, file_list_path: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, delete_files_after_completion: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, file_filter: Optional[Any] = None, **kwargs)

File server read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – FileServer wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – FileServer wildcardFileName. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

• file_filter (any) – Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – FileServer wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – FileServer wildcardFileName. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

• file_filter (any) – Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FileServerWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, copy_behavior: Optional[Any] = None, **kwargs)

File server write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FileShareDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, format: Optional[azure.synapse.artifacts.models._models_py3.DatasetStorageFormat] = None, file_filter: Optional[Any] = None, compression: Optional[azure.synapse.artifacts.models._models_py3.DatasetCompression] = None, **kwargs)

An on-premises file system dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• folder_path (any) – The path of the on-premises file system. Type: string (or Expression with resultType string).

• file_name (any) – The name of the on-premises file system. Type: string (or Expression with resultType string).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of the files.

• file_filter (any) – Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).

• compression (DatasetCompression) – The data compression method used for the file system.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• folder_path (any) – The path of the on-premises file system. Type: string (or Expression with resultType string).

• file_name (any) – The name of the on-premises file system. Type: string (or Expression with resultType string).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of the files.

• file_filter (any) – Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).

• compression (DatasetCompression) – The data compression method used for the file system.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FileSystemSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, copy_behavior: Optional[Any] = None, **kwargs)

A copy activity file system sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FileSystemSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity file system source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FilterActivity(*, name: str, items: azure.synapse.artifacts.models._models_py3.Expression, condition: azure.synapse.artifacts.models._models_py3.Expression, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, **kwargs)

Filter and return results from input array based on the conditions.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• items (Expression) – Required. Input array on which filter should be applied.

• condition (Expression) – Required. Condition to be used for filtering the input.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• items (Expression) – Required. Input array on which filter should be applied.

• condition (Expression) – Required. Condition to be used for filtering the input.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Flowlet(*, description: Optional[str] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DataFlowFolder] = None, sources: Optional[List[azure.synapse.artifacts.models._models_py3.DataFlowSource]] = None, sinks: Optional[List[azure.synapse.artifacts.models._models_py3.DataFlowSink]] = None, transformations: Optional[List[azure.synapse.artifacts.models._models_py3.Transformation]] = None, script: Optional[str] = None, script_lines: Optional[List[str]] = None, **kwargs)

Data flow flowlet.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – Required. Type of data flow.Constant filled by server.

• description (str) – The description of the data flow.

• annotations (list[any]) – List of tags that can be used for describing the data flow.

• folder (DataFlowFolder) – The folder that this data flow is in. If not specified, Data flow will appear at the root level.

• sources (list[DataFlowSource]) – List of sources in Flowlet.

• sinks (list[DataFlowSink]) – List of sinks in Flowlet.

• transformations (list[Transformation]) – List of transformations in Flowlet.

• script (str) – Flowlet script.

• script_lines (list[str]) – Flowlet script lines.

Keyword Arguments

• description (str) – The description of the data flow.

• annotations (list[any]) – List of tags that can be used for describing the data flow.

• folder (DataFlowFolder) – The folder that this data flow is in. If not specified, Data flow will appear at the root level.

• sources (list[DataFlowSource]) – List of sources in Flowlet.

• sinks (list[DataFlowSink]) – List of sinks in Flowlet.

• transformations (list[Transformation]) – List of transformations in Flowlet.

• script (str) – Flowlet script.

• script_lines (list[str]) – Flowlet script lines.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ForEachActivity(*, name: str, items: azure.synapse.artifacts.models._models_py3.Expression, activities: List[azure.synapse.artifacts.models._models_py3.Activity], additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, is_sequential: Optional[bool] = None, batch_count: Optional[int] = None, **kwargs)

This activity is used for iterating over a collection and execute given activities.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• is_sequential (bool) – Should the loop be executed in sequence or in parallel (max 50).

• batch_count (int) – Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).

• items (Expression) – Required. Collection to iterate.

• activities (list[Activity]) – Required. List of activities to execute .

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• is_sequential (bool) – Should the loop be executed in sequence or in parallel (max 50).

• batch_count (int) – Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).

• items (Expression) – Required. Collection to iterate.

• activities (list[Activity]) – Required. List of activities to execute .

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FormatReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

Format read settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BinaryReadSettings, DelimitedTextReadSettings, JsonReadSettings, XmlReadSettings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

Keyword Arguments

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FormatWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

Format write settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AvroWriteSettings, DelimitedTextWriteSettings, JsonWriteSettings, OrcWriteSettings, ParquetWriteSettings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

Keyword Arguments

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FtpAuthenticationType(value)

The authentication type to be used to connect to the FTP server.

ANONYMOUS = 'Anonymous'

BASIC = 'Basic'

class azure.synapse.artifacts.models.FtpReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, delete_files_after_completion: Optional[Any] = None, file_list_path: Optional[Any] = None, use_binary_transfer: Optional[bool] = None, disable_chunking: Optional[Any] = None, **kwargs)

Ftp read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Ftp wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Ftp wildcardFileName. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• use_binary_transfer (bool) – Specify whether to use binary transfer mode for FTP stores.

• disable_chunking (any) – If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Ftp wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Ftp wildcardFileName. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• use_binary_transfer (bool) – Specify whether to use binary transfer mode for FTP stores.

• disable_chunking (any) – If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FtpServerLinkedService(*, host: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, port: Optional[Any] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.FtpAuthenticationType]] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, enable_ssl: Optional[Any] = None, enable_server_certificate_validation: Optional[Any] = None, **kwargs)

A FTP server Linked Service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. Host name of the FTP server. Type: string (or Expression with resultType string).

• port (any) – The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0.

• authentication_type (str or FtpAuthenticationType) – The authentication type to be used to connect to the FTP server. Possible values include: “Basic”, “Anonymous”.

• user_name (any) – Username to logon the FTP server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to logon the FTP server.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• enable_ssl (any) – If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).

• enable_server_certificate_validation (any) – If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. Host name of the FTP server. Type: string (or Expression with resultType string).

• port (any) – The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0.

• authentication_type (str or FtpAuthenticationType) – The authentication type to be used to connect to the FTP server. Possible values include: “Basic”, “Anonymous”.

• user_name (any) – Username to logon the FTP server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to logon the FTP server.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• enable_ssl (any) – If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).

• enable_server_certificate_validation (any) – If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.FtpServerLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, **kwargs)

The location of ftp server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GetMetadataActivity(*, name: str, dataset: azure.synapse.artifacts.models._models_py3.DatasetReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, field_list: Optional[List[Any]] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreReadSettings] = None, format_settings: Optional[azure.synapse.artifacts.models._models_py3.FormatReadSettings] = None, **kwargs)

Activity to get metadata of dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• dataset (DatasetReference) – Required. GetMetadata activity dataset reference.

• field_list (list[any]) – Fields of metadata to get from dataset.

• store_settings (StoreReadSettings) – GetMetadata activity store settings.

• format_settings (FormatReadSettings) – GetMetadata activity format settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• dataset (DatasetReference) – Required. GetMetadata activity dataset reference.

• field_list (list[any]) – Fields of metadata to get from dataset.

• store_settings (StoreReadSettings) – GetMetadata activity store settings.

• format_settings (FormatReadSettings) – GetMetadata activity format settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GetSsisObjectMetadataRequest(*, metadata_path: Optional[str] = None, **kwargs)

The request payload of get SSIS object metadata.

Variables

metadata_path (str) – Metadata path.

Keyword Arguments

metadata_path (str) – Metadata path.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GitHubAccessTokenRequest(*, git_hub_client_id: str, git_hub_access_code: str, git_hub_access_token_base_url: str, **kwargs)

GitHubAccessTokenRequest.

All required parameters must be populated in order to send to Azure.

Variables

• git_hub_client_id (str) – Required. The GitHub Client Id.

• git_hub_access_code (str) – Required. The GitHub Access code.

• git_hub_access_token_base_url (str) – Required. The GitHub access token base URL.

Keyword Arguments

• git_hub_client_id (str) – Required. The GitHub Client Id.

• git_hub_access_code (str) – Required. The GitHub Access code.

• git_hub_access_token_base_url (str) – Required. The GitHub access token base URL.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GitHubAccessTokenResponse(*, git_hub_access_token: Optional[str] = None, **kwargs)

GitHubAccessTokenResponse.

Variables

git_hub_access_token (str) –

Keyword Arguments

git_hub_access_token (str) –

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GitHubClientSecret(*, byoa_secret_akv_url: Optional[str] = None, byoa_secret_name: Optional[str] = None, **kwargs)

Client secret information for factory’s bring your own app repository configuration.

Variables

• byoa_secret_akv_url (str) – Bring your own app client secret AKV URL.

• byoa_secret_name (str) – Bring your own app client secret name in AKV.

Keyword Arguments

• byoa_secret_akv_url (str) – Bring your own app client secret AKV URL.

• byoa_secret_name (str) – Bring your own app client secret name in AKV.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType(value)

The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.

SERVICE_AUTHENTICATION = 'ServiceAuthentication'

USER_AUTHENTICATION = 'UserAuthentication'

class azure.synapse.artifacts.models.GoogleAdWordsLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_properties: Optional[Any] = None, client_customer_id: Optional[Any] = None, developer_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.GoogleAdWordsAuthenticationType]] = None, refresh_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, client_id: Optional[Any] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, email: Optional[Any] = None, key_file_path: Optional[Any] = None, trusted_cert_path: Optional[Any] = None, use_system_trust_store: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Google AdWords service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object.

• client_customer_id (any) – The Client customer ID of the AdWords account that you want to fetch report data for.

• developer_token (SecretBase) – The developer token associated with the manager account that you use to grant access to the AdWords API.

• authentication_type (str or GoogleAdWordsAuthenticationType) – The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Possible values include: “ServiceAuthentication”, “UserAuthentication”.

• refresh_token (SecretBase) – The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.

• client_id (any) – The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).

• client_secret (SecretBase) – The client secret of the google application used to acquire the refresh token.

• email (any) – The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.

• key_file_path (any) – The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object.

• client_customer_id (any) – The Client customer ID of the AdWords account that you want to fetch report data for.

• developer_token (SecretBase) – The developer token associated with the manager account that you use to grant access to the AdWords API.

• authentication_type (str or GoogleAdWordsAuthenticationType) – The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Possible values include: “ServiceAuthentication”, “UserAuthentication”.

• refresh_token (SecretBase) – The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.

• client_id (any) – The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).

• client_secret (SecretBase) – The client secret of the google application used to acquire the refresh token.

• email (any) – The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.

• key_file_path (any) – The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GoogleAdWordsObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Google AdWords service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GoogleAdWordsSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Google AdWords service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType(value)

The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.

SERVICE_AUTHENTICATION = 'ServiceAuthentication'

USER_AUTHENTICATION = 'UserAuthentication'

class azure.synapse.artifacts.models.GoogleBigQueryLinkedService(*, project: Any, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.GoogleBigQueryAuthenticationType], additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, additional_projects: Optional[Any] = None, request_google_drive_scope: Optional[Any] = None, refresh_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, client_id: Optional[Any] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, email: Optional[Any] = None, key_file_path: Optional[Any] = None, trusted_cert_path: Optional[Any] = None, use_system_trust_store: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Google BigQuery service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• project (any) – Required. The default BigQuery project to query against.

• additional_projects (any) – A comma-separated list of public BigQuery projects to access.

• request_google_drive_scope (any) – Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.

• authentication_type (str or GoogleBigQueryAuthenticationType) – Required. The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Possible values include: “ServiceAuthentication”, “UserAuthentication”.

• refresh_token (SecretBase) – The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.

• client_id (any) – The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).

• client_secret (SecretBase) – The client secret of the google application used to acquire the refresh token.

• email (any) – The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.

• key_file_path (any) – The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• project (any) – Required. The default BigQuery project to query against.

• additional_projects (any) – A comma-separated list of public BigQuery projects to access.

• request_google_drive_scope (any) – Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.

• authentication_type (str or GoogleBigQueryAuthenticationType) – Required. The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Possible values include: “ServiceAuthentication”, “UserAuthentication”.

• refresh_token (SecretBase) – The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.

• client_id (any) – The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).

• client_secret (SecretBase) – The client secret of the google application used to acquire the refresh token.

• email (any) – The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.

• key_file_path (any) – The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GoogleBigQueryObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, dataset: Optional[Any] = None, **kwargs)

Google BigQuery service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using database + table properties instead.

• table (any) – The table name of the Google BigQuery. Type: string (or Expression with resultType string).

• dataset (any) – The database name of the Google BigQuery. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using database + table properties instead.

• table (any) – The table name of the Google BigQuery. Type: string (or Expression with resultType string).

• dataset (any) – The database name of the Google BigQuery. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GoogleBigQuerySource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Google BigQuery service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GoogleCloudStorageLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, access_key_id: Optional[Any] = None, secret_access_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_url: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for Google Cloud Storage.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• access_key_id (any) – The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).

• secret_access_key (SecretBase) – The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user.

• service_url (any) – This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• access_key_id (any) – The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).

• secret_access_key (SecretBase) – The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user.

• service_url (any) – This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GoogleCloudStorageLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, bucket_name: Optional[Any] = None, version: Optional[Any] = None, **kwargs)

The location of Google Cloud Storage dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

• bucket_name (any) – Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string).

• version (any) – Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

• bucket_name (any) – Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string).

• version (any) – Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GoogleCloudStorageReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, prefix: Optional[Any] = None, file_list_path: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, delete_files_after_completion: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, **kwargs)

Google Cloud Storage read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string).

• prefix (any) – The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string).

• prefix (any) – The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GreenplumLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, pwd: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Greenplum Database linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GreenplumSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Greenplum Database source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.GreenplumTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

Greenplum Database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of Greenplum. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of Greenplum. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of Greenplum. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of Greenplum. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HBaseAuthenticationType(value)

The authentication mechanism to use to connect to the HBase server.

ANONYMOUS = 'Anonymous'

BASIC = 'Basic'

class azure.synapse.artifacts.models.HBaseLinkedService(*, host: Any, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HBaseAuthenticationType], additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, port: Optional[Any] = None, http_path: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, enable_ssl: Optional[Any] = None, trusted_cert_path: Optional[Any] = None, allow_host_name_cn_mismatch: Optional[Any] = None, allow_self_signed_server_cert: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

HBase server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The IP address or host name of the HBase server. (i.e. 192.168.222.160).

• port (any) – The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.

• http_path (any) – The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version).

• authentication_type (str or HBaseAuthenticationType) – Required. The authentication mechanism to use to connect to the HBase server. Possible values include: “Anonymous”, “Basic”.

• username (any) – The user name used to connect to the HBase instance.

• password (SecretBase) – The password corresponding to the user name.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The IP address or host name of the HBase server. (i.e. 192.168.222.160).

• port (any) – The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.

• http_path (any) – The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version).

• authentication_type (str or HBaseAuthenticationType) – Required. The authentication mechanism to use to connect to the HBase server. Possible values include: “Anonymous”, “Basic”.

• username (any) – The user name used to connect to the HBase instance.

• password (SecretBase) – The password corresponding to the user name.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HBaseObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

HBase server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HBaseSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity HBase server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption(value)

The HDInsightActivityDebugInfoOption settings to use.

ALWAYS = 'Always'

FAILURE = 'Failure'

NONE = 'None'

class azure.synapse.artifacts.models.HDInsightHiveActivity(*, name: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, storage_linked_services: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceReference]] = None, arguments: Optional[List[Any]] = None, get_debug_info: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HDInsightActivityDebugInfoOption]] = None, script_path: Optional[Any] = None, script_linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, defines: Optional[Dict[str, Any]] = None, variables: Optional[List[Any]] = None, query_timeout: Optional[int] = None, **kwargs)

HDInsight Hive activity type.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.

• arguments (list[any]) – User specified arguments to HDInsightActivity.

• get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: “None”, “Always”, “Failure”.

• script_path (any) – Script path. Type: string (or Expression with resultType string).

• script_linked_service (LinkedServiceReference) – Script linked service reference.

• defines (dict[str, any]) – Allows user to specify defines for Hive job request.

• variables (list[any]) – User specified arguments under hivevar namespace.

• query_timeout (int) – Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.

• arguments (list[any]) – User specified arguments to HDInsightActivity.

• get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: “None”, “Always”, “Failure”.

• script_path (any) – Script path. Type: string (or Expression with resultType string).

• script_linked_service (LinkedServiceReference) – Script linked service reference.

• defines (dict[str, any]) – Allows user to specify defines for Hive job request.

• variables (list[any]) – User specified arguments under hivevar namespace.

• query_timeout (int) – Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HDInsightLinkedService(*, cluster_uri: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, hcatalog_linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, encrypted_credential: Optional[Any] = None, is_esp_enabled: Optional[Any] = None, file_system: Optional[Any] = None, **kwargs)

HDInsight linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• cluster_uri (any) – Required. HDInsight cluster URI. Type: string (or Expression with resultType string).

• user_name (any) – HDInsight cluster user name. Type: string (or Expression with resultType string).

• password (SecretBase) – HDInsight cluster password.

• linked_service_name (LinkedServiceReference) – The Azure Storage linked service reference.

• hcatalog_linked_service_name (LinkedServiceReference) – A reference to the Azure SQL linked service that points to the HCatalog database.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• is_esp_enabled (any) – Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean.

• file_system (any) – Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• cluster_uri (any) – Required. HDInsight cluster URI. Type: string (or Expression with resultType string).

• user_name (any) – HDInsight cluster user name. Type: string (or Expression with resultType string).

• password (SecretBase) – HDInsight cluster password.

• linked_service_name (LinkedServiceReference) – The Azure Storage linked service reference.

• hcatalog_linked_service_name (LinkedServiceReference) – A reference to the Azure SQL linked service that points to the HCatalog database.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• is_esp_enabled (any) – Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean.

• file_system (any) – Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HDInsightMapReduceActivity(*, name: str, class_name: Any, jar_file_path: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, storage_linked_services: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceReference]] = None, arguments: Optional[List[Any]] = None, get_debug_info: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HDInsightActivityDebugInfoOption]] = None, jar_linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, jar_libs: Optional[List[Any]] = None, defines: Optional[Dict[str, Any]] = None, **kwargs)

HDInsight MapReduce activity type.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.

• arguments (list[any]) – User specified arguments to HDInsightActivity.

• get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: “None”, “Always”, “Failure”.

• class_name (any) – Required. Class name. Type: string (or Expression with resultType string).

• jar_file_path (any) – Required. Jar path. Type: string (or Expression with resultType string).

• jar_linked_service (LinkedServiceReference) – Jar linked service reference.

• jar_libs (list[any]) – Jar libs.

• defines (dict[str, any]) – Allows user to specify defines for the MapReduce job request.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.

• arguments (list[any]) – User specified arguments to HDInsightActivity.

• get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: “None”, “Always”, “Failure”.

• class_name (any) – Required. Class name. Type: string (or Expression with resultType string).

• jar_file_path (any) – Required. Jar path. Type: string (or Expression with resultType string).

• jar_linked_service (LinkedServiceReference) – Jar linked service reference.

• jar_libs (list[any]) – Jar libs.

• defines (dict[str, any]) – Allows user to specify defines for the MapReduce job request.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HDInsightOnDemandLinkedService(*, cluster_size: Any, time_to_live: Any, version: Any, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, host_subscription_id: Any, tenant: Any, cluster_resource_group: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, cluster_name_prefix: Optional[Any] = None, cluster_user_name: Optional[Any] = None, cluster_password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, cluster_ssh_user_name: Optional[Any] = None, cluster_ssh_password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, additional_linked_service_names: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceReference]] = None, hcatalog_linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, cluster_type: Optional[Any] = None, spark_version: Optional[Any] = None, core_configuration: Optional[Any] = None, h_base_configuration: Optional[Any] = None, hdfs_configuration: Optional[Any] = None, hive_configuration: Optional[Any] = None, map_reduce_configuration: Optional[Any] = None, oozie_configuration: Optional[Any] = None, storm_configuration: Optional[Any] = None, yarn_configuration: Optional[Any] = None, encrypted_credential: Optional[Any] = None, head_node_size: Optional[Any] = None, data_node_size: Optional[Any] = None, zookeeper_node_size: Optional[Any] = None, script_actions: Optional[List[azure.synapse.artifacts.models._models_py3.ScriptAction]] = None, virtual_network_id: Optional[Any] = None, subnet_name: Optional[Any] = None, **kwargs)

HDInsight ondemand linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• cluster_size (any) – Required. Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).

• time_to_live (any) – Required. The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string).

• version (any) – Required. Version of the HDInsight cluster.  Type: string (or Expression with resultType string).

• linked_service_name (LinkedServiceReference) – Required. Azure Storage linked service to be used by the on-demand cluster for storing and processing data.

• host_subscription_id (any) – Required. The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).

• service_principal_id (any) – The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key for the service principal id.

• tenant (any) – Required. The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).

• cluster_resource_group (any) – Required. The resource group where the cluster belongs. Type: string (or Expression with resultType string).

• cluster_name_prefix (any) – The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).

• cluster_user_name (any) – The username to access the cluster. Type: string (or Expression with resultType string).

• cluster_password (SecretBase) – The password to access the cluster.

• cluster_ssh_user_name (any) – The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string).

• cluster_ssh_password (SecretBase) – The password to SSH remotely connect cluster’s node (for Linux).

• additional_linked_service_names (list[LinkedServiceReference]) – Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.

• hcatalog_linked_service_name (LinkedServiceReference) – The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.

• cluster_type (any) – The cluster type. Type: string (or Expression with resultType string).

• spark_version (any) – The version of spark if the cluster type is ‘spark’. Type: string (or Expression with resultType string).

• core_configuration (any) – Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.

• h_base_configuration (any) – Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.

• hdfs_configuration (any) – Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.

• hive_configuration (any) – Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.

• map_reduce_configuration (any) – Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.

• oozie_configuration (any) – Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.

• storm_configuration (any) – Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.

• yarn_configuration (any) – Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• head_node_size (any) – Specifies the size of the head node for the HDInsight cluster.

• data_node_size (any) – Specifies the size of the data node for the HDInsight cluster.

• zookeeper_node_size (any) – Specifies the size of the Zoo Keeper node for the HDInsight cluster.

• script_actions (list[ScriptAction]) – Custom script actions to run on HDI ondemand cluster once it’s up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.

• virtual_network_id (any) – The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).

• subnet_name (any) – The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• cluster_size (any) – Required. Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).

• time_to_live (any) – Required. The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string).

• version (any) – Required. Version of the HDInsight cluster.  Type: string (or Expression with resultType string).

• linked_service_name (LinkedServiceReference) – Required. Azure Storage linked service to be used by the on-demand cluster for storing and processing data.

• host_subscription_id (any) – Required. The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).

• service_principal_id (any) – The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – The key for the service principal id.

• tenant (any) – Required. The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).

• cluster_resource_group (any) – Required. The resource group where the cluster belongs. Type: string (or Expression with resultType string).

• cluster_name_prefix (any) – The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).

• cluster_user_name (any) – The username to access the cluster. Type: string (or Expression with resultType string).

• cluster_password (SecretBase) – The password to access the cluster.

• cluster_ssh_user_name (any) – The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string).

• cluster_ssh_password (SecretBase) – The password to SSH remotely connect cluster’s node (for Linux).

• additional_linked_service_names (list[LinkedServiceReference]) – Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.

• hcatalog_linked_service_name (LinkedServiceReference) – The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.

• cluster_type (any) – The cluster type. Type: string (or Expression with resultType string).

• spark_version (any) – The version of spark if the cluster type is ‘spark’. Type: string (or Expression with resultType string).

• core_configuration (any) – Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.

• h_base_configuration (any) – Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.

• hdfs_configuration (any) – Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.

• hive_configuration (any) – Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.

• map_reduce_configuration (any) – Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.

• oozie_configuration (any) – Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.

• storm_configuration (any) – Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.

• yarn_configuration (any) – Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• head_node_size (any) – Specifies the size of the head node for the HDInsight cluster.

• data_node_size (any) – Specifies the size of the data node for the HDInsight cluster.

• zookeeper_node_size (any) – Specifies the size of the Zoo Keeper node for the HDInsight cluster.

• script_actions (list[ScriptAction]) – Custom script actions to run on HDI ondemand cluster once it’s up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.

• virtual_network_id (any) – The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).

• subnet_name (any) – The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HDInsightPigActivity(*, name: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, storage_linked_services: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceReference]] = None, arguments: Optional[Any] = None, get_debug_info: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HDInsightActivityDebugInfoOption]] = None, script_path: Optional[Any] = None, script_linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, defines: Optional[Dict[str, Any]] = None, **kwargs)

HDInsight Pig activity type.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.

• arguments (any) – User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array).

• get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: “None”, “Always”, “Failure”.

• script_path (any) – Script path. Type: string (or Expression with resultType string).

• script_linked_service (LinkedServiceReference) – Script linked service reference.

• defines (dict[str, any]) – Allows user to specify defines for Pig job request.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.

• arguments (any) – User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array).

• get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: “None”, “Always”, “Failure”.

• script_path (any) – Script path. Type: string (or Expression with resultType string).

• script_linked_service (LinkedServiceReference) – Script linked service reference.

• defines (dict[str, any]) – Allows user to specify defines for Pig job request.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HDInsightSparkActivity(*, name: str, root_path: Any, entry_file_path: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, arguments: Optional[List[Any]] = None, get_debug_info: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HDInsightActivityDebugInfoOption]] = None, spark_job_linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, class_name: Optional[str] = None, proxy_user: Optional[Any] = None, spark_config: Optional[Dict[str, Any]] = None, **kwargs)

HDInsight Spark activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• root_path (any) – Required. The root path in ‘sparkJobLinkedService’ for all the job’s files. Type: string (or Expression with resultType string).

• entry_file_path (any) – Required. The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string).

• arguments (list[any]) – The user-specified arguments to HDInsightSparkActivity.

• get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: “None”, “Always”, “Failure”.

• spark_job_linked_service (LinkedServiceReference) – The storage linked service for uploading the entry file and dependencies, and for receiving logs.

• class_name (str) – The application’s Java/Spark main class.

• proxy_user (any) – The user to impersonate that will execute the job. Type: string (or Expression with resultType string).

• spark_config (dict[str, any]) – Spark configuration property.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• root_path (any) – Required. The root path in ‘sparkJobLinkedService’ for all the job’s files. Type: string (or Expression with resultType string).

• entry_file_path (any) – Required. The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string).

• arguments (list[any]) – The user-specified arguments to HDInsightSparkActivity.

• get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: “None”, “Always”, “Failure”.

• spark_job_linked_service (LinkedServiceReference) – The storage linked service for uploading the entry file and dependencies, and for receiving logs.

• class_name (str) – The application’s Java/Spark main class.

• proxy_user (any) – The user to impersonate that will execute the job. Type: string (or Expression with resultType string).

• spark_config (dict[str, any]) – Spark configuration property.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HDInsightStreamingActivity(*, name: str, mapper: Any, reducer: Any, input: Any, output: Any, file_paths: List[Any], additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, storage_linked_services: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceReference]] = None, arguments: Optional[List[Any]] = None, get_debug_info: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HDInsightActivityDebugInfoOption]] = None, file_linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, combiner: Optional[Any] = None, command_environment: Optional[List[Any]] = None, defines: Optional[Dict[str, Any]] = None, **kwargs)

HDInsight streaming activity type.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.

• arguments (list[any]) – User specified arguments to HDInsightActivity.

• get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: “None”, “Always”, “Failure”.

• mapper (any) – Required. Mapper executable name. Type: string (or Expression with resultType string).

• reducer (any) – Required. Reducer executable name. Type: string (or Expression with resultType string).

• input (any) – Required. Input blob path. Type: string (or Expression with resultType string).

• output (any) – Required. Output blob path. Type: string (or Expression with resultType string).

• file_paths (list[any]) – Required. Paths to streaming job files. Can be directories.

• file_linked_service (LinkedServiceReference) – Linked service reference where the files are located.

• combiner (any) – Combiner executable name. Type: string (or Expression with resultType string).

• command_environment (list[any]) – Command line environment values.

• defines (dict[str, any]) – Allows user to specify defines for streaming job request.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.

• arguments (list[any]) – User specified arguments to HDInsightActivity.

• get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: “None”, “Always”, “Failure”.

• mapper (any) – Required. Mapper executable name. Type: string (or Expression with resultType string).

• reducer (any) – Required. Reducer executable name. Type: string (or Expression with resultType string).

• input (any) – Required. Input blob path. Type: string (or Expression with resultType string).

• output (any) – Required. Output blob path. Type: string (or Expression with resultType string).

• file_paths (list[any]) – Required. Paths to streaming job files. Can be directories.

• file_linked_service (LinkedServiceReference) – Linked service reference where the files are located.

• combiner (any) – Combiner executable name. Type: string (or Expression with resultType string).

• command_environment (list[any]) – Command line environment values.

• defines (dict[str, any]) – Allows user to specify defines for streaming job request.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HdfsLinkedService(*, url: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, authentication_type: Optional[Any] = None, encrypted_credential: Optional[Any] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, **kwargs)

Hadoop Distributed File System (HDFS) linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string).

• authentication_type (any) – Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• user_name (any) – User name for Windows authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for Windows authentication.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string).

• authentication_type (any) – Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• user_name (any) – User name for Windows authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for Windows authentication.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HdfsLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, **kwargs)

The location of HDFS.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HdfsReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, file_list_path: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, distcp_settings: Optional[azure.synapse.artifacts.models._models_py3.DistcpSettings] = None, delete_files_after_completion: Optional[Any] = None, **kwargs)

HDFS read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – HDFS wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – HDFS wildcardFileName. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

• distcp_settings (DistcpSettings) – Specifies Distcp-related settings.

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – HDFS wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – HDFS wildcardFileName. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

• distcp_settings (DistcpSettings) – Specifies Distcp-related settings.

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HdfsSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, distcp_settings: Optional[azure.synapse.artifacts.models._models_py3.DistcpSettings] = None, **kwargs)

A copy activity HDFS source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• distcp_settings (DistcpSettings) – Specifies Distcp-related settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• distcp_settings (DistcpSettings) – Specifies Distcp-related settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HdiNodeTypes(value)

All available HdiNodeTypes values.

HEADNODE = 'Headnode'

WORKERNODE = 'Workernode'

ZOOKEEPER = 'Zookeeper'

class azure.synapse.artifacts.models.HiveAuthenticationType(value)

The authentication method used to access the Hive server.

ANONYMOUS = 'Anonymous'

USERNAME = 'Username'

USERNAME_AND_PASSWORD = 'UsernameAndPassword'

WINDOWS_AZURE_HD_INSIGHT_SERVICE = 'WindowsAzureHDInsightService'

class azure.synapse.artifacts.models.HiveLinkedService(*, host: Any, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HiveAuthenticationType], additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, port: Optional[Any] = None, server_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HiveServerType]] = None, thrift_transport_protocol: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HiveThriftTransportProtocol]] = None, service_discovery_mode: Optional[Any] = None, zoo_keeper_name_space: Optional[Any] = None, use_native_query: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, http_path: Optional[Any] = None, enable_ssl: Optional[Any] = None, trusted_cert_path: Optional[Any] = None, use_system_trust_store: Optional[Any] = None, allow_host_name_cn_mismatch: Optional[Any] = None, allow_self_signed_server_cert: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Hive Server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. IP address or host name of the Hive server, separated by ‘;’ for multiple hosts (only when serviceDiscoveryMode is enable).

• port (any) – The TCP port that the Hive server uses to listen for client connections.

• server_type (str or HiveServerType) – The type of Hive server. Possible values include: “HiveServer1”, “HiveServer2”, “HiveThriftServer”.

• thrift_transport_protocol (str or HiveThriftTransportProtocol) – The transport protocol to use in the Thrift layer. Possible values include: “Binary”, “SASL”, “HTTP “.

• authentication_type (str or HiveAuthenticationType) – Required. The authentication method used to access the Hive server. Possible values include: “Anonymous”, “Username”, “UsernameAndPassword”, “WindowsAzureHDInsightService”.

• service_discovery_mode (any) – true to indicate using the ZooKeeper service, false not.

• zoo_keeper_name_space (any) – The namespace on ZooKeeper under which Hive Server 2 nodes are added.

• use_native_query (any) – Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.

• username (any) – The user name that you use to access Hive Server.

• password (SecretBase) – The password corresponding to the user name that you provided in the Username field.

• http_path (any) – The partial URL corresponding to the Hive server.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. IP address or host name of the Hive server, separated by ‘;’ for multiple hosts (only when serviceDiscoveryMode is enable).

• port (any) – The TCP port that the Hive server uses to listen for client connections.

• server_type (str or HiveServerType) – The type of Hive server. Possible values include: “HiveServer1”, “HiveServer2”, “HiveThriftServer”.

• thrift_transport_protocol (str or HiveThriftTransportProtocol) – The transport protocol to use in the Thrift layer. Possible values include: “Binary”, “SASL”, “HTTP “.

• authentication_type (str or HiveAuthenticationType) – Required. The authentication method used to access the Hive server. Possible values include: “Anonymous”, “Username”, “UsernameAndPassword”, “WindowsAzureHDInsightService”.

• service_discovery_mode (any) – true to indicate using the ZooKeeper service, false not.

• zoo_keeper_name_space (any) – The namespace on ZooKeeper under which Hive Server 2 nodes are added.

• use_native_query (any) – Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.

• username (any) – The user name that you use to access Hive Server.

• password (SecretBase) – The password corresponding to the user name that you provided in the Username field.

• http_path (any) – The partial URL corresponding to the Hive server.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HiveObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

Hive Server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Hive. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Hive. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Hive. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Hive. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HiveServerType(value)

The type of Hive server.

HIVE_SERVER1 = 'HiveServer1'

HIVE_SERVER2 = 'HiveServer2'

HIVE_THRIFT_SERVER = 'HiveThriftServer'

class azure.synapse.artifacts.models.HiveSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Hive Server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HiveThriftTransportProtocol(value)

The transport protocol to use in the Thrift layer.

BINARY = 'Binary'

HTTP = 'HTTP '

SASL = 'SASL'

class azure.synapse.artifacts.models.HttpAuthenticationType(value)

The authentication type to be used to connect to the HTTP server.

ANONYMOUS = 'Anonymous'

BASIC = 'Basic'

CLIENT_CERTIFICATE = 'ClientCertificate'

DIGEST = 'Digest'

WINDOWS = 'Windows'

class azure.synapse.artifacts.models.HttpDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, relative_url: Optional[Any] = None, request_method: Optional[Any] = None, request_body: Optional[Any] = None, additional_headers: Optional[Any] = None, format: Optional[azure.synapse.artifacts.models._models_py3.DatasetStorageFormat] = None, compression: Optional[azure.synapse.artifacts.models._models_py3.DatasetCompression] = None, **kwargs)

A file in an HTTP web server.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• relative_url (any) – The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).

• request_method (any) – The HTTP method for the HTTP request. Type: string (or Expression with resultType string).

• request_body (any) – The body for the HTTP request. Type: string (or Expression with resultType string).

• additional_headers (any) – The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 … request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of files.

• compression (DatasetCompression) – The data compression method used on files.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• relative_url (any) – The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).

• request_method (any) – The HTTP method for the HTTP request. Type: string (or Expression with resultType string).

• request_body (any) – The body for the HTTP request. Type: string (or Expression with resultType string).

• additional_headers (any) – The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 … request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).

• format (DatasetStorageFormat) – The format of files.

• compression (DatasetCompression) – The data compression method used on files.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HttpLinkedService(*, url: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HttpAuthenticationType]] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, embedded_cert_data: Optional[Any] = None, cert_thumbprint: Optional[Any] = None, encrypted_credential: Optional[Any] = None, enable_server_certificate_validation: Optional[Any] = None, **kwargs)

Linked service for an HTTP source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string).

• authentication_type (str or HttpAuthenticationType) – The authentication type to be used to connect to the HTTP server. Possible values include: “Basic”, “Anonymous”, “Digest”, “Windows”, “ClientCertificate”.

• user_name (any) – User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.

• embedded_cert_data (any) – Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).

• cert_thumbprint (any) – Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• enable_server_certificate_validation (any) – If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string).

• authentication_type (str or HttpAuthenticationType) – The authentication type to be used to connect to the HTTP server. Possible values include: “Basic”, “Anonymous”, “Digest”, “Windows”, “ClientCertificate”.

• user_name (any) – User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.

• embedded_cert_data (any) – Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).

• cert_thumbprint (any) – Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• enable_server_certificate_validation (any) – If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HttpReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, request_method: Optional[Any] = None, request_body: Optional[Any] = None, additional_headers: Optional[Any] = None, request_timeout: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, **kwargs)

Sftp read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• request_method (any) – The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

• request_body (any) – The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

• additional_headers (any) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

• request_timeout (any) – Specifies the timeout for a HTTP client to get HTTP response from HTTP server.

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• request_method (any) – The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

• request_body (any) – The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

• additional_headers (any) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

• request_timeout (any) – Specifies the timeout for a HTTP client to get HTTP response from HTTP server.

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HttpServerLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, relative_url: Optional[Any] = None, **kwargs)

The location of http server.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

• relative_url (any) – Specify the relativeUrl of http server. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

• relative_url (any) – Specify the relativeUrl of http server. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HttpSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, http_request_timeout: Optional[Any] = None, **kwargs)

A copy activity source for an HTTP file.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• http_request_timeout (any) – Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• http_request_timeout (any) – Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HubspotLinkedService(*, client_id: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, access_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, refresh_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Hubspot Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• client_id (any) – Required. The client ID associated with your Hubspot application.

• client_secret (SecretBase) – The client secret associated with your Hubspot application.

• access_token (SecretBase) – The access token obtained when initially authenticating your OAuth integration.

• refresh_token (SecretBase) – The refresh token obtained when initially authenticating your OAuth integration.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• client_id (any) – Required. The client ID associated with your Hubspot application.

• client_secret (SecretBase) – The client secret associated with your Hubspot application.

• access_token (SecretBase) – The access token obtained when initially authenticating your OAuth integration.

• refresh_token (SecretBase) – The refresh token obtained when initially authenticating your OAuth integration.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HubspotObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Hubspot Service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.HubspotSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Hubspot Service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IfConditionActivity(*, name: str, expression: azure.synapse.artifacts.models._models_py3.Expression, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, if_true_activities: Optional[List[azure.synapse.artifacts.models._models_py3.Activity]] = None, if_false_activities: Optional[List[azure.synapse.artifacts.models._models_py3.Activity]] = None, **kwargs)

This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• expression (Expression) – Required. An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.

• if_true_activities (list[Activity]) – List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.

• if_false_activities (list[Activity]) – List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• expression (Expression) – Required. An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.

• if_true_activities (list[Activity]) – List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.

• if_false_activities (list[Activity]) – List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ImpalaAuthenticationType(value)

The authentication type to use.

ANONYMOUS = 'Anonymous'

SASL_USERNAME = 'SASLUsername'

USERNAME_AND_PASSWORD = 'UsernameAndPassword'

class azure.synapse.artifacts.models.ImpalaLinkedService(*, host: Any, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.ImpalaAuthenticationType], additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, port: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, enable_ssl: Optional[Any] = None, trusted_cert_path: Optional[Any] = None, use_system_trust_store: Optional[Any] = None, allow_host_name_cn_mismatch: Optional[Any] = None, allow_self_signed_server_cert: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Impala server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The IP address or host name of the Impala server. (i.e. 192.168.222.160).

• port (any) – The TCP port that the Impala server uses to listen for client connections. The default value is 21050.

• authentication_type (str or ImpalaAuthenticationType) – Required. The authentication type to use. Possible values include: “Anonymous”, “SASLUsername”, “UsernameAndPassword”.

• username (any) – The user name used to access the Impala server. The default value is anonymous when using SASLUsername.

• password (SecretBase) – The password corresponding to the user name when using UsernameAndPassword.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The IP address or host name of the Impala server. (i.e. 192.168.222.160).

• port (any) – The TCP port that the Impala server uses to listen for client connections. The default value is 21050.

• authentication_type (str or ImpalaAuthenticationType) – Required. The authentication type to use. Possible values include: “Anonymous”, “SASLUsername”, “UsernameAndPassword”.

• username (any) – The user name used to access the Impala server. The default value is anonymous when using SASLUsername.

• password (SecretBase) – The password corresponding to the user name when using UsernameAndPassword.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ImpalaObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

Impala server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Impala. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Impala. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Impala. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Impala. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ImpalaSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Impala server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ImportSettings(*, additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

Import command settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureDatabricksDeltaLakeImportCommand, SnowflakeImportCopyCommand.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The import setting type.Constant filled by server.

Keyword Arguments

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.InformixLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, authentication_type: Optional[Any] = None, credential: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Informix linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.

• authentication_type (any) – Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).

• credential (SecretBase) – The access credential portion of the connection string specified in driver-specific property-value format.

• user_name (any) – User name for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for Basic authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.

• authentication_type (any) – Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).

• credential (SecretBase) – The access credential portion of the connection string specified in driver-specific property-value format.

• user_name (any) – User name for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for Basic authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.InformixSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, pre_copy_script: Optional[Any] = None, **kwargs)

A copy activity Informix sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.InformixSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity source for Informix.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.InformixTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

The Informix table dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The Informix table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The Informix table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntime(*, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, **kwargs)

Azure Synapse nested object which serves as a compute resource for activities.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ManagedIntegrationRuntime, SelfHostedIntegrationRuntime.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str or IntegrationRuntimeType) – Required. Type of integration runtime.Constant filled by server. Possible values include: “Managed”, “SelfHosted”.

• description (str) – Integration runtime description.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Integration runtime description.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeComputeProperties(*, additional_properties: Optional[Dict[str, Any]] = None, location: Optional[str] = None, node_size: Optional[str] = None, number_of_nodes: Optional[int] = None, max_parallel_executions_per_node: Optional[int] = None, data_flow_properties: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeDataFlowProperties] = None, v_net_properties: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeVNetProperties] = None, **kwargs)

The compute resource properties for managed integration runtime.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• location (str) – The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities.

• node_size (str) – The node size requirement to managed integration runtime.

• number_of_nodes (int) – The required number of nodes for managed integration runtime.

• max_parallel_executions_per_node (int) – Maximum parallel executions count per node for managed integration runtime.

• data_flow_properties (IntegrationRuntimeDataFlowProperties) – Data flow properties for managed integration runtime.

• v_net_properties (IntegrationRuntimeVNetProperties) – VNet properties for managed integration runtime.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• location (str) – The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities.

• node_size (str) – The node size requirement to managed integration runtime.

• number_of_nodes (int) – The required number of nodes for managed integration runtime.

• max_parallel_executions_per_node (int) – Maximum parallel executions count per node for managed integration runtime.

• data_flow_properties (IntegrationRuntimeDataFlowProperties) – Data flow properties for managed integration runtime.

• v_net_properties (IntegrationRuntimeVNetProperties) – VNet properties for managed integration runtime.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeCustomSetupScriptProperties(*, blob_container_uri: Optional[str] = None, sas_token: Optional[azure.synapse.artifacts.models._models_py3.SecureString] = None, **kwargs)

Custom setup script properties for a managed dedicated integration runtime.

Variables

• blob_container_uri (str) – The URI of the Azure blob container that contains the custom setup script.

• sas_token (SecureString) – The SAS token of the Azure blob container.

Keyword Arguments

• blob_container_uri (str) – The URI of the Azure blob container that contains the custom setup script.

• sas_token (SecureString) – The SAS token of the Azure blob container.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeDataFlowProperties(*, additional_properties: Optional[Dict[str, Any]] = None, compute_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DataFlowComputeType]] = None, core_count: Optional[int] = None, time_to_live: Optional[int] = None, cleanup: Optional[bool] = None, **kwargs)

Data flow properties for managed integration runtime.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• compute_type (str or DataFlowComputeType) – Compute type of the cluster which will execute data flow job. Possible values include: “General”, “MemoryOptimized”, “ComputeOptimized”.

• core_count (int) – Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.

• time_to_live (int) – Time to live (in minutes) setting of the cluster which will execute data flow job.

• cleanup (bool) – Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• compute_type (str or DataFlowComputeType) – Compute type of the cluster which will execute data flow job. Possible values include: “General”, “MemoryOptimized”, “ComputeOptimized”.

• core_count (int) – Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.

• time_to_live (int) – Time to live (in minutes) setting of the cluster which will execute data flow job.

• cleanup (bool) – Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeDataProxyProperties(*, connect_via: Optional[azure.synapse.artifacts.models._models_py3.EntityReference] = None, staging_linked_service: Optional[azure.synapse.artifacts.models._models_py3.EntityReference] = None, path: Optional[str] = None, **kwargs)

Data proxy properties for a managed dedicated integration runtime.

Variables

• connect_via (EntityReference) – The self-hosted integration runtime reference.

• staging_linked_service (EntityReference) – The staging linked service reference.

• path (str) – The path to contain the staged data in the Blob storage.

Keyword Arguments

• connect_via (EntityReference) – The self-hosted integration runtime reference.

• staging_linked_service (EntityReference) – The staging linked service reference.

• path (str) – The path to contain the staged data in the Blob storage.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeDebugResource(*, properties: azure.synapse.artifacts.models._models_py3.IntegrationRuntime, name: Optional[str] = None, **kwargs)

Integration runtime debug resource.

All required parameters must be populated in order to send to Azure.

Variables

• name (str) – The resource name.

• properties (IntegrationRuntime) – Required. Integration runtime properties.

Keyword Arguments

• name (str) – The resource name.

• properties (IntegrationRuntime) – Required. Integration runtime properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeEdition(value)

The edition for the SSIS Integration Runtime

ENTERPRISE = 'Enterprise'

STANDARD = 'Standard'

class azure.synapse.artifacts.models.IntegrationRuntimeEntityReferenceType(value)

The type of this referenced entity.

INTEGRATION_RUNTIME_REFERENCE = 'IntegrationRuntimeReference'

LINKED_SERVICE_REFERENCE = 'LinkedServiceReference'

class azure.synapse.artifacts.models.IntegrationRuntimeLicenseType(value)

License type for bringing your own license scenario.

BASE_PRICE = 'BasePrice'

LICENSE_INCLUDED = 'LicenseIncluded'

class azure.synapse.artifacts.models.IntegrationRuntimeListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeResource], next_link: Optional[str] = None, **kwargs)

A list of integration runtime resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[IntegrationRuntimeResource]) – Required. List of integration runtimes.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[IntegrationRuntimeResource]) – Required. List of integration runtimes.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeReference(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.IntegrationRuntimeReferenceType], reference_name: str, parameters: Optional[Dict[str, Any]] = None, **kwargs)

Integration runtime reference type.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or IntegrationRuntimeReferenceType) – Required. Type of integration runtime. Possible values include: “IntegrationRuntimeReference”.

• reference_name (str) – Required. Reference integration runtime name.

• parameters (dict[str, any]) – Arguments for integration runtime.

Keyword Arguments

• type (str or IntegrationRuntimeReferenceType) – Required. Type of integration runtime. Possible values include: “IntegrationRuntimeReference”.

• reference_name (str) – Required. Reference integration runtime name.

• parameters (dict[str, any]) – Arguments for integration runtime.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeReferenceType(value)

Type of integration runtime.

INTEGRATION_RUNTIME_REFERENCE = 'IntegrationRuntimeReference'

class azure.synapse.artifacts.models.IntegrationRuntimeResource(*, properties: azure.synapse.artifacts.models._models_py3.IntegrationRuntime, **kwargs)

Integration runtime resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• properties (IntegrationRuntime) – Required. Integration runtime properties.

Keyword Arguments

properties (IntegrationRuntime) – Required. Integration runtime properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogInfo(*, additional_properties: Optional[Dict[str, Any]] = None, catalog_server_endpoint: Optional[str] = None, catalog_admin_user_name: Optional[str] = None, catalog_admin_password: Optional[azure.synapse.artifacts.models._models_py3.SecureString] = None, catalog_pricing_tier: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.IntegrationRuntimeSsisCatalogPricingTier]] = None, **kwargs)

Catalog information for managed dedicated integration runtime.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• catalog_server_endpoint (str) – The catalog database server URL.

• catalog_admin_user_name (str) – The administrator user name of catalog database.

• catalog_admin_password (SecureString) – The password of the administrator user account of the catalog database.

• catalog_pricing_tier (str or IntegrationRuntimeSsisCatalogPricingTier) – The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible values include: “Basic”, “Standard”, “Premium”, “PremiumRS”.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• catalog_server_endpoint (str) – The catalog database server URL.

• catalog_admin_user_name (str) – The administrator user name of catalog database.

• catalog_admin_password (SecureString) – The password of the administrator user account of the catalog database.

• catalog_pricing_tier (str or IntegrationRuntimeSsisCatalogPricingTier) – The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible values include: “Basic”, “Standard”, “Premium”, “PremiumRS”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeSsisCatalogPricingTier(value)

The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/

BASIC = 'Basic'

PREMIUM = 'Premium'

PREMIUM_RS = 'PremiumRS'

STANDARD = 'Standard'

class azure.synapse.artifacts.models.IntegrationRuntimeSsisProperties(*, additional_properties: Optional[Dict[str, Any]] = None, catalog_info: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeSsisCatalogInfo] = None, license_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.IntegrationRuntimeLicenseType]] = None, custom_setup_script_properties: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeCustomSetupScriptProperties] = None, data_proxy_properties: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeDataProxyProperties] = None, edition: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.IntegrationRuntimeEdition]] = None, express_custom_setup_properties: Optional[List[azure.synapse.artifacts.models._models_py3.CustomSetupBase]] = None, **kwargs)

SSIS properties for managed integration runtime.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• catalog_info (IntegrationRuntimeSsisCatalogInfo) – Catalog information for managed dedicated integration runtime.

• license_type (str or IntegrationRuntimeLicenseType) – License type for bringing your own license scenario. Possible values include: “BasePrice”, “LicenseIncluded”.

• custom_setup_script_properties (IntegrationRuntimeCustomSetupScriptProperties) – Custom setup script properties for a managed dedicated integration runtime.

• data_proxy_properties (IntegrationRuntimeDataProxyProperties) – Data proxy properties for a managed dedicated integration runtime.

• edition (str or IntegrationRuntimeEdition) – The edition for the SSIS Integration Runtime. Possible values include: “Standard”, “Enterprise”.

• express_custom_setup_properties (list[CustomSetupBase]) – Custom setup without script properties for a SSIS integration runtime.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• catalog_info (IntegrationRuntimeSsisCatalogInfo) – Catalog information for managed dedicated integration runtime.

• license_type (str or IntegrationRuntimeLicenseType) – License type for bringing your own license scenario. Possible values include: “BasePrice”, “LicenseIncluded”.

• custom_setup_script_properties (IntegrationRuntimeCustomSetupScriptProperties) – Custom setup script properties for a managed dedicated integration runtime.

• data_proxy_properties (IntegrationRuntimeDataProxyProperties) – Data proxy properties for a managed dedicated integration runtime.

• edition (str or IntegrationRuntimeEdition) – The edition for the SSIS Integration Runtime. Possible values include: “Standard”, “Enterprise”.

• express_custom_setup_properties (list[CustomSetupBase]) – Custom setup without script properties for a SSIS integration runtime.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.IntegrationRuntimeState(value)

The state of integration runtime.

ACCESS_DENIED = 'AccessDenied'

INITIAL = 'Initial'

LIMITED = 'Limited'

NEED_REGISTRATION = 'NeedRegistration'

OFFLINE = 'Offline'

ONLINE = 'Online'

STARTED = 'Started'

STARTING = 'Starting'

STOPPED = 'Stopped'

STOPPING = 'Stopping'

class azure.synapse.artifacts.models.IntegrationRuntimeType(value)

The type of integration runtime.

MANAGED = 'Managed'

SELF_HOSTED = 'SelfHosted'

class azure.synapse.artifacts.models.IntegrationRuntimeVNetProperties(*, additional_properties: Optional[Dict[str, Any]] = None, v_net_id: Optional[str] = None, subnet: Optional[str] = None, public_i_ps: Optional[List[str]] = None, **kwargs)

VNet properties for managed integration runtime.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• v_net_id (str) – The ID of the VNet that this integration runtime will join.

• subnet (str) – The name of the subnet this integration runtime will join.

• public_i_ps (list[str]) – Resource IDs of the public IP addresses that this integration runtime will use.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• v_net_id (str) – The ID of the VNet that this integration runtime will join.

• subnet (str) – The name of the subnet this integration runtime will join.

• public_i_ps (list[str]) – Resource IDs of the public IP addresses that this integration runtime will use.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.JiraLinkedService(*, host: Any, username: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, port: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Jira Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The IP address or host name of the Jira service. (e.g. jira.example.com).

• port (any) – The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.

• username (any) – Required. The user name that you use to access Jira Service.

• password (SecretBase) – The password corresponding to the user name that you provided in the username field.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The IP address or host name of the Jira service. (e.g. jira.example.com).

• port (any) – The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.

• username (any) – Required. The user name that you use to access Jira Service.

• password (SecretBase) – The password corresponding to the user name that you provided in the username field.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.JiraObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Jira Service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.JiraSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Jira Service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.JsonDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, location: Optional[azure.synapse.artifacts.models._models_py3.DatasetLocation] = None, encoding_name: Optional[Any] = None, compression: Optional[azure.synapse.artifacts.models._models_py3.DatasetCompression] = None, **kwargs)

Json dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the json data storage.

• encoding_name (any) – The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

• compression (DatasetCompression) – The data compression method used for the json dataset.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the json data storage.

• encoding_name (any) – The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

• compression (DatasetCompression) – The data compression method used for the json dataset.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.JsonFormat(*, additional_properties: Optional[Dict[str, Any]] = None, serializer: Optional[Any] = None, deserializer: Optional[Any] = None, file_pattern: Optional[Any] = None, nesting_separator: Optional[Any] = None, encoding_name: Optional[Any] = None, json_node_reference: Optional[Any] = None, json_path_definition: Optional[Any] = None, **kwargs)

The data stored in JSON format.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage format.Constant filled by server.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

• file_pattern (any) – File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is ‘setOfObjects’. It is case-sensitive.

• nesting_separator (any) – The character used to separate nesting levels. Default value is ‘.’ (dot). Type: string (or Expression with resultType string).

• encoding_name (any) – The code page name of the preferred encoding. If not provided, the default value is ‘utf-8’, unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the ‘Name’ column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).

• json_node_reference (any) – The JSONPath of the JSON array element to be flattened. Example: “$.ArrayPath”. Type: string (or Expression with resultType string).

• json_path_definition (any) – The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with “$”; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {“Column1”: “$.Column1Path”, “Column2”: “Column2PathInArray”}. Type: object (or Expression with resultType object).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

• file_pattern (any) – File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is ‘setOfObjects’. It is case-sensitive.

• nesting_separator (any) – The character used to separate nesting levels. Default value is ‘.’ (dot). Type: string (or Expression with resultType string).

• encoding_name (any) – The code page name of the preferred encoding. If not provided, the default value is ‘utf-8’, unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the ‘Name’ column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).

• json_node_reference (any) – The JSONPath of the JSON array element to be flattened. Example: “$.ArrayPath”. Type: string (or Expression with resultType string).

• json_path_definition (any) – The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with “$”; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {“Column1”: “$.Column1Path”, “Column2”: “Column2PathInArray”}. Type: object (or Expression with resultType object).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.JsonFormatFilePattern(value)

JSON format file pattern. A property of JsonFormat.

ARRAY_OF_OBJECTS = 'arrayOfObjects'

SET_OF_OBJECTS = 'setOfObjects'

class azure.synapse.artifacts.models.JsonReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, compression_properties: Optional[azure.synapse.artifacts.models._models_py3.CompressionReadSettings] = None, **kwargs)

Json read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• compression_properties (CompressionReadSettings) – Compression settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• compression_properties (CompressionReadSettings) – Compression settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.JsonSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreWriteSettings] = None, format_settings: Optional[azure.synapse.artifacts.models._models_py3.JsonWriteSettings] = None, **kwargs)

A copy activity Json sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – Json store settings.

• format_settings (JsonWriteSettings) – Json format settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – Json store settings.

• format_settings (JsonWriteSettings) – Json format settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.JsonSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreReadSettings] = None, format_settings: Optional[azure.synapse.artifacts.models._models_py3.JsonReadSettings] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Json source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Json store settings.

• format_settings (JsonReadSettings) – Json format settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Json store settings.

• format_settings (JsonReadSettings) – Json format settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.JsonWriteFilePattern(value)

All available filePatterns.

ARRAY_OF_OBJECTS = 'arrayOfObjects'

SET_OF_OBJECTS = 'setOfObjects'

class azure.synapse.artifacts.models.JsonWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, file_pattern: Optional[Any] = None, **kwargs)

Json write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• file_pattern (any) – File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is ‘setOfObjects’. It is case-sensitive.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• file_pattern (any) – File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is ‘setOfObjects’. It is case-sensitive.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.KqlScript(*, content: Optional[azure.synapse.artifacts.models._models_py3.KqlScriptContent] = None, **kwargs)

KqlScript.

Variables

content (KqlScriptContent) –

Keyword Arguments

content (KqlScriptContent) –

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.KqlScriptContent(*, query: Optional[str] = None, metadata: Optional[azure.synapse.artifacts.models._models_py3.KqlScriptContentMetadata] = None, current_connection: Optional[azure.synapse.artifacts.models._models_py3.KqlScriptContentCurrentConnection] = None, **kwargs)

KqlScriptContent.

Variables

• query (str) –

• metadata (KqlScriptContentMetadata) –

• current_connection (KqlScriptContentCurrentConnection) –

Keyword Arguments

• query (str) –

• metadata (KqlScriptContentMetadata) –

• current_connection (KqlScriptContentCurrentConnection) –

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.KqlScriptContentCurrentConnection(*, name: Optional[str] = None, pool_name: Optional[str] = None, database_name: Optional[str] = None, type: Optional[str] = None, **kwargs)

KqlScriptContentCurrentConnection.

Variables

• name (str) –

• pool_name (str) –

• database_name (str) –

• type (str) –

Keyword Arguments

• name (str) –

• pool_name (str) –

• database_name (str) –

• type (str) –

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.KqlScriptContentMetadata(*, language: Optional[str] = None, **kwargs)

KqlScriptContentMetadata.

Variables

language (str) –

Keyword Arguments

language (str) –

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.KqlScriptResource(*, id: Optional[str] = None, name: Optional[str] = None, type: Optional[str] = None, properties: Optional[azure.synapse.artifacts.models._models_py3.KqlScript] = None, **kwargs)

KqlScriptResource.

Variables

• id (str) –

• name (str) –

• type (str) –

• properties (KqlScript) – Properties of sql script.

Keyword Arguments

• id (str) –

• name (str) –

• type (str) –

• properties (KqlScript) – Properties of sql script.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.KqlScriptsResourceCollectionResponse(*, value: Optional[List[azure.synapse.artifacts.models._models_py3.KqlScriptResource]] = None, next_link: Optional[str] = None, **kwargs)

KqlScriptsResourceCollectionResponse.

Variables

• value (list[KqlScriptResource]) –

• next_link (str) –

Keyword Arguments

• value (list[KqlScriptResource]) –

• next_link (str) –

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LibraryInfo(*, name: Optional[str] = None, path: Optional[str] = None, container_name: Optional[str] = None, uploaded_timestamp: Optional[datetime.datetime] = None, type: Optional[str] = None, **kwargs)

Library/package information of a Big Data pool powered by Apache Spark.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• name (str) – Name of the library.

• path (str) – Storage blob path of library.

• container_name (str) – Storage blob container name.

• uploaded_timestamp (datetime) – The last update time of the library.

• type (str) – Type of the library.

• provisioning_status (str) – Provisioning status of the library/package.

• creator_id (str) – Creator Id of the library/package.

Keyword Arguments

• name (str) – Name of the library.

• path (str) – Storage blob path of library.

• container_name (str) – Storage blob container name.

• uploaded_timestamp (datetime) – The last update time of the library.

• type (str) – Type of the library.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LibraryListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.LibraryResource], next_link: Optional[str] = None, **kwargs)

A list of Library resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[LibraryResource]) – Required. List of Library.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[LibraryResource]) – Required. List of Library.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LibraryRequirements(*, content: Optional[str] = None, filename: Optional[str] = None, **kwargs)

Library requirements for a Big Data pool powered by Apache Spark.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• time (datetime) – The last update time of the library requirements file.

• content (str) – The library requirements.

• filename (str) – The filename of the library requirements file.

Keyword Arguments

• content (str) – The library requirements.

• filename (str) – The filename of the library requirements file.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LibraryResource(*, properties: azure.synapse.artifacts.models._models_py3.LibraryResourceProperties, **kwargs)

Library response details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• properties (LibraryResourceProperties) – Required. Library/package properties.

Keyword Arguments

properties (LibraryResourceProperties) – Required. Library/package properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LibraryResourceInfo(**kwargs)

Library resource info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• record_id (int) – record Id of the library/package.

• state (str) – Provisioning status of the library/package.

• created (str) – The creation time of the library/package.

• changed (str) – The last updated time of the library/package.

• type (str) – The type of the resource. E.g. LibraryArtifact.

• name (str) – Name of the library/package.

• operation_id (str) – Operation Id of the operation performed on library/package.

• artifact_id (str) – artifact Id of the library/package.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LibraryResourceProperties(**kwargs)

Library/package properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• name (str) – Name of the library/package.

• path (str) – Location of library/package in storage account.

• container_name (str) – Container name of the library/package.

• uploaded_timestamp (str) – The last update time of the library/package.

• type (str) – Type of the library/package.

• provisioning_status (str) – Provisioning status of the library/package.

• creator_id (str) – Creator Id of the library/package.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LinkedIntegrationRuntimeKeyAuthorization(*, key: azure.synapse.artifacts.models._models_py3.SecureString, **kwargs)

The key authorization type integration runtime.

All required parameters must be populated in order to send to Azure.

Variables

• authorization_type (str) – Required. The authorization type for integration runtime sharing.Constant filled by server.

• key (SecureString) – Required. The key used for authorization.

Keyword Arguments

key (SecureString) – Required. The key used for authorization.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LinkedIntegrationRuntimeRbacAuthorization(*, resource_id: str, **kwargs)

The role based access control (RBAC) authorization type integration runtime.

All required parameters must be populated in order to send to Azure.

Variables

• authorization_type (str) – Required. The authorization type for integration runtime sharing.Constant filled by server.

• resource_id (str) – Required. The resource identifier of the integration runtime to be shared.

Keyword Arguments

resource_id (str) – Required. The resource identifier of the integration runtime to be shared.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LinkedIntegrationRuntimeType(**kwargs)

The base definition of a linked integration runtime.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: LinkedIntegrationRuntimeKeyAuthorization, LinkedIntegrationRuntimeRbacAuthorization.

All required parameters must be populated in order to send to Azure.

Variables

authorization_type (str) – Required. The authorization type for integration runtime sharing.Constant filled by server.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, **kwargs)

The Azure Synapse nested object which contains the information and credential which can be used to connect with related store or compute resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AmazonMWSLinkedService, AmazonRdsForOracleLinkedService, AmazonRdsForSqlServerLinkedService, AmazonRedshiftLinkedService, AmazonS3LinkedService, AzureBatchLinkedService, AzureBlobFSLinkedService, AzureBlobStorageLinkedService, AzureDataExplorerLinkedService, AzureDataLakeAnalyticsLinkedService, AzureDataLakeStoreLinkedService, AzureDatabricksLinkedService, AzureDatabricksDeltaLakeLinkedService, AzureFileStorageLinkedService, AzureFunctionLinkedService, AzureKeyVaultLinkedService, AzureMLLinkedService, AzureMLServiceLinkedService, AzureMariaDBLinkedService, AzureMySqlLinkedService, AzurePostgreSqlLinkedService, AzureSearchLinkedService, AzureSqlDWLinkedService, AzureSqlDatabaseLinkedService, AzureSqlMILinkedService, AzureStorageLinkedService, AzureTableStorageLinkedService, CassandraLinkedService, CommonDataServiceForAppsLinkedService, ConcurLinkedService, CosmosDbLinkedService, CosmosDbMongoDbApiLinkedService, CouchbaseLinkedService, CustomDataSourceLinkedService, Db2LinkedService, DrillLinkedService, DynamicsLinkedService, DynamicsAXLinkedService, DynamicsCrmLinkedService, EloquaLinkedService, FileServerLinkedService, FtpServerLinkedService, GoogleAdWordsLinkedService, GoogleBigQueryLinkedService, GoogleCloudStorageLinkedService, GreenplumLinkedService, HBaseLinkedService, HDInsightLinkedService, HDInsightOnDemandLinkedService, HdfsLinkedService, HiveLinkedService, HttpLinkedService, HubspotLinkedService, ImpalaLinkedService, InformixLinkedService, JiraLinkedService, MagentoLinkedService, MariaDBLinkedService, MarketoLinkedService, MicrosoftAccessLinkedService, MongoDbLinkedService, MongoDbAtlasLinkedService, MongoDbV2LinkedService, MySqlLinkedService, NetezzaLinkedService, ODataLinkedService, OdbcLinkedService, Office365LinkedService, OracleLinkedService, OracleServiceCloudLinkedService, PaypalLinkedService, PhoenixLinkedService, PostgreSqlLinkedService, PrestoLinkedService, QuickBooksLinkedService, ResponsysLinkedService, RestServiceLinkedService, SalesforceLinkedService, SalesforceMarketingCloudLinkedService, SalesforceServiceCloudLinkedService, SapBWLinkedService, SapCloudForCustomerLinkedService, SapEccLinkedService, SapHanaLinkedService, SapOpenHubLinkedService, SapTableLinkedService, ServiceNowLinkedService, SftpServerLinkedService, SharePointOnlineListLinkedService, ShopifyLinkedService, SnowflakeLinkedService, SparkLinkedService, SqlServerLinkedService, SquareLinkedService, SybaseLinkedService, TeradataLinkedService, VerticaLinkedService, WebLinkedService, XeroLinkedService, ZohoLinkedService.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LinkedServiceDebugResource(*, properties: azure.synapse.artifacts.models._models_py3.LinkedService, name: Optional[str] = None, **kwargs)

Linked service debug resource.

All required parameters must be populated in order to send to Azure.

Variables

• name (str) – The resource name.

• properties (LinkedService) – Required. Properties of linked service.

Keyword Arguments

• name (str) – The resource name.

• properties (LinkedService) – Required. Properties of linked service.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LinkedServiceListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.LinkedServiceResource], next_link: Optional[str] = None, **kwargs)

A list of linked service resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[LinkedServiceResource]) – Required. List of linked services.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[LinkedServiceResource]) – Required. List of linked services.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LinkedServiceReference(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.Type], reference_name: str, parameters: Optional[Dict[str, Any]] = None, **kwargs)

Linked service reference type.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or Type) – Required. Linked service reference type. Possible values include: “LinkedServiceReference”.

• reference_name (str) – Required. Reference LinkedService name.

• parameters (dict[str, any]) – Arguments for LinkedService.

Keyword Arguments

• type (str or Type) – Required. Linked service reference type. Possible values include: “LinkedServiceReference”.

• reference_name (str) – Required. Reference LinkedService name.

• parameters (dict[str, any]) – Arguments for LinkedService.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LinkedServiceResource(*, properties: azure.synapse.artifacts.models._models_py3.LinkedService, **kwargs)

Linked service resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• properties (LinkedService) – Required. Properties of linked service.

Keyword Arguments

properties (LinkedService) – Required. Properties of linked service.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LivyStates(value)

The batch state

BUSY = 'busy'

DEAD = 'dead'

ERROR = 'error'

IDLE = 'idle'

KILLED = 'killed'

NOT_STARTED = 'not_started'

RECOVERING = 'recovering'

RUNNING = 'running'

SHUTTING_DOWN = 'shutting_down'

STARTING = 'starting'

SUCCESS = 'success'

class azure.synapse.artifacts.models.LogLocationSettings(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, path: Optional[Any] = None, **kwargs)

Log location settings.

All required parameters must be populated in order to send to Azure.

Variables

• linked_service_name (LinkedServiceReference) – Required. Log storage linked service reference.

• path (any) – The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string).

Keyword Arguments

• linked_service_name (LinkedServiceReference) – Required. Log storage linked service reference.

• path (any) – The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LogSettings(*, log_location_settings: azure.synapse.artifacts.models._models_py3.LogLocationSettings, enable_copy_activity_log: Optional[Any] = None, copy_activity_log_settings: Optional[azure.synapse.artifacts.models._models_py3.CopyActivityLogSettings] = None, **kwargs)

Log settings.

All required parameters must be populated in order to send to Azure.

Variables

• enable_copy_activity_log (any) – Specifies whether to enable copy activity log. Type: boolean (or Expression with resultType boolean).

• copy_activity_log_settings (CopyActivityLogSettings) – Specifies settings for copy activity log.

• log_location_settings (LogLocationSettings) – Required. Log location settings customer needs to provide when enabling log.

Keyword Arguments

• enable_copy_activity_log (any) – Specifies whether to enable copy activity log. Type: boolean (or Expression with resultType boolean).

• copy_activity_log_settings (CopyActivityLogSettings) – Specifies settings for copy activity log.

• log_location_settings (LogLocationSettings) – Required. Log location settings customer needs to provide when enabling log.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LogStorageSettings(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, path: Optional[Any] = None, log_level: Optional[Any] = None, enable_reliable_logging: Optional[Any] = None, **kwargs)

(Deprecated. Please use LogSettings) Log storage settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• linked_service_name (LinkedServiceReference) – Required. Log storage linked service reference.

• path (any) – The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string).

• log_level (any) – Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string).

• enable_reliable_logging (any) – Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• linked_service_name (LinkedServiceReference) – Required. Log storage linked service reference.

• path (any) – The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string).

• log_level (any) – Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string).

• enable_reliable_logging (any) – Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.LookupActivity(*, name: str, source: azure.synapse.artifacts.models._models_py3.CopySource, dataset: azure.synapse.artifacts.models._models_py3.DatasetReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, first_row_only: Optional[Any] = None, **kwargs)

Lookup activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• source (CopySource) – Required. Dataset-specific source properties, same as copy activity source.

• dataset (DatasetReference) – Required. Lookup activity dataset reference.

• first_row_only (any) – Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• source (CopySource) – Required. Dataset-specific source properties, same as copy activity source.

• dataset (DatasetReference) – Required. Lookup activity dataset reference.

• first_row_only (any) – Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MagentoLinkedService(*, host: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, access_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Magento server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The URL of the Magento instance. (i.e. 192.168.222.110/magento3).

• access_token (SecretBase) – The access token from Magento.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The URL of the Magento instance. (i.e. 192.168.222.110/magento3).

• access_token (SecretBase) – The access token from Magento.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MagentoObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Magento server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MagentoSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Magento server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ManagedIdentity(*, type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.ResourceIdentityType]] = None, **kwargs)

The workspace managed identity.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• principal_id (str) – The principal ID of the workspace managed identity.

• tenant_id (str) – The tenant ID of the workspace managed identity.

• type (str or ResourceIdentityType) – The type of managed identity for the workspace. Possible values include: “None”, “SystemAssigned”.

Keyword Arguments

type (str or ResourceIdentityType) – The type of managed identity for the workspace. Possible values include: “None”, “SystemAssigned”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ManagedIntegrationRuntime(*, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, managed_virtual_network: Optional[azure.synapse.artifacts.models._models_py3.ManagedVirtualNetworkReference] = None, compute_properties: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeComputeProperties] = None, ssis_properties: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeSsisProperties] = None, **kwargs)

Managed integration runtime, including managed elastic and managed dedicated integration runtimes.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str or IntegrationRuntimeType) – Required. Type of integration runtime.Constant filled by server. Possible values include: “Managed”, “SelfHosted”.

• description (str) – Integration runtime description.

• state (str or IntegrationRuntimeState) – Integration runtime state, only valid for managed dedicated integration runtime. Possible values include: “Initial”, “Stopped”, “Started”, “Starting”, “Stopping”, “NeedRegistration”, “Online”, “Limited”, “Offline”, “AccessDenied”.

• managed_virtual_network (ManagedVirtualNetworkReference) – Managed Virtual Network reference.

• compute_properties (IntegrationRuntimeComputeProperties) – The compute resource for managed integration runtime.

• ssis_properties (IntegrationRuntimeSsisProperties) – SSIS properties for managed integration runtime.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Integration runtime description.

• managed_virtual_network (ManagedVirtualNetworkReference) – Managed Virtual Network reference.

• compute_properties (IntegrationRuntimeComputeProperties) – The compute resource for managed integration runtime.

• ssis_properties (IntegrationRuntimeSsisProperties) – SSIS properties for managed integration runtime.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ManagedVirtualNetworkReference(*, reference_name: str, **kwargs)

Managed Virtual Network reference type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – Managed Virtual Network reference type. Has constant value: “ManagedVirtualNetworkReference”.

• reference_name (str) – Required. Reference ManagedVirtualNetwork name.

Keyword Arguments

reference_name (str) – Required. Reference ManagedVirtualNetwork name.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

type = 'ManagedVirtualNetworkReference'

class azure.synapse.artifacts.models.ManagedVirtualNetworkSettings(*, prevent_data_exfiltration: Optional[bool] = None, linked_access_check_on_target_resource: Optional[bool] = None, allowed_aad_tenant_ids_for_linking: Optional[List[str]] = None, **kwargs)

Managed Virtual Network Settings.

Variables

• prevent_data_exfiltration (bool) – Prevent Data Exfiltration.

• linked_access_check_on_target_resource (bool) – Linked Access Check On Target Resource.

• allowed_aad_tenant_ids_for_linking (list[str]) – Allowed Aad Tenant Ids For Linking.

Keyword Arguments

• prevent_data_exfiltration (bool) – Prevent Data Exfiltration.

• linked_access_check_on_target_resource (bool) – Linked Access Check On Target Resource.

• allowed_aad_tenant_ids_for_linking (list[str]) – Allowed Aad Tenant Ids For Linking.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MappingDataFlow(*, description: Optional[str] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DataFlowFolder] = None, sources: Optional[List[azure.synapse.artifacts.models._models_py3.DataFlowSource]] = None, sinks: Optional[List[azure.synapse.artifacts.models._models_py3.DataFlowSink]] = None, transformations: Optional[List[azure.synapse.artifacts.models._models_py3.Transformation]] = None, script: Optional[str] = None, script_lines: Optional[List[str]] = None, **kwargs)

Mapping data flow.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – Required. Type of data flow.Constant filled by server.

• description (str) – The description of the data flow.

• annotations (list[any]) – List of tags that can be used for describing the data flow.

• folder (DataFlowFolder) – The folder that this data flow is in. If not specified, Data flow will appear at the root level.

• sources (list[DataFlowSource]) – List of sources in data flow.

• sinks (list[DataFlowSink]) – List of sinks in data flow.

• transformations (list[Transformation]) – List of transformations in data flow.

• script (str) – DataFlow script.

• script_lines (list[str]) – Data flow script lines.

Keyword Arguments

• description (str) – The description of the data flow.

• annotations (list[any]) – List of tags that can be used for describing the data flow.

• folder (DataFlowFolder) – The folder that this data flow is in. If not specified, Data flow will appear at the root level.

• sources (list[DataFlowSource]) – List of sources in data flow.

• sinks (list[DataFlowSink]) – List of sinks in data flow.

• transformations (list[Transformation]) – List of transformations in data flow.

• script (str) – DataFlow script.

• script_lines (list[str]) – Data flow script lines.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MariaDBLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, pwd: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

MariaDB server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MariaDBSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity MariaDB server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MariaDBTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

MariaDB server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MarketoLinkedService(*, endpoint: Any, client_id: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Marketo server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com).

• client_id (any) – Required. The client Id of your Marketo service.

• client_secret (SecretBase) – The client secret of your Marketo service.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com).

• client_id (any) – Required. The client Id of your Marketo service.

• client_secret (SecretBase) – The client secret of your Marketo service.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MarketoObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Marketo server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MarketoSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Marketo server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MetastoreRegisterObject(*, input_folder: str, **kwargs)

MetastoreRegisterObject.

All required parameters must be populated in order to send to Azure.

Variables

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

Keyword Arguments

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

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MetastoreRegistrationResponse(*, status: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.RequestStatus]] = None, **kwargs)

MetastoreRegistrationResponse.

Variables

status (str or RequestStatus) – Enumerates possible request statuses. Possible values include: “Running”, “Completed”, “Failed”.

Keyword Arguments

status (str or RequestStatus) – Enumerates possible request statuses. Possible values include: “Running”, “Completed”, “Failed”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MetastoreRequestSuccessResponse(*, status: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.ResourceStatus]] = None, **kwargs)

MetastoreRequestSuccessResponse.

Variables

status (str or ResourceStatus) – Enumerates possible Status of the resource. Possible values include: “Creating”, “Created”, “Failed”.

Keyword Arguments

status (str or ResourceStatus) – Enumerates possible Status of the resource. Possible values include: “Creating”, “Created”, “Failed”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MetastoreUpdateObject(*, input_folder: str, **kwargs)

MetastoreUpdateObject.

All required parameters must be populated in order to send to Azure.

Variables

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

Keyword Arguments

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

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MetastoreUpdationResponse(*, status: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.RequestStatus]] = None, **kwargs)

MetastoreUpdationResponse.

Variables

status (str or RequestStatus) – Enumerates possible request statuses. Possible values include: “Running”, “Completed”, “Failed”.

Keyword Arguments

status (str or RequestStatus) – Enumerates possible request statuses. Possible values include: “Running”, “Completed”, “Failed”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MicrosoftAccessLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, authentication_type: Optional[Any] = None, credential: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Microsoft Access linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.

• authentication_type (any) – Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).

• credential (SecretBase) – The access credential portion of the connection string specified in driver-specific property-value format.

• user_name (any) – User name for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for Basic authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.

• authentication_type (any) – Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).

• credential (SecretBase) – The access credential portion of the connection string specified in driver-specific property-value format.

• user_name (any) – User name for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for Basic authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MicrosoftAccessSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, pre_copy_script: Optional[Any] = None, **kwargs)

A copy activity Microsoft Access sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MicrosoftAccessSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity source for Microsoft Access.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Database query. Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Database query. Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MicrosoftAccessTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

The Microsoft Access table dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The Microsoft Access table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The Microsoft Access table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MongoDbAtlasCollectionDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, collection: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The MongoDB Atlas database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection (any) – Required. The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection (any) – Required. The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MongoDbAtlasLinkedService(*, connection_string: Any, database: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, **kwargs)

Linked service for MongoDB Atlas data source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

• database (any) – Required. The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

• database (any) – Required. The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MongoDbAtlasSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, filter: Optional[Any] = None, cursor_methods: Optional[azure.synapse.artifacts.models._models_py3.MongoDbCursorMethodsProperties] = None, batch_size: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity source for a MongoDB Atlas database.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• filter (any) – Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).

• cursor_methods (MongoDbCursorMethodsProperties) – Cursor methods for Mongodb query.

• batch_size (any) – Specifies the number of documents to return in each batch of the response from MongoDB Atlas instance. In most cases, modifying the batch size will not affect the user or the application. This property’s main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• filter (any) – Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).

• cursor_methods (MongoDbCursorMethodsProperties) – Cursor methods for Mongodb query.

• batch_size (any) – Specifies the number of documents to return in each batch of the response from MongoDB Atlas instance. In most cases, modifying the batch size will not affect the user or the application. This property’s main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MongoDbAuthenticationType(value)

The authentication type to be used to connect to the MongoDB database.

ANONYMOUS = 'Anonymous'

BASIC = 'Basic'

class azure.synapse.artifacts.models.MongoDbCollectionDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, collection_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The MongoDB database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection_name (any) – Required. The table name of the MongoDB database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection_name (any) – Required. The table name of the MongoDB database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MongoDbCursorMethodsProperties(*, additional_properties: Optional[Dict[str, Any]] = None, project: Optional[Any] = None, sort: Optional[Any] = None, skip: Optional[Any] = None, limit: Optional[Any] = None, **kwargs)

Cursor methods for Mongodb query.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• project (any) – Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string).

• sort (any) – Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).

• skip (any) – Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer).

• limit (any) – Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• project (any) – Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string).

• sort (any) – Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).

• skip (any) – Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer).

• limit (any) – Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MongoDbLinkedService(*, server: Any, database_name: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.MongoDbAuthenticationType]] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, auth_source: Optional[Any] = None, port: Optional[Any] = None, enable_ssl: Optional[Any] = None, allow_self_signed_server_cert: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for MongoDb data source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Required. The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).

• authentication_type (str or MongoDbAuthenticationType) – The authentication type to be used to connect to the MongoDB database. Possible values include: “Basic”, “Anonymous”.

• database_name (any) – Required. The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).

• username (any) – Username for authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for authentication.

• auth_source (any) – Database to verify the username and password. Type: string (or Expression with resultType string).

• port (any) – The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Required. The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).

• authentication_type (str or MongoDbAuthenticationType) – The authentication type to be used to connect to the MongoDB database. Possible values include: “Basic”, “Anonymous”.

• database_name (any) – Required. The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).

• username (any) – Username for authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for authentication.

• auth_source (any) – Database to verify the username and password. Type: string (or Expression with resultType string).

• port (any) – The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MongoDbSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity source for a MongoDB database.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MongoDbV2CollectionDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, collection: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The MongoDB database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection (any) – Required. The collection name of the MongoDB database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• collection (any) – Required. The collection name of the MongoDB database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MongoDbV2LinkedService(*, connection_string: Any, database: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, **kwargs)

Linked service for MongoDB data source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

• database (any) – Required. The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

• database (any) – Required. The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MongoDbV2Source(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, filter: Optional[Any] = None, cursor_methods: Optional[azure.synapse.artifacts.models._models_py3.MongoDbCursorMethodsProperties] = None, batch_size: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity source for a MongoDB database.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• filter (any) – Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).

• cursor_methods (MongoDbCursorMethodsProperties) – Cursor methods for Mongodb query.

• batch_size (any) – Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property’s main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• filter (any) – Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).

• cursor_methods (MongoDbCursorMethodsProperties) – Cursor methods for Mongodb query.

• batch_size (any) – Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property’s main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MultiplePipelineTrigger(*, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, annotations: Optional[List[Any]] = None, pipelines: Optional[List[azure.synapse.artifacts.models._models_py3.TriggerPipelineReference]] = None, **kwargs)

Base class for all triggers that support one to many model for trigger to pipeline.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BlobEventsTrigger, BlobTrigger, CustomEventsTrigger, ScheduleTrigger.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Trigger type.Constant filled by server.

• description (str) – Trigger description.

• runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: “Started”, “Stopped”, “Disabled”.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Trigger description.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MySqlLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for MySQL data source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MySqlSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity source for MySQL databases.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.MySqlTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

The MySQL table dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The MySQL table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The MySQL table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NetezzaLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, pwd: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Netezza linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NetezzaPartitionOption(value)

The partition mechanism that will be used for Netezza read in parallel.

DATA_SLICE = 'DataSlice'

DYNAMIC_RANGE = 'DynamicRange'

NONE = 'None'

class azure.synapse.artifacts.models.NetezzaPartitionSettings(*, partition_column_name: Optional[Any] = None, partition_upper_bound: Optional[Any] = None, partition_lower_bound: Optional[Any] = None, **kwargs)

The settings that will be leveraged for Netezza source partitioning.

Variables

• partition_column_name (any) – The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

Keyword Arguments

• partition_column_name (any) – The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NetezzaSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, partition_option: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.NetezzaPartitionOption]] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.NetezzaPartitionSettings] = None, **kwargs)

A copy activity Netezza source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

• partition_option (str or NetezzaPartitionOption) – The partition mechanism that will be used for Netezza read in parallel. Possible values include: “None”, “DataSlice”, “DynamicRange”.

• partition_settings (NetezzaPartitionSettings) – The settings that will be leveraged for Netezza source partitioning.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

• partition_option (str or NetezzaPartitionOption) – The partition mechanism that will be used for Netezza read in parallel. Possible values include: “None”, “DataSlice”, “DynamicRange”.

• partition_settings (NetezzaPartitionSettings) – The settings that will be leveraged for Netezza source partitioning.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NetezzaTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

Netezza dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Netezza. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Netezza. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Netezza. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Netezza. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NodeSize(value)

The level of compute power that each node in the Big Data pool has.

LARGE = 'Large'

MEDIUM = 'Medium'

NONE = 'None'

SMALL = 'Small'

XXX_LARGE = 'XXXLarge'

XX_LARGE = 'XXLarge'

X_LARGE = 'XLarge'

class azure.synapse.artifacts.models.NodeSizeFamily(value)

The kind of nodes that the Big Data pool provides.

MEMORY_OPTIMIZED = 'MemoryOptimized'

NONE = 'None'

class azure.synapse.artifacts.models.Notebook(*, metadata: azure.synapse.artifacts.models._models_py3.NotebookMetadata, nbformat: int, nbformat_minor: int, cells: List[azure.synapse.artifacts.models._models_py3.NotebookCell], additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, big_data_pool: Optional[azure.synapse.artifacts.models._models_py3.BigDataPoolReference] = None, session_properties: Optional[azure.synapse.artifacts.models._models_py3.NotebookSessionProperties] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.NotebookFolder] = None, **kwargs)

Notebook.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – The description of the notebook.

• big_data_pool (BigDataPoolReference) – Big data pool reference.

• session_properties (NotebookSessionProperties) – Session properties.

• metadata (NotebookMetadata) – Required. Notebook root-level metadata.

• nbformat (int) – Required. Notebook format (major number). Incremented between backwards incompatible changes to the notebook format.

• nbformat_minor (int) – Required. Notebook format (minor number). Incremented for backward compatible changes to the notebook format.

• cells (list[NotebookCell]) – Required. Array of cells of the current notebook.

• folder (NotebookFolder) – The folder that this notebook is in. If not specified, this notebook will appear at the root level.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – The description of the notebook.

• big_data_pool (BigDataPoolReference) – Big data pool reference.

• session_properties (NotebookSessionProperties) – Session properties.

• metadata (NotebookMetadata) – Required. Notebook root-level metadata.

• nbformat (int) – Required. Notebook format (major number). Incremented between backwards incompatible changes to the notebook format.

• nbformat_minor (int) – Required. Notebook format (minor number). Incremented for backward compatible changes to the notebook format.

• cells (list[NotebookCell]) – Required. Array of cells of the current notebook.

• folder (NotebookFolder) – The folder that this notebook is in. If not specified, this notebook will appear at the root level.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NotebookCell(*, cell_type: str, metadata: Any, source: List[str], additional_properties: Optional[Dict[str, Any]] = None, attachments: Optional[Any] = None, outputs: Optional[List[azure.synapse.artifacts.models._models_py3.NotebookCellOutputItem]] = None, **kwargs)

Notebook cell.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• cell_type (str) – Required. String identifying the type of cell.

• metadata (any) – Required. Cell-level metadata.

• source (list[str]) – Required. Contents of the cell, represented as an array of lines.

• attachments (any) – Attachments associated with the cell.

• outputs (list[NotebookCellOutputItem]) – Cell-level output items.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• cell_type (str) – Required. String identifying the type of cell.

• metadata (any) – Required. Cell-level metadata.

• source (list[str]) – Required. Contents of the cell, represented as an array of lines.

• attachments (any) – Attachments associated with the cell.

• outputs (list[NotebookCellOutputItem]) – Cell-level output items.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NotebookCellOutputItem(*, output_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.CellOutputType], name: Optional[str] = None, execution_count: Optional[int] = None, text: Optional[Any] = None, data: Optional[Any] = None, metadata: Optional[Any] = None, **kwargs)

An item of the notebook cell execution output.

All required parameters must be populated in order to send to Azure.

Variables

• name (str) – For output_type=stream, determines the name of stream (stdout / stderr).

• execution_count (int) – Execution sequence number.

• output_type (str or CellOutputType) – Required. Execution, display, or stream outputs. Possible values include: “execute_result”, “display_data”, “stream”, “error”.

• text (any) – For output_type=stream, the stream’s text output, represented as a string or an array of strings.

• data (any) – Output data. Use MIME type as key, and content as value.

• metadata (any) – Metadata for the output item.

Keyword Arguments

• name (str) – For output_type=stream, determines the name of stream (stdout / stderr).

• execution_count (int) – Execution sequence number.

• output_type (str or CellOutputType) – Required. Execution, display, or stream outputs. Possible values include: “execute_result”, “display_data”, “stream”, “error”.

• text (any) – For output_type=stream, the stream’s text output, represented as a string or an array of strings.

• data (any) – Output data. Use MIME type as key, and content as value.

• metadata (any) – Metadata for the output item.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NotebookFolder(*, name: Optional[str] = None, **kwargs)

The folder that this notebook is in. If not specified, this notebook will appear at the root level.

Variables

name (str) – The name of the folder that this notebook is in.

Keyword Arguments

name (str) – The name of the folder that this notebook is in.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NotebookKernelSpec(*, name: str, display_name: str, additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

Kernel information.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Name of the kernel specification.

• display_name (str) – Required. Name to display in UI.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Name of the kernel specification.

• display_name (str) – Required. Name to display in UI.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NotebookLanguageInfo(*, name: str, additional_properties: Optional[Dict[str, Any]] = None, codemirror_mode: Optional[str] = None, **kwargs)

Language info.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. The programming language which this kernel runs.

• codemirror_mode (str) – The codemirror mode to use for code in this language.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. The programming language which this kernel runs.

• codemirror_mode (str) – The codemirror mode to use for code in this language.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NotebookListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.NotebookResource], next_link: Optional[str] = None, **kwargs)

A list of Notebook resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[NotebookResource]) – Required. List of Notebooks.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[NotebookResource]) – Required. List of Notebooks.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NotebookMetadata(*, additional_properties: Optional[Dict[str, Any]] = None, kernelspec: Optional[azure.synapse.artifacts.models._models_py3.NotebookKernelSpec] = None, language_info: Optional[azure.synapse.artifacts.models._models_py3.NotebookLanguageInfo] = None, **kwargs)

Notebook root-level metadata.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• kernelspec (NotebookKernelSpec) – Kernel information.

• language_info (NotebookLanguageInfo) – Language info.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• kernelspec (NotebookKernelSpec) – Kernel information.

• language_info (NotebookLanguageInfo) – Language info.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NotebookParameter(*, value: Optional[Any] = None, type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.NotebookParameterType]] = None, **kwargs)

Notebook parameter.

Variables

• value (any) – Notebook parameter value. Type: string (or Expression with resultType string).

• type (str or NotebookParameterType) – Notebook parameter type. Possible values include: “string”, “int”, “float”, “bool”.

Keyword Arguments

• value (any) – Notebook parameter value. Type: string (or Expression with resultType string).

• type (str or NotebookParameterType) – Notebook parameter type. Possible values include: “string”, “int”, “float”, “bool”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NotebookParameterType(value)

Notebook parameter type.

BOOL = 'bool'

FLOAT = 'float'

INT = 'int'

STRING = 'string'

class azure.synapse.artifacts.models.NotebookReferenceType(value)

Synapse notebook reference type.

NOTEBOOK_REFERENCE = 'NotebookReference'

class azure.synapse.artifacts.models.NotebookResource(*, name: str, properties: azure.synapse.artifacts.models._models_py3.Notebook, **kwargs)

Notebook resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – Required. The name of the resource.

• type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

• etag (str) – Resource Etag.

• properties (Notebook) – Required. Properties of Notebook.

Keyword Arguments

• name (str) – Required. The name of the resource.

• properties (Notebook) – Required. Properties of Notebook.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.NotebookSessionProperties(*, driver_memory: str, driver_cores: int, executor_memory: str, executor_cores: int, num_executors: int, **kwargs)

Session properties.

All required parameters must be populated in order to send to Azure.

Variables

• driver_memory (str) – Required. Amount of memory to use for the driver process.

• driver_cores (int) – Required. Number of cores to use for the driver.

• executor_memory (str) – Required. Amount of memory to use per executor process.

• executor_cores (int) – Required. Number of cores to use for each executor.

• num_executors (int) – Required. Number of executors to launch for this session.

Keyword Arguments

• driver_memory (str) – Required. Amount of memory to use for the driver process.

• driver_cores (int) – Required. Number of cores to use for the driver.

• executor_memory (str) – Required. Amount of memory to use per executor process.

• executor_cores (int) – Required. Number of cores to use for each executor.

• num_executors (int) – Required. Number of executors to launch for this session.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType(value)

Specify the credential type (key or cert) is used for service principal.

SERVICE_PRINCIPAL_CERT = 'ServicePrincipalCert'

SERVICE_PRINCIPAL_KEY = 'ServicePrincipalKey'

class azure.synapse.artifacts.models.ODataAuthenticationType(value)

Type of authentication used to connect to the OData service.

AAD_SERVICE_PRINCIPAL = 'AadServicePrincipal'

ANONYMOUS = 'Anonymous'

BASIC = 'Basic'

MANAGED_SERVICE_IDENTITY = 'ManagedServiceIdentity'

WINDOWS = 'Windows'

class azure.synapse.artifacts.models.ODataLinkedService(*, url: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.ODataAuthenticationType]] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, service_principal_id: Optional[Any] = None, azure_cloud_type: Optional[Any] = None, aad_resource_id: Optional[Any] = None, aad_service_principal_credential_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.ODataAadServicePrincipalCredentialType]] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_principal_embedded_cert: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_principal_embedded_cert_password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Open Data Protocol (OData) linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The URL of the OData service endpoint. Type: string (or Expression with resultType string).

• authentication_type (str or ODataAuthenticationType) – Type of authentication used to connect to the OData service. Possible values include: “Basic”, “Anonymous”, “Windows”, “AadServicePrincipal”, “ManagedServiceIdentity”.

• user_name (any) – User name of the OData service. Type: string (or Expression with resultType string).

• password (SecretBase) – Password of the OData service.

• tenant (any) – Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).

• service_principal_id (any) – Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• aad_resource_id (any) – Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string).

• aad_service_principal_credential_type (str or ODataAadServicePrincipalCredentialType) – Specify the credential type (key or cert) is used for service principal. Possible values include: “ServicePrincipalKey”, “ServicePrincipalCert”.

• service_principal_key (SecretBase) – Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

• service_principal_embedded_cert (SecretBase) – Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

• service_principal_embedded_cert_password (SecretBase) – Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The URL of the OData service endpoint. Type: string (or Expression with resultType string).

• authentication_type (str or ODataAuthenticationType) – Type of authentication used to connect to the OData service. Possible values include: “Basic”, “Anonymous”, “Windows”, “AadServicePrincipal”, “ManagedServiceIdentity”.

• user_name (any) – User name of the OData service. Type: string (or Expression with resultType string).

• password (SecretBase) – Password of the OData service.

• tenant (any) – Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).

• service_principal_id (any) – Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• aad_resource_id (any) – Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string).

• aad_service_principal_credential_type (str or ODataAadServicePrincipalCredentialType) – Specify the credential type (key or cert) is used for service principal. Possible values include: “ServicePrincipalKey”, “ServicePrincipalCert”.

• service_principal_key (SecretBase) – Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

• service_principal_embedded_cert (SecretBase) – Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

• service_principal_embedded_cert_password (SecretBase) – Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ODataResourceDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, path: Optional[Any] = None, **kwargs)

The Open Data Protocol (OData) resource dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• path (any) – The OData resource path. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• path (any) – The OData resource path. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ODataSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, http_request_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity source for OData source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – OData query. For example, “$top=1”. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – OData query. For example, “$top=1”. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OdbcLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, authentication_type: Optional[Any] = None, credential: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Open Database Connectivity (ODBC) linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.

• authentication_type (any) – Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).

• credential (SecretBase) – The access credential portion of the connection string specified in driver-specific property-value format.

• user_name (any) – User name for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for Basic authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.

• authentication_type (any) – Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).

• credential (SecretBase) – The access credential portion of the connection string specified in driver-specific property-value format.

• user_name (any) – User name for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for Basic authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OdbcSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, pre_copy_script: Optional[Any] = None, **kwargs)

A copy activity ODBC sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OdbcSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity source for ODBC databases.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OdbcTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

The ODBC table dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The ODBC table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The ODBC table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Office365Dataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, table_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, predicate: Optional[Any] = None, **kwargs)

The Office365 account.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – Required. Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string).

• predicate (any) – A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – Required. Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string).

• predicate (any) – A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Office365LinkedService(*, office365_tenant_id: Any, service_principal_tenant_id: Any, service_principal_id: Any, service_principal_key: azure.synapse.artifacts.models._models_py3.SecretBase, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Office365 linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• office365_tenant_id (any) – Required. Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string).

• service_principal_tenant_id (any) – Required. Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string).

• service_principal_id (any) – Required. Specify the application’s client ID. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – Required. Specify the application’s key.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• office365_tenant_id (any) – Required. Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string).

• service_principal_tenant_id (any) – Required. Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string).

• service_principal_id (any) – Required. Specify the application’s client ID. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – Required. Specify the application’s key.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Office365Source(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, allowed_groups: Optional[Any] = None, user_scope_filter_uri: Optional[Any] = None, date_filter_column: Optional[Any] = None, start_time: Optional[Any] = None, end_time: Optional[Any] = None, output_columns: Optional[Any] = None, **kwargs)

A copy activity source for an Office 365 service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• allowed_groups (any) – The groups containing all the users. Type: array of strings (or Expression with resultType array of strings).

• user_scope_filter_uri (any) – The user scope uri. Type: string (or Expression with resultType string).

• date_filter_column (any) – The Column to apply the <paramref name="StartTime"/> and <paramref name="EndTime"/>. Type: string (or Expression with resultType string).

• start_time (any) – Start time of the requested range for this dataset. Type: string (or Expression with resultType string).

• end_time (any) – End time of the requested range for this dataset. Type: string (or Expression with resultType string).

• output_columns (any) – The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). Example: [ { “name”: “Id” }, { “name”: “CreatedDateTime” } ].

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• allowed_groups (any) – The groups containing all the users. Type: array of strings (or Expression with resultType array of strings).

• user_scope_filter_uri (any) – The user scope uri. Type: string (or Expression with resultType string).

• date_filter_column (any) – The Column to apply the <paramref name="StartTime"/> and <paramref name="EndTime"/>. Type: string (or Expression with resultType string).

• start_time (any) – Start time of the requested range for this dataset. Type: string (or Expression with resultType string).

• end_time (any) – End time of the requested range for this dataset. Type: string (or Expression with resultType string).

• output_columns (any) – The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). Example: [ { “name”: “Id” }, { “name”: “CreatedDateTime” } ].

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OperationResult(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[azure.synapse.artifacts.models._models_py3.CloudErrorAutoGenerated]] = None, **kwargs)

Operation status for the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• status (str) – Operation status.

• code (str) – Error code.

• message (str) – Error message.

• target (str) – Property name/path in request associated with error.

• details (list[CloudErrorAutoGenerated]) – Array with additional error details.

Keyword Arguments

• code (str) – Error code.

• message (str) – Error message.

• target (str) – Property name/path in request associated with error.

• details (list[CloudErrorAutoGenerated]) – Array with additional error details.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OracleLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Oracle database.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OraclePartitionOption(value)

The partition mechanism that will be used for Oracle read in parallel.

DYNAMIC_RANGE = 'DynamicRange'

NONE = 'None'

PHYSICAL_PARTITIONS_OF_TABLE = 'PhysicalPartitionsOfTable'

class azure.synapse.artifacts.models.OraclePartitionSettings(*, partition_names: Optional[Any] = None, partition_column_name: Optional[Any] = None, partition_upper_bound: Optional[Any] = None, partition_lower_bound: Optional[Any] = None, **kwargs)

The settings that will be leveraged for Oracle source partitioning.

Variables

• partition_names (any) – Names of the physical partitions of Oracle table.

• partition_column_name (any) – The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

Keyword Arguments

• partition_names (any) – Names of the physical partitions of Oracle table.

• partition_column_name (any) – The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OracleServiceCloudLinkedService(*, host: Any, username: Any, password: azure.synapse.artifacts.models._models_py3.SecretBase, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Oracle Service Cloud linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The URL of the Oracle Service Cloud instance.

• username (any) – Required. The user name that you use to access Oracle Service Cloud server.

• password (SecretBase) – Required. The password corresponding to the user name that you provided in the username key.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The URL of the Oracle Service Cloud instance.

• username (any) – Required. The user name that you use to access Oracle Service Cloud server.

• password (SecretBase) – Required. The password corresponding to the user name that you provided in the username key.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OracleServiceCloudObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Oracle Service Cloud dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OracleServiceCloudSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Oracle Service Cloud source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OracleSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, pre_copy_script: Optional[Any] = None, **kwargs)

A copy activity Oracle sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OracleSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, oracle_reader_query: Optional[Any] = None, query_timeout: Optional[Any] = None, partition_option: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.OraclePartitionOption]] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.OraclePartitionSettings] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Oracle source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• oracle_reader_query (any) – Oracle reader query. Type: string (or Expression with resultType string).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• partition_option (str or OraclePartitionOption) – The partition mechanism that will be used for Oracle read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (OraclePartitionSettings) – The settings that will be leveraged for Oracle source partitioning.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• oracle_reader_query (any) – Oracle reader query. Type: string (or Expression with resultType string).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• partition_option (str or OraclePartitionOption) – The partition mechanism that will be used for Oracle read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (OraclePartitionSettings) – The settings that will be leveraged for Oracle source partitioning.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OracleTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The on-premises Oracle database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string).

• table (any) – The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string).

• table (any) – The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OrcCompressionCodec(value)

An enumeration.

LZO = 'lzo'

NONE = 'none'

SNAPPY = 'snappy'

ZLIB = 'zlib'

class azure.synapse.artifacts.models.OrcDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, location: Optional[azure.synapse.artifacts.models._models_py3.DatasetLocation] = None, orc_compression_codec: Optional[Any] = None, **kwargs)

ORC dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the ORC data storage.

• orc_compression_codec (any) – The data orcCompressionCodec. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the ORC data storage.

• orc_compression_codec (any) – The data orcCompressionCodec. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OrcFormat(*, additional_properties: Optional[Dict[str, Any]] = None, serializer: Optional[Any] = None, deserializer: Optional[Any] = None, **kwargs)

The data stored in Optimized Row Columnar (ORC) format.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage format.Constant filled by server.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OrcSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreWriteSettings] = None, format_settings: Optional[azure.synapse.artifacts.models._models_py3.OrcWriteSettings] = None, **kwargs)

A copy activity ORC sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – ORC store settings.

• format_settings (OrcWriteSettings) – ORC format settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – ORC store settings.

• format_settings (OrcWriteSettings) – ORC format settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OrcSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreReadSettings] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity ORC source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – ORC store settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – ORC store settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.OrcWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_rows_per_file: Optional[Any] = None, file_name_prefix: Optional[Any] = None, **kwargs)

Orc write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• max_rows_per_file (any) – Limit the written file’s row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).

• file_name_prefix (any) – Specifies the file name pattern :code:`<fileNamePrefix>`_<fileIndex>.:code:<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_rows_per_file (any) – Limit the written file’s row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).

• file_name_prefix (any) – Specifies the file name pattern :code:`<fileNamePrefix>`_<fileIndex>.:code:<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ParameterSpecification(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.ParameterType], default_value: Optional[Any] = None, **kwargs)

Definition of a single parameter for an entity.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or ParameterType) – Required. Parameter type. Possible values include: “Object”, “String”, “Int”, “Float”, “Bool”, “Array”, “SecureString”.

• default_value (any) – Default value of parameter.

Keyword Arguments

• type (str or ParameterType) – Required. Parameter type. Possible values include: “Object”, “String”, “Int”, “Float”, “Bool”, “Array”, “SecureString”.

• default_value (any) – Default value of parameter.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ParameterType(value)

Parameter type.

ARRAY = 'Array'

BOOL = 'Bool'

FLOAT = 'Float'

INT = 'Int'

OBJECT = 'Object'

SECURE_STRING = 'SecureString'

STRING = 'String'

class azure.synapse.artifacts.models.ParquetCompressionCodecEnum(value)

An enumeration.

GZIP = 'gzip'

LZO = 'lzo'

NONE = 'none'

SNAPPY = 'snappy'

class azure.synapse.artifacts.models.ParquetDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, location: Optional[azure.synapse.artifacts.models._models_py3.DatasetLocation] = None, compression_codec: Optional[Any] = None, **kwargs)

Parquet dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the parquet storage.

• compression_codec (any) – A string from ParquetCompressionCodecEnum or an expression.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the parquet storage.

• compression_codec (any) – A string from ParquetCompressionCodecEnum or an expression.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ParquetFormat(*, additional_properties: Optional[Dict[str, Any]] = None, serializer: Optional[Any] = None, deserializer: Optional[Any] = None, **kwargs)

The data stored in Parquet format.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage format.Constant filled by server.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ParquetSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreWriteSettings] = None, format_settings: Optional[azure.synapse.artifacts.models._models_py3.ParquetWriteSettings] = None, **kwargs)

A copy activity Parquet sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – Parquet store settings.

• format_settings (ParquetWriteSettings) – Parquet format settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreWriteSettings) – Parquet store settings.

• format_settings (ParquetWriteSettings) – Parquet format settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ParquetSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreReadSettings] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Parquet source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Parquet store settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Parquet store settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ParquetWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_rows_per_file: Optional[Any] = None, file_name_prefix: Optional[Any] = None, **kwargs)

Parquet write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• max_rows_per_file (any) – Limit the written file’s row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).

• file_name_prefix (any) – Specifies the file name pattern :code:`<fileNamePrefix>`_<fileIndex>.:code:<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_rows_per_file (any) – Limit the written file’s row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).

• file_name_prefix (any) – Specifies the file name pattern :code:`<fileNamePrefix>`_<fileIndex>.:code:<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PaypalLinkedService(*, host: Any, client_id: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Paypal Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The URL of the PayPal instance. (i.e. api.sandbox.paypal.com).

• client_id (any) – Required. The client ID associated with your PayPal application.

• client_secret (SecretBase) – The client secret associated with your PayPal application.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The URL of the PayPal instance. (i.e. api.sandbox.paypal.com).

• client_id (any) – Required. The client ID associated with your PayPal application.

• client_secret (SecretBase) – The client secret associated with your PayPal application.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PaypalObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Paypal Service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PaypalSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Paypal Service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PhoenixAuthenticationType(value)

The authentication mechanism used to connect to the Phoenix server.

ANONYMOUS = 'Anonymous'

USERNAME_AND_PASSWORD = 'UsernameAndPassword'

WINDOWS_AZURE_HD_INSIGHT_SERVICE = 'WindowsAzureHDInsightService'

class azure.synapse.artifacts.models.PhoenixLinkedService(*, host: Any, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.PhoenixAuthenticationType], additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, port: Optional[Any] = None, http_path: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, enable_ssl: Optional[Any] = None, trusted_cert_path: Optional[Any] = None, use_system_trust_store: Optional[Any] = None, allow_host_name_cn_mismatch: Optional[Any] = None, allow_self_signed_server_cert: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Phoenix server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The IP address or host name of the Phoenix server. (i.e. 192.168.222.160).

• port (any) – The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.

• http_path (any) – The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.

• authentication_type (str or PhoenixAuthenticationType) – Required. The authentication mechanism used to connect to the Phoenix server. Possible values include: “Anonymous”, “UsernameAndPassword”, “WindowsAzureHDInsightService”.

• username (any) – The user name used to connect to the Phoenix server.

• password (SecretBase) – The password corresponding to the user name.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The IP address or host name of the Phoenix server. (i.e. 192.168.222.160).

• port (any) – The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.

• http_path (any) – The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.

• authentication_type (str or PhoenixAuthenticationType) – Required. The authentication mechanism used to connect to the Phoenix server. Possible values include: “Anonymous”, “UsernameAndPassword”, “WindowsAzureHDInsightService”.

• username (any) – The user name used to connect to the Phoenix server.

• password (SecretBase) – The password corresponding to the user name.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PhoenixObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

Phoenix server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Phoenix. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Phoenix. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Phoenix. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Phoenix. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PhoenixSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Phoenix server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PipelineFolder(*, name: Optional[str] = None, **kwargs)

The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.

Variables

name (str) – The name of the folder that this Pipeline is in.

Keyword Arguments

name (str) – The name of the folder that this Pipeline is in.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PipelineListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.PipelineResource], next_link: Optional[str] = None, **kwargs)

A list of pipeline resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[PipelineResource]) – Required. List of pipelines.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[PipelineResource]) – Required. List of pipelines.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PipelineReference(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.PipelineReferenceType], reference_name: str, name: Optional[str] = None, **kwargs)

Pipeline reference type.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or PipelineReferenceType) – Required. Pipeline reference type. Possible values include: “PipelineReference”.

• reference_name (str) – Required. Reference pipeline name.

• name (str) – Reference name.

Keyword Arguments

• type (str or PipelineReferenceType) – Required. Pipeline reference type. Possible values include: “PipelineReference”.

• reference_name (str) – Required. Reference pipeline name.

• name (str) – Reference name.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PipelineReferenceType(value)

Pipeline reference type.

PIPELINE_REFERENCE = 'PipelineReference'

class azure.synapse.artifacts.models.PipelineResource(*, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, activities: Optional[List[azure.synapse.artifacts.models._models_py3.Activity]] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, variables: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.VariableSpecification]] = None, concurrency: Optional[int] = None, annotations: Optional[List[Any]] = None, run_dimensions: Optional[Dict[str, Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.PipelineFolder] = None, **kwargs)

Pipeline resource type.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – The description of the pipeline.

• activities (list[Activity]) – List of activities in pipeline.

• parameters (dict[str, ParameterSpecification]) – List of parameters for pipeline.

• variables (dict[str, VariableSpecification]) – List of variables for pipeline.

• concurrency (int) – The max number of concurrent runs for the pipeline.

• annotations (list[any]) – List of tags that can be used for describing the Pipeline.

• run_dimensions (dict[str, any]) – Dimensions emitted by Pipeline.

• folder (PipelineFolder) – The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – The description of the pipeline.

• activities (list[Activity]) – List of activities in pipeline.

• parameters (dict[str, ParameterSpecification]) – List of parameters for pipeline.

• variables (dict[str, VariableSpecification]) – List of variables for pipeline.

• concurrency (int) – The max number of concurrent runs for the pipeline.

• annotations (list[any]) – List of tags that can be used for describing the Pipeline.

• run_dimensions (dict[str, any]) – Dimensions emitted by Pipeline.

• folder (PipelineFolder) – The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PipelineRun(*, additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

Information about a pipeline run.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• run_id (str) – Identifier of a run.

• run_group_id (str) – Identifier that correlates all the recovery runs of a pipeline run.

• is_latest (bool) – Indicates if the recovered pipeline run is the latest in its group.

• pipeline_name (str) – The pipeline name.

• parameters (dict[str, str]) – The full or partial list of parameter name, value pair used in the pipeline run.

• invoked_by (PipelineRunInvokedBy) – Entity that started the pipeline run.

• last_updated (datetime) – The last updated timestamp for the pipeline run event in ISO8601 format.

• run_start (datetime) – The start time of a pipeline run in ISO8601 format.

• run_end (datetime) – The end time of a pipeline run in ISO8601 format.

• duration_in_ms (int) – The duration of a pipeline run.

• status (str) – The status of a pipeline run.

• message (str) – The message from a pipeline run.

Keyword Arguments

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PipelineRunInvokedBy(**kwargs)

Provides entity name and id that started the pipeline run.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• name (str) – Name of the entity that started the pipeline run.

• id (str) – The ID of the entity that started the run.

• invoked_by_type (str) – The type of the entity that started the run.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PipelineRunsQueryResponse(*, value: List[azure.synapse.artifacts.models._models_py3.PipelineRun], continuation_token: Optional[str] = None, **kwargs)

A list pipeline runs.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[PipelineRun]) – Required. List of pipeline runs.

• continuation_token (str) – The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

Keyword Arguments

• value (list[PipelineRun]) – Required. List of pipeline runs.

• continuation_token (str) – The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PluginCurrentState(value)

An enumeration.

CLEANUP = 'Cleanup'

ENDED = 'Ended'

MONITORING = 'Monitoring'

PREPARATION = 'Preparation'

QUEUED = 'Queued'

RESOURCE_ACQUISITION = 'ResourceAcquisition'

SUBMISSION = 'Submission'

class azure.synapse.artifacts.models.PolybaseSettings(*, additional_properties: Optional[Dict[str, Any]] = None, reject_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.PolybaseSettingsRejectType]] = None, reject_value: Optional[Any] = None, reject_sample_value: Optional[Any] = None, use_type_default: Optional[Any] = None, **kwargs)

PolyBase settings.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• reject_type (str or PolybaseSettingsRejectType) – Reject type. Possible values include: “value”, “percentage”.

• reject_value (any) – Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0.

• reject_sample_value (any) – Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0.

• use_type_default (any) – Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• reject_type (str or PolybaseSettingsRejectType) – Reject type. Possible values include: “value”, “percentage”.

• reject_value (any) – Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0.

• reject_sample_value (any) – Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0.

• use_type_default (any) – Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PolybaseSettingsRejectType(value)

Indicates whether the RejectValue property is specified as a literal value or a percentage.

PERCENTAGE = 'percentage'

VALUE = 'value'

class azure.synapse.artifacts.models.PostgreSqlLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for PostgreSQL data source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PostgreSqlSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity source for PostgreSQL databases.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PostgreSqlTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

The PostgreSQL table dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The PostgreSQL table name. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The PostgreSQL schema name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The PostgreSQL table name. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The PostgreSQL schema name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PrestoAuthenticationType(value)

The authentication mechanism used to connect to the Presto server.

ANONYMOUS = 'Anonymous'

LDAP = 'LDAP'

class azure.synapse.artifacts.models.PrestoLinkedService(*, host: Any, server_version: Any, catalog: Any, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.PrestoAuthenticationType], additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, port: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, enable_ssl: Optional[Any] = None, trusted_cert_path: Optional[Any] = None, use_system_trust_store: Optional[Any] = None, allow_host_name_cn_mismatch: Optional[Any] = None, allow_self_signed_server_cert: Optional[Any] = None, time_zone_id: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Presto server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The IP address or host name of the Presto server. (i.e. 192.168.222.160).

• server_version (any) – Required. The version of the Presto server. (i.e. 0.148-t).

• catalog (any) – Required. The catalog context for all request against the server.

• port (any) – The TCP port that the Presto server uses to listen for client connections. The default value is 8080.

• authentication_type (str or PrestoAuthenticationType) – Required. The authentication mechanism used to connect to the Presto server. Possible values include: “Anonymous”, “LDAP”.

• username (any) – The user name used to connect to the Presto server.

• password (SecretBase) – The password corresponding to the user name.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• time_zone_id (any) – The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The IP address or host name of the Presto server. (i.e. 192.168.222.160).

• server_version (any) – Required. The version of the Presto server. (i.e. 0.148-t).

• catalog (any) – Required. The catalog context for all request against the server.

• port (any) – The TCP port that the Presto server uses to listen for client connections. The default value is 8080.

• authentication_type (str or PrestoAuthenticationType) – Required. The authentication mechanism used to connect to the Presto server. Possible values include: “Anonymous”, “LDAP”.

• username (any) – The user name used to connect to the Presto server.

• password (SecretBase) – The password corresponding to the user name.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• time_zone_id (any) – The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PrestoObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

Presto server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Presto. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Presto. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Presto. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Presto. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PrestoSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Presto server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PrivateEndpoint(**kwargs)

Private endpoint details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource id of the private endpoint.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PrivateEndpointConnection(*, private_endpoint: Optional[azure.synapse.artifacts.models._models_py3.PrivateEndpoint] = None, private_link_service_connection_state: Optional[azure.synapse.artifacts.models._models_py3.PrivateLinkServiceConnectionState] = None, **kwargs)

A private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• private_endpoint (PrivateEndpoint) – The private endpoint which the connection belongs to.

• private_link_service_connection_state (PrivateLinkServiceConnectionState) – Connection state of the private endpoint connection.

• provisioning_state (str) – Provisioning state of the private endpoint connection.

Keyword Arguments

• private_endpoint (PrivateEndpoint) – The private endpoint which the connection belongs to.

• private_link_service_connection_state (PrivateLinkServiceConnectionState) – Connection state of the private endpoint connection.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PrivateLinkServiceConnectionState(*, status: Optional[str] = None, description: Optional[str] = None, **kwargs)

Connection state details of the private endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• status (str) – The private link service connection status.

• description (str) – The private link service connection description.

• actions_required (str) – The actions required for private link service connection.

Keyword Arguments

• status (str) – The private link service connection status.

• description (str) – The private link service connection description.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ProxyResource(**kwargs)

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.PurviewConfiguration(*, purview_resource_id: Optional[str] = None, **kwargs)

Purview Configuration.

Variables

purview_resource_id (str) – Purview Resource ID.

Keyword Arguments

purview_resource_id (str) – Purview Resource ID.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse(*, value: Optional[List[azure.synapse.artifacts.models._models_py3.DataFlowDebugSessionInfo]] = None, next_link: Optional[str] = None, **kwargs)

A list of active debug sessions.

Variables

• value (list[DataFlowDebugSessionInfo]) – Array with all active debug sessions.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[DataFlowDebugSessionInfo]) – Array with all active debug sessions.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.QuickBooksLinkedService(*, endpoint: Any, company_id: Any, consumer_key: Any, consumer_secret: azure.synapse.artifacts.models._models_py3.SecretBase, access_token: azure.synapse.artifacts.models._models_py3.SecretBase, access_token_secret: azure.synapse.artifacts.models._models_py3.SecretBase, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_properties: Optional[Any] = None, use_encrypted_endpoints: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

QuickBooks server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.

• endpoint (any) – Required. The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com).

• company_id (any) – Required. The company ID of the QuickBooks company to authorize.

• consumer_key (any) – Required. The consumer key for OAuth 1.0 authentication.

• consumer_secret (SecretBase) – Required. The consumer secret for OAuth 1.0 authentication.

• access_token (SecretBase) – Required. The access token for OAuth 1.0 authentication.

• access_token_secret (SecretBase) – Required. The access token secret for OAuth 1.0 authentication.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.

• endpoint (any) – Required. The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com).

• company_id (any) – Required. The company ID of the QuickBooks company to authorize.

• consumer_key (any) – Required. The consumer key for OAuth 1.0 authentication.

• consumer_secret (SecretBase) – Required. The consumer secret for OAuth 1.0 authentication.

• access_token (SecretBase) – Required. The access token for OAuth 1.0 authentication.

• access_token_secret (SecretBase) – Required. The access token secret for OAuth 1.0 authentication.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.QuickBooksObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

QuickBooks server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.QuickBooksSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity QuickBooks server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RecurrenceFrequency(value)

Enumerates possible frequency option for the schedule trigger.

DAY = 'Day'

HOUR = 'Hour'

MINUTE = 'Minute'

MONTH = 'Month'

NOT_SPECIFIED = 'NotSpecified'

WEEK = 'Week'

YEAR = 'Year'

class azure.synapse.artifacts.models.RecurrenceSchedule(*, additional_properties: Optional[Dict[str, Any]] = None, minutes: Optional[List[int]] = None, hours: Optional[List[int]] = None, week_days: Optional[List[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DayOfWeek]]] = None, month_days: Optional[List[int]] = None, monthly_occurrences: Optional[List[azure.synapse.artifacts.models._models_py3.RecurrenceScheduleOccurrence]] = None, **kwargs)

The recurrence schedule.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• minutes (list[int]) – The minutes.

• hours (list[int]) – The hours.

• week_days (list[str or DayOfWeek]) – The days of the week.

• month_days (list[int]) – The month days.

• monthly_occurrences (list[RecurrenceScheduleOccurrence]) – The monthly occurrences.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• minutes (list[int]) – The minutes.

• hours (list[int]) – The hours.

• week_days (list[str or DayOfWeek]) – The days of the week.

• month_days (list[int]) – The month days.

• monthly_occurrences (list[RecurrenceScheduleOccurrence]) – The monthly occurrences.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RecurrenceScheduleOccurrence(*, additional_properties: Optional[Dict[str, Any]] = None, day: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DayOfWeek]] = None, occurrence: Optional[int] = None, **kwargs)

The recurrence schedule occurrence.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• day (str or DayOfWeek) – The day of the week. Possible values include: “Sunday”, “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”.

• occurrence (int) – The occurrence.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• day (str or DayOfWeek) – The day of the week. Possible values include: “Sunday”, “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”.

• occurrence (int) – The occurrence.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RedirectIncompatibleRowSettings(*, linked_service_name: Any, additional_properties: Optional[Dict[str, Any]] = None, path: Optional[Any] = None, **kwargs)

Redirect incompatible row settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• linked_service_name (any) – Required. Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string).

• path (any) – The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• linked_service_name (any) – Required. Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string).

• path (any) – The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RedshiftUnloadSettings(*, s3_linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, bucket_name: Any, **kwargs)

The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.

All required parameters must be populated in order to send to Azure.

Variables

• s3_linked_service_name (LinkedServiceReference) – Required. The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.

• bucket_name (any) – Required. The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string).

Keyword Arguments

• s3_linked_service_name (LinkedServiceReference) – Required. The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.

• bucket_name (any) – Required. The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RelationalSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity source for various relational databases.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Database query. Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Database query. Type: string (or Expression with resultType string).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RelationalTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

The relational table dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The relational table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The relational table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RequestStatus(value)

Enumerates possible request statuses.

COMPLETED = 'Completed'

FAILED = 'Failed'

RUNNING = 'Running'

class azure.synapse.artifacts.models.RerunTriggerListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.RerunTriggerResource], **kwargs)

A list of rerun triggers.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[RerunTriggerResource]) – Required. List of rerun triggers.

• next_link (str) – The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

Keyword Arguments

value (list[RerunTriggerResource]) – Required. List of rerun triggers.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RerunTriggerResource(*, properties: azure.synapse.artifacts.models._models_py3.RerunTumblingWindowTrigger, **kwargs)

RerunTrigger resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• properties (RerunTumblingWindowTrigger) – Required. Properties of the rerun trigger.

Keyword Arguments

properties (RerunTumblingWindowTrigger) – Required. Properties of the rerun trigger.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RerunTumblingWindowTrigger(*, parent_trigger: Any, requested_start_time: datetime.datetime, requested_end_time: datetime.datetime, rerun_concurrency: int, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, annotations: Optional[List[Any]] = None, **kwargs)

Trigger that schedules pipeline reruns for all fixed time interval windows from a requested start time to requested end time.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Trigger type.Constant filled by server.

• description (str) – Trigger description.

• runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: “Started”, “Stopped”, “Disabled”.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• parent_trigger (any) – Required. The parent trigger reference.

• requested_start_time (datetime) – Required. The start time for the time period for which restatement is initiated. Only UTC time is currently supported.

• requested_end_time (datetime) – Required. The end time for the time period for which restatement is initiated. Only UTC time is currently supported.

• rerun_concurrency (int) – Required. The max number of parallel time windows (ready for execution) for which a rerun is triggered.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Trigger description.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• parent_trigger (any) – Required. The parent trigger reference.

• requested_start_time (datetime) – Required. The start time for the time period for which restatement is initiated. Only UTC time is currently supported.

• requested_end_time (datetime) – Required. The end time for the time period for which restatement is initiated. Only UTC time is currently supported.

• rerun_concurrency (int) – Required. The max number of parallel time windows (ready for execution) for which a rerun is triggered.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters(*, start_time: datetime.datetime, end_time: datetime.datetime, max_concurrency: int, **kwargs)

Rerun tumbling window trigger Parameters.

All required parameters must be populated in order to send to Azure.

Variables

• start_time (datetime) – Required. The start time for the time period for which restatement is initiated. Only UTC time is currently supported.

• end_time (datetime) – Required. The end time for the time period for which restatement is initiated. Only UTC time is currently supported.

• max_concurrency (int) – Required. The max number of parallel time windows (ready for execution) for which a rerun is triggered.

Keyword Arguments

• start_time (datetime) – Required. The start time for the time period for which restatement is initiated. Only UTC time is currently supported.

• end_time (datetime) – Required. The end time for the time period for which restatement is initiated. Only UTC time is currently supported.

• max_concurrency (int) – Required. The max number of parallel time windows (ready for execution) for which a rerun is triggered.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Resource(**kwargs)

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ResourceIdentityType(value)

The type of managed identity for the workspace

NONE = 'None'

SYSTEM_ASSIGNED = 'SystemAssigned'

class azure.synapse.artifacts.models.ResourceStatus(value)

Enumerates possible Status of the resource.

CREATED = 'Created'

CREATING = 'Creating'

FAILED = 'Failed'

class azure.synapse.artifacts.models.ResponsysLinkedService(*, endpoint: Any, client_id: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Responsys linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of the Responsys server.

• client_id (any) – Required. The client ID associated with the Responsys application. Type: string (or Expression with resultType string).

• client_secret (SecretBase) – The client secret associated with the Responsys application. Type: string (or Expression with resultType string).

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of the Responsys server.

• client_id (any) – Required. The client ID associated with the Responsys application. Type: string (or Expression with resultType string).

• client_secret (SecretBase) – The client secret associated with the Responsys application. Type: string (or Expression with resultType string).

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ResponsysObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Responsys dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ResponsysSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Responsys source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RestResourceDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, relative_url: Optional[Any] = None, request_method: Optional[Any] = None, request_body: Optional[Any] = None, additional_headers: Optional[Any] = None, pagination_rules: Optional[Any] = None, **kwargs)

A Rest service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• relative_url (any) – The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).

• request_method (any) – The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

• request_body (any) – The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

• additional_headers (any) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

• pagination_rules (any) – The pagination rules to compose next page requests. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• relative_url (any) – The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).

• request_method (any) – The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

• request_body (any) – The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

• additional_headers (any) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

• pagination_rules (any) – The pagination rules to compose next page requests. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RestServiceAuthenticationType(value)

Type of authentication used to connect to the REST service.

AAD_SERVICE_PRINCIPAL = 'AadServicePrincipal'

ANONYMOUS = 'Anonymous'

BASIC = 'Basic'

MANAGED_SERVICE_IDENTITY = 'ManagedServiceIdentity'

class azure.synapse.artifacts.models.RestServiceLinkedService(*, url: Any, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.RestServiceAuthenticationType], additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, enable_server_certificate_validation: Optional[Any] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_principal_id: Optional[Any] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[Any] = None, azure_cloud_type: Optional[Any] = None, aad_resource_id: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Rest Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The base URL of the REST service.

• enable_server_certificate_validation (any) – Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).

• authentication_type (str or RestServiceAuthenticationType) – Required. Type of authentication used to connect to the REST service. Possible values include: “Anonymous”, “Basic”, “AadServicePrincipal”, “ManagedServiceIdentity”.

• user_name (any) – The user name used in Basic authentication type.

• password (SecretBase) – The password used in Basic authentication type.

• service_principal_id (any) – The application’s client ID used in AadServicePrincipal authentication type.

• service_principal_key (SecretBase) – The application’s key used in AadServicePrincipal authentication type.

• tenant (any) – The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• aad_resource_id (any) – The resource you are requesting authorization to use.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The base URL of the REST service.

• enable_server_certificate_validation (any) – Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).

• authentication_type (str or RestServiceAuthenticationType) – Required. Type of authentication used to connect to the REST service. Possible values include: “Anonymous”, “Basic”, “AadServicePrincipal”, “ManagedServiceIdentity”.

• user_name (any) – The user name used in Basic authentication type.

• password (SecretBase) – The password used in Basic authentication type.

• service_principal_id (any) – The application’s client ID used in AadServicePrincipal authentication type.

• service_principal_key (SecretBase) – The application’s key used in AadServicePrincipal authentication type.

• tenant (any) – The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.

• azure_cloud_type (any) – Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

• aad_resource_id (any) – The resource you are requesting authorization to use.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RestSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, request_method: Optional[Any] = None, additional_headers: Optional[Any] = None, http_request_timeout: Optional[Any] = None, request_interval: Optional[Any] = None, http_compression_type: Optional[Any] = None, **kwargs)

A copy activity Rest service Sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• request_method (any) – The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string).

• additional_headers (any) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• request_interval (any) – The time to await before sending next request, in milliseconds.

• http_compression_type (any) – Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• request_method (any) – The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string).

• additional_headers (any) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• request_interval (any) – The time to await before sending next request, in milliseconds.

• http_compression_type (any) – Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RestSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, request_method: Optional[Any] = None, request_body: Optional[Any] = None, additional_headers: Optional[Any] = None, pagination_rules: Optional[Any] = None, http_request_timeout: Optional[Any] = None, request_interval: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Rest service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• request_method (any) – The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

• request_body (any) – The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

• additional_headers (any) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

• pagination_rules (any) – The pagination rules to compose next page requests. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• request_interval (any) – The time to await before sending next page request.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• request_method (any) – The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).

• request_body (any) – The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).

• additional_headers (any) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

• pagination_rules (any) – The pagination rules to compose next page requests. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• request_interval (any) – The time to await before sending next page request.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RetryPolicy(*, count: Optional[Any] = None, interval_in_seconds: Optional[int] = None, **kwargs)

Execution policy for an activity.

Variables

• count (any) – Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.

• interval_in_seconds (int) – Interval between retries in seconds. Default is 30.

Keyword Arguments

• count (any) – Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.

• interval_in_seconds (int) – Interval between retries in seconds. Default is 30.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RunFilterParameters(*, last_updated_after: datetime.datetime, last_updated_before: datetime.datetime, continuation_token: Optional[str] = None, filters: Optional[List[azure.synapse.artifacts.models._models_py3.RunQueryFilter]] = None, order_by: Optional[List[azure.synapse.artifacts.models._models_py3.RunQueryOrderBy]] = None, **kwargs)

Query parameters for listing runs.

All required parameters must be populated in order to send to Azure.

Variables

• continuation_token (str) – The continuation token for getting the next page of results. Null for first page.

• last_updated_after (datetime) – Required. The time at or after which the run event was updated in ‘ISO 8601’ format.

• last_updated_before (datetime) – Required. The time at or before which the run event was updated in ‘ISO 8601’ format.

• filters (list[RunQueryFilter]) – List of filters.

• order_by (list[RunQueryOrderBy]) – List of OrderBy option.

Keyword Arguments

• continuation_token (str) – The continuation token for getting the next page of results. Null for first page.

• last_updated_after (datetime) – Required. The time at or after which the run event was updated in ‘ISO 8601’ format.

• last_updated_before (datetime) – Required. The time at or before which the run event was updated in ‘ISO 8601’ format.

• filters (list[RunQueryFilter]) – List of filters.

• order_by (list[RunQueryOrderBy]) – List of OrderBy option.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RunQueryFilter(*, operand: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.RunQueryFilterOperand], operator: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.RunQueryFilterOperator], values: List[str], **kwargs)

Query filter option for listing runs.

All required parameters must be populated in order to send to Azure.

Variables

• operand (str or RunQueryFilterOperand) – Required. Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. Possible values include: “PipelineName”, “Status”, “RunStart”, “RunEnd”, “ActivityName”, “ActivityRunStart”, “ActivityRunEnd”, “ActivityType”, “TriggerName”, “TriggerRunTimestamp”, “RunGroupId”, “LatestOnly”.

• operator (str or RunQueryFilterOperator) – Required. Operator to be used for filter. Possible values include: “Equals”, “NotEquals”, “In”, “NotIn”.

• values (list[str]) – Required. List of filter values.

Keyword Arguments

• operand (str or RunQueryFilterOperand) – Required. Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. Possible values include: “PipelineName”, “Status”, “RunStart”, “RunEnd”, “ActivityName”, “ActivityRunStart”, “ActivityRunEnd”, “ActivityType”, “TriggerName”, “TriggerRunTimestamp”, “RunGroupId”, “LatestOnly”.

• operator (str or RunQueryFilterOperator) – Required. Operator to be used for filter. Possible values include: “Equals”, “NotEquals”, “In”, “NotIn”.

• values (list[str]) – Required. List of filter values.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RunQueryFilterOperand(value)

Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.

ACTIVITY_NAME = 'ActivityName'

ACTIVITY_RUN_END = 'ActivityRunEnd'

ACTIVITY_RUN_START = 'ActivityRunStart'

ACTIVITY_TYPE = 'ActivityType'

LATEST_ONLY = 'LatestOnly'

PIPELINE_NAME = 'PipelineName'

RUN_END = 'RunEnd'

RUN_GROUP_ID = 'RunGroupId'

RUN_START = 'RunStart'

STATUS = 'Status'

TRIGGER_NAME = 'TriggerName'

TRIGGER_RUN_TIMESTAMP = 'TriggerRunTimestamp'

class azure.synapse.artifacts.models.RunQueryFilterOperator(value)

Operator to be used for filter.

EQUALS = 'Equals'

IN_ENUM = 'In'

NOT_EQUALS = 'NotEquals'

NOT_IN = 'NotIn'

class azure.synapse.artifacts.models.RunQueryOrder(value)

Sorting order of the parameter.

ASC = 'ASC'

DESC = 'DESC'

class azure.synapse.artifacts.models.RunQueryOrderBy(*, order_by: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.RunQueryOrderByField], order: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.RunQueryOrder], **kwargs)

An object to provide order by options for listing runs.

All required parameters must be populated in order to send to Azure.

Variables

• order_by (str or RunQueryOrderByField) – Required. Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. Possible values include: “RunStart”, “RunEnd”, “PipelineName”, “Status”, “ActivityName”, “ActivityRunStart”, “ActivityRunEnd”, “TriggerName”, “TriggerRunTimestamp”.

• order (str or RunQueryOrder) – Required. Sorting order of the parameter. Possible values include: “ASC”, “DESC”.

Keyword Arguments

• order_by (str or RunQueryOrderByField) – Required. Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. Possible values include: “RunStart”, “RunEnd”, “PipelineName”, “Status”, “ActivityName”, “ActivityRunStart”, “ActivityRunEnd”, “TriggerName”, “TriggerRunTimestamp”.

• order (str or RunQueryOrder) – Required. Sorting order of the parameter. Possible values include: “ASC”, “DESC”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.RunQueryOrderByField(value)

Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.

ACTIVITY_NAME = 'ActivityName'

ACTIVITY_RUN_END = 'ActivityRunEnd'

ACTIVITY_RUN_START = 'ActivityRunStart'

PIPELINE_NAME = 'PipelineName'

RUN_END = 'RunEnd'

RUN_START = 'RunStart'

STATUS = 'Status'

TRIGGER_NAME = 'TriggerName'

TRIGGER_RUN_TIMESTAMP = 'TriggerRunTimestamp'

class azure.synapse.artifacts.models.SSISAccessCredential(*, domain: Any, user_name: Any, password: azure.synapse.artifacts.models._models_py3.SecretBase, **kwargs)

SSIS access credential.

All required parameters must be populated in order to send to Azure.

Variables

• domain (any) – Required. Domain for windows authentication.

• user_name (any) – Required. UseName for windows authentication.

• password (SecretBase) – Required. Password for windows authentication.

Keyword Arguments

• domain (any) – Required. Domain for windows authentication.

• user_name (any) – Required. UseName for windows authentication.

• password (SecretBase) – Required. Password for windows authentication.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SSISChildPackage(*, package_path: Any, package_content: Any, package_name: Optional[str] = None, package_last_modified_date: Optional[str] = None, **kwargs)

SSIS embedded child package.

All required parameters must be populated in order to send to Azure.

Variables

• package_path (any) – Required. Path for embedded child package. Type: string (or Expression with resultType string).

• package_name (str) – Name for embedded child package.

• package_content (any) – Required. Content for embedded child package. Type: string (or Expression with resultType string).

• package_last_modified_date (str) – Last modified date for embedded child package.

Keyword Arguments

• package_path (any) – Required. Path for embedded child package. Type: string (or Expression with resultType string).

• package_name (str) – Name for embedded child package.

• package_content (any) – Required. Content for embedded child package. Type: string (or Expression with resultType string).

• package_last_modified_date (str) – Last modified date for embedded child package.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SSISExecutionCredential(*, domain: Any, user_name: Any, password: azure.synapse.artifacts.models._models_py3.SecureString, **kwargs)

SSIS package execution credential.

All required parameters must be populated in order to send to Azure.

Variables

• domain (any) – Required. Domain for windows authentication.

• user_name (any) – Required. UseName for windows authentication.

• password (SecureString) – Required. Password for windows authentication.

Keyword Arguments

• domain (any) – Required. Domain for windows authentication.

• user_name (any) – Required. UseName for windows authentication.

• password (SecureString) – Required. Password for windows authentication.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SSISExecutionParameter(*, value: Any, **kwargs)

SSIS execution parameter.

All required parameters must be populated in order to send to Azure.

Variables

value (any) – Required. SSIS package execution parameter value. Type: string (or Expression with resultType string).

Keyword Arguments

value (any) – Required. SSIS package execution parameter value. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SSISLogLocation(*, log_path: Any, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SsisLogLocationType], access_credential: Optional[azure.synapse.artifacts.models._models_py3.SSISAccessCredential] = None, log_refresh_interval: Optional[Any] = None, **kwargs)

SSIS package execution log location.

All required parameters must be populated in order to send to Azure.

Variables

• log_path (any) – Required. The SSIS package execution log path. Type: string (or Expression with resultType string).

• type (str or SsisLogLocationType) – Required. The type of SSIS log location. Possible values include: “File”.

• access_credential (SSISAccessCredential) – The package execution log access credential.

• log_refresh_interval (any) – Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

Keyword Arguments

• log_path (any) – Required. The SSIS package execution log path. Type: string (or Expression with resultType string).

• type (str or SsisLogLocationType) – Required. The type of SSIS log location. Possible values include: “File”.

• access_credential (SSISAccessCredential) – The package execution log access credential.

• log_refresh_interval (any) – Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SSISPackageLocation(*, package_path: Optional[Any] = None, type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SsisPackageLocationType]] = None, package_password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, access_credential: Optional[azure.synapse.artifacts.models._models_py3.SSISAccessCredential] = None, configuration_path: Optional[Any] = None, configuration_access_credential: Optional[azure.synapse.artifacts.models._models_py3.SSISAccessCredential] = None, package_name: Optional[str] = None, package_content: Optional[Any] = None, package_last_modified_date: Optional[str] = None, child_packages: Optional[List[azure.synapse.artifacts.models._models_py3.SSISChildPackage]] = None, **kwargs)

SSIS package location.

Variables

• package_path (any) – The SSIS package path. Type: string (or Expression with resultType string).

• type (str or SsisPackageLocationType) – The type of SSIS package location. Possible values include: “SSISDB”, “File”, “InlinePackage”, “PackageStore”.

• package_password (SecretBase) – Password of the package.

• access_credential (SSISAccessCredential) – The package access credential.

• configuration_path (any) – The configuration file of the package execution. Type: string (or Expression with resultType string).

• configuration_access_credential (SSISAccessCredential) – The configuration file access credential.

• package_name (str) – The package name.

• package_content (any) – The embedded package content. Type: string (or Expression with resultType string).

• package_last_modified_date (str) – The embedded package last modified date.

• child_packages (list[SSISChildPackage]) – The embedded child package list.

Keyword Arguments

• package_path (any) – The SSIS package path. Type: string (or Expression with resultType string).

• type (str or SsisPackageLocationType) – The type of SSIS package location. Possible values include: “SSISDB”, “File”, “InlinePackage”, “PackageStore”.

• package_password (SecretBase) – Password of the package.

• access_credential (SSISAccessCredential) – The package access credential.

• configuration_path (any) – The configuration file of the package execution. Type: string (or Expression with resultType string).

• configuration_access_credential (SSISAccessCredential) – The configuration file access credential.

• package_name (str) – The package name.

• package_content (any) – The embedded package content. Type: string (or Expression with resultType string).

• package_last_modified_date (str) – The embedded package last modified date.

• child_packages (list[SSISChildPackage]) – The embedded child package list.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SSISPropertyOverride(*, value: Any, is_sensitive: Optional[bool] = None, **kwargs)

SSIS property override.

All required parameters must be populated in order to send to Azure.

Variables

• value (any) – Required. SSIS package property override value. Type: string (or Expression with resultType string).

• is_sensitive (bool) – Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true.

Keyword Arguments

• value (any) – Required. SSIS package property override value. Type: string (or Expression with resultType string).

• is_sensitive (bool) – Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, environment_url: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, security_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, api_version: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for Salesforce.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• environment_url (any) – The URL of Salesforce instance. Default is ‘https://login.salesforce.com’. To copy data from sandbox, specify ‘https://test.salesforce.com’. To copy data from custom domain, specify, for example, ‘https://[domain].my.salesforce.com’. Type: string (or Expression with resultType string).

• username (any) – The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

• password (SecretBase) – The password for Basic authentication of the Salesforce instance.

• security_token (SecretBase) – The security token is optional to remotely access Salesforce instance.

• api_version (any) – The Salesforce API version used in ADF. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• environment_url (any) – The URL of Salesforce instance. Default is ‘https://login.salesforce.com’. To copy data from sandbox, specify ‘https://test.salesforce.com’. To copy data from custom domain, specify, for example, ‘https://[domain].my.salesforce.com’. Type: string (or Expression with resultType string).

• username (any) – The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

• password (SecretBase) – The password for Basic authentication of the Salesforce instance.

• security_token (SecretBase) – The security token is optional to remotely access Salesforce instance.

• api_version (any) – The Salesforce API version used in ADF. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService(*, client_id: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_properties: Optional[Any] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Salesforce Marketing Cloud linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object.

• client_id (any) – Required. The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).

• client_secret (SecretBase) – The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object.

• client_id (any) – Required. The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).

• client_secret (SecretBase) – The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Salesforce Marketing Cloud dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceMarketingCloudSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Salesforce Marketing Cloud source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, object_api_name: Optional[Any] = None, **kwargs)

The Salesforce object dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• object_api_name (any) – The Salesforce object API name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• object_api_name (any) – The Salesforce object API name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, environment_url: Optional[Any] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, security_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, api_version: Optional[Any] = None, extended_properties: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for Salesforce Service Cloud.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• environment_url (any) – The URL of Salesforce Service Cloud instance. Default is ‘https://login.salesforce.com’. To copy data from sandbox, specify ‘https://test.salesforce.com’. To copy data from custom domain, specify, for example, ‘https://[domain].my.salesforce.com’. Type: string (or Expression with resultType string).

• username (any) – The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

• password (SecretBase) – The password for Basic authentication of the Salesforce instance.

• security_token (SecretBase) – The security token is optional to remotely access Salesforce instance.

• api_version (any) – The Salesforce API version used in ADF. Type: string (or Expression with resultType string).

• extended_properties (any) – Extended properties appended to the connection string. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• environment_url (any) – The URL of Salesforce Service Cloud instance. Default is ‘https://login.salesforce.com’. To copy data from sandbox, specify ‘https://test.salesforce.com’. To copy data from custom domain, specify, for example, ‘https://[domain].my.salesforce.com’. Type: string (or Expression with resultType string).

• username (any) – The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

• password (SecretBase) – The password for Basic authentication of the Salesforce instance.

• security_token (SecretBase) – The security token is optional to remotely access Salesforce instance.

• api_version (any) – The Salesforce API version used in ADF. Type: string (or Expression with resultType string).

• extended_properties (any) – Extended properties appended to the connection string. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, object_api_name: Optional[Any] = None, **kwargs)

The Salesforce Service Cloud object dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• object_api_name (any) – The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• object_api_name (any) – The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceServiceCloudSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, write_behavior: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SalesforceSinkWriteBehavior]] = None, external_id_field_name: Optional[Any] = None, ignore_null_values: Optional[Any] = None, **kwargs)

A copy activity Salesforce Service Cloud sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or SalesforceSinkWriteBehavior) – The write behavior for the operation. Default is Insert. Possible values include: “Insert”, “Upsert”.

• external_id_field_name (any) – The name of the external ID field for upsert operation. Default value is ‘Id’ column. Type: string (or Expression with resultType string).

• ignore_null_values (any) – The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or SalesforceSinkWriteBehavior) – The write behavior for the operation. Default is Insert. Possible values include: “Insert”, “Upsert”.

• external_id_field_name (any) – The name of the external ID field for upsert operation. Default value is ‘Id’ column. Type: string (or Expression with resultType string).

• ignore_null_values (any) – The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceServiceCloudSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, read_behavior: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SalesforceSourceReadBehavior]] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Salesforce Service Cloud source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Database query. Type: string (or Expression with resultType string).

• read_behavior (str or SalesforceSourceReadBehavior) – The read behavior for the operation. Default is Query. Possible values include: “Query”, “QueryAll”.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Database query. Type: string (or Expression with resultType string).

• read_behavior (str or SalesforceSourceReadBehavior) – The read behavior for the operation. Default is Query. Possible values include: “Query”, “QueryAll”.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, write_behavior: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SalesforceSinkWriteBehavior]] = None, external_id_field_name: Optional[Any] = None, ignore_null_values: Optional[Any] = None, **kwargs)

A copy activity Salesforce sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or SalesforceSinkWriteBehavior) – The write behavior for the operation. Default is Insert. Possible values include: “Insert”, “Upsert”.

• external_id_field_name (any) – The name of the external ID field for upsert operation. Default value is ‘Id’ column. Type: string (or Expression with resultType string).

• ignore_null_values (any) – The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or SalesforceSinkWriteBehavior) – The write behavior for the operation. Default is Insert. Possible values include: “Insert”, “Upsert”.

• external_id_field_name (any) – The name of the external ID field for upsert operation. Default value is ‘Id’ column. Type: string (or Expression with resultType string).

• ignore_null_values (any) – The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceSinkWriteBehavior(value)

The write behavior for the operation. Default is Insert.

INSERT = 'Insert'

UPSERT = 'Upsert'

class azure.synapse.artifacts.models.SalesforceSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, read_behavior: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SalesforceSourceReadBehavior]] = None, **kwargs)

A copy activity Salesforce source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

• read_behavior (str or SalesforceSourceReadBehavior) – The read behavior for the operation. Default is Query. Possible values include: “Query”, “QueryAll”.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

• read_behavior (str or SalesforceSourceReadBehavior) – The read behavior for the operation. Default is Query. Possible values include: “Query”, “QueryAll”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SalesforceSourceReadBehavior(value)

The read behavior for the operation. Default is Query.

QUERY = 'Query'

QUERY_ALL = 'QueryAll'

class azure.synapse.artifacts.models.SapBWLinkedService(*, server: Any, system_number: Any, client_id: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

SAP Business Warehouse Linked Service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Required. Host name of the SAP BW instance. Type: string (or Expression with resultType string).

• system_number (any) – Required. System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).

• client_id (any) – Required. Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).

• user_name (any) – Username to access the SAP BW server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the SAP BW server.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Required. Host name of the SAP BW instance. Type: string (or Expression with resultType string).

• system_number (any) – Required. System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).

• client_id (any) – Required. Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).

• user_name (any) – Username to access the SAP BW server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the SAP BW server.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapBwCubeDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The SAP BW cube dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapBwSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity source for SapBW server via MDX.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – MDX query. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – MDX query. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapCloudForCustomerLinkedService(*, url: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for SAP Cloud for Customer.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The URL of SAP Cloud for Customer OData API. For example, ‘[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]’. Type: string (or Expression with resultType string).

• username (any) – The username for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – The password for Basic authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (any) – Required. The URL of SAP Cloud for Customer OData API. For example, ‘[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]’. Type: string (or Expression with resultType string).

• username (any) – The username for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – The password for Basic authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, path: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The path of the SAP Cloud for Customer OData entity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• path (any) – Required. The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• path (any) – Required. The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapCloudForCustomerSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, write_behavior: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SapCloudForCustomerSinkWriteBehavior]] = None, http_request_timeout: Optional[Any] = None, **kwargs)

A copy activity SAP Cloud for Customer sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or SapCloudForCustomerSinkWriteBehavior) – The write behavior for the operation. Default is ‘Insert’. Possible values include: “Insert”, “Update”.

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• write_behavior (str or SapCloudForCustomerSinkWriteBehavior) – The write behavior for the operation. Default is ‘Insert’. Possible values include: “Insert”, “Update”.

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapCloudForCustomerSinkWriteBehavior(value)

The write behavior for the operation. Default is ‘Insert’.

INSERT = 'Insert'

UPDATE = 'Update'

class azure.synapse.artifacts.models.SapCloudForCustomerSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, http_request_timeout: Optional[Any] = None, **kwargs)

A copy activity source for SAP Cloud for Customer source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – SAP Cloud for Customer OData query. For example, “$top=1”. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – SAP Cloud for Customer OData query. For example, “$top=1”. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapEccLinkedService(*, url: str, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, username: Optional[str] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[str] = None, **kwargs)

Linked service for SAP ERP Central Component(SAP ECC).

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (str) – Required. The URL of SAP ECC OData API. For example, ‘[https://hostname:port/sap/opu/odata/sap/servicename/]’. Type: string (or Expression with resultType string).

• username (str) – The username for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – The password for Basic authentication.

• encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• url (str) – Required. The URL of SAP ECC OData API. For example, ‘[https://hostname:port/sap/opu/odata/sap/servicename/]’. Type: string (or Expression with resultType string).

• username (str) – The username for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – The password for Basic authentication.

• encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapEccResourceDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, path: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

The path of the SAP ECC OData entity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• path (any) – Required. The path of the SAP ECC OData entity. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• path (any) – Required. The path of the SAP ECC OData entity. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapEccSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, http_request_timeout: Optional[Any] = None, **kwargs)

A copy activity source for SAP ECC source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – SAP ECC OData query. For example, “$top=1”. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – SAP ECC OData query. For example, “$top=1”. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapHanaAuthenticationType(value)

The authentication type to be used to connect to the SAP HANA server.

BASIC = 'Basic'

WINDOWS = 'Windows'

class azure.synapse.artifacts.models.SapHanaLinkedService(*, server: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SapHanaAuthenticationType]] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

SAP HANA Linked Service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• server (any) – Required. Host name of the SAP HANA server. Type: string (or Expression with resultType string).

• authentication_type (str or SapHanaAuthenticationType) – The authentication type to be used to connect to the SAP HANA server. Possible values include: “Basic”, “Windows”.

• user_name (any) – Username to access the SAP HANA server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the SAP HANA server.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• server (any) – Required. Host name of the SAP HANA server. Type: string (or Expression with resultType string).

• authentication_type (str or SapHanaAuthenticationType) – The authentication type to be used to connect to the SAP HANA server. Possible values include: “Basic”, “Windows”.

• user_name (any) – Username to access the SAP HANA server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the SAP HANA server.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapHanaPartitionOption(value)

The partition mechanism that will be used for SAP HANA read in parallel.

NONE = 'None'

PHYSICAL_PARTITIONS_OF_TABLE = 'PhysicalPartitionsOfTable'

SAP_HANA_DYNAMIC_RANGE = 'SapHanaDynamicRange'

class azure.synapse.artifacts.models.SapHanaPartitionSettings(*, partition_column_name: Optional[Any] = None, **kwargs)

The settings that will be leveraged for SAP HANA source partitioning.

Variables

partition_column_name (any) – The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

Keyword Arguments

partition_column_name (any) – The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapHanaSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, packet_size: Optional[Any] = None, partition_option: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SapHanaPartitionOption]] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.SapHanaPartitionSettings] = None, **kwargs)

A copy activity source for SAP HANA source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – SAP HANA Sql query. Type: string (or Expression with resultType string).

• packet_size (any) – The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer).

• partition_option (str or SapHanaPartitionOption) – The partition mechanism that will be used for SAP HANA read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “SapHanaDynamicRange”.

• partition_settings (SapHanaPartitionSettings) – The settings that will be leveraged for SAP HANA source partitioning.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – SAP HANA Sql query. Type: string (or Expression with resultType string).

• packet_size (any) – The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer).

• partition_option (str or SapHanaPartitionOption) – The partition mechanism that will be used for SAP HANA read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “SapHanaDynamicRange”.

• partition_settings (SapHanaPartitionSettings) – The settings that will be leveraged for SAP HANA source partitioning.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapHanaTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, schema_type_properties_schema: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

SAP HANA Table properties.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• schema_type_properties_schema (any) – The schema name of SAP HANA. Type: string (or Expression with resultType string).

• table (any) – The table name of SAP HANA. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• schema_type_properties_schema (any) – The schema name of SAP HANA. Type: string (or Expression with resultType string).

• table (any) – The table name of SAP HANA. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapOpenHubLinkedService(*, server: Any, system_number: Any, client_id: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, language: Optional[Any] = None, system_id: Optional[Any] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, message_server: Optional[Any] = None, message_server_service: Optional[Any] = None, logon_group: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

SAP Business Warehouse Open Hub Destination Linked Service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Required. Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string).

• system_number (any) – Required. System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).

• client_id (any) – Required. Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).

• language (any) – Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string).

• system_id (any) – SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).

• user_name (any) – Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the SAP BW server where the open hub destination is located.

• message_server (any) – The hostname of the SAP Message Server. Type: string (or Expression with resultType string).

• message_server_service (any) – The service name or port number of the Message Server. Type: string (or Expression with resultType string).

• logon_group (any) – The Logon Group for the SAP System. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Required. Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string).

• system_number (any) – Required. System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).

• client_id (any) – Required. Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).

• language (any) – Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string).

• system_id (any) – SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).

• user_name (any) – Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the SAP BW server where the open hub destination is located.

• message_server (any) – The hostname of the SAP Message Server. Type: string (or Expression with resultType string).

• message_server_service (any) – The service name or port number of the Message Server. Type: string (or Expression with resultType string).

• logon_group (any) – The Logon Group for the SAP System. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapOpenHubSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, exclude_last_request: Optional[Any] = None, base_request_id: Optional[Any] = None, custom_rfc_read_table_function_module: Optional[Any] = None, sap_data_column_delimiter: Optional[Any] = None, **kwargs)

A copy activity source for SAP Business Warehouse Open Hub Destination source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• exclude_last_request (any) – Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).

• base_request_id (any) – The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).

• custom_rfc_read_table_function_module (any) – Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).

• sap_data_column_delimiter (any) – The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• exclude_last_request (any) – Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).

• base_request_id (any) – The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).

• custom_rfc_read_table_function_module (any) – Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).

• sap_data_column_delimiter (any) – The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapOpenHubTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, open_hub_destination_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, exclude_last_request: Optional[Any] = None, base_request_id: Optional[Any] = None, **kwargs)

Sap Business Warehouse Open Hub Destination Table properties.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• open_hub_destination_name (any) – Required. The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string).

• exclude_last_request (any) – Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).

• base_request_id (any) – The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• open_hub_destination_name (any) – Required. The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string).

• exclude_last_request (any) – Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).

• base_request_id (any) – The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapTableLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, server: Optional[Any] = None, system_number: Optional[Any] = None, client_id: Optional[Any] = None, language: Optional[Any] = None, system_id: Optional[Any] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, message_server: Optional[Any] = None, message_server_service: Optional[Any] = None, snc_mode: Optional[Any] = None, snc_my_name: Optional[Any] = None, snc_partner_name: Optional[Any] = None, snc_library_path: Optional[Any] = None, snc_qop: Optional[Any] = None, logon_group: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

SAP Table Linked Service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).

• system_number (any) – System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).

• client_id (any) – Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).

• language (any) – Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).

• system_id (any) – SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).

• user_name (any) – Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the SAP server where the table is located.

• message_server (any) – The hostname of the SAP Message Server. Type: string (or Expression with resultType string).

• message_server_service (any) – The service name or port number of the Message Server. Type: string (or Expression with resultType string).

• snc_mode (any) – SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).

• snc_my_name (any) – Initiator’s SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).

• snc_partner_name (any) – Communication partner’s SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).

• snc_library_path (any) – External security product’s library to access the SAP server where the table is located. Type: string (or Expression with resultType string).

• snc_qop (any) – SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).

• logon_group (any) – The Logon Group for the SAP System. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).

• system_number (any) – System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).

• client_id (any) – Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).

• language (any) – Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).

• system_id (any) – SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).

• user_name (any) – Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to access the SAP server where the table is located.

• message_server (any) – The hostname of the SAP Message Server. Type: string (or Expression with resultType string).

• message_server_service (any) – The service name or port number of the Message Server. Type: string (or Expression with resultType string).

• snc_mode (any) – SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).

• snc_my_name (any) – Initiator’s SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).

• snc_partner_name (any) – Communication partner’s SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).

• snc_library_path (any) – External security product’s library to access the SAP server where the table is located. Type: string (or Expression with resultType string).

• snc_qop (any) – SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).

• logon_group (any) – The Logon Group for the SAP System. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapTablePartitionOption(value)

The partition mechanism that will be used for SAP table read in parallel.

NONE = 'None'

PARTITION_ON_CALENDAR_DATE = 'PartitionOnCalendarDate'

PARTITION_ON_CALENDAR_MONTH = 'PartitionOnCalendarMonth'

PARTITION_ON_CALENDAR_YEAR = 'PartitionOnCalendarYear'

PARTITION_ON_INT = 'PartitionOnInt'

PARTITION_ON_TIME = 'PartitionOnTime'

class azure.synapse.artifacts.models.SapTablePartitionSettings(*, partition_column_name: Optional[Any] = None, partition_upper_bound: Optional[Any] = None, partition_lower_bound: Optional[Any] = None, max_partitions_number: Optional[Any] = None, **kwargs)

The settings that will be leveraged for SAP table source partitioning.

Variables

• partition_column_name (any) – The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• max_partitions_number (any) – The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string).

Keyword Arguments

• partition_column_name (any) – The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• max_partitions_number (any) – The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapTableResourceDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, table_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, **kwargs)

SAP Table Resource properties.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – Required. The name of the SAP Table. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – Required. The name of the SAP Table. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SapTableSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, row_count: Optional[Any] = None, row_skips: Optional[Any] = None, rfc_table_fields: Optional[Any] = None, rfc_table_options: Optional[Any] = None, batch_size: Optional[Any] = None, custom_rfc_read_table_function_module: Optional[Any] = None, sap_data_column_delimiter: Optional[Any] = None, partition_option: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SapTablePartitionOption]] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.SapTablePartitionSettings] = None, **kwargs)

A copy activity source for SAP Table source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• row_count (any) – The number of rows to be retrieved. Type: integer(or Expression with resultType integer).

• row_skips (any) – The number of rows that will be skipped. Type: integer (or Expression with resultType integer).

• rfc_table_fields (any) – The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).

• rfc_table_options (any) – The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).

• batch_size (any) – Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).

• custom_rfc_read_table_function_module (any) – Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).

• sap_data_column_delimiter (any) – The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).

• partition_option (str or SapTablePartitionOption) – The partition mechanism that will be used for SAP table read in parallel. Possible values include: “None”, “PartitionOnInt”, “PartitionOnCalendarYear”, “PartitionOnCalendarMonth”, “PartitionOnCalendarDate”, “PartitionOnTime”.

• partition_settings (SapTablePartitionSettings) – The settings that will be leveraged for SAP table source partitioning.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• row_count (any) – The number of rows to be retrieved. Type: integer(or Expression with resultType integer).

• row_skips (any) – The number of rows that will be skipped. Type: integer (or Expression with resultType integer).

• rfc_table_fields (any) – The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).

• rfc_table_options (any) – The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).

• batch_size (any) – Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).

• custom_rfc_read_table_function_module (any) – Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).

• sap_data_column_delimiter (any) – The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).

• partition_option (str or SapTablePartitionOption) – The partition mechanism that will be used for SAP table read in parallel. Possible values include: “None”, “PartitionOnInt”, “PartitionOnCalendarYear”, “PartitionOnCalendarMonth”, “PartitionOnCalendarDate”, “PartitionOnTime”.

• partition_settings (SapTablePartitionSettings) – The settings that will be leveraged for SAP table source partitioning.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ScheduleTrigger(*, recurrence: azure.synapse.artifacts.models._models_py3.ScheduleTriggerRecurrence, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, annotations: Optional[List[Any]] = None, pipelines: Optional[List[azure.synapse.artifacts.models._models_py3.TriggerPipelineReference]] = None, **kwargs)

Trigger that creates pipeline runs periodically, on schedule.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Trigger type.Constant filled by server.

• description (str) – Trigger description.

• runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: “Started”, “Stopped”, “Disabled”.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

• recurrence (ScheduleTriggerRecurrence) – Required. Recurrence schedule configuration.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Trigger description.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

• recurrence (ScheduleTriggerRecurrence) – Required. Recurrence schedule configuration.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ScheduleTriggerRecurrence(*, additional_properties: Optional[Dict[str, Any]] = None, frequency: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.RecurrenceFrequency]] = None, interval: Optional[int] = None, start_time: Optional[datetime.datetime] = None, end_time: Optional[datetime.datetime] = None, time_zone: Optional[str] = None, schedule: Optional[azure.synapse.artifacts.models._models_py3.RecurrenceSchedule] = None, **kwargs)

The workflow trigger recurrence.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• frequency (str or RecurrenceFrequency) – The frequency. Possible values include: “NotSpecified”, “Minute”, “Hour”, “Day”, “Week”, “Month”, “Year”.

• interval (int) – The interval.

• start_time (datetime) – The start time.

• end_time (datetime) – The end time.

• time_zone (str) – The time zone.

• schedule (RecurrenceSchedule) – The recurrence schedule.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• frequency (str or RecurrenceFrequency) – The frequency. Possible values include: “NotSpecified”, “Minute”, “Hour”, “Day”, “Week”, “Month”, “Year”.

• interval (int) – The interval.

• start_time (datetime) – The start time.

• end_time (datetime) – The end time.

• time_zone (str) – The time zone.

• schedule (RecurrenceSchedule) – The recurrence schedule.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SchedulerCurrentState(value)

An enumeration.

ENDED = 'Ended'

QUEUED = 'Queued'

SCHEDULED = 'Scheduled'

class azure.synapse.artifacts.models.ScriptAction(*, name: str, uri: str, roles: Any, parameters: Optional[str] = None, **kwargs)

Custom script action to run on HDI ondemand cluster once it’s up.

All required parameters must be populated in order to send to Azure.

Variables

• name (str) – Required. The user provided name of the script action.

• uri (str) – Required. The URI for the script action.

• roles (any) – Required. The node types on which the script action should be executed.

• parameters (str) – The parameters for the script action.

Keyword Arguments

• name (str) – Required. The user provided name of the script action.

• uri (str) – Required. The URI for the script action.

• roles (any) – Required. The node types on which the script action should be executed.

• parameters (str) – The parameters for the script action.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SecretBase(**kwargs)

The base definition of a secret type.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureKeyVaultSecretReference, SecureString.

All required parameters must be populated in order to send to Azure.

Variables

type (str) – Required. Type of the secret.Constant filled by server.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SecureString(*, value: str, **kwargs)

Azure Synapse secure string definition. The string value will be masked with asterisks ‘*’ during Get or List API calls.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – Required. Type of the secret.Constant filled by server.

• value (str) – Required. Value of secure string.

Keyword Arguments

value (str) – Required. Value of secure string.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SelfDependencyTumblingWindowTriggerReference(*, offset: str, size: Optional[str] = None, **kwargs)

Self referenced tumbling window trigger dependency.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – Required. The type of dependency reference.Constant filled by server.

• offset (str) – Required. Timespan applied to the start time of a tumbling window when evaluating dependency.

• size (str) – The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.

Keyword Arguments

• offset (str) – Required. Timespan applied to the start time of a tumbling window when evaluating dependency.

• size (str) – The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SelfHostedIntegrationRuntime(*, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, linked_info: Optional[azure.synapse.artifacts.models._models_py3.LinkedIntegrationRuntimeType] = None, **kwargs)

Self-hosted integration runtime.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str or IntegrationRuntimeType) – Required. Type of integration runtime.Constant filled by server. Possible values include: “Managed”, “SelfHosted”.

• description (str) – Integration runtime description.

• linked_info (LinkedIntegrationRuntimeType) – Linked integration runtime type from data factory.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Integration runtime description.

• linked_info (LinkedIntegrationRuntimeType) – Linked integration runtime type from data factory.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ServiceNowAuthenticationType(value)

The authentication type to use.

BASIC = 'Basic'

O_AUTH2 = 'OAuth2'

class azure.synapse.artifacts.models.ServiceNowLinkedService(*, endpoint: Any, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.ServiceNowAuthenticationType], additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, client_id: Optional[Any] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

ServiceNow server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of the ServiceNow server. (i.e. <instance>.service-now.com).

• authentication_type (str or ServiceNowAuthenticationType) – Required. The authentication type to use. Possible values include: “Basic”, “OAuth2”.

• username (any) – The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.

• password (SecretBase) – The password corresponding to the user name for Basic and OAuth2 authentication.

• client_id (any) – The client id for OAuth2 authentication.

• client_secret (SecretBase) – The client secret for OAuth2 authentication.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• endpoint (any) – Required. The endpoint of the ServiceNow server. (i.e. <instance>.service-now.com).

• authentication_type (str or ServiceNowAuthenticationType) – Required. The authentication type to use. Possible values include: “Basic”, “OAuth2”.

• username (any) – The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.

• password (SecretBase) – The password corresponding to the user name for Basic and OAuth2 authentication.

• client_id (any) – The client id for OAuth2 authentication.

• client_secret (SecretBase) – The client secret for OAuth2 authentication.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ServiceNowObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

ServiceNow server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ServiceNowSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity ServiceNow server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SetVariableActivity(*, name: str, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, variable_name: Optional[str] = None, value: Optional[Any] = None, **kwargs)

Set value for a Variable.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• variable_name (str) – Name of the variable whose value needs to be set.

• value (any) – Value to be set. Could be a static value or Expression.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• variable_name (str) – Name of the variable whose value needs to be set.

• value (any) – Value to be set. Could be a static value or Expression.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SftpAuthenticationType(value)

The authentication type to be used to connect to the FTP server.

BASIC = 'Basic'

SSH_PUBLIC_KEY = 'SshPublicKey'

class azure.synapse.artifacts.models.SftpLocation(*, additional_properties: Optional[Dict[str, Any]] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, **kwargs)

The location of SFTP dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage location.Constant filled by server.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• folder_path (any) – Specify the folder path of dataset. Type: string (or Expression with resultType string).

• file_name (any) – Specify the file name of dataset. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SftpReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, file_list_path: Optional[Any] = None, delete_files_after_completion: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, disable_chunking: Optional[Any] = None, **kwargs)

Sftp read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Sftp wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Sftp wildcardFileName. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

• disable_chunking (any) – If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• recursive (any) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

• wildcard_folder_path (any) – Sftp wildcardFolderPath. Type: string (or Expression with resultType string).

• wildcard_file_name (any) – Sftp wildcardFileName. Type: string (or Expression with resultType string).

• enable_partition_discovery (bool) – Indicates whether to enable partition discovery.

• partition_root_path (any) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

• file_list_path (any) – Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

• delete_files_after_completion (any) – Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

• modified_datetime_start (any) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

• modified_datetime_end (any) – The end of file’s modified datetime. Type: string (or Expression with resultType string).

• disable_chunking (any) – If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SftpServerLinkedService(*, host: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, port: Optional[Any] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SftpAuthenticationType]] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, private_key_path: Optional[Any] = None, private_key_content: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, pass_phrase: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, skip_host_key_validation: Optional[Any] = None, host_key_fingerprint: Optional[Any] = None, **kwargs)

A linked service for an SSH File Transfer Protocol (SFTP) server.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The SFTP server host name. Type: string (or Expression with resultType string).

• port (any) – The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.

• authentication_type (str or SftpAuthenticationType) – The authentication type to be used to connect to the FTP server. Possible values include: “Basic”, “SshPublicKey”.

• user_name (any) – The username used to log on to the SFTP server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to logon the SFTP server for Basic authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• private_key_path (any) – The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).

• private_key_content (SecretBase) – Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.

• pass_phrase (SecretBase) – The password to decrypt the SSH private key if the SSH private key is encrypted.

• skip_host_key_validation (any) – If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).

• host_key_fingerprint (any) – The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The SFTP server host name. Type: string (or Expression with resultType string).

• port (any) – The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.

• authentication_type (str or SftpAuthenticationType) – The authentication type to be used to connect to the FTP server. Possible values include: “Basic”, “SshPublicKey”.

• user_name (any) – The username used to log on to the SFTP server. Type: string (or Expression with resultType string).

• password (SecretBase) – Password to logon the SFTP server for Basic authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

• private_key_path (any) – The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).

• private_key_content (SecretBase) – Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.

• pass_phrase (SecretBase) – The password to decrypt the SSH private key if the SSH private key is encrypted.

• skip_host_key_validation (any) – If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).

• host_key_fingerprint (any) – The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SftpWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, copy_behavior: Optional[Any] = None, operation_timeout: Optional[Any] = None, use_temp_file_rename: Optional[Any] = None, **kwargs)

Sftp write settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

• operation_timeout (any) – Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).

• use_temp_file_rename (any) – Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn’t support rename operation. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

• operation_timeout (any) – Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).

• use_temp_file_rename (any) – Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn’t support rename operation. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SharePointOnlineListLinkedService(*, site_url: Any, tenant_id: Any, service_principal_id: Any, service_principal_key: azure.synapse.artifacts.models._models_py3.SecretBase, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, encrypted_credential: Optional[Any] = None, **kwargs)

SharePoint Online List linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• site_url (any) – Required. The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string).

• tenant_id (any) – Required. The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string).

• service_principal_id (any) – Required. The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – Required. The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• site_url (any) – Required. The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string).

• tenant_id (any) – Required. The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string).

• service_principal_id (any) – Required. The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string).

• service_principal_key (SecretBase) – Required. The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SharePointOnlineListResourceDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, list_name: Optional[Any] = None, **kwargs)

The sharepoint online list resource dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• list_name (any) – The name of the SharePoint Online list. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• list_name (any) – The name of the SharePoint Online list. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SharePointOnlineListSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, http_request_timeout: Optional[Any] = None, **kwargs)

A copy activity source for sharePoint online list source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – The OData query to filter the data in SharePoint Online list. For example, “$top=1”. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – The OData query to filter the data in SharePoint Online list. For example, “$top=1”. Type: string (or Expression with resultType string).

• http_request_timeout (any) – The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ShopifyLinkedService(*, host: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, access_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Shopify Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The endpoint of the Shopify server. (i.e. mystore.myshopify.com).

• access_token (SecretBase) – The API access token that can be used to access Shopify’s data. The token won’t expire if it is offline mode.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. The endpoint of the Shopify server. (i.e. mystore.myshopify.com).

• access_token (SecretBase) – The API access token that can be used to access Shopify’s data. The token won’t expire if it is offline mode.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ShopifyObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Shopify Service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ShopifySource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Shopify Service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SkipErrorFile(*, file_missing: Optional[Any] = None, data_inconsistency: Optional[Any] = None, **kwargs)

Skip error file.

Variables

• file_missing (any) – Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean).

• data_inconsistency (any) – Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• file_missing (any) – Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean).

• data_inconsistency (any) – Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Sku(*, tier: Optional[str] = None, name: Optional[str] = None, capacity: Optional[int] = None, **kwargs)

SQL pool SKU.

Variables

• tier (str) – The service tier.

• name (str) – The SKU name.

• capacity (int) – If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

Keyword Arguments

• tier (str) – The service tier.

• name (str) – The SKU name.

• capacity (int) – If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SnowflakeDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, schema_type_properties_schema: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The snowflake dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• schema_type_properties_schema (any) – The schema name of the Snowflake database. Type: string (or Expression with resultType string).

• table (any) – The table name of the Snowflake database. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• schema_type_properties_schema (any) – The schema name of the Snowflake database. Type: string (or Expression with resultType string).

• table (any) – The table name of the Snowflake database. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SnowflakeExportCopyCommand(*, additional_properties: Optional[Dict[str, Any]] = None, additional_copy_options: Optional[Dict[str, Any]] = None, additional_format_options: Optional[Dict[str, Any]] = None, **kwargs)

Snowflake export command settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The export setting type.Constant filled by server.

• additional_copy_options (dict[str, any]) – Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalCopyOptions”: { “DATE_FORMAT”: “MM/DD/YYYY”, “TIME_FORMAT”: “‘HH24:MI:SS.FF’” }.

• additional_format_options (dict[str, any]) – Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalFormatOptions”: { “OVERWRITE”: “TRUE”, “MAX_FILE_SIZE”: “‘FALSE’” }.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• additional_copy_options (dict[str, any]) – Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalCopyOptions”: { “DATE_FORMAT”: “MM/DD/YYYY”, “TIME_FORMAT”: “‘HH24:MI:SS.FF’” }.

• additional_format_options (dict[str, any]) – Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalFormatOptions”: { “OVERWRITE”: “TRUE”, “MAX_FILE_SIZE”: “‘FALSE’” }.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SnowflakeImportCopyCommand(*, additional_properties: Optional[Dict[str, Any]] = None, additional_copy_options: Optional[Dict[str, Any]] = None, additional_format_options: Optional[Dict[str, Any]] = None, **kwargs)

Snowflake import command settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The import setting type.Constant filled by server.

• additional_copy_options (dict[str, any]) – Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalCopyOptions”: { “DATE_FORMAT”: “MM/DD/YYYY”, “TIME_FORMAT”: “‘HH24:MI:SS.FF’” }.

• additional_format_options (dict[str, any]) – Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalFormatOptions”: { “FORCE”: “TRUE”, “LOAD_UNCERTAIN_FILES”: “‘FALSE’” }.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• additional_copy_options (dict[str, any]) – Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalCopyOptions”: { “DATE_FORMAT”: “MM/DD/YYYY”, “TIME_FORMAT”: “‘HH24:MI:SS.FF’” }.

• additional_format_options (dict[str, any]) – Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalFormatOptions”: { “FORCE”: “TRUE”, “LOAD_UNCERTAIN_FILES”: “‘FALSE’” }.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SnowflakeLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Snowflake linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string of snowflake. Type: string, SecureString.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string of snowflake. Type: string, SecureString.

• password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SnowflakeSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, pre_copy_script: Optional[Any] = None, import_settings: Optional[azure.synapse.artifacts.models._models_py3.SnowflakeImportCopyCommand] = None, **kwargs)

A copy activity snowflake sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• import_settings (SnowflakeImportCopyCommand) – Snowflake import settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• import_settings (SnowflakeImportCopyCommand) – Snowflake import settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SnowflakeSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query: Optional[Any] = None, export_settings: Optional[azure.synapse.artifacts.models._models_py3.SnowflakeExportCopyCommand] = None, **kwargs)

A copy activity snowflake source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Snowflake Sql query. Type: string (or Expression with resultType string).

• export_settings (SnowflakeExportCopyCommand) – Snowflake export settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query (any) – Snowflake Sql query. Type: string (or Expression with resultType string).

• export_settings (SnowflakeExportCopyCommand) – Snowflake export settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkAuthenticationType(value)

The authentication method used to access the Spark server.

ANONYMOUS = 'Anonymous'

USERNAME = 'Username'

USERNAME_AND_PASSWORD = 'UsernameAndPassword'

WINDOWS_AZURE_HD_INSIGHT_SERVICE = 'WindowsAzureHDInsightService'

class azure.synapse.artifacts.models.SparkBatchJob(*, id: int, livy_info: Optional[azure.synapse.artifacts.models._models_py3.SparkBatchJobState] = None, name: Optional[str] = None, workspace_name: Optional[str] = None, spark_pool_name: Optional[str] = None, submitter_name: Optional[str] = None, submitter_id: Optional[str] = None, artifact_id: Optional[str] = None, job_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SparkJobType]] = None, result: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SparkBatchJobResultType]] = None, scheduler: Optional[azure.synapse.artifacts.models._models_py3.SparkScheduler] = None, plugin: Optional[azure.synapse.artifacts.models._models_py3.SparkServicePlugin] = None, errors: Optional[List[azure.synapse.artifacts.models._models_py3.SparkServiceError]] = None, tags: Optional[Dict[str, str]] = None, app_id: Optional[str] = None, app_info: Optional[Dict[str, str]] = None, state: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.LivyStates]] = None, log_lines: Optional[List[str]] = None, **kwargs)

SparkBatchJob.

All required parameters must be populated in order to send to Azure.

Variables

• livy_info (SparkBatchJobState) –

• name (str) – The batch name.

• workspace_name (str) – The workspace name.

• spark_pool_name (str) – The Spark pool name.

• submitter_name (str) – The submitter name.

• submitter_id (str) – The submitter identifier.

• artifact_id (str) – The artifact identifier.

• job_type (str or SparkJobType) – The job type. Possible values include: “SparkBatch”, “SparkSession”.

• result (str or SparkBatchJobResultType) – The Spark batch job result. Possible values include: “Uncertain”, “Succeeded”, “Failed”, “Cancelled”.

• scheduler (SparkScheduler) – The scheduler information.

• plugin (SparkServicePlugin) – The plugin information.

• errors (list[SparkServiceError]) – The error information.

• tags (dict[str, str]) – A set of tags. The tags.

• id (int) – Required. The session Id.

• app_id (str) – The application id of this session.

• app_info (dict[str, str]) – The detailed application info.

• state (str or LivyStates) – The batch state. Possible values include: “not_started”, “starting”, “idle”, “busy”, “shutting_down”, “error”, “dead”, “killed”, “success”, “running”, “recovering”.

• log_lines (list[str]) – The log lines.

Keyword Arguments

• livy_info (SparkBatchJobState) –

• name (str) – The batch name.

• workspace_name (str) – The workspace name.

• spark_pool_name (str) – The Spark pool name.

• submitter_name (str) – The submitter name.

• submitter_id (str) – The submitter identifier.

• artifact_id (str) – The artifact identifier.

• job_type (str or SparkJobType) – The job type. Possible values include: “SparkBatch”, “SparkSession”.

• result (str or SparkBatchJobResultType) – The Spark batch job result. Possible values include: “Uncertain”, “Succeeded”, “Failed”, “Cancelled”.

• scheduler (SparkScheduler) – The scheduler information.

• plugin (SparkServicePlugin) – The plugin information.

• errors (list[SparkServiceError]) – The error information.

• tags (dict[str, str]) – A set of tags. The tags.

• id (int) – Required. The session Id.

• app_id (str) – The application id of this session.

• app_info (dict[str, str]) – The detailed application info.

• state (str or LivyStates) – The batch state. Possible values include: “not_started”, “starting”, “idle”, “busy”, “shutting_down”, “error”, “dead”, “killed”, “success”, “running”, “recovering”.

• log_lines (list[str]) – The log lines.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkBatchJobResultType(value)

The Spark batch job result.

CANCELLED = 'Cancelled'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UNCERTAIN = 'Uncertain'

class azure.synapse.artifacts.models.SparkBatchJobState(*, not_started_at: Optional[datetime.datetime] = None, starting_at: Optional[datetime.datetime] = None, running_at: Optional[datetime.datetime] = None, dead_at: Optional[datetime.datetime] = None, success_at: Optional[datetime.datetime] = None, terminated_at: Optional[datetime.datetime] = None, recovering_at: Optional[datetime.datetime] = None, current_state: Optional[str] = None, job_creation_request: Optional[azure.synapse.artifacts.models._models_py3.SparkRequest] = None, **kwargs)

SparkBatchJobState.

Variables

• not_started_at (datetime) – the time that at which “not_started” livy state was first seen.

• starting_at (datetime) – the time that at which “starting” livy state was first seen.

• running_at (datetime) – the time that at which “running” livy state was first seen.

• dead_at (datetime) – time that at which “dead” livy state was first seen.

• success_at (datetime) – the time that at which “success” livy state was first seen.

• terminated_at (datetime) – the time that at which “killed” livy state was first seen.

• recovering_at (datetime) – the time that at which “recovering” livy state was first seen.

• current_state (str) – the Spark job state.

• job_creation_request (SparkRequest) –

Keyword Arguments

• not_started_at (datetime) – the time that at which “not_started” livy state was first seen.

• starting_at (datetime) – the time that at which “starting” livy state was first seen.

• running_at (datetime) – the time that at which “running” livy state was first seen.

• dead_at (datetime) – time that at which “dead” livy state was first seen.

• success_at (datetime) – the time that at which “success” livy state was first seen.

• terminated_at (datetime) – the time that at which “killed” livy state was first seen.

• recovering_at (datetime) – the time that at which “recovering” livy state was first seen.

• current_state (str) – the Spark job state.

• job_creation_request (SparkRequest) –

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkConfiguration(*, configs: Dict[str, str], description: Optional[str] = None, annotations: Optional[List[str]] = None, notes: Optional[str] = None, created_by: Optional[str] = None, created: Optional[datetime.datetime] = None, config_merge_rule: Optional[Dict[str, str]] = None, **kwargs)

SparkConfiguration Artifact information.

All required parameters must be populated in order to send to Azure.

Variables

• description (str) – Description about the SparkConfiguration.

• configs (dict[str, str]) – Required. SparkConfiguration configs.

• annotations (list[str]) – Annotations for SparkConfiguration.

• notes (str) – additional Notes.

• created_by (str) – The identity that created the resource.

• created (datetime) – The timestamp of resource creation.

• config_merge_rule (dict[str, str]) – SparkConfiguration configMergeRule.

Keyword Arguments

• description (str) – Description about the SparkConfiguration.

• configs (dict[str, str]) – Required. SparkConfiguration configs.

• annotations (list[str]) – Annotations for SparkConfiguration.

• notes (str) – additional Notes.

• created_by (str) – The identity that created the resource.

• created (datetime) – The timestamp of resource creation.

• config_merge_rule (dict[str, str]) – SparkConfiguration configMergeRule.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkConfigurationListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.SparkConfigurationResource], next_link: Optional[str] = None, **kwargs)

A list of sparkconfiguration resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[SparkConfigurationResource]) – Required. List of sparkconfigurations.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[SparkConfigurationResource]) – Required. List of sparkconfigurations.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkConfigurationResource(*, properties: azure.synapse.artifacts.models._models_py3.SparkConfiguration, **kwargs)

Spark Configuration resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• properties (SparkConfiguration) – Required. Properties of Spark Configuration.

Keyword Arguments

properties (SparkConfiguration) – Required. Properties of Spark Configuration.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkErrorSource(value)

An enumeration.

DEPENDENCY = 'Dependency'

SYSTEM = 'System'

UNKNOWN = 'Unknown'

USER = 'User'

class azure.synapse.artifacts.models.SparkJobDefinition(*, target_big_data_pool: azure.synapse.artifacts.models._models_py3.BigDataPoolReference, job_properties: azure.synapse.artifacts.models._models_py3.SparkJobProperties, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, required_spark_version: Optional[str] = None, language: Optional[str] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.SparkJobDefinitionFolder] = None, **kwargs)

Spark job definition.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – The description of the Spark job definition.

• target_big_data_pool (BigDataPoolReference) – Required. Big data pool reference.

• required_spark_version (str) – The required Spark version of the application.

• language (str) – The language of the Spark application.

• job_properties (SparkJobProperties) – Required. The properties of the Spark job.

• folder (SparkJobDefinitionFolder) – The folder that this Spark job definition is in. If not specified, this Spark job definition will appear at the root level.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – The description of the Spark job definition.

• target_big_data_pool (BigDataPoolReference) – Required. Big data pool reference.

• required_spark_version (str) – The required Spark version of the application.

• language (str) – The language of the Spark application.

• job_properties (SparkJobProperties) – Required. The properties of the Spark job.

• folder (SparkJobDefinitionFolder) – The folder that this Spark job definition is in. If not specified, this Spark job definition will appear at the root level.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkJobDefinitionFolder(*, name: Optional[str] = None, **kwargs)

The folder that this Spark job definition is in. If not specified, this Spark job definition will appear at the root level.

Variables

name (str) – The name of the folder that this Spark job definition is in.

Keyword Arguments

name (str) – The name of the folder that this Spark job definition is in.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkJobDefinitionResource(*, properties: azure.synapse.artifacts.models._models_py3.SparkJobDefinition, **kwargs)

Spark job definition resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

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

Keyword Arguments

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

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkJobDefinitionsListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.SparkJobDefinitionResource], next_link: Optional[str] = None, **kwargs)

A list of spark job definitions resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[SparkJobDefinitionResource]) – Required. List of spark job definitions.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[SparkJobDefinitionResource]) – Required. List of spark job definitions.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkJobProperties(*, file: str, driver_memory: str, driver_cores: int, executor_memory: str, executor_cores: int, num_executors: int, additional_properties: Optional[Dict[str, Any]] = None, name: Optional[str] = None, class_name: Optional[str] = None, conf: Optional[Any] = None, args: Optional[List[str]] = None, jars: Optional[List[str]] = None, files: Optional[List[str]] = None, archives: Optional[List[str]] = None, **kwargs)

The properties of the Spark job.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – The name of the job.

• file (str) – Required. File containing the application to execute.

• class_name (str) – Main class for Java/Scala application.

• conf (any) – Spark configuration properties.

• args (list[str]) – Command line arguments for the application.

• jars (list[str]) – Jars to be used in this job.

• files (list[str]) – files to be used in this job.

• archives (list[str]) – Archives to be used in this job.

• driver_memory (str) – Required. Amount of memory to use for the driver process.

• driver_cores (int) – Required. Number of cores to use for the driver.

• executor_memory (str) – Required. Amount of memory to use per executor process.

• executor_cores (int) – Required. Number of cores to use for each executor.

• num_executors (int) – Required. Number of executors to launch for this job.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – The name of the job.

• file (str) – Required. File containing the application to execute.

• class_name (str) – Main class for Java/Scala application.

• conf (any) – Spark configuration properties.

• args (list[str]) – Command line arguments for the application.

• jars (list[str]) – Jars to be used in this job.

• files (list[str]) – files to be used in this job.

• archives (list[str]) – Archives to be used in this job.

• driver_memory (str) – Required. Amount of memory to use for the driver process.

• driver_cores (int) – Required. Number of cores to use for the driver.

• executor_memory (str) – Required. Amount of memory to use per executor process.

• executor_cores (int) – Required. Number of cores to use for each executor.

• num_executors (int) – Required. Number of executors to launch for this job.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkJobReferenceType(value)

Synapse spark job reference type.

SPARK_JOB_DEFINITION_REFERENCE = 'SparkJobDefinitionReference'

class azure.synapse.artifacts.models.SparkJobType(value)

The job type.

SPARK_BATCH = 'SparkBatch'

SPARK_SESSION = 'SparkSession'

class azure.synapse.artifacts.models.SparkLinkedService(*, host: Any, port: Any, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SparkAuthenticationType], additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, server_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SparkServerType]] = None, thrift_transport_protocol: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SparkThriftTransportProtocol]] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, http_path: Optional[Any] = None, enable_ssl: Optional[Any] = None, trusted_cert_path: Optional[Any] = None, use_system_trust_store: Optional[Any] = None, allow_host_name_cn_mismatch: Optional[Any] = None, allow_self_signed_server_cert: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Spark Server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. IP address or host name of the Spark server.

• port (any) – Required. The TCP port that the Spark server uses to listen for client connections.

• server_type (str or SparkServerType) – The type of Spark server. Possible values include: “SharkServer”, “SharkServer2”, “SparkThriftServer”.

• thrift_transport_protocol (str or SparkThriftTransportProtocol) – The transport protocol to use in the Thrift layer. Possible values include: “Binary”, “SASL”, “HTTP “.

• authentication_type (str or SparkAuthenticationType) – Required. The authentication method used to access the Spark server. Possible values include: “Anonymous”, “Username”, “UsernameAndPassword”, “WindowsAzureHDInsightService”.

• username (any) – The user name that you use to access Spark Server.

• password (SecretBase) – The password corresponding to the user name that you provided in the Username field.

• http_path (any) – The partial URL corresponding to the Spark server.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• host (any) – Required. IP address or host name of the Spark server.

• port (any) – Required. The TCP port that the Spark server uses to listen for client connections.

• server_type (str or SparkServerType) – The type of Spark server. Possible values include: “SharkServer”, “SharkServer2”, “SparkThriftServer”.

• thrift_transport_protocol (str or SparkThriftTransportProtocol) – The transport protocol to use in the Thrift layer. Possible values include: “Binary”, “SASL”, “HTTP “.

• authentication_type (str or SparkAuthenticationType) – Required. The authentication method used to access the Spark server. Possible values include: “Anonymous”, “Username”, “UsernameAndPassword”, “WindowsAzureHDInsightService”.

• username (any) – The user name that you use to access Spark Server.

• password (SecretBase) – The password corresponding to the user name that you provided in the Username field.

• http_path (any) – The partial URL corresponding to the Spark server.

• enable_ssl (any) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.

• trusted_cert_path (any) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

• use_system_trust_store (any) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

• allow_host_name_cn_mismatch (any) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

• allow_self_signed_server_cert (any) – Specifies whether to allow self-signed certificates from the server. The default value is false.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

Spark Server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Spark. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Spark. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Spark. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Spark. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkRequest(*, name: Optional[str] = None, file: Optional[str] = None, class_name: Optional[str] = None, arguments: Optional[List[str]] = None, jars: Optional[List[str]] = None, python_files: Optional[List[str]] = None, files: Optional[List[str]] = None, archives: Optional[List[str]] = None, configuration: Optional[Dict[str, str]] = None, driver_memory: Optional[str] = None, driver_cores: Optional[int] = None, executor_memory: Optional[str] = None, executor_cores: Optional[int] = None, executor_count: Optional[int] = None, **kwargs)

SparkRequest.

Variables

• name (str) –

• file (str) –

• class_name (str) –

• arguments (list[str]) –

• jars (list[str]) –

• python_files (list[str]) –

• files (list[str]) –

• archives (list[str]) –

• configuration (dict[str, str]) – Dictionary of <string>.

• driver_memory (str) –

• driver_cores (int) –

• executor_memory (str) –

• executor_cores (int) –

• executor_count (int) –

Keyword Arguments

• name (str) –

• file (str) –

• class_name (str) –

• arguments (list[str]) –

• jars (list[str]) –

• python_files (list[str]) –

• files (list[str]) –

• archives (list[str]) –

• configuration (dict[str, str]) – Dictionary of <string>.

• driver_memory (str) –

• driver_cores (int) –

• executor_memory (str) –

• executor_cores (int) –

• executor_count (int) –

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkScheduler(*, submitted_at: Optional[datetime.datetime] = None, scheduled_at: Optional[datetime.datetime] = None, ended_at: Optional[datetime.datetime] = None, cancellation_requested_at: Optional[datetime.datetime] = None, current_state: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SchedulerCurrentState]] = None, **kwargs)

SparkScheduler.

Variables

• submitted_at (datetime) –

• scheduled_at (datetime) –

• ended_at (datetime) –

• cancellation_requested_at (datetime) –

• current_state (str or SchedulerCurrentState) – Possible values include: “Queued”, “Scheduled”, “Ended”.

Keyword Arguments

• submitted_at (datetime) –

• scheduled_at (datetime) –

• ended_at (datetime) –

• cancellation_requested_at (datetime) –

• current_state (str or SchedulerCurrentState) – Possible values include: “Queued”, “Scheduled”, “Ended”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkServerType(value)

The type of Spark server.

SHARK_SERVER = 'SharkServer'

SHARK_SERVER2 = 'SharkServer2'

SPARK_THRIFT_SERVER = 'SparkThriftServer'

class azure.synapse.artifacts.models.SparkServiceError(*, message: Optional[str] = None, error_code: Optional[str] = None, source: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SparkErrorSource]] = None, **kwargs)

SparkServiceError.

Variables

• message (str) –

• error_code (str) –

• source (str or SparkErrorSource) – Possible values include: “System”, “User”, “Unknown”, “Dependency”.

Keyword Arguments

• message (str) –

• error_code (str) –

• source (str or SparkErrorSource) – Possible values include: “System”, “User”, “Unknown”, “Dependency”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkServicePlugin(*, preparation_started_at: Optional[datetime.datetime] = None, resource_acquisition_started_at: Optional[datetime.datetime] = None, submission_started_at: Optional[datetime.datetime] = None, monitoring_started_at: Optional[datetime.datetime] = None, cleanup_started_at: Optional[datetime.datetime] = None, current_state: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.PluginCurrentState]] = None, **kwargs)

SparkServicePlugin.

Variables

• preparation_started_at (datetime) –

• resource_acquisition_started_at (datetime) –

• submission_started_at (datetime) –

• monitoring_started_at (datetime) –

• cleanup_started_at (datetime) –

• current_state (str or PluginCurrentState) – Possible values include: “Preparation”, “ResourceAcquisition”, “Queued”, “Submission”, “Monitoring”, “Cleanup”, “Ended”.

Keyword Arguments

• preparation_started_at (datetime) –

• resource_acquisition_started_at (datetime) –

• submission_started_at (datetime) –

• monitoring_started_at (datetime) –

• cleanup_started_at (datetime) –

• current_state (str or PluginCurrentState) – Possible values include: “Preparation”, “ResourceAcquisition”, “Queued”, “Submission”, “Monitoring”, “Cleanup”, “Ended”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Spark Server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SparkThriftTransportProtocol(value)

The transport protocol to use in the Thrift layer.

BINARY = 'Binary'

HTTP = 'HTTP '

SASL = 'SASL'

class azure.synapse.artifacts.models.SqlConnection(*, additional_properties: Optional[Dict[str, Any]] = None, type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SqlConnectionType]] = None, name: Optional[str] = None, pool_name: Optional[str] = None, database_name: Optional[str] = None, **kwargs)

The connection used to execute the SQL script.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str or SqlConnectionType) – The type of the connection. Possible values include: “SqlOnDemand”, “SqlPool”.

• name (str) – The identifier of the connection.

• pool_name (str) – The associated SQL pool name (supported by SQL pool v3).

• database_name (str) – The associated database name (supported by SQL pool v3).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str or SqlConnectionType) – The type of the connection. Possible values include: “SqlOnDemand”, “SqlPool”.

• name (str) – The identifier of the connection.

• pool_name (str) – The associated SQL pool name (supported by SQL pool v3).

• database_name (str) – The associated database name (supported by SQL pool v3).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlConnectionType(value)

The type of the connection.

SQL_ON_DEMAND = 'SqlOnDemand'

SQL_POOL = 'SqlPool'

class azure.synapse.artifacts.models.SqlDWSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, pre_copy_script: Optional[Any] = None, allow_poly_base: Optional[Any] = None, poly_base_settings: Optional[azure.synapse.artifacts.models._models_py3.PolybaseSettings] = None, allow_copy_command: Optional[Any] = None, copy_command_settings: Optional[azure.synapse.artifacts.models._models_py3.DWCopyCommandSettings] = None, table_option: Optional[Any] = None, **kwargs)

A copy activity SQL Data Warehouse sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• allow_poly_base (any) – Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).

• poly_base_settings (PolybaseSettings) – Specifies PolyBase-related settings when allowPolyBase is true.

• allow_copy_command (any) – Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).

• copy_command_settings (DWCopyCommandSettings) – Specifies Copy Command related settings when allowCopyCommand is true.

• table_option (any) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• allow_poly_base (any) – Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).

• poly_base_settings (PolybaseSettings) – Specifies PolyBase-related settings when allowPolyBase is true.

• allow_copy_command (any) – Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).

• copy_command_settings (DWCopyCommandSettings) – Specifies Copy Command related settings when allowCopyCommand is true.

• table_option (any) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlDWSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, sql_reader_query: Optional[Any] = None, sql_reader_stored_procedure_name: Optional[Any] = None, stored_procedure_parameters: Optional[Any] = None, partition_option: Optional[Any] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.SqlPartitionSettings] = None, **kwargs)

A copy activity SQL Data Warehouse source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL Data Warehouse reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (any) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”. Type: object (or Expression with resultType object), itemType: StoredProcedureParameter.

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL Data Warehouse reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (any) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”. Type: object (or Expression with resultType object), itemType: StoredProcedureParameter.

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlMISink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, sql_writer_stored_procedure_name: Optional[Any] = None, sql_writer_table_type: Optional[Any] = None, pre_copy_script: Optional[Any] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, stored_procedure_table_type_parameter_name: Optional[Any] = None, table_option: Optional[Any] = None, **kwargs)

A copy activity Azure SQL Managed Instance sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• sql_writer_stored_procedure_name (any) – SQL writer stored procedure name. Type: string (or Expression with resultType string).

• sql_writer_table_type (any) – SQL writer table type. Type: string (or Expression with resultType string).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.

• stored_procedure_table_type_parameter_name (any) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).

• table_option (any) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• sql_writer_stored_procedure_name (any) – SQL writer stored procedure name. Type: string (or Expression with resultType string).

• sql_writer_table_type (any) – SQL writer table type. Type: string (or Expression with resultType string).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.

• stored_procedure_table_type_parameter_name (any) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).

• table_option (any) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlMISource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, sql_reader_query: Optional[Any] = None, sql_reader_stored_procedure_name: Optional[Any] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, produce_additional_types: Optional[Any] = None, partition_option: Optional[Any] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.SqlPartitionSettings] = None, **kwargs)

A copy activity Azure SQL Managed Instance source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

• produce_additional_types (any) – Which additional types to produce.

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

• produce_additional_types (any) – Which additional types to produce.

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlPartitionOption(value)

The partition mechanism that will be used for Sql read in parallel.

DYNAMIC_RANGE = 'DynamicRange'

NONE = 'None'

PHYSICAL_PARTITIONS_OF_TABLE = 'PhysicalPartitionsOfTable'

class azure.synapse.artifacts.models.SqlPartitionSettings(*, partition_column_name: Optional[Any] = None, partition_upper_bound: Optional[Any] = None, partition_lower_bound: Optional[Any] = None, **kwargs)

The settings that will be leveraged for Sql source partitioning.

Variables

• partition_column_name (any) – The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).

Keyword Arguments

• partition_column_name (any) – The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlPool(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[azure.synapse.artifacts.models._models_py3.Sku] = None, max_size_bytes: Optional[int] = None, collation: Optional[str] = None, source_database_id: Optional[str] = None, recoverable_database_id: Optional[str] = None, provisioning_state: Optional[str] = None, status: Optional[str] = None, restore_point_in_time: Optional[str] = None, create_mode: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.CreateMode]] = None, creation_date: Optional[datetime.datetime] = None, **kwargs)

A SQL Analytics pool.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• tags (dict[str, str]) – A set of tags. Resource tags.

• location (str) – Required. The geo-location where the resource lives.

• sku (Sku) – SQL pool SKU.

• max_size_bytes (long) – Maximum size in bytes.

• collation (str) – Collation mode.

• source_database_id (str) – Source database to create from.

• recoverable_database_id (str) – Backup database to restore from.

• provisioning_state (str) – Resource state.

• status (str) – Resource status.

• restore_point_in_time (str) – Snapshot time to restore.

• create_mode (str or CreateMode) –

  Specifies the mode of sql pool creation.

  Default: regular sql pool creation.

  PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

  Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

  Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool’s original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified. Possible values include: “Default”, “PointInTimeRestore”, “Recovery”, “Restore”.

• creation_date (datetime) – Date the SQL pool was created.

Keyword Arguments

• tags (dict[str, str]) – A set of tags. Resource tags.

• location (str) – Required. The geo-location where the resource lives.

• sku (Sku) – SQL pool SKU.

• max_size_bytes (long) – Maximum size in bytes.

• collation (str) – Collation mode.

• source_database_id (str) – Source database to create from.

• recoverable_database_id (str) – Backup database to restore from.

• provisioning_state (str) – Resource state.

• status (str) – Resource status.

• restore_point_in_time (str) – Snapshot time to restore.

• create_mode (str or CreateMode) –

  Specifies the mode of sql pool creation.

  Default: regular sql pool creation.

  PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

  Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

  Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool’s original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified. Possible values include: “Default”, “PointInTimeRestore”, “Recovery”, “Restore”.

• creation_date (datetime) – Date the SQL pool was created.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlPoolInfoListResult(*, next_link: Optional[str] = None, value: Optional[List[azure.synapse.artifacts.models._models_py3.SqlPool]] = None, **kwargs)

List of SQL pools.

Variables

• next_link (str) – Link to the next page of results.

• value (list[SqlPool]) – List of SQL pools.

Keyword Arguments

• next_link (str) – Link to the next page of results.

• value (list[SqlPool]) – List of SQL pools.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlPoolReference(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SqlPoolReferenceType], reference_name: str, **kwargs)

SQL pool reference type.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or SqlPoolReferenceType) – Required. SQL pool reference type. Possible values include: “SqlPoolReference”.

• reference_name (str) – Required. Reference SQL pool name.

Keyword Arguments

• type (str or SqlPoolReferenceType) – Required. SQL pool reference type. Possible values include: “SqlPoolReference”.

• reference_name (str) – Required. Reference SQL pool name.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlPoolReferenceType(value)

SQL pool reference type.

SQL_POOL_REFERENCE = 'SqlPoolReference'

class azure.synapse.artifacts.models.SqlPoolStoredProcedureActivity(*, name: str, sql_pool: azure.synapse.artifacts.models._models_py3.SqlPoolReference, stored_procedure_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, **kwargs)

Execute SQL pool stored procedure activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• sql_pool (SqlPoolReference) – Required. SQL pool stored procedure reference.

• stored_procedure_name (any) – Required. Stored procedure name. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• sql_pool (SqlPoolReference) – Required. SQL pool stored procedure reference.

• stored_procedure_name (any) – Required. Stored procedure name. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlScript(*, content: azure.synapse.artifacts.models._models_py3.SqlScriptContent, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SqlScriptType]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.SqlScriptFolder] = None, **kwargs)

SQL script.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – The description of the SQL script.

• type (str or SqlScriptType) – The type of the SQL script. Possible values include: “SqlQuery”.

• content (SqlScriptContent) – Required. The content of the SQL script.

• folder (SqlScriptFolder) – The folder that this SQL script is in. If not specified, this SQL script will appear at the root level.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – The description of the SQL script.

• type (str or SqlScriptType) – The type of the SQL script. Possible values include: “SqlQuery”.

• content (SqlScriptContent) – Required. The content of the SQL script.

• folder (SqlScriptFolder) – The folder that this SQL script is in. If not specified, this SQL script will appear at the root level.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlScriptContent(*, query: str, additional_properties: Optional[Dict[str, Any]] = None, current_connection: Optional[azure.synapse.artifacts.models._models_py3.SqlConnection] = None, result_limit: Optional[int] = None, metadata: Optional[azure.synapse.artifacts.models._models_py3.SqlScriptMetadata] = None, **kwargs)

The content of the SQL script.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• query (str) – Required. SQL query to execute.

• current_connection (SqlConnection) – The connection used to execute the SQL script.

• result_limit (int) – Limit of results, ‘-1’ for no limit.

• metadata (SqlScriptMetadata) – The metadata of the SQL script.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• query (str) – Required. SQL query to execute.

• current_connection (SqlConnection) – The connection used to execute the SQL script.

• result_limit (int) – Limit of results, ‘-1’ for no limit.

• metadata (SqlScriptMetadata) – The metadata of the SQL script.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlScriptFolder(*, name: Optional[str] = None, **kwargs)

The folder that this SQL script is in. If not specified, this SQL script will appear at the root level.

Variables

name (str) – The name of the folder that this SQL script is in.

Keyword Arguments

name (str) – The name of the folder that this SQL script is in.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlScriptMetadata(*, additional_properties: Optional[Dict[str, Any]] = None, language: Optional[str] = None, **kwargs)

The metadata of the SQL script.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• language (str) – The language of the SQL script.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• language (str) – The language of the SQL script.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlScriptResource(*, name: str, properties: azure.synapse.artifacts.models._models_py3.SqlScript, **kwargs)

Sql Script resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – Required. The name of the resource.

• type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

• etag (str) – Resource Etag.

• properties (SqlScript) – Required. Properties of sql script.

Keyword Arguments

• name (str) – Required. The name of the resource.

• properties (SqlScript) – Required. Properties of sql script.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlScriptType(value)

The type of the SQL script.

SQL_QUERY = 'SqlQuery'

class azure.synapse.artifacts.models.SqlScriptsListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.SqlScriptResource], next_link: Optional[str] = None, **kwargs)

A list of sql scripts resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[SqlScriptResource]) – Required. List of sql scripts.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[SqlScriptResource]) – Required. List of sql scripts.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlServerLinkedService(*, connection_string: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, user_name: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

SQL Server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• user_name (any) – The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

• password (SecretBase) – The on-premises Windows authentication password.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• user_name (any) – The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

• password (SecretBase) – The on-premises Windows authentication password.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlServerSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, sql_writer_stored_procedure_name: Optional[Any] = None, sql_writer_table_type: Optional[Any] = None, pre_copy_script: Optional[Any] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, stored_procedure_table_type_parameter_name: Optional[Any] = None, table_option: Optional[Any] = None, **kwargs)

A copy activity SQL server sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• sql_writer_stored_procedure_name (any) – SQL writer stored procedure name. Type: string (or Expression with resultType string).

• sql_writer_table_type (any) – SQL writer table type. Type: string (or Expression with resultType string).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.

• stored_procedure_table_type_parameter_name (any) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).

• table_option (any) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• sql_writer_stored_procedure_name (any) – SQL writer stored procedure name. Type: string (or Expression with resultType string).

• sql_writer_table_type (any) – SQL writer table type. Type: string (or Expression with resultType string).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.

• stored_procedure_table_type_parameter_name (any) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).

• table_option (any) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlServerSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, sql_reader_query: Optional[Any] = None, sql_reader_stored_procedure_name: Optional[Any] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, produce_additional_types: Optional[Any] = None, partition_option: Optional[Any] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.SqlPartitionSettings] = None, **kwargs)

A copy activity SQL server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

• produce_additional_types (any) – Which additional types to produce.

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

• produce_additional_types (any) – Which additional types to produce.

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlServerStoredProcedureActivity(*, name: str, stored_procedure_name: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, **kwargs)

SQL stored procedure activity type.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• stored_procedure_name (any) – Required. Stored procedure name. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• stored_procedure_name (any) – Required. Stored procedure name. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlServerTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The on-premises SQL Server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).

• table (any) – The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• schema_type_properties_schema (any) – The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).

• table (any) – The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, sql_writer_stored_procedure_name: Optional[Any] = None, sql_writer_table_type: Optional[Any] = None, pre_copy_script: Optional[Any] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, stored_procedure_table_type_parameter_name: Optional[Any] = None, table_option: Optional[Any] = None, **kwargs)

A copy activity SQL sink.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy sink type.Constant filled by server.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• sql_writer_stored_procedure_name (any) – SQL writer stored procedure name. Type: string (or Expression with resultType string).

• sql_writer_table_type (any) – SQL writer table type. Type: string (or Expression with resultType string).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.

• stored_procedure_table_type_parameter_name (any) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).

• table_option (any) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• write_batch_size (any) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

• write_batch_timeout (any) – Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sink_retry_count (any) – Sink retry count. Type: integer (or Expression with resultType integer).

• sink_retry_wait (any) – Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

• sql_writer_stored_procedure_name (any) – SQL writer stored procedure name. Type: string (or Expression with resultType string).

• sql_writer_table_type (any) – SQL writer table type. Type: string (or Expression with resultType string).

• pre_copy_script (any) – SQL pre-copy script. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.

• stored_procedure_table_type_parameter_name (any) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).

• table_option (any) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SqlSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, sql_reader_query: Optional[Any] = None, sql_reader_stored_procedure_name: Optional[Any] = None, stored_procedure_parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.StoredProcedureParameter]] = None, isolation_level: Optional[Any] = None, partition_option: Optional[Any] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.SqlPartitionSettings] = None, **kwargs)

A copy activity SQL source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

• isolation_level (any) – Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• sql_reader_query (any) – SQL reader query. Type: string (or Expression with resultType string).

• sql_reader_stored_procedure_name (any) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

• stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

• isolation_level (any) – Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).

• partition_option (any) – The partition mechanism that will be used for Sql read in parallel. Possible values include: “None”, “PhysicalPartitionsOfTable”, “DynamicRange”.

• partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SquareLinkedService(*, host: Any, client_id: Any, redirect_uri: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_properties: Optional[Any] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Square Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object.

• host (any) – Required. The URL of the Square instance. (i.e. mystore.mysquare.com).

• client_id (any) – Required. The client ID associated with your Square application.

• client_secret (SecretBase) – The client secret associated with your Square application.

• redirect_uri (any) – Required. The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500).

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object.

• host (any) – Required. The URL of the Square instance. (i.e. mystore.mysquare.com).

• client_id (any) – Required. The client ID associated with your Square application.

• client_secret (SecretBase) – The client secret associated with your Square application.

• redirect_uri (any) – Required. The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500).

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SquareObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Square Service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SquareSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Square Service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SsisLogLocationType(value)

The type of SSIS log location.

FILE = 'File'

class azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse(*, status: Optional[str] = None, name: Optional[str] = None, properties: Optional[str] = None, error: Optional[str] = None, **kwargs)

The status of the operation.

Variables

• status (str) – The status of the operation.

• name (str) – The operation name.

• properties (str) – The operation properties.

• error (str) – The operation error message.

Keyword Arguments

• status (str) – The status of the operation.

• name (str) – The operation name.

• properties (str) – The operation properties.

• error (str) – The operation error message.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SsisPackageLocationType(value)

The type of SSIS package location.

FILE = 'File'

INLINE_PACKAGE = 'InlinePackage'

PACKAGE_STORE = 'PackageStore'

SSISDB = 'SSISDB'

class azure.synapse.artifacts.models.StagingSettings(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, path: Optional[Any] = None, enable_compression: Optional[Any] = None, **kwargs)

Staging settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• linked_service_name (LinkedServiceReference) – Required. Staging linked service reference.

• path (any) – The path to storage for storing the interim data. Type: string (or Expression with resultType string).

• enable_compression (any) – Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• linked_service_name (LinkedServiceReference) – Required. Staging linked service reference.

• path (any) – The path to storage for storing the interim data. Type: string (or Expression with resultType string).

• enable_compression (any) – Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest(*, session_id: Optional[str] = None, data_flow: Optional[azure.synapse.artifacts.models._models_py3.DataFlowResource] = None, data_flows: Optional[List[azure.synapse.artifacts.models._models_py3.DataFlowResource]] = None, datasets: Optional[List[azure.synapse.artifacts.models._models_py3.DatasetResource]] = None, linked_services: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceResource]] = None, staging: Optional[Any] = None, debug_settings: Optional[Any] = None, incremental_debug: Optional[bool] = None, **kwargs)

Request body structure for starting data flow debug session.

Variables

• session_id (str) – The ID of data flow debug session.

• data_flow (DataFlowResource) – Data flow instance.

• data_flows (list[DataFlowResource]) – List of Data flows.

• datasets (list[DatasetResource]) – List of datasets.

• linked_services (list[LinkedServiceResource]) – List of linked services.

• staging (any) – Staging info for debug session.

• debug_settings (any) – Data flow debug settings.

• incremental_debug (bool) – The type of new Databricks cluster.

Keyword Arguments

• session_id (str) – The ID of data flow debug session.

• data_flow (DataFlowResource) – Data flow instance.

• data_flows (list[DataFlowResource]) – List of Data flows.

• datasets (list[DatasetResource]) – List of datasets.

• linked_services (list[LinkedServiceResource]) – List of linked services.

• staging (any) – Staging info for debug session.

• debug_settings (any) – Data flow debug settings.

• incremental_debug (bool) – The type of new Databricks cluster.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse(*, job_version: Optional[str] = None, **kwargs)

Response body structure for starting data flow debug session.

Variables

job_version (str) – The ID of data flow debug job version.

Keyword Arguments

job_version (str) – The ID of data flow debug job version.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.StoreReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, **kwargs)

Connector read setting.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AmazonS3ReadSettings, AzureBlobFSReadSettings, AzureBlobStorageReadSettings, AzureDataLakeStoreReadSettings, AzureFileStorageReadSettings, FileServerReadSettings, FtpReadSettings, GoogleCloudStorageReadSettings, HdfsReadSettings, HttpReadSettings, SftpReadSettings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.StoreWriteSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, copy_behavior: Optional[Any] = None, **kwargs)

Connector write settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureBlobFSWriteSettings, AzureBlobStorageWriteSettings, AzureDataLakeStoreWriteSettings, AzureFileStorageWriteSettings, FileServerWriteSettings, SftpWriteSettings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The write setting type.Constant filled by server.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• copy_behavior (any) – The type of copy behavior for copy sink.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.StoredProcedureParameter(*, value: Optional[Any] = None, type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.StoredProcedureParameterType]] = None, **kwargs)

SQL stored procedure parameter.

Variables

• value (any) – Stored procedure parameter value. Type: string (or Expression with resultType string).

• type (str or StoredProcedureParameterType) – Stored procedure parameter type. Possible values include: “String”, “Int”, “Int64”, “Decimal”, “Guid”, “Boolean”, “Date”.

Keyword Arguments

• value (any) – Stored procedure parameter value. Type: string (or Expression with resultType string).

• type (str or StoredProcedureParameterType) – Stored procedure parameter type. Possible values include: “String”, “Int”, “Int64”, “Decimal”, “Guid”, “Boolean”, “Date”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.StoredProcedureParameterType(value)

Stored procedure parameter type.

BOOLEAN = 'Boolean'

DATE = 'Date'

DECIMAL = 'Decimal'

GUID = 'Guid'

INT = 'Int'

INT64 = 'Int64'

STRING = 'String'

class azure.synapse.artifacts.models.SubResource(**kwargs)

Azure Synapse nested resource, which belongs to a workspace.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SubResourceDebugResource(*, name: Optional[str] = None, **kwargs)

Azure Synapse nested debug resource.

Variables

name (str) – The resource name.

Keyword Arguments

name (str) – The resource name.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SwitchActivity(*, name: str, on: azure.synapse.artifacts.models._models_py3.Expression, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, cases: Optional[List[azure.synapse.artifacts.models._models_py3.SwitchCase]] = None, default_activities: Optional[List[azure.synapse.artifacts.models._models_py3.Activity]] = None, **kwargs)

This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• on (Expression) – Required. An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.

• cases (list[SwitchCase]) – List of cases that correspond to expected values of the ‘on’ property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.

• default_activities (list[Activity]) – List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• on (Expression) – Required. An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.

• cases (list[SwitchCase]) – List of cases that correspond to expected values of the ‘on’ property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.

• default_activities (list[Activity]) – List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SwitchCase(*, value: Optional[str] = None, activities: Optional[List[azure.synapse.artifacts.models._models_py3.Activity]] = None, **kwargs)

Switch cases with have a value and corresponding activities.

Variables

• value (str) – Expected value that satisfies the expression result of the ‘on’ property.

• activities (list[Activity]) – List of activities to execute for satisfied case condition.

Keyword Arguments

• value (str) – Expected value that satisfies the expression result of the ‘on’ property.

• activities (list[Activity]) – List of activities to execute for satisfied case condition.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SybaseAuthenticationType(value)

AuthenticationType to be used for connection.

BASIC = 'Basic'

WINDOWS = 'Windows'

class azure.synapse.artifacts.models.SybaseLinkedService(*, server: Any, database: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, schema: Optional[Any] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SybaseAuthenticationType]] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for Sybase data source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Required. Server name for connection. Type: string (or Expression with resultType string).

• database (any) – Required. Database name for connection. Type: string (or Expression with resultType string).

• schema (any) – Schema name for connection. Type: string (or Expression with resultType string).

• authentication_type (str or SybaseAuthenticationType) – AuthenticationType to be used for connection. Possible values include: “Basic”, “Windows”.

• username (any) – Username for authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• server (any) – Required. Server name for connection. Type: string (or Expression with resultType string).

• database (any) – Required. Database name for connection. Type: string (or Expression with resultType string).

• schema (any) – Schema name for connection. Type: string (or Expression with resultType string).

• authentication_type (str or SybaseAuthenticationType) – AuthenticationType to be used for connection. Possible values include: “Basic”, “Windows”.

• username (any) – Username for authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SybaseSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity source for Sybase databases.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Database query. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SybaseTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

The Sybase table dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The Sybase table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The Sybase table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SynapseNotebookActivity(*, name: str, notebook: azure.synapse.artifacts.models._models_py3.SynapseNotebookReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.NotebookParameter]] = None, **kwargs)

Execute Synapse notebook activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• notebook (SynapseNotebookReference) – Required. Synapse notebook reference.

• parameters (dict[str, NotebookParameter]) – Notebook parameters.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• notebook (SynapseNotebookReference) – Required. Synapse notebook reference.

• parameters (dict[str, NotebookParameter]) – Notebook parameters.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SynapseNotebookReference(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.NotebookReferenceType], reference_name: str, **kwargs)

Synapse notebook reference type.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or NotebookReferenceType) – Required. Synapse notebook reference type. Possible values include: “NotebookReference”.

• reference_name (str) – Required. Reference notebook name.

Keyword Arguments

• type (str or NotebookReferenceType) – Required. Synapse notebook reference type. Possible values include: “NotebookReference”.

• reference_name (str) – Required. Reference notebook name.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SynapseSparkJobDefinitionActivity(*, name: str, spark_job: azure.synapse.artifacts.models._models_py3.SynapseSparkJobReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, arguments: Optional[List[Any]] = None, **kwargs)

Execute spark job activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• spark_job (SynapseSparkJobReference) – Required. Synapse spark job reference.

• arguments (list[any]) – User specified arguments to SynapseSparkJobDefinitionActivity.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• spark_job (SynapseSparkJobReference) – Required. Synapse spark job reference.

• arguments (list[any]) – User specified arguments to SynapseSparkJobDefinitionActivity.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.SynapseSparkJobReference(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.SparkJobReferenceType], reference_name: str, **kwargs)

Synapse spark job reference type.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or SparkJobReferenceType) – Required. Synapse spark job reference type. Possible values include: “SparkJobDefinitionReference”.

• reference_name (str) – Required. Reference spark job name.

Keyword Arguments

• type (str or SparkJobReferenceType) – Required. Synapse spark job reference type. Possible values include: “SparkJobDefinitionReference”.

• reference_name (str) – Required. Reference spark job name.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TabularSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

Copy activity sources of tabular type.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AmazonMWSSource, AmazonRdsForSqlServerSource, AmazonRedshiftSource, AzureMariaDBSource, AzureMySqlSource, AzurePostgreSqlSource, AzureSqlSource, AzureTableSource, CassandraSource, ConcurSource, CouchbaseSource, Db2Source, DrillSource, DynamicsAXSource, EloquaSource, GoogleAdWordsSource, GoogleBigQuerySource, GreenplumSource, HBaseSource, HiveSource, HubspotSource, ImpalaSource, InformixSource, JiraSource, MagentoSource, MariaDBSource, MarketoSource, MySqlSource, NetezzaSource, OdbcSource, OracleServiceCloudSource, PaypalSource, PhoenixSource, PostgreSqlSource, PrestoSource, QuickBooksSource, ResponsysSource, SalesforceMarketingCloudSource, SalesforceSource, SapBwSource, SapCloudForCustomerSource, SapEccSource, SapHanaSource, SapOpenHubSource, SapTableSource, ServiceNowSource, ShopifySource, SparkSource, SqlDWSource, SqlMISource, SqlServerSource, SqlSource, SquareSource, SybaseSource, TeradataSource, VerticaSource, XeroSource, ZohoSource.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TabularTranslator(*, additional_properties: Optional[Dict[str, Any]] = None, column_mappings: Optional[Any] = None, schema_mapping: Optional[Any] = None, collection_reference: Optional[Any] = None, map_complex_values_to_string: Optional[Any] = None, mappings: Optional[Any] = None, type_conversion: Optional[Any] = None, type_conversion_settings: Optional[azure.synapse.artifacts.models._models_py3.TypeConversionSettings] = None, **kwargs)

A copy activity tabular translator.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy translator type.Constant filled by server.

• column_mappings (any) – Column mappings. Example: “UserId: MyUserId, Group: MyGroup, Name: MyName” Type: string (or Expression with resultType string). This property will be retired. Please use mappings property.

• schema_mapping (any) – The schema mapping to map between tabular data and hierarchical data. Example: {“Column1”: “$.Column1”, “Column2”: “$.Column2.Property1”, “Column3”: “$.Column2.Property2”}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property.

• collection_reference (any) – The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object).

• map_complex_values_to_string (any) – Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean).

• mappings (any) – Column mappings with logical types. Tabular->tabular example: [{“source”:{“name”:”CustomerName”,”type”:”String”},”sink”:{“name”:”ClientName”,”type”:”String”}},{“source”:{“name”:”CustomerAddress”,”type”:”String”},”sink”:{“name”:”ClientAddress”,”type”:”String”}}]. Hierarchical->tabular example: [{“source”:{“path”:”$.CustomerName”,”type”:”String”},”sink”:{“name”:”ClientName”,”type”:”String”}},{“source”:{“path”:”$.CustomerAddress”,”type”:”String”},”sink”:{“name”:”ClientAddress”,”type”:”String”}}]. Type: object (or Expression with resultType object).

• type_conversion (any) – Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean).

• type_conversion_settings (TypeConversionSettings) – Type conversion settings.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• column_mappings (any) – Column mappings. Example: “UserId: MyUserId, Group: MyGroup, Name: MyName” Type: string (or Expression with resultType string). This property will be retired. Please use mappings property.

• schema_mapping (any) – The schema mapping to map between tabular data and hierarchical data. Example: {“Column1”: “$.Column1”, “Column2”: “$.Column2.Property1”, “Column3”: “$.Column2.Property2”}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property.

• collection_reference (any) – The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object).

• map_complex_values_to_string (any) – Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean).

• mappings (any) – Column mappings with logical types. Tabular->tabular example: [{“source”:{“name”:”CustomerName”,”type”:”String”},”sink”:{“name”:”ClientName”,”type”:”String”}},{“source”:{“name”:”CustomerAddress”,”type”:”String”},”sink”:{“name”:”ClientAddress”,”type”:”String”}}]. Hierarchical->tabular example: [{“source”:{“path”:”$.CustomerName”,”type”:”String”},”sink”:{“name”:”ClientName”,”type”:”String”}},{“source”:{“path”:”$.CustomerAddress”,”type”:”String”},”sink”:{“name”:”ClientAddress”,”type”:”String”}}]. Type: object (or Expression with resultType object).

• type_conversion (any) – Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean).

• type_conversion_settings (TypeConversionSettings) – Type conversion settings.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TarGZipReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, preserve_compression_file_name_as_folder: Optional[Any] = None, **kwargs)

The TarGZip compression read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The Compression setting type.Constant filled by server.

• preserve_compression_file_name_as_folder (any) – Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• preserve_compression_file_name_as_folder (any) – Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TarReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, preserve_compression_file_name_as_folder: Optional[Any] = None, **kwargs)

The Tar compression read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The Compression setting type.Constant filled by server.

• preserve_compression_file_name_as_folder (any) – Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• preserve_compression_file_name_as_folder (any) – Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TeradataAuthenticationType(value)

AuthenticationType to be used for connection.

BASIC = 'Basic'

WINDOWS = 'Windows'

class azure.synapse.artifacts.models.TeradataLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, server: Optional[Any] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.TeradataAuthenticationType]] = None, username: Optional[Any] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Linked service for Teradata data source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• server (any) – Server name for connection. Type: string (or Expression with resultType string).

• authentication_type (str or TeradataAuthenticationType) – AuthenticationType to be used for connection. Possible values include: “Basic”, “Windows”.

• username (any) – Username for authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• server (any) – Server name for connection. Type: string (or Expression with resultType string).

• authentication_type (str or TeradataAuthenticationType) – AuthenticationType to be used for connection. Possible values include: “Basic”, “Windows”.

• username (any) – Username for authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Password for authentication.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TeradataPartitionOption(value)

The partition mechanism that will be used for teradata read in parallel.

DYNAMIC_RANGE = 'DynamicRange'

HASH = 'Hash'

NONE = 'None'

class azure.synapse.artifacts.models.TeradataPartitionSettings(*, partition_column_name: Optional[Any] = None, partition_upper_bound: Optional[Any] = None, partition_lower_bound: Optional[Any] = None, **kwargs)

The settings that will be leveraged for teradata source partitioning.

Variables

• partition_column_name (any) – The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

Keyword Arguments

• partition_column_name (any) – The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string).

• partition_upper_bound (any) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

• partition_lower_bound (any) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TeradataSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, partition_option: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.TeradataPartitionOption]] = None, partition_settings: Optional[azure.synapse.artifacts.models._models_py3.TeradataPartitionSettings] = None, **kwargs)

A copy activity Teradata source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Teradata query. Type: string (or Expression with resultType string).

• partition_option (str or TeradataPartitionOption) – The partition mechanism that will be used for teradata read in parallel. Possible values include: “None”, “Hash”, “DynamicRange”.

• partition_settings (TeradataPartitionSettings) – The settings that will be leveraged for teradata source partitioning.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – Teradata query. Type: string (or Expression with resultType string).

• partition_option (str or TeradataPartitionOption) – The partition mechanism that will be used for teradata read in parallel. Possible values include: “None”, “Hash”, “DynamicRange”.

• partition_settings (TeradataPartitionSettings) – The settings that will be leveraged for teradata source partitioning.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TeradataTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, database: Optional[Any] = None, table: Optional[Any] = None, **kwargs)

The Teradata database dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• database (any) – The database name of Teradata. Type: string (or Expression with resultType string).

• table (any) – The table name of Teradata. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• database (any) – The database name of Teradata. Type: string (or Expression with resultType string).

• table (any) – The table name of Teradata. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TextFormat(*, additional_properties: Optional[Dict[str, Any]] = None, serializer: Optional[Any] = None, deserializer: Optional[Any] = None, column_delimiter: Optional[Any] = None, row_delimiter: Optional[Any] = None, escape_char: Optional[Any] = None, quote_char: Optional[Any] = None, null_value: Optional[Any] = None, encoding_name: Optional[Any] = None, treat_empty_as_null: Optional[Any] = None, skip_line_count: Optional[Any] = None, first_row_as_header: Optional[Any] = None, **kwargs)

The data stored in text format.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset storage format.Constant filled by server.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

• column_delimiter (any) – The column delimiter. Type: string (or Expression with resultType string).

• row_delimiter (any) – The row delimiter. Type: string (or Expression with resultType string).

• escape_char (any) – The escape character. Type: string (or Expression with resultType string).

• quote_char (any) – The quote character. Type: string (or Expression with resultType string).

• null_value (any) – The null value string. Type: string (or Expression with resultType string).

• encoding_name (any) – The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

• treat_empty_as_null (any) – Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).

• skip_line_count (any) – The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).

• first_row_as_header (any) – When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• serializer (any) – Serializer. Type: string (or Expression with resultType string).

• deserializer (any) – Deserializer. Type: string (or Expression with resultType string).

• column_delimiter (any) – The column delimiter. Type: string (or Expression with resultType string).

• row_delimiter (any) – The row delimiter. Type: string (or Expression with resultType string).

• escape_char (any) – The escape character. Type: string (or Expression with resultType string).

• quote_char (any) – The quote character. Type: string (or Expression with resultType string).

• null_value (any) – The null value string. Type: string (or Expression with resultType string).

• encoding_name (any) – The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

• treat_empty_as_null (any) – Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).

• skip_line_count (any) – The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).

• first_row_as_header (any) – When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• tags (dict[str, str]) – A set of tags. Resource tags.

• location (str) – Required. The geo-location where the resource lives.

Keyword Arguments

• tags (dict[str, str]) – A set of tags. Resource tags.

• location (str) – Required. The geo-location where the resource lives.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Transformation(*, name: str, description: Optional[str] = None, dataset: Optional[azure.synapse.artifacts.models._models_py3.DatasetReference] = None, linked_service: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, flowlet: Optional[azure.synapse.artifacts.models._models_py3.DataFlowReference] = None, **kwargs)

A data flow transformation.

All required parameters must be populated in order to send to Azure.

Variables

• name (str) – Required. Transformation name.

• description (str) – Transformation description.

• dataset (DatasetReference) – Dataset reference.

• linked_service (LinkedServiceReference) – Linked service reference.

• flowlet (DataFlowReference) – Flowlet Reference.

Keyword Arguments

• name (str) – Required. Transformation name.

• description (str) – Transformation description.

• dataset (DatasetReference) – Dataset reference.

• linked_service (LinkedServiceReference) – Linked service reference.

• flowlet (DataFlowReference) – Flowlet Reference.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Trigger(*, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, annotations: Optional[List[Any]] = None, **kwargs)

Azure Synapse nested object which contains information about creating pipeline run.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ChainingTrigger, MultiplePipelineTrigger, RerunTumblingWindowTrigger, TumblingWindowTrigger.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Trigger type.Constant filled by server.

• description (str) – Trigger description.

• runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: “Started”, “Stopped”, “Disabled”.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Trigger description.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus(*, trigger_name: str, provisioning_status: str, **kwargs)

Defines the response of a provision trigger dependency operation.

All required parameters must be populated in order to send to Azure.

Variables

• trigger_name (str) – Required. Trigger name.

• provisioning_status (str) – Required. Provisioning status.

Keyword Arguments

• trigger_name (str) – Required. Trigger name.

• provisioning_status (str) – Required. Provisioning status.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TriggerDependencyReference(*, reference_trigger: azure.synapse.artifacts.models._models_py3.TriggerReference, **kwargs)

Trigger referenced dependency.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: TumblingWindowTriggerDependencyReference.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – Required. The type of dependency reference.Constant filled by server.

• reference_trigger (TriggerReference) – Required. Referenced trigger.

Keyword Arguments

reference_trigger (TriggerReference) – Required. Referenced trigger.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TriggerListResponse(*, value: List[azure.synapse.artifacts.models._models_py3.TriggerResource], next_link: Optional[str] = None, **kwargs)

A list of trigger resources.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[TriggerResource]) – Required. List of triggers.

• next_link (str) – The link to the next page of results, if any remaining results exist.

Keyword Arguments

• value (list[TriggerResource]) – Required. List of triggers.

• next_link (str) – The link to the next page of results, if any remaining results exist.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TriggerPipelineReference(*, pipeline_reference: Optional[azure.synapse.artifacts.models._models_py3.PipelineReference] = None, parameters: Optional[Dict[str, Any]] = None, **kwargs)

Pipeline that needs to be triggered with the given parameters.

Variables

• pipeline_reference (PipelineReference) – Pipeline reference.

• parameters (dict[str, any]) – Pipeline parameters.

Keyword Arguments

• pipeline_reference (PipelineReference) – Pipeline reference.

• parameters (dict[str, any]) – Pipeline parameters.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TriggerReference(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.TriggerReferenceType], reference_name: str, **kwargs)

Trigger reference type.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or TriggerReferenceType) – Required. Trigger reference type. Possible values include: “TriggerReference”.

• reference_name (str) – Required. Reference trigger name.

Keyword Arguments

• type (str or TriggerReferenceType) – Required. Trigger reference type. Possible values include: “TriggerReference”.

• reference_name (str) – Required. Reference trigger name.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TriggerReferenceType(value)

Trigger reference type.

TRIGGER_REFERENCE = 'TriggerReference'

class azure.synapse.artifacts.models.TriggerResource(*, properties: azure.synapse.artifacts.models._models_py3.Trigger, **kwargs)

Trigger resource type.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• properties (Trigger) – Required. Properties of the trigger.

Keyword Arguments

properties (Trigger) – Required. Properties of the trigger.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TriggerRun(*, additional_properties: Optional[Dict[str, Any]] = None, **kwargs)

Trigger runs.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• trigger_run_id (str) – Trigger run id.

• trigger_name (str) – Trigger name.

• trigger_type (str) – Trigger type.

• trigger_run_timestamp (datetime) – Trigger run start time.

• status (str or TriggerRunStatus) – Trigger run status. Possible values include: “Succeeded”, “Failed”, “Inprogress”.

• message (str) – Trigger error message.

• properties (dict[str, str]) – List of property name and value related to trigger run. Name, value pair depends on type of trigger.

• triggered_pipelines (dict[str, str]) – List of pipeline name and run Id triggered by the trigger run.

Keyword Arguments

additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TriggerRunStatus(value)

Trigger run status.

FAILED = 'Failed'

INPROGRESS = 'Inprogress'

SUCCEEDED = 'Succeeded'

class azure.synapse.artifacts.models.TriggerRunsQueryResponse(*, value: List[azure.synapse.artifacts.models._models_py3.TriggerRun], continuation_token: Optional[str] = None, **kwargs)

A list of trigger runs.

All required parameters must be populated in order to send to Azure.

Variables

• value (list[TriggerRun]) – Required. List of trigger runs.

• continuation_token (str) – The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

Keyword Arguments

• value (list[TriggerRun]) – Required. List of trigger runs.

• continuation_token (str) – The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TriggerRuntimeState(value)

Enumerates possible state of Triggers.

DISABLED = 'Disabled'

STARTED = 'Started'

STOPPED = 'Stopped'

class azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus(**kwargs)

Defines the response of a trigger subscription operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• trigger_name (str) – Trigger name.

• status (str or EventSubscriptionStatus) – Event Subscription Status. Possible values include: “Enabled”, “Provisioning”, “Deprovisioning”, “Disabled”, “Unknown”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TumblingWindowFrequency(value)

Enumerates possible frequency option for the tumbling window trigger.

HOUR = 'Hour'

MINUTE = 'Minute'

MONTH = 'Month'

class azure.synapse.artifacts.models.TumblingWindowTrigger(*, pipeline: azure.synapse.artifacts.models._models_py3.TriggerPipelineReference, frequency: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.TumblingWindowFrequency], interval: int, start_time: datetime.datetime, max_concurrency: int, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, annotations: Optional[List[Any]] = None, end_time: Optional[datetime.datetime] = None, delay: Optional[Any] = None, retry_policy: Optional[azure.synapse.artifacts.models._models_py3.RetryPolicy] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.DependencyReference]] = None, **kwargs)

Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Trigger type.Constant filled by server.

• description (str) – Trigger description.

• runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: “Started”, “Stopped”, “Disabled”.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipeline (TriggerPipelineReference) – Required. Pipeline for which runs are created when an event is fired for trigger window that is ready.

• frequency (str or TumblingWindowFrequency) – Required. The frequency of the time windows. Possible values include: “Minute”, “Hour”, “Month”.

• interval (int) – Required. The interval of the time windows. The minimum interval allowed is 15 Minutes.

• start_time (datetime) – Required. The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

• end_time (datetime) – The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

• delay (any) – Specifies how long the trigger waits past due time before triggering new run. It doesn’t alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrency (int) – Required. The max number of parallel time windows (ready for execution) for which a new run is triggered.

• retry_policy (RetryPolicy) – Retry policy that will be applied for failed pipeline runs.

• depends_on (list[DependencyReference]) – Triggers that this trigger depends on. Only tumbling window triggers are supported.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Trigger description.

• annotations (list[any]) – List of tags that can be used for describing the trigger.

• pipeline (TriggerPipelineReference) – Required. Pipeline for which runs are created when an event is fired for trigger window that is ready.

• frequency (str or TumblingWindowFrequency) – Required. The frequency of the time windows. Possible values include: “Minute”, “Hour”, “Month”.

• interval (int) – Required. The interval of the time windows. The minimum interval allowed is 15 Minutes.

• start_time (datetime) – Required. The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

• end_time (datetime) – The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

• delay (any) – Specifies how long the trigger waits past due time before triggering new run. It doesn’t alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrency (int) – Required. The max number of parallel time windows (ready for execution) for which a new run is triggered.

• retry_policy (RetryPolicy) – Retry policy that will be applied for failed pipeline runs.

• depends_on (list[DependencyReference]) – Triggers that this trigger depends on. Only tumbling window triggers are supported.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.TumblingWindowTriggerDependencyReference(*, reference_trigger: azure.synapse.artifacts.models._models_py3.TriggerReference, offset: Optional[str] = None, size: Optional[str] = None, **kwargs)

Referenced tumbling window trigger dependency.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – Required. The type of dependency reference.Constant filled by server.

• reference_trigger (TriggerReference) – Required. Referenced trigger.

• offset (str) – Timespan applied to the start time of a tumbling window when evaluating dependency.

• size (str) – The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.

Keyword Arguments

• reference_trigger (TriggerReference) – Required. Referenced trigger.

• offset (str) – Timespan applied to the start time of a tumbling window when evaluating dependency.

• size (str) – The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Type(value)

Linked service reference type.

LINKED_SERVICE_REFERENCE = 'LinkedServiceReference'

class azure.synapse.artifacts.models.TypeConversionSettings(*, allow_data_truncation: Optional[Any] = None, treat_boolean_as_number: Optional[Any] = None, date_time_format: Optional[Any] = None, date_time_offset_format: Optional[Any] = None, time_span_format: Optional[Any] = None, culture: Optional[Any] = None, **kwargs)

Type conversion settings.

Variables

• allow_data_truncation (any) – Whether to allow data truncation when converting the data. Type: boolean (or Expression with resultType boolean).

• treat_boolean_as_number (any) – Whether to treat boolean values as numbers. Type: boolean (or Expression with resultType boolean).

• date_time_format (any) – The format for DateTime values. Type: string (or Expression with resultType string).

• date_time_offset_format (any) – The format for DateTimeOffset values. Type: string (or Expression with resultType string).

• time_span_format (any) – The format for TimeSpan values. Type: string (or Expression with resultType string).

• culture (any) – The culture used to convert data from/to string. Type: string (or Expression with resultType string).

Keyword Arguments

• allow_data_truncation (any) – Whether to allow data truncation when converting the data. Type: boolean (or Expression with resultType boolean).

• treat_boolean_as_number (any) – Whether to treat boolean values as numbers. Type: boolean (or Expression with resultType boolean).

• date_time_format (any) – The format for DateTime values. Type: string (or Expression with resultType string).

• date_time_offset_format (any) – The format for DateTimeOffset values. Type: string (or Expression with resultType string).

• time_span_format (any) – The format for TimeSpan values. Type: string (or Expression with resultType string).

• culture (any) – The culture used to convert data from/to string. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.UntilActivity(*, name: str, expression: azure.synapse.artifacts.models._models_py3.Expression, activities: List[azure.synapse.artifacts.models._models_py3.Activity], additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, timeout: Optional[Any] = None, **kwargs)

This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• expression (Expression) – Required. An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true.

• timeout (any) – Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• activities (list[Activity]) – Required. List of activities to execute.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• expression (Expression) – Required. An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true.

• timeout (any) – Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• activities (list[Activity]) – Required. List of activities to execute.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.UserProperty(*, name: str, value: Any, **kwargs)

User property.

All required parameters must be populated in order to send to Azure.

Variables

• name (str) – Required. User property name.

• value (any) – Required. User property value. Type: string (or Expression with resultType string).

Keyword Arguments

• name (str) – Required. User property name.

• value (any) – Required. User property value. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ValidationActivity(*, name: str, dataset: azure.synapse.artifacts.models._models_py3.DatasetReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, timeout: Optional[Any] = None, sleep: Optional[Any] = None, minimum_size: Optional[Any] = None, child_items: Optional[Any] = None, **kwargs)

This activity verifies that an external resource exists.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• timeout (any) – Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sleep (any) – A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer).

• minimum_size (any) – Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer).

• child_items (any) – Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean).

• dataset (DatasetReference) – Required. Validation activity dataset reference.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• timeout (any) – Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• sleep (any) – A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer).

• minimum_size (any) – Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer).

• child_items (any) – Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean).

• dataset (DatasetReference) – Required. Validation activity dataset reference.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.VariableSpecification(*, type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.VariableType], default_value: Optional[Any] = None, **kwargs)

Definition of a single variable for a Pipeline.

All required parameters must be populated in order to send to Azure.

Variables

• type (str or VariableType) – Required. Variable type. Possible values include: “String”, “Bool”, “Boolean”, “Array”.

• default_value (any) – Default value of variable.

Keyword Arguments

• type (str or VariableType) – Required. Variable type. Possible values include: “String”, “Bool”, “Boolean”, “Array”.

• default_value (any) – Default value of variable.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.VariableType(value)

Variable type.

ARRAY = 'Array'

BOOL = 'Bool'

BOOLEAN = 'Boolean'

STRING = 'String'

class azure.synapse.artifacts.models.VerticaLinkedService(*, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_string: Optional[Any] = None, pwd: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Vertica linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_string (any) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

• pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.VerticaSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Vertica source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.VerticaTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, table: Optional[Any] = None, schema_type_properties_schema: Optional[Any] = None, **kwargs)

Vertica dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Vertica. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Vertica. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – This property will be retired. Please consider using schema + table properties instead.

• table (any) – The table name of the Vertica. Type: string (or Expression with resultType string).

• schema_type_properties_schema (any) – The schema name of the Vertica. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.VirtualNetworkProfile(*, compute_subnet_id: Optional[str] = None, **kwargs)

Virtual Network Profile.

Variables

compute_subnet_id (str) – Subnet ID used for computes in workspace.

Keyword Arguments

compute_subnet_id (str) – Subnet ID used for computes in workspace.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WaitActivity(*, name: str, wait_time_in_seconds: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, **kwargs)

This activity suspends pipeline execution for the specified interval.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• wait_time_in_seconds (any) – Required. Duration in seconds.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• wait_time_in_seconds (any) – Required. Duration in seconds.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WebActivity(*, name: str, method: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.WebActivityMethod], url: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, headers: Optional[Any] = None, body: Optional[Any] = None, authentication: Optional[azure.synapse.artifacts.models._models_py3.WebActivityAuthentication] = None, datasets: Optional[List[azure.synapse.artifacts.models._models_py3.DatasetReference]] = None, linked_services: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceReference]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, **kwargs)

Web activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• method (str or WebActivityMethod) – Required. Rest API method for target endpoint. Possible values include: “GET”, “POST”, “PUT”, “DELETE”.

• url (any) – Required. Web activity target endpoint and path. Type: string (or Expression with resultType string).

• headers (any) – Represents the headers that will be sent to the request. For example, to set the language and type on a request: “headers” : { “Accept-Language”: “en-us”, “Content-Type”: “application/json” }. Type: string (or Expression with resultType string).

• body (any) – Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).

• authentication (WebActivityAuthentication) – Authentication method used for calling the endpoint.

• datasets (list[DatasetReference]) – List of datasets passed to web endpoint.

• linked_services (list[LinkedServiceReference]) – List of linked services passed to web endpoint.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• linked_service_name (LinkedServiceReference) – Linked service reference.

• policy (ActivityPolicy) – Activity policy.

• method (str or WebActivityMethod) – Required. Rest API method for target endpoint. Possible values include: “GET”, “POST”, “PUT”, “DELETE”.

• url (any) – Required. Web activity target endpoint and path. Type: string (or Expression with resultType string).

• headers (any) – Represents the headers that will be sent to the request. For example, to set the language and type on a request: “headers” : { “Accept-Language”: “en-us”, “Content-Type”: “application/json” }. Type: string (or Expression with resultType string).

• body (any) – Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).

• authentication (WebActivityAuthentication) – Authentication method used for calling the endpoint.

• datasets (list[DatasetReference]) – List of datasets passed to web endpoint.

• linked_services (list[LinkedServiceReference]) – List of linked services passed to web endpoint.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WebActivityAuthentication(*, type: str, pfx: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, username: Optional[str] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, resource: Optional[str] = None, **kwargs)

Web activity authentication properties.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – Required. Web activity authentication (Basic/ClientCertificate/MSI).

• pfx (SecretBase) – Base64-encoded contents of a PFX file.

• username (str) – Web activity authentication user name for basic authentication.

• password (SecretBase) – Password for the PFX file or basic authentication.

• resource (str) – Resource for which Azure Auth token will be requested when using MSI Authentication.

Keyword Arguments

• type (str) – Required. Web activity authentication (Basic/ClientCertificate/MSI).

• pfx (SecretBase) – Base64-encoded contents of a PFX file.

• username (str) – Web activity authentication user name for basic authentication.

• password (SecretBase) – Password for the PFX file or basic authentication.

• resource (str) – Resource for which Azure Auth token will be requested when using MSI Authentication.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WebActivityMethod(value)

The list of HTTP methods supported by a WebActivity.

DELETE = 'DELETE'

GET = 'GET'

POST = 'POST'

PUT = 'PUT'

class azure.synapse.artifacts.models.WebAnonymousAuthentication(*, url: Any, **kwargs)

A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.

All required parameters must be populated in order to send to Azure.

Variables

• url (any) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

• authentication_type (str or WebAuthenticationType) – Required. Type of authentication used to connect to the web table source.Constant filled by server. Possible values include: “Basic”, “Anonymous”, “ClientCertificate”.

Keyword Arguments

url (any) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WebAuthenticationType(value)

Type of authentication used to connect to the web table source.

ANONYMOUS = 'Anonymous'

BASIC = 'Basic'

CLIENT_CERTIFICATE = 'ClientCertificate'

class azure.synapse.artifacts.models.WebBasicAuthentication(*, url: Any, username: Any, password: azure.synapse.artifacts.models._models_py3.SecretBase, **kwargs)

A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.

All required parameters must be populated in order to send to Azure.

Variables

• url (any) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

• authentication_type (str or WebAuthenticationType) – Required. Type of authentication used to connect to the web table source.Constant filled by server. Possible values include: “Basic”, “Anonymous”, “ClientCertificate”.

• username (any) – Required. User name for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Required. The password for Basic authentication.

Keyword Arguments

• url (any) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

• username (any) – Required. User name for Basic authentication. Type: string (or Expression with resultType string).

• password (SecretBase) – Required. The password for Basic authentication.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WebClientCertificateAuthentication(*, url: Any, pfx: azure.synapse.artifacts.models._models_py3.SecretBase, password: azure.synapse.artifacts.models._models_py3.SecretBase, **kwargs)

A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.

All required parameters must be populated in order to send to Azure.

Variables

• url (any) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

• authentication_type (str or WebAuthenticationType) – Required. Type of authentication used to connect to the web table source.Constant filled by server. Possible values include: “Basic”, “Anonymous”, “ClientCertificate”.

• pfx (SecretBase) – Required. Base64-encoded contents of a PFX file.

• password (SecretBase) – Required. Password for the PFX file.

Keyword Arguments

• url (any) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

• pfx (SecretBase) – Required. Base64-encoded contents of a PFX file.

• password (SecretBase) – Required. Password for the PFX file.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WebHookActivity(*, name: str, method: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.WebHookActivityMethod], url: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, timeout: Optional[str] = None, headers: Optional[Any] = None, body: Optional[Any] = None, authentication: Optional[azure.synapse.artifacts.models._models_py3.WebActivityAuthentication] = None, report_status_on_call_back: Optional[Any] = None, **kwargs)

WebHook activity.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• type (str) – Required. Type of activity.Constant filled by server.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• method (str or WebHookActivityMethod) – Required. Rest API method for target endpoint. Possible values include: “POST”.

• url (any) – Required. WebHook activity target endpoint and path. Type: string (or Expression with resultType string).

• timeout (str) – The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• headers (any) – Represents the headers that will be sent to the request. For example, to set the language and type on a request: “headers” : { “Accept-Language”: “en-us”, “Content-Type”: “application/json” }. Type: string (or Expression with resultType string).

• body (any) – Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).

• authentication (WebActivityAuthentication) – Authentication method used for calling the endpoint.

• report_status_on_call_back (any) – When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• name (str) – Required. Activity name.

• description (str) – Activity description.

• depends_on (list[ActivityDependency]) – Activity depends on condition.

• user_properties (list[UserProperty]) – Activity user properties.

• method (str or WebHookActivityMethod) – Required. Rest API method for target endpoint. Possible values include: “POST”.

• url (any) – Required. WebHook activity target endpoint and path. Type: string (or Expression with resultType string).

• timeout (str) – The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• headers (any) – Represents the headers that will be sent to the request. For example, to set the language and type on a request: “headers” : { “Accept-Language”: “en-us”, “Content-Type”: “application/json” }. Type: string (or Expression with resultType string).

• body (any) – Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).

• authentication (WebActivityAuthentication) – Authentication method used for calling the endpoint.

• report_status_on_call_back (any) – When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WebHookActivityMethod(value)

The list of HTTP methods supported by a WebHook activity.

POST = 'POST'

class azure.synapse.artifacts.models.WebLinkedService(*, type_properties: azure.synapse.artifacts.models._models_py3.WebLinkedServiceTypeProperties, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, **kwargs)

Web linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• type_properties (WebLinkedServiceTypeProperties) – Required. Web linked service properties.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• type_properties (WebLinkedServiceTypeProperties) – Required. Web linked service properties.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WebLinkedServiceTypeProperties(*, url: Any, **kwargs)

Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: WebAnonymousAuthentication, WebBasicAuthentication, WebClientCertificateAuthentication.

All required parameters must be populated in order to send to Azure.

Variables

• url (any) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

• authentication_type (str or WebAuthenticationType) – Required. Type of authentication used to connect to the web table source.Constant filled by server. Possible values include: “Basic”, “Anonymous”, “ClientCertificate”.

Keyword Arguments

url (any) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WebSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity source for web page table.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WebTableDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, index: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, path: Optional[Any] = None, **kwargs)

The dataset points to a HTML table in the web page.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• index (any) – Required. The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0.

• path (any) – The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• index (any) – Required. The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0.

• path (any) – The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.Workspace(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.synapse.artifacts.models._models_py3.ManagedIdentity] = None, default_data_lake_storage: Optional[azure.synapse.artifacts.models._models_py3.DataLakeStorageAccountDetails] = None, sql_administrator_login_password: Optional[str] = None, managed_resource_group_name: Optional[str] = None, sql_administrator_login: Optional[str] = None, virtual_network_profile: Optional[azure.synapse.artifacts.models._models_py3.VirtualNetworkProfile] = None, connectivity_endpoints: Optional[Dict[str, str]] = None, managed_virtual_network: Optional[str] = None, private_endpoint_connections: Optional[List[azure.synapse.artifacts.models._models_py3.PrivateEndpointConnection]] = None, encryption: Optional[azure.synapse.artifacts.models._models_py3.EncryptionDetails] = None, managed_virtual_network_settings: Optional[azure.synapse.artifacts.models._models_py3.ManagedVirtualNetworkSettings] = None, workspace_repository_configuration: Optional[azure.synapse.artifacts.models._models_py3.WorkspaceRepositoryConfiguration] = None, purview_configuration: Optional[azure.synapse.artifacts.models._models_py3.PurviewConfiguration] = None, **kwargs)

A workspace.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• tags (dict[str, str]) – A set of tags. Resource tags.

• location (str) – Required. The geo-location where the resource lives.

• identity (ManagedIdentity) – Identity of the workspace.

• default_data_lake_storage (DataLakeStorageAccountDetails) – Workspace default data lake storage account details.

• sql_administrator_login_password (str) – SQL administrator login password.

• managed_resource_group_name (str) – Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and ‘-‘, ‘_’, ‘(‘, ‘)’ and’.’. Note that the name cannot end with ‘.’.

• provisioning_state (str) – Resource provisioning state.

• sql_administrator_login (str) – Login for workspace SQL active directory administrator.

• virtual_network_profile (VirtualNetworkProfile) – Virtual Network profile.

• connectivity_endpoints (dict[str, str]) – Connectivity endpoints.

• managed_virtual_network (str) – Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.

• private_endpoint_connections (list[PrivateEndpointConnection]) – Private endpoint connections to the workspace.

• encryption (EncryptionDetails) – The encryption details of the workspace.

• workspace_uid (str) – The workspace unique identifier.

• extra_properties (dict[str, any]) – Workspace level configs and feature flags.

• managed_virtual_network_settings (ManagedVirtualNetworkSettings) – Managed Virtual Network Settings.

• workspace_repository_configuration (WorkspaceRepositoryConfiguration) – Git integration settings.

• purview_configuration (PurviewConfiguration) – Purview Configuration.

• adla_resource_id (str) – The ADLA resource ID.

Keyword Arguments

• tags (dict[str, str]) – A set of tags. Resource tags.

• location (str) – Required. The geo-location where the resource lives.

• identity (ManagedIdentity) – Identity of the workspace.

• default_data_lake_storage (DataLakeStorageAccountDetails) – Workspace default data lake storage account details.

• sql_administrator_login_password (str) – SQL administrator login password.

• managed_resource_group_name (str) – Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and ‘-‘, ‘_’, ‘(‘, ‘)’ and’.’. Note that the name cannot end with ‘.’.

• sql_administrator_login (str) – Login for workspace SQL active directory administrator.

• virtual_network_profile (VirtualNetworkProfile) – Virtual Network profile.

• connectivity_endpoints (dict[str, str]) – Connectivity endpoints.

• managed_virtual_network (str) – Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.

• private_endpoint_connections (list[PrivateEndpointConnection]) – Private endpoint connections to the workspace.

• encryption (EncryptionDetails) – The encryption details of the workspace.

• managed_virtual_network_settings (ManagedVirtualNetworkSettings) – Managed Virtual Network Settings.

• workspace_repository_configuration (WorkspaceRepositoryConfiguration) – Git integration settings.

• purview_configuration (PurviewConfiguration) – Purview Configuration.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WorkspaceIdentity(**kwargs)

Identity properties of the workspace resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• type (str) – The identity type. Currently the only supported type is ‘SystemAssigned’. Has constant value: “SystemAssigned”.

• principal_id (str) – The principal id of the identity.

• tenant_id (str) – The client tenant id of the identity.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

type = 'SystemAssigned'

class azure.synapse.artifacts.models.WorkspaceKeyDetails(*, name: Optional[str] = None, key_vault_url: Optional[str] = None, **kwargs)

Details of the customer managed key associated with the workspace.

Variables

• name (str) – Workspace Key sub-resource name.

• key_vault_url (str) – Workspace Key sub-resource key vault url.

Keyword Arguments

• name (str) – Workspace Key sub-resource name.

• key_vault_url (str) – Workspace Key sub-resource key vault url.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WorkspaceRepositoryConfiguration(*, type: Optional[str] = None, host_name: Optional[str] = None, account_name: Optional[str] = None, project_name: Optional[str] = None, repository_name: Optional[str] = None, collaboration_branch: Optional[str] = None, root_folder: Optional[str] = None, last_commit_id: Optional[str] = None, tenant_id: Optional[str] = None, client_id: Optional[str] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.GitHubClientSecret] = None, **kwargs)

Git integration settings.

Variables

• type (str) – Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration.

• host_name (str) – GitHub Enterprise host name. For example: https://github.mydomain.com.

• account_name (str) – Account name.

• project_name (str) – VSTS project name.

• repository_name (str) – Repository name.

• collaboration_branch (str) – Collaboration branch.

• root_folder (str) – Root folder to use in the repository.

• last_commit_id (str) – The last commit ID.

• tenant_id (str) – The VSTS tenant ID.

• client_id (str) – GitHub bring your own app client id.

• client_secret (GitHubClientSecret) – GitHub bring your own app client secret information.

Keyword Arguments

• type (str) – Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration.

• host_name (str) – GitHub Enterprise host name. For example: https://github.mydomain.com.

• account_name (str) – Account name.

• project_name (str) – VSTS project name.

• repository_name (str) – Repository name.

• collaboration_branch (str) – Collaboration branch.

• root_folder (str) – Root folder to use in the repository.

• last_commit_id (str) – The last commit ID.

• tenant_id (str) – The VSTS tenant ID.

• client_id (str) – GitHub bring your own app client id.

• client_secret (GitHubClientSecret) – GitHub bring your own app client secret information.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.WorkspaceUpdateParameters(*, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.synapse.artifacts.models._models_py3.WorkspaceIdentity] = None, **kwargs)

Parameters for updating a workspace resource.

Variables

• tags (dict[str, str]) – A set of tags. The resource tags.

• identity (WorkspaceIdentity) – Managed service identity of the workspace.

Keyword Arguments

• tags (dict[str, str]) – A set of tags. The resource tags.

• identity (WorkspaceIdentity) – Managed service identity of the workspace.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.XeroLinkedService(*, host: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_properties: Optional[Any] = None, consumer_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, private_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Xero Service linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object.

• host (any) – Required. The endpoint of the Xero server. (i.e. api.xero.com).

• consumer_key (SecretBase) – The consumer key associated with the Xero application.

• private_key (SecretBase) – The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings( ).

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object.

• host (any) – Required. The endpoint of the Xero server. (i.e. api.xero.com).

• consumer_key (SecretBase) – The consumer key associated with the Xero application.

• private_key (SecretBase) – The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings( ).

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.XeroObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Xero Service dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.XeroSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Xero Service source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.XmlDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, location: Optional[azure.synapse.artifacts.models._models_py3.DatasetLocation] = None, encoding_name: Optional[Any] = None, null_value: Optional[Any] = None, compression: Optional[azure.synapse.artifacts.models._models_py3.DatasetCompression] = None, **kwargs)

Xml dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the json data storage.

• encoding_name (any) – The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

• null_value (any) – The null value string. Type: string (or Expression with resultType string).

• compression (DatasetCompression) – The data compression method used for the json dataset.

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• location (DatasetLocation) – The location of the json data storage.

• encoding_name (any) – The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

• null_value (any) – The null value string. Type: string (or Expression with resultType string).

• compression (DatasetCompression) – The data compression method used for the json dataset.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.XmlReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, compression_properties: Optional[azure.synapse.artifacts.models._models_py3.CompressionReadSettings] = None, validation_mode: Optional[Any] = None, detect_data_type: Optional[Any] = None, namespaces: Optional[Any] = None, namespace_prefixes: Optional[Any] = None, **kwargs)

Xml read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The read setting type.Constant filled by server.

• compression_properties (CompressionReadSettings) – Compression settings.

• validation_mode (any) – Indicates what validation method is used when reading the xml files. Allowed values: ‘none’, ‘xsd’, or ‘dtd’. Type: string (or Expression with resultType string).

• detect_data_type (any) – Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).

• namespaces (any) – Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).

• namespace_prefixes (any) – Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: “{“http://www.example.com/xml”:”prefix”}” Type: object (or Expression with resultType object).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• compression_properties (CompressionReadSettings) – Compression settings.

• validation_mode (any) – Indicates what validation method is used when reading the xml files. Allowed values: ‘none’, ‘xsd’, or ‘dtd’. Type: string (or Expression with resultType string).

• detect_data_type (any) – Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).

• namespaces (any) – Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).

• namespace_prefixes (any) – Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: “{“http://www.example.com/xml”:”prefix”}” Type: object (or Expression with resultType object).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.XmlSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, store_settings: Optional[azure.synapse.artifacts.models._models_py3.StoreReadSettings] = None, format_settings: Optional[azure.synapse.artifacts.models._models_py3.XmlReadSettings] = None, additional_columns: Optional[Any] = None, **kwargs)

A copy activity Xml source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Xml store settings.

• format_settings (XmlReadSettings) – Xml format settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• store_settings (StoreReadSettings) – Xml store settings.

• format_settings (XmlReadSettings) – Xml format settings.

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ZipDeflateReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, preserve_zip_file_name_as_folder: Optional[Any] = None, **kwargs)

The ZipDeflate compression read settings.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. The Compression setting type.Constant filled by server.

• preserve_zip_file_name_as_folder (any) – Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• preserve_zip_file_name_as_folder (any) – Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ZohoLinkedService(*, endpoint: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, connection_properties: Optional[Any] = None, access_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, use_encrypted_endpoints: Optional[Any] = None, use_host_verification: Optional[Any] = None, use_peer_verification: Optional[Any] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Zoho server linked service.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of linked service.Constant filled by server.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object.

• endpoint (any) – Required. The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private).

• access_token (SecretBase) – The access token for Zoho authentication.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• connect_via (IntegrationRuntimeReference) – The integration runtime reference.

• description (str) – Linked service description.

• parameters (dict[str, ParameterSpecification]) – Parameters for linked service.

• annotations (list[any]) – List of tags that can be used for describing the linked service.

• connection_properties (any) – Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object.

• endpoint (any) – Required. The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private).

• access_token (SecretBase) – The access token for Zoho authentication.

• use_encrypted_endpoints (any) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

• use_host_verification (any) – Specifies whether to require the host name in the server’s certificate to match the host name of the server when connecting over SSL. The default value is true.

• use_peer_verification (any) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

• encrypted_credential (any) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ZohoObjectDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, table_name: Optional[Any] = None, **kwargs)

Zoho server dataset.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Type of dataset.Constant filled by server.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• description (str) – Dataset description.

• structure (any) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

• schema (any) – Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

• linked_service_name (LinkedServiceReference) – Required. Linked service reference.

• parameters (dict[str, ParameterSpecification]) – Parameters for dataset.

• annotations (list[any]) – List of tags that can be used for describing the Dataset.

• folder (DatasetFolder) – The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

• table_name (any) – The table name. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list

class azure.synapse.artifacts.models.ZohoSource(*, additional_properties: Optional[Dict[str, Any]] = None, source_retry_count: Optional[Any] = None, source_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, query_timeout: Optional[Any] = None, additional_columns: Optional[Any] = None, query: Optional[Any] = None, **kwargs)

A copy activity Zoho server source.

All required parameters must be populated in order to send to Azure.

Variables

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• type (str) – Required. Copy source type.Constant filled by server.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

Keyword Arguments

• additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.

• source_retry_count (any) – Source retry count. Type: integer (or Expression with resultType integer).

• source_retry_wait (any) – Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• max_concurrent_connections (any) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

• query_timeout (any) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

• additional_columns (any) – Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

• query (any) – A query to retrieve data from source. Type: string (or Expression with resultType string).

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

Parse a str using the RestAPI syntax and return a model.

Parameters

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()

classmethod from_dict(data, key_extractors=None, content_type=None)

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()

serialize(keep_readonly=False, **kwargs)

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters

keep_readonly (bool) – If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

dict

validate()

Validate this model recursively and return a list of ValidationError.

Returns

A list of validation error

Return type

list