azure.synapse.artifacts.models package

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

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.

Parameters
  • additional_properties (dict[str, object]) – 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.

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

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

Advanced usage might optionaly use a callback as parameter:

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

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

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

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

Parameters

key_transformer (function) – A key transformer function.

Returns

A dict JSON compatible object

Return type

dict

classmethod deserialize(data, content_type=None)

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

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

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

Returns

An instance of this model

Raises

DeserializationError if something went wrong

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

Parse a dict using given key extractor return a model.

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

Parameters
  • data (dict) – A dict using RestAPI structure

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

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()
serialize(keep_readonly=False, **kwargs)

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

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

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

Parameters

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

Returns

A dict JSON compatible object

Return type

dict

validate()

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, DependencyCondition]], additional_properties: Optional[Dict[str, object]] = None, **kwargs)[source]

Activity dependency information.

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

Parameters
  • additional_properties (dict[str, object]) – 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, object]] = None, timeout: object = None, retry: object = None, retry_interval_in_seconds: Optional[int] = None, secure_input: Optional[bool] = None, secure_output: Optional[bool] = None, **kwargs)[source]

Execution policy for an activity.

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

  • timeout (object) – 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 (object) – 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, object]] = None, **kwargs)[source]

Information about an activity run in a pipeline.

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

Parameters

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

Variables
  • 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 (object) – The input for the activity.

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

  • error (object) – The error if any from the activity 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.ActivityRunsQueryResponse(*, value: List[ActivityRun], continuation_token: Optional[str] = None, **kwargs)[source]

A list activity runs.

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

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

Response body structure for starting data flow debug session.

Parameters

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: object = None, value: object = None, **kwargs)[source]

Specify the column name and value of additional columns.

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

  • value (object) – 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: object, marketplace_id: object, seller_id: object, access_key_id: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, mws_auth_token: Optional[SecretBase] = None, secret_key: Optional[SecretBase] = None, use_encrypted_endpoints: object = None, use_host_verification: object = None, use_peer_verification: object = None, encrypted_credential: object = None, **kwargs)[source]

Amazon Marketplace Web Service linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

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

  • marketplace_id (object) – 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 (object) – Required. The Amazon seller ID.

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

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

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

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

  • use_host_verification (object) – 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 (object) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

  • encrypted_credential (object) – 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, object]] = None, description: Optional[str] = None, structure: object = None, schema: object = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[DatasetFolder] = None, table_name: object = None, **kwargs)[source]

Amazon Marketplace Web Service dataset.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

  • schema (object) – 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[object]) – 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 (object) – 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, object]] = None, source_retry_count: object = None, source_retry_wait: object = None, max_concurrent_connections: object = None, query_timeout: object = None, additional_columns: Optional[List[AdditionalColumns]] = None, query: object = None, **kwargs)[source]

A copy activity Amazon Marketplace Web Service source.

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

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

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

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

  • source_retry_wait (object) – 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 (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

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

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

  • query (object) – 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.AmazonRedshiftLinkedService(*, server: object, database: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, username: object = None, password: Optional[SecretBase] = None, port: object = None, encrypted_credential: object = None, **kwargs)[source]

Linked service for Amazon Redshift.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

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

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

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

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

  • port (object) – 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 (object) – 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, object]] = None, source_retry_count: object = None, source_retry_wait: object = None, max_concurrent_connections: object = None, query_timeout: object = None, additional_columns: Optional[List[AdditionalColumns]] = None, query: object = None, redshift_unload_settings: Optional[RedshiftUnloadSettings] = None, **kwargs)[source]

A copy activity source for Amazon Redshift Source.

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

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

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

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

  • source_retry_wait (object) – 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 (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

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

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

  • query (object) – 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, object]] = None, description: Optional[str] = None, structure: object = None, schema: object = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[DatasetFolder] = None, table_name: object = None, table: object = None, schema_type_properties_schema: object = None, **kwargs)[source]

The Amazon Redshift table dataset.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

  • schema (object) – 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[object]) – 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 (object) – This property will be retired. Please consider using schema + table properties instead.

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

  • schema_type_properties_schema (object) – 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: object, additional_properties: Optional[Dict[str, object]] = None, description: Optional[str] = None, structure: object = None, schema: object = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[DatasetFolder] = None, key: object = None, prefix: object = None, version: object = None, modified_datetime_start: object = None, modified_datetime_end: object = None, format: Optional[DatasetStorageFormat] = None, compression: Optional[DatasetCompression] = None, **kwargs)[source]

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.

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

  • schema (object) – 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[object]) – 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 (object) – Required. The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).

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

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

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

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

  • modified_datetime_end (object) – 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, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, authentication_type: object = None, access_key_id: object = None, secret_access_key: Optional[SecretBase] = None, service_url: object = None, session_token: Optional[SecretBase] = None, encrypted_credential: object = None, **kwargs)[source]

Linked service for Amazon S3.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

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

  • access_key_id (object) – 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 (object) – 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 (object) – 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, object]] = None, folder_path: object = None, file_name: object = None, bucket_name: object = None, version: object = None, **kwargs)[source]

The location of amazon S3 dataset.

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

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

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

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

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

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

  • version (object) – 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, object]] = None, max_concurrent_connections: object = None, recursive: object = None, wildcard_folder_path: object = None, wildcard_file_name: object = None, prefix: object = None, file_list_path: object = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: object = None, delete_files_after_completion: object = None, modified_datetime_start: object = None, modified_datetime_end: object = None, **kwargs)[source]

Azure data lake store read settings.

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

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

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

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

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

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

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

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

  • file_list_path (object) – 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 (object) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

  • delete_files_after_completion (object) – 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 (object) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

  • modified_datetime_end (object) – 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, object]] = None, description: Optional[str] = None, depends_on: Optional[List[ActivityDependency]] = None, user_properties: Optional[List[UserProperty]] = None, variable_name: Optional[str] = None, value: object = None, **kwargs)[source]

Append value for a Variable of type Array.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – 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)[source]

Request body structure for rename artifact.

Parameters

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

Auto-pausing properties of a Big Data pool powered by Apache Spark.

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

Auto-scaling properties of a Big Data pool powered by Apache Spark.

Parameters
  • 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.AvroDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, object]] = None, description: Optional[str] = None, structure: object = None, schema: object = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[DatasetFolder] = None, location: Optional[DatasetLocation] = None, avro_compression_codec: object = None, avro_compression_level: Optional[int] = None, **kwargs)[source]

Avro dataset.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

  • schema (object) – 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[object]) – 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 (object) – 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, object]] = None, serializer: object = None, deserializer: object = None, **kwargs)[source]

The data stored in Avro format.

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

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

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

  • serializer (object) – Serializer. Type: string (or Expression with resultType string).

  • deserializer (object) – 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, object]] = None, write_batch_size: object = None, write_batch_timeout: object = None, sink_retry_count: object = None, sink_retry_wait: object = None, max_concurrent_connections: object = None, store_settings: Optional[StoreWriteSettings] = None, format_settings: Optional[AvroWriteSettings] = None, **kwargs)[source]

A copy activity Avro sink.

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

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

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

  • write_batch_size (object) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

  • write_batch_timeout (object) – 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 (object) – Sink retry count. Type: integer (or Expression with resultType integer).

  • sink_retry_wait (object) – 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 (object) – 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, object]] = None, source_retry_count: object = None, source_retry_wait: object = None, max_concurrent_connections: object = None, store_settings: Optional[StoreReadSettings] = None, additional_columns: Optional[List[AdditionalColumns]] = None, **kwargs)[source]

A copy activity Avro source.

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

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

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

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

  • source_retry_wait (object) – 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 (object) – 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 (list[AdditionalColumns]) – Specifies the additional columns to be added to source data. Type: array of objects (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, object]] = None, record_name: Optional[str] = None, record_namespace: Optional[str] = None, max_rows_per_file: object = None, file_name_prefix: object = None, **kwargs)[source]

Avro write settings.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – 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 (object) – 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: object, batch_uri: object, pool_name: object, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, access_key: Optional[SecretBase] = None, encrypted_credential: object = None, **kwargs)[source]

Azure Batch linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • account_name (object) – Required. The Azure Batch account name. Type: string (or Expression with resultType string).

  • access_key (SecretBase) – The Azure Batch account access key.

  • batch_uri (object) – Required. The Azure Batch URI. Type: string (or Expression with resultType string).

  • pool_name (object) – 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 (object) – 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, object]] = None, description: Optional[str] = None, structure: object = None, schema: object = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[DatasetFolder] = None, folder_path: object = None, table_root_location: object = None, file_name: object = None, modified_datetime_start: object = None, modified_datetime_end: object = None, format: Optional[DatasetStorageFormat] = None, compression: Optional[DatasetCompression] = None, **kwargs)[source]

The Azure Blob storage.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

  • schema (object) – 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[object]) – 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 (object) – The path of the Azure Blob storage. Type: string (or Expression with resultType string).

  • table_root_location (object) – The root of blob path. Type: string (or Expression with resultType string).

  • file_name (object) – The name of the Azure Blob. Type: string (or Expression with resultType string).

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

  • modified_datetime_end (object) – 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, object]] = None, description: Optional[str] = None, structure: object = None, schema: object = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[DatasetFolder] = None, folder_path: object = None, file_name: object = None, format: Optional[DatasetStorageFormat] = None, compression: Optional[DatasetCompression] = None, **kwargs)[source]

The Azure Data Lake Storage Gen2 storage.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

  • schema (object) – 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[object]) – 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 (object) – The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string).

  • file_name (object) – 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: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, account_key: object = None, service_principal_id: object = None, service_principal_key: Optional[SecretBase] = None, tenant: object = None, azure_cloud_type: object = None, encrypted_credential: object = None, **kwargs)[source]

Azure Data Lake Storage Gen2 linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • url (object) – Required. Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).

  • account_key (object) – Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).

  • service_principal_id (object) – 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 (object) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

  • azure_cloud_type (object) – 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 (object) – 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, object]] = None, folder_path: object = None, file_name: object = None, file_system: object = None, **kwargs)[source]

The location of azure blobFS dataset.

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

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

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

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

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

  • file_system (object) – 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, object]] = None, max_concurrent_connections: object = None, recursive: object = None, wildcard_folder_path: object = None, wildcard_file_name: object = None, file_list_path: object = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: object = None, delete_files_after_completion: object = None, modified_datetime_start: object = None, modified_datetime_end: object = None, **kwargs)[source]

Azure blobFS read settings.

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

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

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

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

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

  • wildcard_folder_path (object) – Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string).

  • wildcard_file_name (object) – Azure blobFS wildcardFileName. Type: string (or Expression with resultType string).

  • file_list_path (object) – 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 (object) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

  • delete_files_after_completion (object) – 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 (object) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

  • modified_datetime_end (object) – 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, object]] = None, write_batch_size: object = None, write_batch_timeout: object = None, sink_retry_count: object = None, sink_retry_wait: object = None, max_concurrent_connections: object = None, copy_behavior: object = None, **kwargs)[source]

A copy activity Azure Data Lake Storage Gen2 sink.

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

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

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

  • write_batch_size (object) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

  • write_batch_timeout (object) – 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 (object) – Sink retry count. Type: integer (or Expression with resultType integer).

  • sink_retry_wait (object) – 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 (object) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

  • copy_behavior (object) – 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, object]] = None, source_retry_count: object = None, source_retry_wait: object = None, max_concurrent_connections: object = None, treat_empty_as_null: object = None, skip_header_line_count: object = None, recursive: object = None, **kwargs)[source]

A copy activity Azure BlobFS source.

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

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

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

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

  • source_retry_wait (object) – 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 (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

  • treat_empty_as_null (object) – Treat empty as null. Type: boolean (or Expression with resultType boolean).

  • skip_header_line_count (object) – Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer).

  • recursive (object) – 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, object]] = None, max_concurrent_connections: object = None, copy_behavior: object = None, block_size_in_mb: object = None, **kwargs)[source]

Azure blobFS write settings.

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

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

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

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

  • copy_behavior (object) – The type of copy behavior for copy sink.

  • block_size_in_mb (object) – 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, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, connection_string: object = None, account_key: Optional[AzureKeyVaultSecretReference] = None, sas_uri: object = None, sas_token: Optional[AzureKeyVaultSecretReference] = None, service_endpoint: Optional[str] = None, service_principal_id: object = None, service_principal_key: Optional[SecretBase] = None, tenant: object = None, azure_cloud_type: object = None, encrypted_credential: Optional[str] = None, **kwargs)[source]

The azure blob storage linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • connection_string (object) – 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 (object) – 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 (object) – 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 (object) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

  • azure_cloud_type (object) – 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 (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, object]] = None, folder_path: object = None, file_name: object = None, container: object = None, **kwargs)[source]

The location of azure blob dataset.

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

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

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

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

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

  • container (object) – 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, object]] = None, max_concurrent_connections: object = None, recursive: object = None, wildcard_folder_path: object = None, wildcard_file_name: object = None, prefix: object = None, file_list_path: object = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: object = None, delete_files_after_completion: object = None, modified_datetime_start: object = None, modified_datetime_end: object = None, **kwargs)[source]

Azure blob read settings.

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

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

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

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

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

  • wildcard_folder_path (object) – Azure blob wildcardFolderPath. Type: string (or Expression with resultType string).

  • wildcard_file_name (object) – Azure blob wildcardFileName. Type: string (or Expression with resultType string).

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

  • file_list_path (object) – 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 (object) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

  • delete_files_after_completion (object) – 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 (object) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

  • modified_datetime_end (object) – 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, object]] = None, max_concurrent_connections: object = None, copy_behavior: object = None, block_size_in_mb: object = None, **kwargs)[source]

Azure blob write settings.

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

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

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

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

  • copy_behavior (object) – The type of copy behavior for copy sink.

  • block_size_in_mb (object) – 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: object, additional_properties: Optional[Dict[str, object]] = None, description: Optional[str] = None, depends_on: Optional[List[ActivityDependency]] = None, user_properties: Optional[List[UserProperty]] = None, linked_service_name: Optional[LinkedServiceReference] = None, policy: Optional[ActivityPolicy] = None, command_timeout: object = None, **kwargs)[source]

Azure Data Explorer command activity.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Required. A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string).

  • command_timeout (object) – 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: object, service_principal_id: object, service_principal_key: azure.synapse.artifacts.models._models_py3.SecretBase, database: object, tenant: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, **kwargs)[source]

Azure Data Explorer (Kusto) linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • endpoint (object) – 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 (object) – Required. The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string).

  • service_principal_key (SecretBase) – Required. The key of the service principal used to authenticate against Kusto.

  • database (object) – Required. Database name for connection. Type: string (or Expression with resultType string).

  • tenant (object) – Required. 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, object]] = None, write_batch_size: object = None, write_batch_timeout: object = None, sink_retry_count: object = None, sink_retry_wait: object = None, max_concurrent_connections: object = None, ingestion_mapping_name: object = None, ingestion_mapping_as_json: object = None, flush_immediately: object = None, **kwargs)[source]

A copy activity Azure Data Explorer sink.

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

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

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

  • write_batch_size (object) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

  • write_batch_timeout (object) – 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 (object) – Sink retry count. Type: integer (or Expression with resultType integer).

  • sink_retry_wait (object) – 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 (object) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

  • ingestion_mapping_name (object) – A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string.

  • ingestion_mapping_as_json (object) – An explicit column mapping description provided in a json format. Type: string.

  • flush_immediately (object) – 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: object, additional_properties: Optional[Dict[str, object]] = None, source_retry_count: object = None, source_retry_wait: object = None, max_concurrent_connections: object = None, no_truncation: object = None, query_timeout: object = None, additional_columns: Optional[List[AdditionalColumns]] = None, **kwargs)[source]

A copy activity Azure Data Explorer (Kusto) source.

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

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

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

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

  • source_retry_wait (object) – 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 (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

  • query (object) – Required. Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string).

  • no_truncation (object) – 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 (object) – Query timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9]))..

  • additional_columns (list[AdditionalColumns]) – Specifies the additional columns to be added to source data. Type: array of objects (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, object]] = None, description: Optional[str] = None, structure: object = None, schema: object = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[DatasetFolder] = None, table: object = None, **kwargs)[source]

The Azure Data Explorer (Kusto) dataset.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

  • schema (object) – 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[object]) – 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 (object) – 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: object, tenant: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, service_principal_id: object = None, service_principal_key: Optional[SecretBase] = None, subscription_id: object = None, resource_group_name: object = None, data_lake_analytics_uri: object = None, encrypted_credential: object = None, **kwargs)[source]

Azure Data Lake Analytics linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • account_name (object) – Required. The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string).

  • service_principal_id (object) – 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 (object) – Required. The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

  • subscription_id (object) – Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).

  • resource_group_name (object) – Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).

  • data_lake_analytics_uri (object) – Azure Data Lake Analytics URI Type: string (or Expression with resultType string).

  • encrypted_credential (object) – 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, object]] = None, description: Optional[str] = None, structure: object = None, schema: object = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[DatasetFolder] = None, folder_path: object = None, file_name: object = None, format: Optional[DatasetStorageFormat] = None, compression: Optional[DatasetCompression] = None, **kwargs)[source]

Azure Data Lake Store dataset.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

  • schema (object) – 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[object]) – 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 (object) – Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).

  • file_name (object) – 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: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, service_principal_id: object = None, service_principal_key: Optional[SecretBase] = None, tenant: object = None, azure_cloud_type: object = None, account_name: object = None, subscription_id: object = None, resource_group_name: object = None, encrypted_credential: object = None, **kwargs)[source]

Azure Data Lake Store linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • data_lake_store_uri (object) – Required. Data Lake Store service URI. Type: string (or Expression with resultType string).

  • service_principal_id (object) – 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 (object) – The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

  • azure_cloud_type (object) – 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 (object) – Data Lake Store account name. Type: string (or Expression with resultType string).

  • subscription_id (object) – Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).

  • resource_group_name (object) – Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).

  • encrypted_credential (object) – 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, object]] = None, folder_path: object = None, file_name: object = None, **kwargs)[source]

The location of azure data lake store dataset.

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

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

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

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

  • file_name (object) – 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, object]] = None, max_concurrent_connections: object = None, recursive: object = None, wildcard_folder_path: object = None, wildcard_file_name: object = None, file_list_path: object = None, list_after: object = None, list_before: object = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: object = None, delete_files_after_completion: object = None, modified_datetime_start: object = None, modified_datetime_end: object = None, **kwargs)[source]

Azure data lake store read settings.

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

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

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

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

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

  • wildcard_folder_path (object) – ADLS wildcardFolderPath. Type: string (or Expression with resultType string).

  • wildcard_file_name (object) – ADLS wildcardFileName. Type: string (or Expression with resultType string).

  • file_list_path (object) – 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 (object) – 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 (object) – 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 (object) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

  • delete_files_after_completion (object) – 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 (object) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

  • modified_datetime_end (object) – 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, object]] = None, write_batch_size: object = None, write_batch_timeout: object = None, sink_retry_count: object = None, sink_retry_wait: object = None, max_concurrent_connections: object = None, copy_behavior: object = None, enable_adls_single_file_parallel: object = None, **kwargs)[source]

A copy activity Azure Data Lake Store sink.

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

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

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

  • write_batch_size (object) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

  • write_batch_timeout (object) – 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 (object) – Sink retry count. Type: integer (or Expression with resultType integer).

  • sink_retry_wait (object) – 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 (object) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

  • copy_behavior (object) – The type of copy behavior for copy sink.

  • enable_adls_single_file_parallel (object) – 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, object]] = None, source_retry_count: object = None, source_retry_wait: object = None, max_concurrent_connections: object = None, recursive: object = None, **kwargs)[source]

A copy activity Azure Data Lake source.

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

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

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

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

  • source_retry_wait (object) – 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 (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

  • recursive (object) – 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, object]] = None, max_concurrent_connections: object = None, copy_behavior: object = None, expiry_date_time: object = None, **kwargs)[source]

Azure data lake store write settings.

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

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

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

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

  • copy_behavior (object) – The type of copy behavior for copy sink.

  • expiry_date_time (object) – 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, object]] = None, description: Optional[str] = None, structure: object = None, schema: object = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[DatasetFolder] = None, table: object = None, database: object = None, **kwargs)[source]

Azure Databricks Delta Lake dataset.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

  • schema (object) – 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[object]) – 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 (object) – The name of delta table. Type: string (or Expression with resultType string).

  • database (object) – 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, object]] = None, date_format: object = None, timestamp_format: object = None, **kwargs)[source]

Azure Databricks Delta Lake export command settings.

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

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

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

  • date_format (object) – Specify the date format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).

  • timestamp_format (object) – 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, object]] = None, date_format: object = None, timestamp_format: object = None, **kwargs)[source]

Azure Databricks Delta Lake import command settings.

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

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

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

  • date_format (object) – Specify the date format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).

  • timestamp_format (object) – 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: object, access_token: azure.synapse.artifacts.models._models_py3.SecretBase, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, cluster_id: object = None, encrypted_credential: object = None, **kwargs)[source]

Azure Databricks Delta Lake linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • domain (object) – 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 (object) – 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 (object) – 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, object]] = None, write_batch_size: object = None, write_batch_timeout: object = None, sink_retry_count: object = None, sink_retry_wait: object = None, max_concurrent_connections: object = None, pre_copy_script: object = None, import_settings: Optional[AzureDatabricksDeltaLakeImportCommand] = None, **kwargs)[source]

A copy activity Azure Databricks Delta Lake sink.

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

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

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

  • write_batch_size (object) – Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

  • write_batch_timeout (object) – 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 (object) – Sink retry count. Type: integer (or Expression with resultType integer).

  • sink_retry_wait (object) – 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 (object) – The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

  • pre_copy_script (object) – 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, object]] = None, source_retry_count: object = None, source_retry_wait: object = None, max_concurrent_connections: object = None, query: object = None, export_settings: Optional[AzureDatabricksDeltaLakeExportCommand] = None, **kwargs)[source]

A copy activity Azure Databricks Delta Lake source.

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

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

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

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

  • source_retry_wait (object) – 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 (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

  • query (object) – 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: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, access_token: Optional[SecretBase] = None, authentication: object = None, workspace_resource_id: object = None, existing_cluster_id: object = None, instance_pool_id: object = None, new_cluster_version: object = None, new_cluster_num_of_worker: object = None, new_cluster_node_type: object = None, new_cluster_spark_conf: Optional[Dict[str, object]] = None, new_cluster_spark_env_vars: Optional[Dict[str, object]] = None, new_cluster_custom_tags: Optional[Dict[str, object]] = None, new_cluster_log_destination: object = None, new_cluster_driver_node_type: object = None, new_cluster_init_scripts: object = None, new_cluster_enable_elastic_disk: object = None, encrypted_credential: object = None, policy_id: object = None, **kwargs)[source]

Azure Databricks linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • domain (object) – 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 (object) – Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).

  • workspace_resource_id (object) – Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).

  • existing_cluster_id (object) – 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 (object) – 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 (object) – 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 (object) – 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 (object) – 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, object]) – A set of optional, user-specified Spark configuration key-value pairs.

  • new_cluster_spark_env_vars (dict[str, object]) – A set of optional, user-specified Spark environment variables key-value pairs.

  • new_cluster_custom_tags (dict[str, object]) – Additional tags for cluster resources. This property is ignored in instance pool configurations.

  • new_cluster_log_destination (object) – Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).

  • new_cluster_driver_node_type (object) – 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 (object) – User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings).

  • new_cluster_enable_elastic_disk (object) – 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 (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

  • policy_id (object) – 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)[source]

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: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, user_id: object = None, password: Optional[SecretBase] = None, connection_string: object = None, account_key: Optional[AzureKeyVaultSecretReference] = None, sas_uri: object = None, sas_token: Optional[AzureKeyVaultSecretReference] = None, file_share: object = None, snapshot: object = None, encrypted_credential: object = None, **kwargs)[source]

Azure File Storage linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • host (object) – Required. Host name of the server. Type: string (or Expression with resultType string).

  • user_id (object) – User ID to logon the server. Type: string (or Expression with resultType string).

  • password (SecretBase) – Password to logon the server.

  • connection_string (object) – 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 (object) – 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 (object) – The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).

  • snapshot (object) – The azure file share snapshot version. Type: string (or Expression with resultType string).

  • encrypted_credential (object) – 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, object]] = None, folder_path: object = None, file_name: object = None, **kwargs)[source]

The location of file server dataset.

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

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

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

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

  • file_name (object) – 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, object]] = None, max_concurrent_connections: object = None, recursive: object = None, wildcard_folder_path: object = None, wildcard_file_name: object = None, prefix: object = None, file_list_path: object = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: object = None, delete_files_after_completion: object = None, modified_datetime_start: object = None, modified_datetime_end: object = None, **kwargs)[source]

Azure File Storage read settings.

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

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

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

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

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

  • wildcard_folder_path (object) – Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string).

  • wildcard_file_name (object) – Azure File Storage wildcardFileName. Type: string (or Expression with resultType string).

  • prefix (object) – The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string).

  • file_list_path (object) – 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 (object) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

  • delete_files_after_completion (object) – 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 (object) – The start of file’s modified datetime. Type: string (or Expression with resultType string).

  • modified_datetime_end (object) – 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, object]] = None, max_concurrent_connections: object = None, copy_behavior: object = None, **kwargs)[source]

Azure File Storage write settings.

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

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

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

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

  • copy_behavior (object) – 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, AzureFunctionActivityMethod], function_name: object, additional_properties: Optional[Dict[str, object]] = None, description: Optional[str] = None, depends_on: Optional[List[ActivityDependency]] = None, user_properties: Optional[List[UserProperty]] = None, linked_service_name: Optional[LinkedServiceReference] = None, policy: Optional[ActivityPolicy] = None, headers: object = None, body: object = None, **kwargs)[source]

Azure Function activity.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Required. Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string).

  • headers (object) – 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 (object) – 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.AzureFunctionLinkedService(*, function_app_url: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, function_key: Optional[SecretBase] = None, encrypted_credential: object = None, **kwargs)[source]

Azure Function linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • function_app_url (object) – 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 (object) – 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: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, ParameterSpecification]] = None, annotations: Optional[List[object]] = None, **kwargs)[source]

Azure Key Vault linked service.

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

Parameters
  • additional_properties (dict[str, object]) – 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[object]) – List of tags that can be used for describing the linked service.

  • base_url (object) – 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: object, secret_version: object = None, **kwargs)[source]

Azure Key Vault secret reference.

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

Parameters
  • type (str) – Required. Type of the secret.Constant filled by server.

  • store (LinkedServiceReference) – Required. The Azure Key Vault linked service reference.

  • secret_name (object) – Required. The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).

  • secret_version (object) – 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, object]] = None, description: Optional[str] = None, depends_on: Optional[List[ActivityDependency]] = None, user_properties: Optional[List[UserProperty]] = None, linked_service_name: Optional[LinkedServiceReference] = None, policy: Optional[ActivityPolicy] = None, global_parameters: Optional[Dict[str, object]] = None, web_service_outputs: Optional[Dict[str, AzureMLWebServiceFile]] = None, web_service_inputs: Optional[Dict[str, AzureMLWebServiceFile]] = None, **kwargs)[source]

Azure ML Batch Execution activity.

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

Parameters
  • additional_properties (dict[str, object]) – 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, object]) – 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: object, additional_properties: Optional[Dict[str, object]] = None, description: Optional[str] = None, depends_on: Optional[List[ActivityDependency]] = None, user_properties: Optional[List[UserProperty]] = None, linked_service_name: Optional[LinkedServiceReference] = None, policy: Optional[ActivityPolicy] = None, experiment_name: object = None, ml_pipeline_parameters: object = None, ml_parent_run_id: object = None, continue_on_step_failure: object = None, **kwargs)[source]

Azure ML Execute Pipeline activity.

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

Parameters
  • additional_properties (dict[str, object]) – 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 (object) – Required. ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).

  • experiment_name (object) – 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 (object) – 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 (object) – 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 (object) – 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