azure.mgmt.datafactory.models module¶

class azure.mgmt.datafactory.models.AccessPolicyResponse(*, policy=None, access_token: str = None, data_plane_url: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Get Data Plane read only token response definition.

Parameters

policy (UserAccessPolicy) – The user access policy.
access_token (str) – Data Plane read only access token.
data_plane_url (str) – Data Plane service base URL.

class azure.mgmt.datafactory.models.Activity(*, name: str, additional_properties=None, description: str = None, depends_on=None, user_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A pipeline activity.

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

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.ActivityDependency(*, activity: str, dependency_conditions, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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 this collection
activity (str) – Required. Activity name.
dependency_conditions (list[str or DependencyCondition]) – Required. Match-Condition for the dependency.

class azure.mgmt.datafactory.models.ActivityPolicy(*, additional_properties=None, timeout=None, retry=None, retry_interval_in_seconds: int = None, secure_input: bool = None, secure_output: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Execution policy for an activity.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized 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.

class azure.mgmt.datafactory.models.ActivityRun(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

class azure.mgmt.datafactory.models.ActivityRunsQueryResponse(*, value, continuation_token: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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.

class azure.mgmt.datafactory.models.AddDataFlowToDebugSessionResponse(*, job_version: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response body structure for starting data flow debug session.

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

class azure.mgmt.datafactory.models.AdditionalColumns(*, name=None, value=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

class azure.mgmt.datafactory.models.AmazonMWSLinkedService(*, endpoint, marketplace_id, seller_id, access_key_id, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, mws_auth_token=None, secret_key=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AmazonMWSObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AmazonMWSSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AmazonRedshiftLinkedService(*, server, database, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, username=None, password=None, port=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AmazonRedshiftSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, redshift_unload_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

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 this collection
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).
type (str) – Required. Constant filled by server.
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.

class azure.mgmt.datafactory.models.AmazonRedshiftTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, amazon_redshift_table_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

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 this collection
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.
type (str) – Required. Constant filled by server.
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).
amazon_redshift_table_dataset_schema (object) – The Amazon Redshift schema name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AmazonS3Dataset(*, linked_service_name, bucket_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, key=None, prefix=None, version=None, modified_datetime_start=None, modified_datetime_end=None, format=None, compression=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

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 this collection
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.
type (str) – Required. Constant filled by server.
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.

class azure.mgmt.datafactory.models.AmazonS3LinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, access_key_id=None, secret_access_key=None, service_url=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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).
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).

class azure.mgmt.datafactory.models.AmazonS3Location(*, additional_properties=None, folder_path=None, file_name=None, bucket_name=None, version=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AmazonS3ReadSettings(*, additional_properties=None, max_concurrent_connections=None, recursive=None, wildcard_folder_path=None, wildcard_file_name=None, prefix=None, file_list_path=None, enable_partition_discovery: bool = None, partition_root_path=None, delete_files_after_completion=None, modified_datetime_start=None, modified_datetime_end=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AppendVariableActivity(*, name: str, additional_properties=None, description: str = None, depends_on=None, user_properties=None, variable_name: str = None, value=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
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

class azure.mgmt.datafactory.models.AvroDataset(*, linked_service_name, location, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, avro_compression_codec=None, avro_compression_level: int = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

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 this collection
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.
type (str) – Required. Constant filled by server.
location (DatasetLocation) – Required. The location of the avro storage.
avro_compression_codec (str or AvroCompressionCodec) – Possible values include: ‘none’, ‘deflate’, ‘snappy’, ‘xz’, ‘bzip2’
avro_compression_level (int) –

class azure.mgmt.datafactory.models.AvroFormat(*, additional_properties=None, serializer=None, deserializer=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetStorageFormat

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 this collection
serializer (object) – Serializer. Type: string (or Expression with resultType string).
deserializer (object) – Deserializer. Type: string (or Expression with resultType string).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.AvroSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, store_settings=None, format_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreWriteSettings) – Avro store settings.
format_settings (AvroWriteSettings) – Avro format settings.

class azure.mgmt.datafactory.models.AvroSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, store_settings=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AvroWriteSettings(*, additional_properties=None, record_name: str = None, record_namespace: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.FormatWriteSettings

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 this collection
type (str) – Required. 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.

class azure.mgmt.datafactory.models.AzPowerShellSetup(*, version: str, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CustomSetupBase

The express custom setup of installing Azure PowerShell.

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

Parameters

type (str) – Required. Constant filled by server.
version (str) – Required. The required version of Azure PowerShell to install.

class azure.mgmt.datafactory.models.AzureBatchLinkedService(*, account_name, batch_uri, pool_name, linked_service_name, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, access_key=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureBlobDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, folder_path=None, table_root_location=None, file_name=None, modified_datetime_start=None, modified_datetime_end=None, format=None, compression=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

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 this collection
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.
type (str) – Required. Constant filled by server.
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.

class azure.mgmt.datafactory.models.AzureBlobFSDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, folder_path=None, file_name=None, format=None, compression=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

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 this collection
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.
type (str) – Required. Constant filled by server.
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.

class azure.mgmt.datafactory.models.AzureBlobFSLinkedService(*, url, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, account_key=None, service_principal_id=None, service_principal_key=None, tenant=None, azure_cloud_type=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureBlobFSLocation(*, additional_properties=None, folder_path=None, file_name=None, file_system=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

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 this collection
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).
type (str) – Required. Constant filled by server.
file_system (object) – Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureBlobFSReadSettings(*, additional_properties=None, max_concurrent_connections=None, recursive=None, wildcard_folder_path=None, wildcard_file_name=None, file_list_path=None, enable_partition_discovery: bool = None, partition_root_path=None, delete_files_after_completion=None, modified_datetime_start=None, modified_datetime_end=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureBlobFSSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, copy_behavior=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

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 this collection
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).
type (str) – Required. Constant filled by server.
copy_behavior (object) – The type of copy behavior for copy sink.

class azure.mgmt.datafactory.models.AzureBlobFSSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, treat_empty_as_null=None, skip_header_line_count=None, recursive=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureBlobFSWriteSettings(*, additional_properties=None, max_concurrent_connections=None, copy_behavior=None, block_size_in_mb=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreWriteSettings

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 this collection
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.
type (str) – Required. Constant filled by server.
block_size_in_mb (object) – Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).

class azure.mgmt.datafactory.models.AzureBlobStorageLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, account_key=None, sas_uri=None, sas_token=None, service_endpoint: str = None, service_principal_id=None, service_principal_key=None, tenant=None, azure_cloud_type=None, encrypted_credential: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureBlobStorageLocation(*, additional_properties=None, folder_path=None, file_name=None, container=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

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 this collection
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).
type (str) – Required. Constant filled by server.
container (object) – Specify the container of azure blob. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureBlobStorageReadSettings(*, additional_properties=None, max_concurrent_connections=None, recursive=None, wildcard_folder_path=None, wildcard_file_name=None, prefix=None, file_list_path=None, enable_partition_discovery: bool = None, partition_root_path=None, delete_files_after_completion=None, modified_datetime_start=None, modified_datetime_end=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureBlobStorageWriteSettings(*, additional_properties=None, max_concurrent_connections=None, copy_behavior=None, block_size_in_mb=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreWriteSettings

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 this collection
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.
type (str) – Required. Constant filled by server.
block_size_in_mb (object) – Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).

class azure.mgmt.datafactory.models.AzureDatabricksLinkedService(*, domain, access_token, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, existing_cluster_id=None, instance_pool_id=None, new_cluster_version=None, new_cluster_num_of_worker=None, new_cluster_node_type=None, new_cluster_spark_conf=None, new_cluster_spark_env_vars=None, new_cluster_custom_tags=None, new_cluster_log_destination=None, new_cluster_driver_node_type=None, new_cluster_init_scripts=None, new_cluster_enable_elastic_disk=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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 (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).

class azure.mgmt.datafactory.models.AzureDataExplorerCommandActivity(*, name: str, command, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, command_timeout=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
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]))..)

class azure.mgmt.datafactory.models.AzureDataExplorerLinkedService(*, endpoint, service_principal_id, service_principal_key, database, tenant, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
endpoint (object) – Required. The endpoint of Azure Data Explorer (the engine’s endpoint). URL will be in the format https://<clusterName>.<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).

class azure.mgmt.datafactory.models.AzureDataExplorerSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, ingestion_mapping_name=None, ingestion_mapping_as_json=None, flush_immediately=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

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 this collection
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).
type (str) – Required. Constant filled by server.
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.

class azure.mgmt.datafactory.models.AzureDataExplorerSource(*, query, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, no_truncation=None, query_timeout=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureDataExplorerTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

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 this collection
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.
type (str) – Required. Constant filled by server.
table (object) – The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureDataLakeAnalyticsLinkedService(*, account_name, tenant, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, service_principal_id=None, service_principal_key=None, subscription_id=None, resource_group_name=None, data_lake_analytics_uri=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureDataLakeStoreDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, folder_path=None, file_name=None, format=None, compression=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

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 this collection
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.
type (str) – Required. Constant filled by server.
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.

class azure.mgmt.datafactory.models.AzureDataLakeStoreLinkedService(*, data_lake_store_uri, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, service_principal_id=None, service_principal_key=None, tenant=None, azure_cloud_type=None, account_name=None, subscription_id=None, resource_group_name=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureDataLakeStoreLocation(*, additional_properties=None, folder_path=None, file_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

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 this collection
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).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.AzureDataLakeStoreReadSettings(*, additional_properties=None, max_concurrent_connections=None, recursive=None, wildcard_folder_path=None, wildcard_file_name=None, file_list_path=None, list_after=None, list_before=None, enable_partition_discovery: bool = None, partition_root_path=None, delete_files_after_completion=None, modified_datetime_start=None, modified_datetime_end=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureDataLakeStoreSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, copy_behavior=None, enable_adls_single_file_parallel=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

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 this collection
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).
type (str) – Required. Constant filled by server.
copy_behavior (object) – The type of copy behavior for copy sink.
enable_adls_single_file_parallel (object) – Single File Parallel.

class azure.mgmt.datafactory.models.AzureDataLakeStoreSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, recursive=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

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 this collection
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).
type (str) – Required. Constant filled by server.
recursive (object) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.AzureDataLakeStoreWriteSettings(*, additional_properties=None, max_concurrent_connections=None, copy_behavior=None, expiry_date_time=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreWriteSettings

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 this collection
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.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureFileStorageLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, host=None, user_id=None, password=None, connection_string=None, account_key=None, sas_uri=None, sas_token=None, file_share=None, snapshot=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – 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).

class azure.mgmt.datafactory.models.AzureFileStorageLocation(*, additional_properties=None, folder_path=None, file_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

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 this collection
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).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.AzureFileStorageReadSettings(*, additional_properties=None, max_concurrent_connections=None, recursive=None, wildcard_folder_path=None, wildcard_file_name=None, prefix=None, file_list_path=None, enable_partition_discovery: bool = None, partition_root_path=None, delete_files_after_completion=None, modified_datetime_start=None, modified_datetime_end=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureFileStorageWriteSettings(*, additional_properties=None, max_concurrent_connections=None, copy_behavior=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreWriteSettings

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 this collection
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.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.AzureFunctionActivity(*, name: str, method, function_name, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, headers=None, body=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureFunctionLinkedService(*, function_app_url, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, function_key=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureKeyVaultLinkedService(*, base_url, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureKeyVaultSecretReference(*, store, secret_name, secret_version=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SecretBase

Azure Key Vault secret reference.

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

Parameters

type (str) – Required. 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).

class azure.mgmt.datafactory.models.AzureMariaDBLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, pwd=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Azure Database for MariaDB 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.AzureMariaDBSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Azure MariaDB 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureMariaDBTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Azure Database for MariaDB 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureMLBatchExecutionActivity(*, name: str, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, global_parameters=None, web_service_outputs=None, web_service_inputs=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
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.

class azure.mgmt.datafactory.models.AzureMLExecutePipelineActivity(*, name: str, ml_pipeline_id, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, experiment_name=None, ml_pipeline_parameters=None, ml_parent_run_id=None, continue_on_step_failure=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureMLLinkedService(*, ml_endpoint, api_key, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, update_resource_endpoint=None, service_principal_id=None, service_principal_key=None, tenant=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Azure ML Studio 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 this collection
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.
type (str) – Required. Constant filled by server.
ml_endpoint (object) – Required. The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
api_key (SecretBase) – Required. The API key for accessing the Azure ML model endpoint.
update_resource_endpoint (object) – The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).
service_principal_id (object) – The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string).
service_principal_key (SecretBase) – The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service.
tenant (object) – The name or ID of the tenant to which the service principal belongs. 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).

class azure.mgmt.datafactory.models.AzureMLServiceLinkedService(*, subscription_id, resource_group_name, ml_workspace_name, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, service_principal_id=None, service_principal_key=None, tenant=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Azure ML 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 this collection
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.
type (str) – Required. Constant filled by server.
subscription_id (object) – Required. Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string).
resource_group_name (object) – Required. Azure ML Service workspace resource group name. Type: string (or Expression with resultType string).
ml_workspace_name (object) – Required. Azure ML Service workspace name. Type: string (or Expression with resultType string).
service_principal_id (object) – The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string).
service_principal_key (SecretBase) – The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline.
tenant (object) – The name or ID of the tenant to which the service principal belongs. 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).

class azure.mgmt.datafactory.models.AzureMLUpdateResourceActivity(*, name: str, trained_model_name, trained_model_linked_service_name, trained_model_file_path, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

Azure ML Update Resource management 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
trained_model_name (object) – Required. Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string).
trained_model_linked_service_name (LinkedServiceReference) – Required. Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.
trained_model_file_path (object) – Required. The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureMLWebServiceFile(*, file_path, linked_service_name, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure ML WebService Input/Output file.

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

Parameters

file_path (object) – Required. The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string).
linked_service_name (LinkedServiceReference) – Required. Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.

class azure.mgmt.datafactory.models.AzureMySqlLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Azure MySQL database 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.AzureMySqlSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, pre_copy_script=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Azure MySql 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 this collection
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).
type (str) – Required. Constant filled by server.
pre_copy_script (object) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureMySqlSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Azure MySQL 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzureMySqlTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Azure MySQL database 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The Azure MySQL database table name. Type: string (or Expression with resultType string).
table (object) – The name of Azure MySQL database table. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzurePostgreSqlLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Azure PostgreSQL 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.AzurePostgreSqlSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, pre_copy_script=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Azure PostgreSQL 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 this collection
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).
type (str) – Required. Constant filled by server.
pre_copy_script (object) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzurePostgreSqlSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Azure PostgreSQL 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.AzurePostgreSqlTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, azure_postgre_sql_table_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Azure PostgreSQL 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string).
table (object) – The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).
azure_postgre_sql_table_dataset_schema (object) – The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureQueueSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Azure Queue 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 this collection
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).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.AzureSearchIndexDataset(*, linked_service_name, index_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Azure Search Index.

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 this collection
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.
type (str) – Required. Constant filled by server.
index_name (object) – Required. The name of the Azure Search Index. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureSearchIndexSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, write_behavior=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Azure Search Index 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 this collection
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).
type (str) – Required. Constant filled by server.
write_behavior (str or AzureSearchIndexWriteBehaviorType) – Specify the write behavior when upserting documents into Azure Search Index. Possible values include: ‘Merge’, ‘Upload’

class azure.mgmt.datafactory.models.AzureSearchLinkedService(*, url, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, key=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for Windows Azure Search 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 this collection
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.
type (str) – Required. Constant filled by server.
url (object) – Required. URL for Azure Search service. Type: string (or Expression with resultType string).
key (SecretBase) – Admin Key for Azure Search service
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).

class azure.mgmt.datafactory.models.AzureSqlDatabaseLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, password=None, service_principal_id=None, service_principal_key=None, tenant=None, azure_cloud_type=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Microsoft Azure SQL Database 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.
service_principal_id (object) – The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).
service_principal_key (SecretBase) – The key of the service principal used to authenticate against Azure SQL Database.
tenant (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).

class azure.mgmt.datafactory.models.AzureSqlDWLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, password=None, service_principal_id=None, service_principal_key=None, tenant=None, azure_cloud_type=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Azure SQL Data Warehouse 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.
service_principal_id (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 (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureSqlDWTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, azure_sql_dw_table_dataset_schema=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Azure SQL Data Warehouse 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
azure_sql_dw_table_dataset_schema (object) – The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
table (object) – The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureSqlMILinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, password=None, service_principal_id=None, service_principal_key=None, tenant=None, azure_cloud_type=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Azure SQL Managed Instance 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection string.
service_principal_id (object) – The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string).
service_principal_key (SecretBase) – The key of the service principal used to authenticate against Azure SQL Managed Instance.
tenant (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).

class azure.mgmt.datafactory.models.AzureSqlMITableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, azure_sql_mi_table_dataset_schema=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Azure SQL Managed Instance 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
azure_sql_mi_table_dataset_schema (object) – The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string).
table (object) – The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureSqlSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, sql_writer_stored_procedure_name=None, sql_writer_table_type=None, pre_copy_script=None, stored_procedure_parameters=None, stored_procedure_table_type_parameter_name=None, table_option=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Azure SQL 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 this collection
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).
type (str) – Required. Constant filled by server.
sql_writer_stored_procedure_name (object) – SQL writer stored procedure name. Type: string (or Expression with resultType string).
sql_writer_table_type (object) – SQL writer table type. Type: string (or Expression with resultType string).
pre_copy_script (object) – SQL pre-copy script. Type: string (or Expression with resultType string).
stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.
stored_procedure_table_type_parameter_name (object) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
table_option (object) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureSqlSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, sql_reader_query=None, sql_reader_stored_procedure_name=None, stored_procedure_parameters=None, produce_additional_types=None, partition_option=None, partition_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Azure SQL 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
sql_reader_query (object) – SQL reader query. Type: string (or Expression with resultType string).
sql_reader_stored_procedure_name (object) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.
produce_additional_types (object) – Which additional types to produce.
partition_option (str or SqlPartitionOption) – The partition mechanism that will be used for Sql read in parallel. Possible values include: ‘None’, ‘PhysicalPartitionsOfTable’, ‘DynamicRange’
partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

class azure.mgmt.datafactory.models.AzureSqlTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, azure_sql_table_dataset_schema=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Azure SQL Server database 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
azure_sql_table_dataset_schema (object) – The schema name of the Azure SQL database. Type: string (or Expression with resultType string).
table (object) – The table name of the Azure SQL database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureStorageLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, account_key=None, sas_uri=None, sas_token=None, encrypted_credential: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

The storage account 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 this collection
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.
type (str) – Required. Constant filled by 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 Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
sas_token (AzureKeyVaultSecretReference) – The Azure key vault secret reference of sasToken in sas uri.
encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureTableDataset(*, linked_service_name, table_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Azure Table storage 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – Required. The table name of the Azure Table storage. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureTableSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, azure_table_default_partition_key_value=None, azure_table_partition_key_name=None, azure_table_row_key_name=None, azure_table_insert_type=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Azure Table 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 this collection
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).
type (str) – Required. Constant filled by server.
azure_table_default_partition_key_value (object) – Azure Table default partition key value. Type: string (or Expression with resultType string).
azure_table_partition_key_name (object) – Azure Table partition key name. Type: string (or Expression with resultType string).
azure_table_row_key_name (object) – Azure Table row key name. Type: string (or Expression with resultType string).
azure_table_insert_type (object) – Azure Table insert type. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureTableSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, azure_table_source_query=None, azure_table_source_ignore_table_not_found=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Azure Table 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
azure_table_source_query (object) – Azure Table source query. Type: string (or Expression with resultType string).
azure_table_source_ignore_table_not_found (object) – Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.AzureTableStorageLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, account_key=None, sas_uri=None, sas_token=None, encrypted_credential: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

The azure table 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 this collection
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.
type (str) – Required. Constant filled by 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 Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
sas_token (AzureKeyVaultSecretReference) – The Azure key vault secret reference of sasToken in sas uri.
encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.BinaryDataset(*, linked_service_name, location, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, compression=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Binary 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 this collection
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.
type (str) – Required. Constant filled by server.
location (DatasetLocation) – Required. The location of the Binary storage.
compression (DatasetCompression) – The data compression method used for the binary dataset.

class azure.mgmt.datafactory.models.BinaryReadSettings(*, additional_properties=None, compression_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.FormatReadSettings

Binary 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 this collection
type (str) – Required. Constant filled by server.
compression_properties (CompressionReadSettings) – Compression settings.

class azure.mgmt.datafactory.models.BinarySink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, store_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Binary 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreWriteSettings) – Binary store settings.

class azure.mgmt.datafactory.models.BinarySource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, store_settings=None, format_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Binary 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreReadSettings) – Binary store settings.
format_settings (BinaryReadSettings) – Binary format settings.

class azure.mgmt.datafactory.models.BlobEventsTrigger(*, events, scope: str, additional_properties=None, description: str = None, annotations=None, pipelines=None, blob_path_begins_with: str = None, blob_path_ends_with: str = None, ignore_empty_blobs: bool = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.MultiplePipelineTrigger

Trigger that runs every time a Blob event occurs.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Trigger description.
annotations (list[object]) – List of tags that can be used for describing the trigger.
type (str) – Required. Constant filled by server.
pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.
blob_path_begins_with (str) – The blob path must begin with the pattern provided for trigger to fire. For example, ‘/records/blobs/december/’ will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.
blob_path_ends_with (str) – The blob path must end with the pattern provided for trigger to fire. For example, ‘december/boxes.csv’ will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.
ignore_empty_blobs (bool) – If set to true, blobs with zero bytes will be ignored.
events (list[str or BlobEventTypes]) – Required. The type of events that cause this trigger to fire.
scope (str) – Required. The ARM resource ID of the Storage Account.

Variables

runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: ‘Started’, ‘Stopped’, ‘Disabled’

class azure.mgmt.datafactory.models.BlobSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, blob_writer_overwrite_files=None, blob_writer_date_time_format=None, blob_writer_add_header=None, copy_behavior=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Azure Blob 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 this collection
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).
type (str) – Required. Constant filled by server.
blob_writer_overwrite_files (object) – Blob writer overwrite files. Type: boolean (or Expression with resultType boolean).
blob_writer_date_time_format (object) – Blob writer date time format. Type: string (or Expression with resultType string).
blob_writer_add_header (object) – Blob writer add header. Type: boolean (or Expression with resultType boolean).
copy_behavior (object) – The type of copy behavior for copy sink.

class azure.mgmt.datafactory.models.BlobSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, treat_empty_as_null=None, skip_header_line_count=None, recursive=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Azure Blob 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.BlobTrigger(*, folder_path: str, max_concurrency: int, linked_service, additional_properties=None, description: str = None, annotations=None, pipelines=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.MultiplePipelineTrigger

Trigger that runs every time the selected Blob container changes.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Trigger description.
annotations (list[object]) – List of tags that can be used for describing the trigger.
type (str) – Required. Constant filled by server.
pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.
folder_path (str) – Required. The path of the container/folder that will trigger the pipeline.
max_concurrency (int) – Required. The max number of parallel files to handle when it is triggered.
linked_service (LinkedServiceReference) – Required. The Azure Storage linked service reference.

Variables

runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: ‘Started’, ‘Stopped’, ‘Disabled’

class azure.mgmt.datafactory.models.CassandraLinkedService(*, host, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, authentication_type=None, port=None, username=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for Cassandra data 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. Host name for connection. Type: string (or Expression with resultType string).
authentication_type (object) – AuthenticationType to be used for connection. Type: string (or Expression with resultType string).
port (object) – The port for the connection. Type: integer (or Expression with resultType integer).
username (object) – Username for authentication. Type: string (or Expression with resultType string).
password (SecretBase) – Password for authentication.
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).

class azure.mgmt.datafactory.models.CassandraSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, consistency_level=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for a Cassandra database.

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 this collection
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).
type (str) – Required. Constant filled by server.
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. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string).
consistency_level (str or CassandraSourceReadConsistencyLevels) – The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is ‘ONE’. It is case-insensitive. Possible values include: ‘ALL’, ‘EACH_QUORUM’, ‘QUORUM’, ‘LOCAL_QUORUM’, ‘ONE’, ‘TWO’, ‘THREE’, ‘LOCAL_ONE’, ‘SERIAL’, ‘LOCAL_SERIAL’

class azure.mgmt.datafactory.models.CassandraTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, keyspace=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Cassandra database 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name of the Cassandra database. Type: string (or Expression with resultType string).
keyspace (object) – The keyspace of the Cassandra database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ChainingTrigger(*, pipeline, depends_on, run_dimension: str, additional_properties=None, description: str = None, annotations=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Trigger

Trigger that allows the referenced pipeline to depend on other pipeline runs based on runDimension Name/Value pairs. Upstream pipelines should declare the same runDimension Name and their runs should have the values for those runDimensions. The referenced pipeline run would be triggered if the values for the runDimension match for all upstream pipeline runs.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Trigger description.
annotations (list[object]) – List of tags that can be used for describing the trigger.
type (str) – Required. Constant filled by server.
pipeline (TriggerPipelineReference) – Required. Pipeline for which runs are created when all upstream pipelines complete successfully.
depends_on (list[PipelineReference]) – Required. Upstream Pipelines.
run_dimension (str) – Required. Run Dimension property that needs to be emitted by upstream pipelines.

Variables

runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: ‘Started’, ‘Stopped’, ‘Disabled’

class azure.mgmt.datafactory.models.CmdkeySetup(*, target_name, user_name, password, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CustomSetupBase

The custom setup of running cmdkey commands.

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

Parameters

type (str) – Required. Constant filled by server.
target_name (object) – Required. The server name of data source access.
user_name (object) – Required. The user name of data source access.
password (SecretBase) – Required. The password of data source access.

class azure.mgmt.datafactory.models.CommonDataServiceForAppsEntityDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, entity_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Common Data Service for Apps entity 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 this collection
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.
type (str) – Required. Constant filled by server.
entity_name (object) – The logical name of the entity. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CommonDataServiceForAppsLinkedService(*, deployment_type, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, host_name=None, port=None, service_uri=None, organization_name=None, username=None, password=None, service_principal_id=None, service_principal_credential_type=None, service_principal_credential=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Common Data Service for Apps 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 this collection
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.
type (str) – Required. Constant filled by server.
deployment_type (str or DynamicsDeploymentType) – Required. The deployment type of the Common Data Service for Apps instance. ‘Online’ for Common Data Service for Apps Online and ‘OnPremisesWithIfd’ for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string). Possible values include: ‘Online’, ‘OnPremisesWithIfd’
host_name (object) – The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
port (object) – The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.
service_uri (object) – The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).
organization_name (object) – The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string).
authentication_type (str or DynamicsAuthenticationType) – Required. The authentication type to connect to Common Data Service for Apps server. ‘Office365’ for online scenario, ‘Ifd’ for on-premises with Ifd scenario. ‘AADServicePrincipal’ for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string). Possible values include: ‘Office365’, ‘Ifd’, ‘AADServicePrincipal’
username (object) – User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string).
password (SecretBase) – Password to access the Common Data Service for Apps instance.
service_principal_id (object) – The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
service_principal_credential_type (object) – The service principal credential type to use in Server-To-Server authentication. ‘ServicePrincipalKey’ for key/secret, ‘ServicePrincipalCert’ for certificate. Type: string (or Expression with resultType string).
service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CommonDataServiceForAppsSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, ignore_null_values=None, alternate_key_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Common Data Service for Apps sink.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
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).
type (str) – Required. Constant filled by server.
ignore_null_values (object) – The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).
alternate_key_name (object) – The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

Variables

write_behavior (str) – Required. The write behavior for the operation. Default value: “Upsert” .

write_behavior = 'Upsert'¶

class azure.mgmt.datafactory.models.CommonDataServiceForAppsSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Common Data Service for Apps 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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string).
additional_columns (list[AdditionalColumns]) – Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).

class azure.mgmt.datafactory.models.ComponentSetup(*, component_name: str, license_key=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CustomSetupBase

The custom setup of installing 3rd party components.

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

Parameters

type (str) – Required. Constant filled by server.
component_name (str) – Required. The name of the 3rd party component.
license_key (SecretBase) – The license key to activate the component.

class azure.mgmt.datafactory.models.CompressionReadSettings(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Compression read settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ZipDeflateReadSettings

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 this collection
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.ConcurLinkedService(*, client_id, username, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, password=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Concur 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 this collection
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.
type (str) – Required. Constant filled by server.
client_id (object) – Required. Application client_id supplied by Concur App Management.
username (object) – Required. The user name that you use to access Concur Service.
password (SecretBase) – The password corresponding to the user name that you provided in the username field.
use_encrypted_endpoints (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).

class azure.mgmt.datafactory.models.ConcurObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Concur 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ConcurSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Concur 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.ConnectionStateProperties(**kwargs)[source]¶

Bases: msrest.serialization.Model

The connection state of a managed private endpoint.

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

Variables

actions_required (str) – The actions required on the managed private endpoint
description (str) – The managed private endpoint description
status (str) – The approval status

class azure.mgmt.datafactory.models.ControlActivity(*, name: str, additional_properties=None, description: str = None, depends_on=None, user_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Activity

Base class for all control activities like IfCondition, ForEach , Until.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: WebHookActivity, AppendVariableActivity, SetVariableActivity, FilterActivity, ValidationActivity, UntilActivity, WaitActivity, ForEachActivity, SwitchActivity, IfConditionActivity, ExecutePipelineActivity

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.CopyActivity(*, name: str, source, sink, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, translator=None, enable_staging=None, staging_settings=None, parallel_copies=None, data_integration_units=None, enable_skip_incompatible_row=None, redirect_incompatible_row_settings=None, log_storage_settings=None, preserve_rules=None, preserve=None, validate_data_consistency=None, skip_error_file=None, inputs=None, outputs=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

Copy 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
source (CopySource) – Required. Copy activity source.
sink (CopySink) – Required. Copy activity sink.
translator (object) – Copy activity translator. If not specified, tabular translator is used.
enable_staging (object) – Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).
staging_settings (StagingSettings) – Specifies interim staging settings when EnableStaging is true.
parallel_copies (object) – Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.
data_integration_units (object) – Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.
enable_skip_incompatible_row (object) – Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).
redirect_incompatible_row_settings (RedirectIncompatibleRowSettings) – Redirect incompatible row settings when EnableSkipIncompatibleRow is true.
log_storage_settings (LogStorageSettings) – Log storage settings customer need to provide when enabling session log.
preserve_rules (list[object]) – Preserve Rules.
preserve (list[object]) – Preserve rules.
validate_data_consistency (object) – Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).
skip_error_file (SkipErrorFile) – Specify the fault tolerance for data consistency.
inputs (list[DatasetReference]) – List of inputs for the activity.
outputs (list[DatasetReference]) – List of outputs for the activity.

class azure.mgmt.datafactory.models.CopySink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A copy activity sink.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CosmosDbMongoDbApiSink, SalesforceServiceCloudSink, SalesforceSink, AzureDataExplorerSink, CommonDataServiceForAppsSink, DynamicsCrmSink, DynamicsSink, MicrosoftAccessSink, InformixSink, OdbcSink, AzureSearchIndexSink, AzureBlobFSSink, AzureDataLakeStoreSink, OracleSink, SnowflakeSink, SqlDWSink, SqlMISink, AzureSqlSink, SqlServerSink, SqlSink, CosmosDbSqlApiSink, DocumentDbCollectionSink, FileSystemSink, BlobSink, BinarySink, ParquetSink, AvroSink, AzureTableSink, AzureQueueSink, SapCloudForCustomerSink, AzureMySqlSink, AzurePostgreSqlSink, RestSink, OrcSink, JsonSink, DelimitedTextSink

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 this collection
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).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.CopySource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A copy activity source.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SharePointOnlineListSource, SnowflakeSource, HttpSource, AzureBlobFSSource, AzureDataLakeStoreSource, Office365Source, CosmosDbMongoDbApiSource, MongoDbV2Source, MongoDbSource, WebSource, OracleSource, AzureDataExplorerSource, HdfsSource, FileSystemSource, RestSource, SalesforceServiceCloudSource, ODataSource, MicrosoftAccessSource, RelationalSource, CommonDataServiceForAppsSource, DynamicsCrmSource, DynamicsSource, CosmosDbSqlApiSource, DocumentDbCollectionSource, BlobSource, TabularSource, BinarySource, OrcSource, XmlSource, JsonSource, DelimitedTextSource, ParquetSource, ExcelSource, AvroSource

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 this collection
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).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.CosmosDbLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, account_endpoint=None, database=None, account_key=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Microsoft Azure Cosmos Database (CosmosDB) 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
account_endpoint (object) – The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string)
database (object) – The name of the database. Type: string (or Expression with resultType string)
account_key (SecretBase) – The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CosmosDbMongoDbApiCollectionDataset(*, linked_service_name, collection, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The CosmosDB (MongoDB API) database 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 this collection
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.
type (str) – Required. Constant filled by server.
collection (object) – Required. The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CosmosDbMongoDbApiLinkedService(*, connection_string, database, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for CosmosDB (MongoDB API) data 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
database (object) – Required. The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CosmosDbMongoDbApiSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, write_behavior=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity sink for a CosmosDB (MongoDB API) database.

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 this collection
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).
type (str) – Required. Constant filled by server.
write_behavior (object) – Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is “insert”. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CosmosDbMongoDbApiSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, filter=None, cursor_methods=None, batch_size=None, query_timeout=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity source for a CosmosDB (MongoDB API) database.

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 this collection
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).
type (str) – Required. Constant filled by server.
filter (object) – Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).
cursor_methods (MongoDbCursorMethodsProperties) – Cursor methods for Mongodb query.
batch_size (object) – Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property’s main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).
query_timeout (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).

class azure.mgmt.datafactory.models.CosmosDbSqlApiCollectionDataset(*, linked_service_name, collection_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Microsoft Azure CosmosDB (SQL API) Collection 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 this collection
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.
type (str) – Required. Constant filled by server.
collection_name (object) – Required. CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CosmosDbSqlApiSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, write_behavior=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Azure CosmosDB (SQL API) Collection 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 this collection
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).
type (str) – Required. Constant filled by server.
write_behavior (object) – Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

class azure.mgmt.datafactory.models.CosmosDbSqlApiSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, page_size=None, preferred_regions=None, detect_datetime=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Azure CosmosDB (SQL API) Collection 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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – SQL API query. Type: string (or Expression with resultType string).
page_size (object) – Page size of the result. Type: integer (or Expression with resultType integer).
preferred_regions (object) – Preferred regions. Type: array of strings (or Expression with resultType array of strings).
detect_datetime (object) – Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).
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).

class azure.mgmt.datafactory.models.CouchbaseLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, cred_string=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Couchbase server 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
cred_string (AzureKeyVaultSecretReference) – The Azure key vault secret reference of credString in connection string.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CouchbaseSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Couchbase server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.CouchbaseTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Couchbase 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CreateDataFlowDebugSessionRequest(*, compute_type: str = None, core_count: int = None, time_to_live: int = None, integration_runtime=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Request body structure for creating data flow debug session.

Parameters

compute_type (str) – Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided.
core_count (int) – Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided.
time_to_live (int) – Time to live setting of the cluster in minutes.
integration_runtime (IntegrationRuntimeDebugResource) – Set to use integration runtime setting for data flow debug session.

class azure.mgmt.datafactory.models.CreateDataFlowDebugSessionResponse(*, status: str = None, session_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response body structure for creating data flow debug session.

Parameters

status (str) – The state of the debug session.
session_id (str) – The ID of data flow debug session.

class azure.mgmt.datafactory.models.CreateLinkedIntegrationRuntimeRequest(*, name: str = None, subscription_id: str = None, data_factory_name: str = None, data_factory_location: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The linked integration runtime information.

Parameters

name (str) – The name of the linked integration runtime.
subscription_id (str) – The ID of the subscription that the linked integration runtime belongs to.
data_factory_name (str) – The name of the data factory that the linked integration runtime belongs to.
data_factory_location (str) – The location of the data factory that the linked integration runtime belongs to.

class azure.mgmt.datafactory.models.CreateRunResponse(*, run_id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response body with a run identifier.

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

Parameters: run_id (str) – Required. Identifier of a run.

class azure.mgmt.datafactory.models.CustomActivity(*, name: str, command, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, resource_linked_service=None, folder_path=None, reference_objects=None, extended_properties=None, retention_time_in_days=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

Custom activity type.

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
command (object) – Required. Command for custom activity Type: string (or Expression with resultType string).
resource_linked_service (LinkedServiceReference) – Resource linked service reference.
folder_path (object) – Folder path for resource files Type: string (or Expression with resultType string).
reference_objects (CustomActivityReferenceObject) – Reference objects
extended_properties (dict[str, object]) – User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.
retention_time_in_days (object) – The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).

class azure.mgmt.datafactory.models.CustomActivityReferenceObject(*, linked_services=None, datasets=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Reference objects for custom activity.

Parameters

linked_services (list[LinkedServiceReference]) – Linked service references.
datasets (list[DatasetReference]) – Dataset references.

class azure.mgmt.datafactory.models.CustomDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, type_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The custom 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 this collection
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.
type (str) – Required. Constant filled by server.
type_properties (object) – Custom dataset properties.

class azure.mgmt.datafactory.models.CustomDataSourceLinkedService(*, type_properties, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Custom 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 this collection
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.
type (str) – Required. Constant filled by server.
type_properties (object) – Required. Custom linked service properties.

class azure.mgmt.datafactory.models.CustomSetupBase(**kwargs)[source]¶

Bases: msrest.serialization.Model

The base definition of the custom setup.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzPowerShellSetup, ComponentSetup, EnvironmentVariableSetup, CmdkeySetup

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

Parameters: type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.DatabricksNotebookActivity(*, name: str, notebook_path, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, base_parameters=None, libraries=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

DatabricksNotebook 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
notebook_path (object) – Required. The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).
base_parameters (dict[str, object]) – Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.
libraries (list[dict[str, object]]) – A list of libraries to be installed on the cluster that will execute the job.

class azure.mgmt.datafactory.models.DatabricksSparkJarActivity(*, name: str, main_class_name, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, parameters=None, libraries=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

DatabricksSparkJar 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
main_class_name (object) – Required. The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string).
parameters (list[object]) – Parameters that will be passed to the main method.
libraries (list[dict[str, object]]) – A list of libraries to be installed on the cluster that will execute the job.

class azure.mgmt.datafactory.models.DatabricksSparkPythonActivity(*, name: str, python_file, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, parameters=None, libraries=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

DatabricksSparkPython 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
python_file (object) – Required. The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string).
parameters (list[object]) – Command line parameters that will be passed to the Python file.
libraries (list[dict[str, object]]) – A list of libraries to be installed on the cluster that will execute the job.

class azure.mgmt.datafactory.models.DataFlow(*, description: str = None, annotations=None, folder=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure Data Factory nested object which contains a flow with data movements and transformations.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MappingDataFlow

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

Parameters

description (str) – The description of the data flow.
annotations (list[object]) – List of tags that can be used for describing the data flow.
folder (DataFlowFolder) – The folder that this data flow is in. If not specified, Data flow will appear at the root level.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.DataFlowDebugCommandPayload(*, stream_name: str, row_limits: int = None, columns=None, expression: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Structure of command payload.

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

Parameters

stream_name (str) – Required. The stream name which is used for preview.
row_limits (int) – Row limits for preview response.
columns (list[str]) – Array of column names.
expression (str) – The expression which is used for preview.

class azure.mgmt.datafactory.models.DataFlowDebugCommandRequest(*, session_id: str = None, command=None, command_payload=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Request body structure for data flow debug command.

Parameters

session_id (str) – The ID of data flow debug session.
command (str or DataFlowDebugCommandType) – The command type. Possible values include: ‘executePreviewQuery’, ‘executeStatisticsQuery’, ‘executeExpressionQuery’
command_payload (DataFlowDebugCommandPayload) – The command payload object.

class azure.mgmt.datafactory.models.DataFlowDebugCommandResponse(*, status: str = None, data: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response body structure of data flow result for data preview, statistics or expression preview.

Parameters

status (str) – The run status of data preview, statistics or expression preview.
data (str) – The result data of data preview, statistics or expression preview.

class azure.mgmt.datafactory.models.DataFlowDebugPackage(*, additional_properties=None, session_id: str = None, data_flow=None, datasets=None, linked_services=None, staging=None, debug_settings=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Request body structure for starting data flow debug session.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
session_id (str) – The ID of data flow debug session.
data_flow (DataFlowDebugResource) – Data flow instance.
datasets (list[DatasetDebugResource]) – List of datasets.
linked_services (list[LinkedServiceDebugResource]) – List of linked services.
staging (DataFlowStagingInfo) – Staging info for debug session.
debug_settings (DataFlowDebugPackageDebugSettings) – Data flow debug settings.

class azure.mgmt.datafactory.models.DataFlowDebugPackageDebugSettings(*, source_settings=None, parameters=None, dataset_parameters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Data flow debug settings.

Parameters

source_settings (list[DataFlowSourceSetting]) – Source setting for data flow debug.
parameters (dict[str, object]) – Data flow parameters.
dataset_parameters (object) – Parameters for dataset.

class azure.mgmt.datafactory.models.DataFlowDebugResource(*, properties, name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResourceDebugResource

Data flow debug resource.

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

Parameters

name (str) – The resource name.
properties (DataFlow) – Required. Data flow properties.

class azure.mgmt.datafactory.models.DataFlowDebugSessionInfo(*, additional_properties=None, data_flow_name: str = None, compute_type: str = None, core_count: int = None, node_count: int = None, integration_runtime_name: str = None, session_id: str = None, start_time: str = None, time_to_live_in_minutes: int = None, last_activity_time: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Data flow debug session info.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
data_flow_name (str) – The name of the data flow.
compute_type (str) – Compute type of the cluster.
core_count (int) – Core count of the cluster.
node_count (int) – Node count of the cluster. (deprecated property)
integration_runtime_name (str) – Attached integration runtime name of data flow debug session.
session_id (str) – The ID of data flow debug session.
start_time (str) – Start time of data flow debug session.
time_to_live_in_minutes (int) – Compute type of the cluster.
last_activity_time (str) – Last activity time of data flow debug session.

class azure.mgmt.datafactory.models.DataFlowFolder(*, name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The folder that this data flow is in. If not specified, Data flow will appear at the root level.

Parameters: name (str) – The name of the folder that this data flow is in.

class azure.mgmt.datafactory.models.DataFlowReference(*, reference_name: str, additional_properties=None, dataset_parameters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Data flow reference type.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
reference_name (str) – Required. Reference data flow name.
dataset_parameters (object) – Reference data flow parameters from dataset.

Variables

type (str) – Required. Data flow reference type. Default value: “DataFlowReference” .

type = 'DataFlowReference'¶

class azure.mgmt.datafactory.models.DataFlowResource(*, properties, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResource

Data flow resource type.

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

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
etag (str) – Etag identifies change in the resource.

Parameters

properties (DataFlow) – Required. Data flow properties.

class azure.mgmt.datafactory.models.DataFlowSink(*, name: str, description: str = None, dataset=None, linked_service=None, schema_linked_service=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Transformation

Transformation for data flow sink.

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

Parameters

name (str) – Required. Transformation name.
description (str) – Transformation description.
dataset (DatasetReference) – Dataset reference.
linked_service (LinkedServiceReference) – Linked service reference.
schema_linked_service (LinkedServiceReference) – Schema linked service reference.

class azure.mgmt.datafactory.models.DataFlowSource(*, name: str, description: str = None, dataset=None, linked_service=None, schema_linked_service=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Transformation

Transformation for data flow source.

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

Parameters

name (str) – Required. Transformation name.
description (str) – Transformation description.
dataset (DatasetReference) – Dataset reference.
linked_service (LinkedServiceReference) – Linked service reference.
schema_linked_service (LinkedServiceReference) – Schema linked service reference.

class azure.mgmt.datafactory.models.DataFlowSourceSetting(*, additional_properties=None, source_name: str = None, row_limit: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Definition of data flow source setting for debug.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
source_name (str) – The data flow source name.
row_limit (int) – Defines the row limit of data flow source in debug.

class azure.mgmt.datafactory.models.DataFlowStagingInfo(*, linked_service=None, folder_path=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Staging info for execute data flow activity.

Parameters

linked_service (LinkedServiceReference) – Staging linked service reference.
folder_path (object) – Folder path for staging blob. Type: string (or Expression with resultType string)

class azure.mgmt.datafactory.models.DataLakeAnalyticsUSQLActivity(*, name: str, script_path, script_linked_service, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, degree_of_parallelism=None, priority=None, parameters=None, runtime_version=None, compilation_mode=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

Data Lake Analytics U-SQL 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
script_path (object) – Required. Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).
script_linked_service (LinkedServiceReference) – Required. Script linked service reference.
degree_of_parallelism (object) – The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1.
priority (object) – Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1.
parameters (dict[str, object]) – Parameters for U-SQL job request.
runtime_version (object) – Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string).
compilation_mode (object) – Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.Dataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SharePointOnlineListResourceDataset, SnowflakeDataset, GoogleAdWordsObjectDataset, AzureDataExplorerTableDataset, OracleServiceCloudObjectDataset, DynamicsAXResourceDataset, ResponsysObjectDataset, SalesforceMarketingCloudObjectDataset, VerticaTableDataset, NetezzaTableDataset, ZohoObjectDataset, XeroObjectDataset, SquareObjectDataset, SparkObjectDataset, ShopifyObjectDataset, ServiceNowObjectDataset, QuickBooksObjectDataset, PrestoObjectDataset, PhoenixObjectDataset, PaypalObjectDataset, MarketoObjectDataset, AzureMariaDBTableDataset, MariaDBTableDataset, MagentoObjectDataset, JiraObjectDataset, ImpalaObjectDataset, HubspotObjectDataset, HiveObjectDataset, HBaseObjectDataset, GreenplumTableDataset, GoogleBigQueryObjectDataset, EloquaObjectDataset, DrillTableDataset, CouchbaseTableDataset, ConcurObjectDataset, AzurePostgreSqlTableDataset, AmazonMWSObjectDataset, HttpDataset, AzureSearchIndexDataset, WebTableDataset, SapTableResourceDataset, RestResourceDataset, SqlServerTableDataset, SapOpenHubTableDataset, SapHanaTableDataset, SapEccResourceDataset, SapCloudForCustomerResourceDataset, SapBwCubeDataset, SybaseTableDataset, SalesforceServiceCloudObjectDataset, SalesforceObjectDataset, MicrosoftAccessTableDataset, PostgreSqlTableDataset, MySqlTableDataset, OdbcTableDataset, InformixTableDataset, RelationalTableDataset, Db2TableDataset, AmazonRedshiftTableDataset, AzureMySqlTableDataset, TeradataTableDataset, OracleTableDataset, ODataResourceDataset, CosmosDbMongoDbApiCollectionDataset, MongoDbV2CollectionDataset, MongoDbCollectionDataset, FileShareDataset, Office365Dataset, AzureBlobFSDataset, AzureDataLakeStoreDataset, CommonDataServiceForAppsEntityDataset, DynamicsCrmEntityDataset, DynamicsEntityDataset, DocumentDbCollectionDataset, CosmosDbSqlApiCollectionDataset, CustomDataset, CassandraTableDataset, AzureSqlDWTableDataset, AzureSqlMITableDataset, AzureSqlTableDataset, AzureTableDataset, AzureBlobDataset, BinaryDataset, OrcDataset, XmlDataset, JsonDataset, DelimitedTextDataset, ParquetDataset, ExcelDataset, AvroDataset, AmazonS3Dataset

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 this collection
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.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.DatasetBZip2Compression(*, additional_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetCompression

The BZip2 compression method used on a 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 this collection
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.DatasetCompression(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The compression method used on a dataset.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DatasetZipDeflateCompression, DatasetDeflateCompression, DatasetGZipCompression, DatasetBZip2Compression

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 this collection
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.DatasetDebugResource(*, properties, name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResourceDebugResource

Dataset debug resource.

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

Parameters

name (str) – The resource name.
properties (Dataset) – Required. Dataset properties.

class azure.mgmt.datafactory.models.DatasetDeflateCompression(*, additional_properties=None, level=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetCompression

The Deflate compression method used on a 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 this collection
type (str) – Required. Constant filled by server.
level (object) – The Deflate compression level.

class azure.mgmt.datafactory.models.DatasetFolder(*, name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Parameters: name (str) – The name of the folder that this Dataset is in.

class azure.mgmt.datafactory.models.DatasetGZipCompression(*, additional_properties=None, level=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetCompression

The GZip compression method used on a 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 this collection
type (str) – Required. Constant filled by server.
level (object) – The GZip compression level.

class azure.mgmt.datafactory.models.DatasetLocation(*, additional_properties=None, folder_path=None, file_name=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Dataset location.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: HdfsLocation, HttpServerLocation, SftpLocation, FtpServerLocation, GoogleCloudStorageLocation, AzureFileStorageLocation, FileServerLocation, AmazonS3Location, AzureDataLakeStoreLocation, AzureBlobFSLocation, AzureBlobStorageLocation

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 this collection
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).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.DatasetReference(*, reference_name: str, parameters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Dataset reference type.

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

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

Variables

type (str) – Required. Dataset reference type. Default value: “DatasetReference” .

Parameters

reference_name (str) – Required. Reference dataset name.
parameters (dict[str, object]) – Arguments for dataset.

type = 'DatasetReference'¶

class azure.mgmt.datafactory.models.DatasetResource(*, properties, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResource

Dataset resource type.

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

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
etag (str) – Etag identifies change in the resource.

Parameters

properties (Dataset) – Required. Dataset properties.

class azure.mgmt.datafactory.models.DatasetStorageFormat(*, additional_properties=None, serializer=None, deserializer=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The format definition of a storage.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ParquetFormat, OrcFormat, AvroFormat, JsonFormat, TextFormat

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 this collection
serializer (object) – Serializer. Type: string (or Expression with resultType string).
deserializer (object) – Deserializer. Type: string (or Expression with resultType string).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.DatasetZipDeflateCompression(*, additional_properties=None, level=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetCompression

The ZipDeflate compression method used on a 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 this collection
type (str) – Required. Constant filled by server.
level (object) – The ZipDeflate compression level.

class azure.mgmt.datafactory.models.Db2LinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, server=None, database=None, authentication_type=None, username=None, password=None, package_collection=None, certificate_common_name=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for DB2 data 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference.
server (object) – Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
database (object) – Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
authentication_type (str or Db2AuthenticationType) – AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. Possible values include: ‘Basic’
username (object) – Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
password (SecretBase) – Password for authentication.
package_collection (object) – Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).
certificate_common_name (object) – Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. 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. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.Db2Source(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for Db2 databases.

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.Db2TableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, db2_table_dataset_schema=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Db2 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
db2_table_dataset_schema (object) – The Db2 schema name. Type: string (or Expression with resultType string).
table (object) – The Db2 table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DeleteActivity(*, name: str, dataset, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, recursive=None, max_concurrent_connections: int = None, enable_logging=None, log_storage_settings=None, store_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

Delete 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
recursive (object) – If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean).
max_concurrent_connections (int) – The max concurrent connections to connect data source at the same time.
enable_logging (object) – Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean).
log_storage_settings (LogStorageSettings) – Log storage settings customer need to provide when enableLogging is true.
dataset (DatasetReference) – Required. Delete activity dataset reference.
store_settings (StoreReadSettings) – Delete activity store settings.

class azure.mgmt.datafactory.models.DeleteDataFlowDebugSessionRequest(*, session_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Request body structure for deleting data flow debug session.

Parameters: session_id (str) – The ID of data flow debug session.

class azure.mgmt.datafactory.models.DelimitedTextDataset(*, linked_service_name, location, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, column_delimiter=None, row_delimiter=None, encoding_name=None, compression_codec=None, compression_level=None, quote_char=None, escape_char=None, first_row_as_header=None, null_value=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Delimited text 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 this collection
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.
type (str) – Required. Constant filled by server.
location (DatasetLocation) – Required. The location of the delimited text storage.
column_delimiter (object) – The column delimiter. Type: string (or Expression with resultType string).
row_delimiter (object) – The row delimiter. Type: string (or Expression with resultType string).
encoding_name (object) – The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
compression_codec (object) –
compression_level (object) – The data compression method used for DelimitedText.
quote_char (object) – The quote character. Type: string (or Expression with resultType string).
escape_char (object) – The escape character. Type: string (or Expression with resultType string).
first_row_as_header (object) – When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
null_value (object) – The null value string. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DelimitedTextReadSettings(*, additional_properties=None, skip_line_count=None, compression_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.FormatReadSettings

Delimited text 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 this collection
type (str) – Required. Constant filled by server.
skip_line_count (object) – Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer).
compression_properties (CompressionReadSettings) – Compression settings.

class azure.mgmt.datafactory.models.DelimitedTextSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, store_settings=None, format_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity DelimitedText 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreWriteSettings) – DelimitedText store settings.
format_settings (DelimitedTextWriteSettings) – DelimitedText format settings.

class azure.mgmt.datafactory.models.DelimitedTextSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, store_settings=None, format_settings=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity DelimitedText 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreReadSettings) – DelimitedText store settings.
format_settings (DelimitedTextReadSettings) – DelimitedText format 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).

class azure.mgmt.datafactory.models.DelimitedTextWriteSettings(*, file_extension, additional_properties=None, quote_all_text=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.FormatWriteSettings

Delimited text 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 this collection
type (str) – Required. Constant filled by server.
quote_all_text (object) – Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean).
file_extension (object) – Required. The file extension used to create the files. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DependencyReference(**kwargs)[source]¶

Bases: msrest.serialization.Model

Referenced dependency.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SelfDependencyTumblingWindowTriggerReference, TriggerDependencyReference

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

Parameters: type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.DistcpSettings(*, resource_manager_endpoint, temp_script_path, distcp_options=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Distcp settings.

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

Parameters

resource_manager_endpoint (object) – Required. Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string).
temp_script_path (object) – Required. Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string).
distcp_options (object) – Specifies the Distcp options. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DocumentDbCollectionDataset(*, linked_service_name, collection_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Microsoft Azure Document Database Collection 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 this collection
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.
type (str) – Required. Constant filled by server.
collection_name (object) – Required. Document Database collection name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DocumentDbCollectionSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, nesting_separator=None, write_behavior=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Document Database Collection 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 this collection
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).
type (str) – Required. Constant filled by server.
nesting_separator (object) – Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).
write_behavior (object) – Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

class azure.mgmt.datafactory.models.DocumentDbCollectionSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, nesting_separator=None, query_timeout=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Document Database Collection 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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – Documents query. Type: string (or Expression with resultType string).
nesting_separator (object) – Nested properties separator. Type: string (or Expression with resultType string).
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).

class azure.mgmt.datafactory.models.DrillLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, pwd=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Drill server 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.DrillSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Drill server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.DrillTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, drill_table_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Drill 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
table (object) – The table name of the Drill. Type: string (or Expression with resultType string).
drill_table_dataset_schema (object) – The schema name of the Drill. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DWCopyCommandDefaultValue(*, column_name=None, default_value=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Default value.

Parameters

column_name (object) – Column name. Type: object (or Expression with resultType string).
default_value (object) – The default value of the column. Type: object (or Expression with resultType string).

class azure.mgmt.datafactory.models.DWCopyCommandSettings(*, default_values=None, additional_options=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

DW Copy Command settings.

Parameters

default_values (list[DWCopyCommandDefaultValue]) – Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).
additional_options (dict[str, str]) – Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalOptions”: { “MAXERRORS”: “1000”, “DATEFORMAT”: “‘ymd’” }

class azure.mgmt.datafactory.models.DynamicsAXLinkedService(*, url, service_principal_id, service_principal_key, tenant, aad_resource_id, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Dynamics AX 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 this collection
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.
type (str) – Required. Constant filled by server.
url (object) – Required. The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint.
service_principal_id (object) – Required. Specify the application’s client ID. Type: string (or Expression with resultType string).
service_principal_key (SecretBase) – Required. Specify the application’s key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string).
tenant (object) – Required. Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).
aad_resource_id (object) – Required. Specify the resource you are requesting authorization. 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).

class azure.mgmt.datafactory.models.DynamicsAXResourceDataset(*, linked_service_name, path, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The path of the Dynamics AX OData entity.

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 this collection
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.
type (str) – Required. Constant filled by server.
path (object) – Required. The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DynamicsAXSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, http_request_timeout=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Dynamics AX 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
http_request_timeout (object) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

class azure.mgmt.datafactory.models.DynamicsCrmEntityDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, entity_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Dynamics CRM entity 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 this collection
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.
type (str) – Required. Constant filled by server.
entity_name (object) – The logical name of the entity. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DynamicsCrmLinkedService(*, deployment_type, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, host_name=None, port=None, service_uri=None, organization_name=None, username=None, password=None, service_principal_id=None, service_principal_credential_type=None, service_principal_credential=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Dynamics CRM 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 this collection
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.
type (str) – Required. Constant filled by server.
deployment_type (str or DynamicsDeploymentType) – Required. The deployment type of the Dynamics CRM instance. ‘Online’ for Dynamics CRM Online and ‘OnPremisesWithIfd’ for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string). Possible values include: ‘Online’, ‘OnPremisesWithIfd’
host_name (object) – The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
port (object) – The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.
service_uri (object) – The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).
organization_name (object) – The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string).
authentication_type (str or DynamicsAuthenticationType) – Required. The authentication type to connect to Dynamics CRM server. ‘Office365’ for online scenario, ‘Ifd’ for on-premises with Ifd scenario, ‘AADServicePrincipal’ for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string). Possible values include: ‘Office365’, ‘Ifd’, ‘AADServicePrincipal’
username (object) – User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string).
password (SecretBase) – Password to access the Dynamics CRM instance.
service_principal_id (object) – The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
service_principal_credential_type (object) – The service principal credential type to use in Server-To-Server authentication. ‘ServicePrincipalKey’ for key/secret, ‘ServicePrincipalCert’ for certificate. Type: string (or Expression with resultType string).
service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DynamicsCrmSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, ignore_null_values=None, alternate_key_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Dynamics CRM sink.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
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).
type (str) – Required. Constant filled by server.
ignore_null_values (object) – The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).
alternate_key_name (object) – The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

Variables

write_behavior (str) – Required. The write behavior for the operation. Default value: “Upsert” .

write_behavior = 'Upsert'¶

class azure.mgmt.datafactory.models.DynamicsCrmSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Dynamics CRM 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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string).
additional_columns (list[AdditionalColumns]) – Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).

class azure.mgmt.datafactory.models.DynamicsEntityDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, entity_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Dynamics entity 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 this collection
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.
type (str) – Required. Constant filled by server.
entity_name (object) – The logical name of the entity. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DynamicsLinkedService(*, deployment_type, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, host_name=None, port=None, service_uri=None, organization_name=None, username=None, password=None, service_principal_id=None, service_principal_credential_type=None, service_principal_credential=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Dynamics 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 this collection
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.
type (str) – Required. Constant filled by server.
deployment_type (object) – Required. The deployment type of the Dynamics instance. ‘Online’ for Dynamics Online and ‘OnPremisesWithIfd’ for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string).
host_name (object) – The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).
port (object) – The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.
service_uri (object) – The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).
organization_name (object) – The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string).
authentication_type (object) – Required. The authentication type to connect to Dynamics server. ‘Office365’ for online scenario, ‘Ifd’ for on-premises with Ifd scenario, ‘AADServicePrincipal’ for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).
username (object) – User name to access the Dynamics instance. Type: string (or Expression with resultType string).
password (SecretBase) – Password to access the Dynamics instance.
service_principal_id (object) – The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
service_principal_credential_type (object) – The service principal credential type to use in Server-To-Server authentication. ‘ServicePrincipalKey’ for key/secret, ‘ServicePrincipalCert’ for certificate. Type: string (or Expression with resultType string).
service_principal_credential (SecretBase) – The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is ‘ServicePrincipalKey’, servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is ‘ServicePrincipalCert’, servicePrincipalCredential can only be AzureKeyVaultSecretReference.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.DynamicsSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, ignore_null_values=None, alternate_key_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Dynamics sink.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
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).
type (str) – Required. Constant filled by server.
ignore_null_values (object) – The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).
alternate_key_name (object) – The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

Variables

write_behavior (str) – Required. The write behavior for the operation. Default value: “Upsert” .

write_behavior = 'Upsert'¶

class azure.mgmt.datafactory.models.DynamicsSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Dynamics 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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string).
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).

class azure.mgmt.datafactory.models.EloquaLinkedService(*, endpoint, username, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, password=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Eloqua server 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 this collection
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.
type (str) – Required. Constant filled by server.
endpoint (object) – Required. The endpoint of the Eloqua server. (i.e. eloqua.example.com)
username (object) – Required. The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)
password (SecretBase) – The password corresponding to the user name.
use_encrypted_endpoints (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).

class azure.mgmt.datafactory.models.EloquaObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Eloqua 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.EloquaSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Eloqua server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.EntityReference(*, type=None, reference_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The entity reference.

Parameters

type (str or IntegrationRuntimeEntityReferenceType) – The type of this referenced entity. Possible values include: ‘IntegrationRuntimeReference’, ‘LinkedServiceReference’
reference_name (str) – The name of this referenced entity.

class azure.mgmt.datafactory.models.EnvironmentVariableSetup(*, variable_name: str, variable_value: str, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CustomSetupBase

The custom setup of setting environment variable.

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

Parameters

type (str) – Required. Constant filled by server.
variable_name (str) – Required. The name of the environment variable.
variable_value (str) – Required. The value of the environment variable.

class azure.mgmt.datafactory.models.ExcelDataset(*, linked_service_name, location, sheet_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, range=None, first_row_as_header=None, compression=None, null_value=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Excel 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 this collection
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.
type (str) – Required. Constant filled by server.
location (DatasetLocation) – Required. The location of the excel storage.
sheet_name (object) – Required. The sheet of excel file. Type: string (or Expression with resultType string).
range (object) – The partial data of one sheet. Type: string (or Expression with resultType string).
first_row_as_header (object) – When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
compression (DatasetCompression) – The data compression method used for the json dataset.
null_value (object) – The null value string. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ExcelSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, store_settings=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity excel 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreReadSettings) – Excel 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).

class azure.mgmt.datafactory.models.ExecuteDataFlowActivity(*, name: str, data_flow, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, staging=None, integration_runtime=None, compute=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

Execute data flow 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
data_flow (DataFlowReference) – Required. Data flow reference.
staging (DataFlowStagingInfo) – Staging info for execute data flow activity.
integration_runtime (IntegrationRuntimeReference) – The integration runtime reference.
compute (ExecuteDataFlowActivityTypePropertiesCompute) – Compute properties for data flow activity.

class azure.mgmt.datafactory.models.ExecuteDataFlowActivityTypePropertiesCompute(*, compute_type=None, core_count: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Compute properties for data flow activity.

Parameters

compute_type (str or DataFlowComputeType) – Compute type of the cluster which will execute data flow job. Possible values include: ‘General’, ‘MemoryOptimized’, ‘ComputeOptimized’
core_count (int) – Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.

class azure.mgmt.datafactory.models.ExecutePipelineActivity(*, name: str, pipeline, additional_properties=None, description: str = None, depends_on=None, user_properties=None, parameters=None, wait_on_completion: bool = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
pipeline (PipelineReference) – Required. Pipeline reference.
parameters (dict[str, object]) – Pipeline parameters.
wait_on_completion (bool) – Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.

class azure.mgmt.datafactory.models.ExecuteSSISPackageActivity(*, name: str, package_location, connect_via, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, runtime=None, logging_level=None, environment_path=None, execution_credential=None, project_parameters=None, package_parameters=None, project_connection_managers=None, package_connection_managers=None, property_overrides=None, log_location=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

Execute SSIS package 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
package_location (SSISPackageLocation) – Required. SSIS package location.
runtime (object) – Specifies the runtime to execute SSIS package. The value should be “x86” or “x64”. Type: string (or Expression with resultType string).
logging_level (object) – The logging level of SSIS package execution. Type: string (or Expression with resultType string).
environment_path (object) – The environment path to execute the SSIS package. Type: string (or Expression with resultType string).
execution_credential (SSISExecutionCredential) – The package execution credential.
connect_via (IntegrationRuntimeReference) – Required. The integration runtime reference.
project_parameters (dict[str, SSISExecutionParameter]) – The project level parameters to execute the SSIS package.
package_parameters (dict[str, SSISExecutionParameter]) – The package level parameters to execute the SSIS package.
project_connection_managers (dict[str, dict[str, SSISExecutionParameter]]) – The project level connection managers to execute the SSIS package.
package_connection_managers (dict[str, dict[str, SSISExecutionParameter]]) – The package level connection managers to execute the SSIS package.
property_overrides (dict[str, SSISPropertyOverride]) – The property overrides to execute the SSIS package.
log_location (SSISLogLocation) – SSIS package execution log location.

class azure.mgmt.datafactory.models.ExecutionActivity(*, name: str, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Activity

Base class for all execution activities.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ExecuteDataFlowActivity, AzureFunctionActivity, DatabricksSparkPythonActivity, DatabricksSparkJarActivity, DatabricksNotebookActivity, DataLakeAnalyticsUSQLActivity, AzureMLExecutePipelineActivity, AzureMLUpdateResourceActivity, AzureMLBatchExecutionActivity, GetMetadataActivity, WebActivity, LookupActivity, AzureDataExplorerCommandActivity, DeleteActivity, SqlServerStoredProcedureActivity, CustomActivity, ExecuteSSISPackageActivity, HDInsightSparkActivity, HDInsightStreamingActivity, HDInsightMapReduceActivity, HDInsightPigActivity, HDInsightHiveActivity, CopyActivity

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.

class azure.mgmt.datafactory.models.ExportSettings(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Export command settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SnowflakeExportCopyCommand

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 this collection
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.ExposureControlBatchRequest(*, exposure_control_requests, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of exposure control features.

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

Parameters: exposure_control_requests (list[ExposureControlRequest]) – Required. List of exposure control features.

class azure.mgmt.datafactory.models.ExposureControlBatchResponse(*, exposure_control_responses, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of exposure control feature values.

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

Parameters: exposure_control_responses (list[ExposureControlResponse]) – Required. List of exposure control feature values.

class azure.mgmt.datafactory.models.ExposureControlRequest(*, feature_name: str = None, feature_type: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The exposure control request.

Parameters

feature_name (str) – The feature name.
feature_type (str) – The feature type.

class azure.mgmt.datafactory.models.ExposureControlResponse(**kwargs)[source]¶

Bases: msrest.serialization.Model

The exposure control response.

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

Variables

feature_name (str) – The feature name.
value (str) – The feature value.

class azure.mgmt.datafactory.models.Expression(*, value: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure Data Factory expression definition.

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

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

Variables: type (str) – Required. Expression type. Default value: “Expression” .
Parameters: value (str) – Required. Expression value.

type = 'Expression'¶

class azure.mgmt.datafactory.models.Factory(*, location: str = None, tags=None, additional_properties=None, identity=None, repo_configuration=None, global_parameters=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Resource

Factory resource type.

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
e_tag (str) – Etag identifies change in the resource.
provisioning_state (str) – Factory provisioning state, example Succeeded.
create_time (datetime) – Time the factory was created in ISO8601 format.
version (str) – Version of the factory.

Parameters

location (str) – The resource location.
tags (dict[str, str]) – The resource tags.
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
identity (FactoryIdentity) – Managed service identity of the factory.
repo_configuration (FactoryRepoConfiguration) – Git repo information of the factory.
global_parameters (dict[str, GlobalParameterSpecification]) – List of parameters for factory.

class azure.mgmt.datafactory.models.FactoryGitHubConfiguration(*, account_name: str, repository_name: str, collaboration_branch: str, root_folder: str, last_commit_id: str = None, host_name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.FactoryRepoConfiguration

Factory’s GitHub repo information.

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

Parameters

account_name (str) – Required. Account name.
repository_name (str) – Required. Repository name.
collaboration_branch (str) – Required. Collaboration branch.
root_folder (str) – Required. Root folder.
last_commit_id (str) – Last commit id.
type (str) – Required. Constant filled by server.
host_name (str) – GitHub Enterprise host name. For example: https://github.mydomain.com

class azure.mgmt.datafactory.models.FactoryIdentity(**kwargs)[source]¶

Bases: msrest.serialization.Model

Identity properties of the factory resource.

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

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

Variables

type (str) – Required. The identity type. Currently the only supported type is ‘SystemAssigned’. Default value: “SystemAssigned” .
principal_id (str) – The principal id of the identity.
tenant_id (str) – The client tenant id of the identity.

type = 'SystemAssigned'¶

class azure.mgmt.datafactory.models.FactoryRepoConfiguration(*, account_name: str, repository_name: str, collaboration_branch: str, root_folder: str, last_commit_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Factory’s git repo information.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: FactoryVSTSConfiguration, FactoryGitHubConfiguration

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

Parameters

account_name (str) – Required. Account name.
repository_name (str) – Required. Repository name.
collaboration_branch (str) – Required. Collaboration branch.
root_folder (str) – Required. Root folder.
last_commit_id (str) – Last commit id.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.FactoryRepoUpdate(*, factory_resource_id: str = None, repo_configuration=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Factory’s git repo information.

Parameters

factory_resource_id (str) – The factory resource id.
repo_configuration (FactoryRepoConfiguration) – Git repo information of the factory.

class azure.mgmt.datafactory.models.FactoryUpdateParameters(*, tags=None, identity=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters for updating a factory resource.

Parameters

tags (dict[str, str]) – The resource tags.
identity (FactoryIdentity) – Managed service identity of the factory.

class azure.mgmt.datafactory.models.FactoryVSTSConfiguration(*, account_name: str, repository_name: str, collaboration_branch: str, root_folder: str, project_name: str, last_commit_id: str = None, tenant_id: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.FactoryRepoConfiguration

Factory’s VSTS repo information.

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

Parameters

account_name (str) – Required. Account name.
repository_name (str) – Required. Repository name.
collaboration_branch (str) – Required. Collaboration branch.
root_folder (str) – Required. Root folder.
last_commit_id (str) – Last commit id.
type (str) – Required. Constant filled by server.
project_name (str) – Required. VSTS project name.
tenant_id (str) – VSTS tenant id.

class azure.mgmt.datafactory.models.FileServerLinkedService(*, host, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, user_id=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

File system 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 this collection
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.
type (str) – Required. Constant filled by server.
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.
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).

class azure.mgmt.datafactory.models.FileServerLocation(*, additional_properties=None, folder_path=None, file_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

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 this collection
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).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.FileServerReadSettings(*, additional_properties=None, max_concurrent_connections=None, recursive=None, wildcard_folder_path=None, wildcard_file_name=None, file_list_path=None, enable_partition_discovery: bool = None, partition_root_path=None, delete_files_after_completion=None, modified_datetime_start=None, modified_datetime_end=None, file_filter=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

File server 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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
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) – FileServer wildcardFolderPath. Type: string (or Expression with resultType string).
wildcard_file_name (object) – FileServer 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).
file_filter (object) – Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.FileServerWriteSettings(*, additional_properties=None, max_concurrent_connections=None, copy_behavior=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreWriteSettings

File server 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 this collection
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.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.FileShareDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, folder_path=None, file_name=None, modified_datetime_start=None, modified_datetime_end=None, format=None, file_filter=None, compression=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

An on-premises file system 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 this collection
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.
type (str) – Required. Constant filled by server.
folder_path (object) – The path of the on-premises file system. Type: string (or Expression with resultType string).
file_name (object) – The name of the on-premises file system. Type: string (or Expression with resultType string).
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).
format (DatasetStorageFormat) – The format of the files.
file_filter (object) – Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).
compression (DatasetCompression) – The data compression method used for the file system.

class azure.mgmt.datafactory.models.FileSystemSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, copy_behavior=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity file system 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 this collection
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).
type (str) – Required. Constant filled by server.
copy_behavior (object) – The type of copy behavior for copy sink.

class azure.mgmt.datafactory.models.FileSystemSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, recursive=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity file system 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 this collection
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).
type (str) – Required. Constant filled by server.
recursive (object) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
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).

class azure.mgmt.datafactory.models.FilterActivity(*, name: str, items, condition, additional_properties=None, description: str = None, depends_on=None, user_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

Filter and return results from input array based on the conditions.

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
items (Expression) – Required. Input array on which filter should be applied.
condition (Expression) – Required. Condition to be used for filtering the input.

class azure.mgmt.datafactory.models.ForEachActivity(*, name: str, items, activities, additional_properties=None, description: str = None, depends_on=None, user_properties=None, is_sequential: bool = None, batch_count: int = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

This activity is used for iterating over a collection and execute given activities.

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
is_sequential (bool) – Should the loop be executed in sequence or in parallel (max 50)
batch_count (int) – Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).
items (Expression) – Required. Collection to iterate.
activities (list[Activity]) – Required. List of activities to execute .

class azure.mgmt.datafactory.models.FormatReadSettings(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Format read settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BinaryReadSettings, XmlReadSettings, JsonReadSettings, DelimitedTextReadSettings

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 this collection
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.FormatWriteSettings(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Format write settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: JsonWriteSettings, DelimitedTextWriteSettings, AvroWriteSettings

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 this collection
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.FtpReadSettings(*, additional_properties=None, max_concurrent_connections=None, recursive=None, wildcard_folder_path=None, wildcard_file_name=None, enable_partition_discovery: bool = None, partition_root_path=None, delete_files_after_completion=None, file_list_path=None, use_binary_transfer: bool = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

Ftp 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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
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) – Ftp wildcardFolderPath. Type: string (or Expression with resultType string).
wildcard_file_name (object) – Ftp wildcardFileName. 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).
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).
use_binary_transfer (bool) – Specify whether to use binary transfer mode for FTP stores.

class azure.mgmt.datafactory.models.FtpServerLinkedService(*, host, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, port=None, authentication_type=None, user_name=None, password=None, encrypted_credential=None, enable_ssl=None, enable_server_certificate_validation=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

A FTP server 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. Host name of the FTP server. Type: string (or Expression with resultType string).
port (object) – The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0.
authentication_type (str or FtpAuthenticationType) – The authentication type to be used to connect to the FTP server. Possible values include: ‘Basic’, ‘Anonymous’
user_name (object) – Username to logon the FTP server. Type: string (or Expression with resultType string).
password (SecretBase) – Password to logon the FTP server.
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).
enable_ssl (object) – If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).
enable_server_certificate_validation (object) – If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.FtpServerLocation(*, additional_properties=None, folder_path=None, file_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

The location of ftp 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 this collection
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).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.GetDataFactoryOperationStatusResponse(*, additional_properties=None, status: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response body structure for get data factory operation status.

Parameters

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

class azure.mgmt.datafactory.models.GetMetadataActivity(*, name: str, dataset, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, field_list=None, store_settings=None, format_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

Activity to get metadata of 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
dataset (DatasetReference) – Required. GetMetadata activity dataset reference.
field_list (list[object]) – Fields of metadata to get from dataset.
store_settings (StoreReadSettings) – GetMetadata activity store settings.
format_settings (FormatReadSettings) – GetMetadata activity format settings.

class azure.mgmt.datafactory.models.GetSsisObjectMetadataRequest(*, metadata_path: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The request payload of get SSIS object metadata.

Parameters: metadata_path (str) – Metadata path.

class azure.mgmt.datafactory.models.GitHubAccessTokenRequest(*, git_hub_access_code: str, git_hub_access_token_base_url: str, git_hub_client_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Get GitHub access token request definition.

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

Parameters

git_hub_access_code (str) – Required. GitHub access code.
git_hub_client_id (str) – GitHub application client ID.
git_hub_access_token_base_url (str) – Required. GitHub access token base URL.

class azure.mgmt.datafactory.models.GitHubAccessTokenResponse(*, git_hub_access_token: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Get GitHub access token response definition.

Parameters: git_hub_access_token (str) – GitHub access token.

class azure.mgmt.datafactory.models.GlobalParameterSpecification(*, type, value, **kwargs)[source]¶

Bases: msrest.serialization.Model

Definition of a single parameter for an entity.

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

Parameters

type (str or GlobalParameterType) – Required. Global Parameter type. Possible values include: ‘Object’, ‘String’, ‘Int’, ‘Float’, ‘Bool’, ‘Array’
value (object) – Required. Value of parameter.

class azure.mgmt.datafactory.models.GoogleAdWordsLinkedService(*, client_customer_id, developer_token, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, refresh_token=None, client_id=None, client_secret=None, email=None, key_file_path=None, trusted_cert_path=None, use_system_trust_store=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Google AdWords 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 this collection
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.
type (str) – Required. Constant filled by server.
client_customer_id (object) – Required. The Client customer ID of the AdWords account that you want to fetch report data for.
developer_token (SecretBase) – Required. The developer token associated with the manager account that you use to grant access to the AdWords API.
authentication_type (str or GoogleAdWordsAuthenticationType) – Required. The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Possible values include: ‘ServiceAuthentication’, ‘UserAuthentication’
refresh_token (SecretBase) – The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.
client_id (object) – The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
client_secret (SecretBase) – The client secret of the google application used to acquire the refresh token.
email (object) – The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.
key_file_path (object) – The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.
trusted_cert_path (object) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
use_system_trust_store (object) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.GoogleAdWordsObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Google AdWords 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.GoogleAdWordsSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Google AdWords 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.GoogleBigQueryLinkedService(*, project, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, additional_projects=None, request_google_drive_scope=None, refresh_token=None, client_id=None, client_secret=None, email=None, key_file_path=None, trusted_cert_path=None, use_system_trust_store=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Google BigQuery 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 this collection
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.
type (str) – Required. Constant filled by server.
project (object) – Required. The default BigQuery project to query against.
additional_projects (object) – A comma-separated list of public BigQuery projects to access.
request_google_drive_scope (object) – Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.
authentication_type (str or GoogleBigQueryAuthenticationType) – Required. The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Possible values include: ‘ServiceAuthentication’, ‘UserAuthentication’
refresh_token (SecretBase) – The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.
client_id (object) – The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
client_secret (SecretBase) – The client secret of the google application used to acquire the refresh token.
email (object) – The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.
key_file_path (object) – The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.
trusted_cert_path (object) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
use_system_trust_store (object) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.GoogleBigQueryObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, dataset=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Google BigQuery 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using database + table properties instead.
table (object) – The table name of the Google BigQuery. Type: string (or Expression with resultType string).
dataset (object) – The database name of the Google BigQuery. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.GoogleBigQuerySource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Google BigQuery 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.GoogleCloudStorageLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, access_key_id=None, secret_access_key=None, service_url=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for Google Cloud 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 this collection
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.
type (str) – Required. Constant filled by server.
access_key_id (object) – The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).
secret_access_key (SecretBase) – The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user.
service_url (object) – This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.GoogleCloudStorageLocation(*, additional_properties=None, folder_path=None, file_name=None, bucket_name=None, version=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

The location of Google Cloud Storage 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 this collection
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).
type (str) – Required. Constant filled by server.
bucket_name (object) – Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string)
version (object) – Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.GoogleCloudStorageReadSettings(*, additional_properties=None, max_concurrent_connections=None, recursive=None, wildcard_folder_path=None, wildcard_file_name=None, prefix=None, file_list_path=None, enable_partition_discovery: bool = None, partition_root_path=None, delete_files_after_completion=None, modified_datetime_start=None, modified_datetime_end=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

Google Cloud 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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
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) – Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string).
wildcard_file_name (object) – Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string).
prefix (object) – The prefix filter for the Google Cloud Storage 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).

class azure.mgmt.datafactory.models.GreenplumLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, pwd=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Greenplum Database 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.GreenplumSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Greenplum Database 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.GreenplumTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, greenplum_table_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Greenplum Database 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
table (object) – The table name of Greenplum. Type: string (or Expression with resultType string).
greenplum_table_dataset_schema (object) – The schema name of Greenplum. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HBaseLinkedService(*, host, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, port=None, http_path=None, username=None, password=None, enable_ssl=None, trusted_cert_path=None, allow_host_name_cn_mismatch=None, allow_self_signed_server_cert=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

HBase server 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. The IP address or host name of the HBase server. (i.e. 192.168.222.160)
port (object) – The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.
http_path (object) – The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)
authentication_type (str or HBaseAuthenticationType) – Required. The authentication mechanism to use to connect to the HBase server. Possible values include: ‘Anonymous’, ‘Basic’
username (object) – The user name used to connect to the HBase instance.
password (SecretBase) – The password corresponding to the user name.
enable_ssl (object) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.
trusted_cert_path (object) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
allow_host_name_cn_mismatch (object) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
allow_self_signed_server_cert (object) – Specifies whether to allow self-signed certificates from the server. The default value is false.
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).

class azure.mgmt.datafactory.models.HBaseObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

HBase 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HBaseSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity HBase server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.HdfsLinkedService(*, url, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, authentication_type=None, encrypted_credential=None, user_name=None, password=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Hadoop Distributed File System (HDFS) 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 this collection
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.
type (str) – Required. Constant filled by server.
url (object) – Required. The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string).
authentication_type (object) – Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. 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).
user_name (object) – User name for Windows authentication. Type: string (or Expression with resultType string).
password (SecretBase) – Password for Windows authentication.

class azure.mgmt.datafactory.models.HdfsLocation(*, additional_properties=None, folder_path=None, file_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

The location of HDFS.

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 this collection
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).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.HdfsReadSettings(*, additional_properties=None, max_concurrent_connections=None, recursive=None, wildcard_folder_path=None, wildcard_file_name=None, file_list_path=None, enable_partition_discovery: bool = None, partition_root_path=None, modified_datetime_start=None, modified_datetime_end=None, distcp_settings=None, delete_files_after_completion=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

HDFS 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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
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) – HDFS wildcardFolderPath. Type: string (or Expression with resultType string).
wildcard_file_name (object) – HDFS 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).
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).
distcp_settings (DistcpSettings) – Specifies Distcp-related settings.
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).

class azure.mgmt.datafactory.models.HdfsSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, recursive=None, distcp_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity HDFS 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 this collection
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).
type (str) – Required. Constant filled by server.
recursive (object) – If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
distcp_settings (DistcpSettings) – Specifies Distcp-related settings.

class azure.mgmt.datafactory.models.HDInsightHiveActivity(*, name: str, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, storage_linked_services=None, arguments=None, get_debug_info=None, script_path=None, script_linked_service=None, defines=None, variables=None, query_timeout: int = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

HDInsight Hive activity type.

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.
arguments (list[object]) – User specified arguments to HDInsightActivity.
get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: ‘None’, ‘Always’, ‘Failure’
script_path (object) – Script path. Type: string (or Expression with resultType string).
script_linked_service (LinkedServiceReference) – Script linked service reference.
defines (dict[str, object]) – Allows user to specify defines for Hive job request.
variables (list[object]) – User specified arguments under hivevar namespace.
query_timeout (int) – Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)

class azure.mgmt.datafactory.models.HDInsightLinkedService(*, cluster_uri, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, user_name=None, password=None, linked_service_name=None, hcatalog_linked_service_name=None, encrypted_credential=None, is_esp_enabled=None, file_system=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

HDInsight 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 this collection
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.
type (str) – Required. Constant filled by server.
cluster_uri (object) – Required. HDInsight cluster URI. Type: string (or Expression with resultType string).
user_name (object) – HDInsight cluster user name. Type: string (or Expression with resultType string).
password (SecretBase) – HDInsight cluster password.
linked_service_name (LinkedServiceReference) – The Azure Storage linked service reference.
hcatalog_linked_service_name (LinkedServiceReference) – A reference to the Azure SQL linked service that points to the HCatalog database.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
is_esp_enabled (object) – Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean.
file_system (object) – Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HDInsightMapReduceActivity(*, name: str, class_name, jar_file_path, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, storage_linked_services=None, arguments=None, get_debug_info=None, jar_linked_service=None, jar_libs=None, defines=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

HDInsight MapReduce activity type.

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.
arguments (list[object]) – User specified arguments to HDInsightActivity.
get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: ‘None’, ‘Always’, ‘Failure’
class_name (object) – Required. Class name. Type: string (or Expression with resultType string).
jar_file_path (object) – Required. Jar path. Type: string (or Expression with resultType string).
jar_linked_service (LinkedServiceReference) – Jar linked service reference.
jar_libs (list[object]) – Jar libs.
defines (dict[str, object]) – Allows user to specify defines for the MapReduce job request.

class azure.mgmt.datafactory.models.HDInsightOnDemandLinkedService(*, cluster_size, time_to_live, version, linked_service_name, host_subscription_id, tenant, cluster_resource_group, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, service_principal_id=None, service_principal_key=None, cluster_name_prefix=None, cluster_user_name=None, cluster_password=None, cluster_ssh_user_name=None, cluster_ssh_password=None, additional_linked_service_names=None, hcatalog_linked_service_name=None, cluster_type=None, spark_version=None, core_configuration=None, h_base_configuration=None, hdfs_configuration=None, hive_configuration=None, map_reduce_configuration=None, oozie_configuration=None, storm_configuration=None, yarn_configuration=None, encrypted_credential=None, head_node_size=None, data_node_size=None, zookeeper_node_size=None, script_actions=None, virtual_network_id=None, subnet_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

HDInsight ondemand 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 this collection
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.
type (str) – Required. Constant filled by server.
cluster_size (object) – Required. Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).
time_to_live (object) – Required. The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string).
version (object) – Required. Version of the HDInsight cluster. Type: string (or Expression with resultType string).
linked_service_name (LinkedServiceReference) – Required. Azure Storage linked service to be used by the on-demand cluster for storing and processing data.
host_subscription_id (object) – Required. The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).
service_principal_id (object) – The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).
service_principal_key (SecretBase) – The key for the service principal id.
tenant (object) – Required. The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
cluster_resource_group (object) – Required. The resource group where the cluster belongs. Type: string (or Expression with resultType string).
cluster_name_prefix (object) – The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).
cluster_user_name (object) – The username to access the cluster. Type: string (or Expression with resultType string).
cluster_password (SecretBase) – The password to access the cluster.
cluster_ssh_user_name (object) – The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string).
cluster_ssh_password (SecretBase) – The password to SSH remotely connect cluster’s node (for Linux).
additional_linked_service_names (list[LinkedServiceReference]) – Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.
hcatalog_linked_service_name (LinkedServiceReference) – The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.
cluster_type (object) – The cluster type. Type: string (or Expression with resultType string).
spark_version (object) – The version of spark if the cluster type is ‘spark’. Type: string (or Expression with resultType string).
core_configuration (object) – Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.
h_base_configuration (object) – Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.
hdfs_configuration (object) – Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.
hive_configuration (object) – Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.
map_reduce_configuration (object) – Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.
oozie_configuration (object) – Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.
storm_configuration (object) – Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.
yarn_configuration (object) – Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.
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).
head_node_size (object) – Specifies the size of the head node for the HDInsight cluster.
data_node_size (object) – Specifies the size of the data node for the HDInsight cluster.
zookeeper_node_size (object) – Specifies the size of the Zoo Keeper node for the HDInsight cluster.
script_actions (list[ScriptAction]) – Custom script actions to run on HDI ondemand cluster once it’s up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.
virtual_network_id (object) – The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).
subnet_name (object) – The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HDInsightPigActivity(*, name: str, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, storage_linked_services=None, arguments=None, get_debug_info=None, script_path=None, script_linked_service=None, defines=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

HDInsight Pig activity type.

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.
arguments (object) – User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array).
get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: ‘None’, ‘Always’, ‘Failure’
script_path (object) – Script path. Type: string (or Expression with resultType string).
script_linked_service (LinkedServiceReference) – Script linked service reference.
defines (dict[str, object]) – Allows user to specify defines for Pig job request.

class azure.mgmt.datafactory.models.HDInsightSparkActivity(*, name: str, root_path, entry_file_path, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, arguments=None, get_debug_info=None, spark_job_linked_service=None, class_name: str = None, proxy_user=None, spark_config=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

HDInsight Spark 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
root_path (object) – Required. The root path in ‘sparkJobLinkedService’ for all the job’s files. Type: string (or Expression with resultType string).
entry_file_path (object) – Required. The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string).
arguments (list[object]) – The user-specified arguments to HDInsightSparkActivity.
get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: ‘None’, ‘Always’, ‘Failure’
spark_job_linked_service (LinkedServiceReference) – The storage linked service for uploading the entry file and dependencies, and for receiving logs.
class_name (str) – The application’s Java/Spark main class.
proxy_user (object) – The user to impersonate that will execute the job. Type: string (or Expression with resultType string).
spark_config (dict[str, object]) – Spark configuration property.

class azure.mgmt.datafactory.models.HDInsightStreamingActivity(*, name: str, mapper, reducer, input, output, file_paths, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, storage_linked_services=None, arguments=None, get_debug_info=None, file_linked_service=None, combiner=None, command_environment=None, defines=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

HDInsight streaming activity type.

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
storage_linked_services (list[LinkedServiceReference]) – Storage linked service references.
arguments (list[object]) – User specified arguments to HDInsightActivity.
get_debug_info (str or HDInsightActivityDebugInfoOption) – Debug info option. Possible values include: ‘None’, ‘Always’, ‘Failure’
mapper (object) – Required. Mapper executable name. Type: string (or Expression with resultType string).
reducer (object) – Required. Reducer executable name. Type: string (or Expression with resultType string).
input (object) – Required. Input blob path. Type: string (or Expression with resultType string).
output (object) – Required. Output blob path. Type: string (or Expression with resultType string).
file_paths (list[object]) – Required. Paths to streaming job files. Can be directories.
file_linked_service (LinkedServiceReference) – Linked service reference where the files are located.
combiner (object) – Combiner executable name. Type: string (or Expression with resultType string).
command_environment (list[object]) – Command line environment values.
defines (dict[str, object]) – Allows user to specify defines for streaming job request.

class azure.mgmt.datafactory.models.HiveLinkedService(*, host, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, port=None, server_type=None, thrift_transport_protocol=None, service_discovery_mode=None, zoo_keeper_name_space=None, use_native_query=None, username=None, password=None, http_path=None, enable_ssl=None, trusted_cert_path=None, use_system_trust_store=None, allow_host_name_cn_mismatch=None, allow_self_signed_server_cert=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Hive Server 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. IP address or host name of the Hive server, separated by ‘;’ for multiple hosts (only when serviceDiscoveryMode is enable).
port (object) – The TCP port that the Hive server uses to listen for client connections.
server_type (str or HiveServerType) – The type of Hive server. Possible values include: ‘HiveServer1’, ‘HiveServer2’, ‘HiveThriftServer’
thrift_transport_protocol (str or HiveThriftTransportProtocol) – The transport protocol to use in the Thrift layer. Possible values include: ‘Binary’, ‘SASL’, ‘HTTP ‘
authentication_type (str or HiveAuthenticationType) – Required. The authentication method used to access the Hive server. Possible values include: ‘Anonymous’, ‘Username’, ‘UsernameAndPassword’, ‘WindowsAzureHDInsightService’
service_discovery_mode (object) – true to indicate using the ZooKeeper service, false not.
zoo_keeper_name_space (object) – The namespace on ZooKeeper under which Hive Server 2 nodes are added.
use_native_query (object) – Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.
username (object) – The user name that you use to access Hive Server.
password (SecretBase) – The password corresponding to the user name that you provided in the Username field
http_path (object) – The partial URL corresponding to the Hive server.
enable_ssl (object) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.
trusted_cert_path (object) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
use_system_trust_store (object) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
allow_host_name_cn_mismatch (object) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
allow_self_signed_server_cert (object) – Specifies whether to allow self-signed certificates from the server. The default value is false.
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).

class azure.mgmt.datafactory.models.HiveObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, hive_object_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Hive 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
table (object) – The table name of the Hive. Type: string (or Expression with resultType string).
hive_object_dataset_schema (object) – The schema name of the Hive. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HiveSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Hive Server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.HttpDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, relative_url=None, request_method=None, request_body=None, additional_headers=None, format=None, compression=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

A file in an HTTP web server.

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 this collection
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.
type (str) – Required. Constant filled by server.
relative_url (object) – The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).
request_method (object) – The HTTP method for the HTTP request. Type: string (or Expression with resultType string).
request_body (object) – The body for the HTTP request. Type: string (or Expression with resultType string).
additional_headers (object) – The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 … request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).
format (DatasetStorageFormat) – The format of files.
compression (DatasetCompression) – The data compression method used on files.

class azure.mgmt.datafactory.models.HttpLinkedService(*, url, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, authentication_type=None, user_name=None, password=None, embedded_cert_data=None, cert_thumbprint=None, encrypted_credential=None, enable_server_certificate_validation=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for an HTTP 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 this collection
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.
type (str) – Required. Constant filled by server.
url (object) – Required. The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string).
authentication_type (str or HttpAuthenticationType) – The authentication type to be used to connect to the HTTP server. Possible values include: ‘Basic’, ‘Anonymous’, ‘Digest’, ‘Windows’, ‘ClientCertificate’
user_name (object) – User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).
password (SecretBase) – Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.
embedded_cert_data (object) – Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).
cert_thumbprint (object) – Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
enable_server_certificate_validation (object) – If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.HttpReadSettings(*, additional_properties=None, max_concurrent_connections=None, request_method=None, request_body=None, additional_headers=None, request_timeout=None, enable_partition_discovery: bool = None, partition_root_path=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

Sftp 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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
request_method (object) – The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
request_body (object) – The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
additional_headers (object) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
request_timeout (object) – Specifies the timeout for a HTTP client to get HTTP response from HTTP server.
enable_partition_discovery (bool) – Indicates whether to enable partition discovery.
partition_root_path (object) – Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HttpServerLocation(*, additional_properties=None, folder_path=None, file_name=None, relative_url=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

The location of http server.

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 this collection
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).
type (str) – Required. Constant filled by server.
relative_url (object) – Specify the relativeUrl of http server. Type: string (or Expression with resultType string)

class azure.mgmt.datafactory.models.HttpSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, http_request_timeout=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity source for an HTTP file.

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 this collection
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).
type (str) – Required. Constant filled by server.
http_request_timeout (object) – Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

class azure.mgmt.datafactory.models.HubspotLinkedService(*, client_id, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, client_secret=None, access_token=None, refresh_token=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Hubspot 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 this collection
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.
type (str) – Required. Constant filled by server.
client_id (object) – Required. The client ID associated with your Hubspot application.
client_secret (SecretBase) – The client secret associated with your Hubspot application.
access_token (SecretBase) – The access token obtained when initially authenticating your OAuth integration.
refresh_token (SecretBase) – The refresh token obtained when initially authenticating your OAuth integration.
use_encrypted_endpoints (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).

class azure.mgmt.datafactory.models.HubspotObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Hubspot 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HubspotSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Hubspot 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.IfConditionActivity(*, name: str, expression, additional_properties=None, description: str = None, depends_on=None, user_properties=None, if_true_activities=None, if_false_activities=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
expression (Expression) – Required. An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.
if_true_activities (list[Activity]) – List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.
if_false_activities (list[Activity]) – List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.

class azure.mgmt.datafactory.models.ImpalaLinkedService(*, host, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, port=None, username=None, password=None, enable_ssl=None, trusted_cert_path=None, use_system_trust_store=None, allow_host_name_cn_mismatch=None, allow_self_signed_server_cert=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Impala server 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. The IP address or host name of the Impala server. (i.e. 192.168.222.160)
port (object) – The TCP port that the Impala server uses to listen for client connections. The default value is 21050.
authentication_type (str or ImpalaAuthenticationType) – Required. The authentication type to use. Possible values include: ‘Anonymous’, ‘SASLUsername’, ‘UsernameAndPassword’
username (object) – The user name used to access the Impala server. The default value is anonymous when using SASLUsername.
password (SecretBase) – The password corresponding to the user name when using UsernameAndPassword.
enable_ssl (object) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.
trusted_cert_path (object) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
use_system_trust_store (object) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
allow_host_name_cn_mismatch (object) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
allow_self_signed_server_cert (object) – Specifies whether to allow self-signed certificates from the server. The default value is false.
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).

class azure.mgmt.datafactory.models.ImpalaObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, impala_object_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Impala 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
table (object) – The table name of the Impala. Type: string (or Expression with resultType string).
impala_object_dataset_schema (object) – The schema name of the Impala. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ImpalaSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Impala server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.ImportSettings(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Import command settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SnowflakeImportCopyCommand

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 this collection
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.InformixLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, authentication_type=None, credential=None, user_name=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Informix 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.
authentication_type (object) – Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
credential (SecretBase) – The access credential portion of the connection string specified in driver-specific property-value format.
user_name (object) – User name for Basic authentication. Type: string (or Expression with resultType string).
password (SecretBase) – Password for Basic authentication.
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).

class azure.mgmt.datafactory.models.InformixSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, pre_copy_script=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Informix 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 this collection
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).
type (str) – Required. Constant filled by server.
pre_copy_script (object) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.InformixSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for Informix.

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.InformixTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Informix 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The Informix table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.IntegrationRuntime(*, additional_properties=None, description: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure Data Factory nested object which serves as a compute resource for activities.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SelfHostedIntegrationRuntime, ManagedIntegrationRuntime

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 this collection
description (str) – Integration runtime description.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.IntegrationRuntimeAuthKeys(*, auth_key1: str = None, auth_key2: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The integration runtime authentication keys.

Parameters

auth_key1 (str) – The primary integration runtime authentication key.
auth_key2 (str) – The secondary integration runtime authentication key.

class azure.mgmt.datafactory.models.IntegrationRuntimeComputeProperties(*, additional_properties=None, location: str = None, node_size: str = None, number_of_nodes: int = None, max_parallel_executions_per_node: int = None, data_flow_properties=None, v_net_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The compute resource properties for managed integration runtime.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
location (str) – The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities
node_size (str) – The node size requirement to managed integration runtime.
number_of_nodes (int) – The required number of nodes for managed integration runtime.
max_parallel_executions_per_node (int) – Maximum parallel executions count per node for managed integration runtime.
data_flow_properties (IntegrationRuntimeDataFlowProperties) – Data flow properties for managed integration runtime.
v_net_properties (IntegrationRuntimeVNetProperties) – VNet properties for managed integration runtime.

class azure.mgmt.datafactory.models.IntegrationRuntimeConnectionInfo(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Connection information for encrypting the on-premises data source credentials.

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 this collection

Variables

service_token (str) – The token generated in service. Callers use this token to authenticate to integration runtime.
identity_cert_thumbprint (str) – The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation.
host_service_uri (str) – The on-premises integration runtime host URL.
version (str) – The integration runtime version.
public_key (str) – The public key for encrypting a credential when transferring the credential to the integration runtime.
is_identity_cert_exprired (bool) – Whether the identity certificate is expired.

class azure.mgmt.datafactory.models.IntegrationRuntimeCustomSetupScriptProperties(*, blob_container_uri: str = None, sas_token=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Custom setup script properties for a managed dedicated integration runtime.

Parameters

blob_container_uri (str) – The URI of the Azure blob container that contains the custom setup script.
sas_token (SecureString) – The SAS token of the Azure blob container.

class azure.mgmt.datafactory.models.IntegrationRuntimeDataFlowProperties(*, additional_properties=None, compute_type=None, core_count: int = None, time_to_live: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Data flow properties for managed integration runtime.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
compute_type (str or DataFlowComputeType) – Compute type of the cluster which will execute data flow job. Possible values include: ‘General’, ‘MemoryOptimized’, ‘ComputeOptimized’
core_count (int) – Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.
time_to_live (int) – Time to live (in minutes) setting of the cluster which will execute data flow job.

class azure.mgmt.datafactory.models.IntegrationRuntimeDataProxyProperties(*, connect_via=None, staging_linked_service=None, path: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Data proxy properties for a managed dedicated integration runtime.

Parameters

connect_via (EntityReference) – The self-hosted integration runtime reference.
staging_linked_service (EntityReference) – The staging linked service reference.
path (str) – The path to contain the staged data in the Blob storage.

class azure.mgmt.datafactory.models.IntegrationRuntimeDebugResource(*, properties, name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResourceDebugResource

Integration runtime debug resource.

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

Parameters

name (str) – The resource name.
properties (IntegrationRuntime) – Required. Integration runtime properties.

class azure.mgmt.datafactory.models.IntegrationRuntimeMonitoringData(*, name: str = None, nodes=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Get monitoring data response.

Parameters

name (str) – Integration runtime name.
nodes (list[IntegrationRuntimeNodeMonitoringData]) – Integration runtime node monitoring data.

class azure.mgmt.datafactory.models.IntegrationRuntimeNodeIpAddress(**kwargs)[source]¶

Bases: msrest.serialization.Model

The IP address of self-hosted integration runtime node.

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

Variables: ip_address (str) – The IP address of self-hosted integration runtime node.

class azure.mgmt.datafactory.models.IntegrationRuntimeNodeMonitoringData(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Monitoring data for integration runtime node.

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 this collection

Variables

node_name (str) – Name of the integration runtime node.
available_memory_in_mb (int) – Available memory (MB) on the integration runtime node.
cpu_utilization (int) – CPU percentage on the integration runtime node.
concurrent_jobs_limit (int) – Maximum concurrent jobs on the integration runtime node.
concurrent_jobs_running (int) – The number of jobs currently running on the integration runtime node.
max_concurrent_jobs (int) – The maximum concurrent jobs in this integration runtime.
sent_bytes (float) – Sent bytes on the integration runtime node.
received_bytes (float) – Received bytes on the integration runtime node.

class azure.mgmt.datafactory.models.IntegrationRuntimeReference(*, reference_name: str, parameters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Integration runtime reference type.

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

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

Variables

type (str) – Required. Type of integration runtime. Default value: “IntegrationRuntimeReference” .

Parameters

reference_name (str) – Required. Reference integration runtime name.
parameters (dict[str, object]) – Arguments for integration runtime.

type = 'IntegrationRuntimeReference'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeRegenerateKeyParameters(*, key_name=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters to regenerate the authentication key.

Parameters: key_name (str or IntegrationRuntimeAuthKeyName) – The name of the authentication key to regenerate. Possible values include: ‘authKey1’, ‘authKey2’

class azure.mgmt.datafactory.models.IntegrationRuntimeResource(*, properties, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResource

Integration runtime resource type.

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

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
etag (str) – Etag identifies change in the resource.

Parameters

properties (IntegrationRuntime) – Required. Integration runtime properties.

class azure.mgmt.datafactory.models.IntegrationRuntimeSsisCatalogInfo(*, additional_properties=None, catalog_server_endpoint: str = None, catalog_admin_user_name: str = None, catalog_admin_password=None, catalog_pricing_tier=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Catalog information for managed dedicated integration runtime.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
catalog_server_endpoint (str) – The catalog database server URL.
catalog_admin_user_name (str) – The administrator user name of catalog database.
catalog_admin_password (SecureString) – The password of the administrator user account of the catalog database.
catalog_pricing_tier (str or IntegrationRuntimeSsisCatalogPricingTier) – The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible values include: ‘Basic’, ‘Standard’, ‘Premium’, ‘PremiumRS’

class azure.mgmt.datafactory.models.IntegrationRuntimeSsisProperties(*, additional_properties=None, catalog_info=None, license_type=None, custom_setup_script_properties=None, data_proxy_properties=None, edition=None, express_custom_setup_properties=None, package_stores=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SSIS properties for managed integration runtime.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
catalog_info (IntegrationRuntimeSsisCatalogInfo) – Catalog information for managed dedicated integration runtime.
license_type (str or IntegrationRuntimeLicenseType) – License type for bringing your own license scenario. Possible values include: ‘BasePrice’, ‘LicenseIncluded’
custom_setup_script_properties (IntegrationRuntimeCustomSetupScriptProperties) – Custom setup script properties for a managed dedicated integration runtime.
data_proxy_properties (IntegrationRuntimeDataProxyProperties) – Data proxy properties for a managed dedicated integration runtime.
edition (str or IntegrationRuntimeEdition) – The edition for the SSIS Integration Runtime. Possible values include: ‘Standard’, ‘Enterprise’
express_custom_setup_properties (list[CustomSetupBase]) – Custom setup without script properties for a SSIS integration runtime.
package_stores (list[PackageStore]) – Package stores for the SSIS Integration Runtime.

class azure.mgmt.datafactory.models.IntegrationRuntimeStatus(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Integration runtime status.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SelfHostedIntegrationRuntimeStatus, ManagedIntegrationRuntimeStatus

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
type (str) – Required. Constant filled by server.

Variables

data_factory_name (str) – The data factory name which the integration runtime belong to.
state (str or IntegrationRuntimeState) – The state of integration runtime. Possible values include: ‘Initial’, ‘Stopped’, ‘Started’, ‘Starting’, ‘Stopping’, ‘NeedRegistration’, ‘Online’, ‘Limited’, ‘Offline’, ‘AccessDenied’

class azure.mgmt.datafactory.models.IntegrationRuntimeStatusListResponse(*, value, next_link: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of integration runtime status.

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

Parameters

value (list[IntegrationRuntimeStatusResponse]) – Required. List of integration runtime status.
next_link (str) – The link to the next page of results, if any remaining results exist.

class azure.mgmt.datafactory.models.IntegrationRuntimeStatusResponse(*, properties, **kwargs)[source]¶

Bases: msrest.serialization.Model

Integration runtime status response.

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

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

Variables: name (str) – The integration runtime name.
Parameters: properties (IntegrationRuntimeStatus) – Required. Integration runtime properties.

class azure.mgmt.datafactory.models.IntegrationRuntimeVNetProperties(*, additional_properties=None, v_net_id: str = None, subnet: str = None, public_ips=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

VNet properties for managed integration runtime.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
v_net_id (str) – The ID of the VNet that this integration runtime will join.
subnet (str) – The name of the subnet this integration runtime will join.
public_ips (list[str]) – Resource IDs of the public IP addresses that this integration runtime will use.

class azure.mgmt.datafactory.models.JiraLinkedService(*, host, username, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, port=None, password=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Jira 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. The IP address or host name of the Jira service. (e.g. jira.example.com)
port (object) – The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.
username (object) – Required. The user name that you use to access Jira Service.
password (SecretBase) – The password corresponding to the user name that you provided in the username field.
use_encrypted_endpoints (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).

class azure.mgmt.datafactory.models.JiraObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Jira 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.JiraSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Jira 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.JsonDataset(*, linked_service_name, location, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, encoding_name=None, compression=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Json 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 this collection
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.
type (str) – Required. Constant filled by server.
location (DatasetLocation) – Required. The location of the json data storage.
encoding_name (object) – The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
compression (DatasetCompression) – The data compression method used for the json dataset.

class azure.mgmt.datafactory.models.JsonFormat(*, additional_properties=None, serializer=None, deserializer=None, file_pattern=None, nesting_separator=None, encoding_name=None, json_node_reference=None, json_path_definition=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetStorageFormat

The data stored in JSON 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 this collection
serializer (object) – Serializer. Type: string (or Expression with resultType string).
deserializer (object) – Deserializer. Type: string (or Expression with resultType string).
type (str) – Required. Constant filled by server.
file_pattern (object) – File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is ‘setOfObjects’. It is case-sensitive.
nesting_separator (object) – The character used to separate nesting levels. Default value is ‘.’ (dot). Type: string (or Expression with resultType string).
encoding_name (object) – The code page name of the preferred encoding. If not provided, the default value is ‘utf-8’, unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the ‘Name’ column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).
json_node_reference (object) – The JSONPath of the JSON array element to be flattened. Example: “$.ArrayPath”. Type: string (or Expression with resultType string).
json_path_definition (object) – The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with “$”; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {“Column1”: “$.Column1Path”, “Column2”: “Column2PathInArray”}. Type: object (or Expression with resultType object).

class azure.mgmt.datafactory.models.JsonReadSettings(*, additional_properties=None, compression_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.FormatReadSettings

Json 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 this collection
type (str) – Required. Constant filled by server.
compression_properties (CompressionReadSettings) – Compression settings.

class azure.mgmt.datafactory.models.JsonSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, store_settings=None, format_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Json 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreWriteSettings) – Json store settings.
format_settings (JsonWriteSettings) – Json format settings.

class azure.mgmt.datafactory.models.JsonSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, store_settings=None, format_settings=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Json 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreReadSettings) – Json store settings.
format_settings (JsonReadSettings) – Json format 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).

class azure.mgmt.datafactory.models.JsonWriteSettings(*, additional_properties=None, file_pattern=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.FormatWriteSettings

Json 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 this collection
type (str) – Required. Constant filled by server.
file_pattern (str or JsonWriteFilePattern) – File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is ‘setOfObjects’. It is case-sensitive. Possible values include: ‘setOfObjects’, ‘arrayOfObjects’

class azure.mgmt.datafactory.models.LinkedIntegrationRuntime(**kwargs)[source]¶

Bases: msrest.serialization.Model

The linked integration runtime information.

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

Variables

name (str) – The name of the linked integration runtime.
subscription_id (str) – The subscription ID for which the linked integration runtime belong to.
data_factory_name (str) – The name of the data factory for which the linked integration runtime belong to.
data_factory_location (str) – The location of the data factory for which the linked integration runtime belong to.
create_time (datetime) – The creating time of the linked integration runtime.

class azure.mgmt.datafactory.models.LinkedIntegrationRuntimeKeyAuthorization(*, key, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedIntegrationRuntimeType

The key authorization type integration runtime.

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

Parameters

authorization_type (str) – Required. Constant filled by server.
key (SecureString) – Required. The key used for authorization.

class azure.mgmt.datafactory.models.LinkedIntegrationRuntimeRbacAuthorization(*, resource_id: str, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedIntegrationRuntimeType

The role based access control (RBAC) authorization type integration runtime.

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

Parameters

authorization_type (str) – Required. Constant filled by server.
resource_id (str) – Required. The resource identifier of the integration runtime to be shared.

class azure.mgmt.datafactory.models.LinkedIntegrationRuntimeRequest(*, linked_factory_name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Data factory name for linked integration runtime request.

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

Parameters: linked_factory_name (str) – Required. The data factory name for linked integration runtime.

class azure.mgmt.datafactory.models.LinkedIntegrationRuntimeType(**kwargs)[source]¶

Bases: msrest.serialization.Model

The base definition of a linked integration runtime.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: LinkedIntegrationRuntimeRbacAuthorization, LinkedIntegrationRuntimeKeyAuthorization

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

Parameters: authorization_type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.LinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The Azure Data Factory nested object which contains the information and credential which can be used to connect with related store or compute resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SharePointOnlineListLinkedService, SnowflakeLinkedService, AzureFunctionLinkedService, AzureDataExplorerLinkedService, SapTableLinkedService, GoogleAdWordsLinkedService, OracleServiceCloudLinkedService, DynamicsAXLinkedService, ResponsysLinkedService, AzureDatabricksLinkedService, AzureDataLakeAnalyticsLinkedService, HDInsightOnDemandLinkedService, SalesforceMarketingCloudLinkedService, NetezzaLinkedService, VerticaLinkedService, ZohoLinkedService, XeroLinkedService, SquareLinkedService, SparkLinkedService, ShopifyLinkedService, ServiceNowLinkedService, QuickBooksLinkedService, PrestoLinkedService, PhoenixLinkedService, PaypalLinkedService, MarketoLinkedService, AzureMariaDBLinkedService, MariaDBLinkedService, MagentoLinkedService, JiraLinkedService, ImpalaLinkedService, HubspotLinkedService, HiveLinkedService, HBaseLinkedService, GreenplumLinkedService, GoogleBigQueryLinkedService, EloquaLinkedService, DrillLinkedService, CouchbaseLinkedService, ConcurLinkedService, AzurePostgreSqlLinkedService, AmazonMWSLinkedService, SapHanaLinkedService, SapBWLinkedService, SftpServerLinkedService, FtpServerLinkedService, HttpLinkedService, AzureSearchLinkedService, CustomDataSourceLinkedService, AmazonRedshiftLinkedService, AmazonS3LinkedService, RestServiceLinkedService, SapOpenHubLinkedService, SapEccLinkedService, SapCloudForCustomerLinkedService, SalesforceServiceCloudLinkedService, SalesforceLinkedService, Office365LinkedService, AzureBlobFSLinkedService, AzureDataLakeStoreLinkedService, CosmosDbMongoDbApiLinkedService, MongoDbV2LinkedService, MongoDbLinkedService, CassandraLinkedService, WebLinkedService, ODataLinkedService, HdfsLinkedService, MicrosoftAccessLinkedService, InformixLinkedService, OdbcLinkedService, AzureMLServiceLinkedService, AzureMLLinkedService, TeradataLinkedService, Db2LinkedService, SybaseLinkedService, PostgreSqlLinkedService, MySqlLinkedService, AzureMySqlLinkedService, OracleLinkedService, GoogleCloudStorageLinkedService, AzureFileStorageLinkedService, FileServerLinkedService, HDInsightLinkedService, CommonDataServiceForAppsLinkedService, DynamicsCrmLinkedService, DynamicsLinkedService, CosmosDbLinkedService, AzureKeyVaultLinkedService, AzureBatchLinkedService, AzureSqlMILinkedService, AzureSqlDatabaseLinkedService, SqlServerLinkedService, AzureSqlDWLinkedService, AzureTableStorageLinkedService, AzureBlobStorageLinkedService, AzureStorageLinkedService

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 this collection
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.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.LinkedServiceDebugResource(*, properties, name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResourceDebugResource

Linked service debug resource.

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

Parameters

name (str) – The resource name.
properties (LinkedService) – Required. Properties of linked service.

class azure.mgmt.datafactory.models.LinkedServiceReference(*, reference_name: str, parameters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Linked service reference type.

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

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

Variables

type (str) – Required. Linked service reference type. Default value: “LinkedServiceReference” .

Parameters

reference_name (str) – Required. Reference LinkedService name.
parameters (dict[str, object]) – Arguments for LinkedService.

type = 'LinkedServiceReference'¶

class azure.mgmt.datafactory.models.LinkedServiceResource(*, properties, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResource

Linked service resource type.

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

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
etag (str) – Etag identifies change in the resource.

Parameters

properties (LinkedService) – Required. Properties of linked service.

class azure.mgmt.datafactory.models.LogStorageSettings(*, linked_service_name, additional_properties=None, path=None, log_level=None, enable_reliable_logging=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Log storage 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 this collection
linked_service_name (LinkedServiceReference) – Required. Log storage linked service reference.
path (object) – The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string).
log_level (object) – Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string).
enable_reliable_logging (object) – Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.LookupActivity(*, name: str, source, dataset, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, first_row_only=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

Lookup 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
source (CopySource) – Required. Dataset-specific source properties, same as copy activity source.
dataset (DatasetReference) – Required. Lookup activity dataset reference.
first_row_only (object) – Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.MagentoLinkedService(*, host, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, access_token=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Magento server 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. The URL of the Magento instance. (i.e. 192.168.222.110/magento3)
access_token (SecretBase) – The access token from Magento.
use_encrypted_endpoints (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).

class azure.mgmt.datafactory.models.MagentoObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Magento 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MagentoSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Magento server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.ManagedIntegrationRuntime(*, additional_properties=None, description: str = None, compute_properties=None, ssis_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.IntegrationRuntime

Managed integration runtime, including managed elastic and managed dedicated integration runtimes.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Integration runtime description.
type (str) – Required. Constant filled by server.
compute_properties (IntegrationRuntimeComputeProperties) – The compute resource for managed integration runtime.
ssis_properties (IntegrationRuntimeSsisProperties) – SSIS properties for managed integration runtime.

Variables

state (str or IntegrationRuntimeState) – Integration runtime state, only valid for managed dedicated integration runtime. Possible values include: ‘Initial’, ‘Stopped’, ‘Started’, ‘Starting’, ‘Stopping’, ‘NeedRegistration’, ‘Online’, ‘Limited’, ‘Offline’, ‘AccessDenied’

class azure.mgmt.datafactory.models.ManagedIntegrationRuntimeError(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Error definition for managed integration runtime.

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 this collection

Variables

time (datetime) – The time when the error occurred.
code (str) – Error code.
parameters (list[str]) – Managed integration runtime error parameters.
message (str) – Error message.

class azure.mgmt.datafactory.models.ManagedIntegrationRuntimeNode(*, additional_properties=None, errors=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of integration runtime node.

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 this collection
errors (list[ManagedIntegrationRuntimeError]) – The errors that occurred on this integration runtime node.

Variables

node_id (str) – The managed integration runtime node id.
status (str or ManagedIntegrationRuntimeNodeStatus) – The managed integration runtime node status. Possible values include: ‘Starting’, ‘Available’, ‘Recycling’, ‘Unavailable’

class azure.mgmt.datafactory.models.ManagedIntegrationRuntimeOperationResult(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of managed integration runtime operation result.

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 this collection

Variables

type (str) – The operation type. Could be start or stop.
start_time (datetime) – The start time of the operation.
result (str) – The operation result.
error_code (str) – The error code.
parameters (list[str]) – Managed integration runtime error parameters.
activity_id (str) – The activity id for the operation request.

class azure.mgmt.datafactory.models.ManagedIntegrationRuntimeStatus(*, additional_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeStatus

Managed integration runtime status.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
type (str) – Required. Constant filled by server.

Variables

data_factory_name (str) – The data factory name which the integration runtime belong to.
state (str or IntegrationRuntimeState) – The state of integration runtime. Possible values include: ‘Initial’, ‘Stopped’, ‘Started’, ‘Starting’, ‘Stopping’, ‘NeedRegistration’, ‘Online’, ‘Limited’, ‘Offline’, ‘AccessDenied’
create_time (datetime) – The time at which the integration runtime was created, in ISO8601 format.
nodes (list[ManagedIntegrationRuntimeNode]) – The list of nodes for managed integration runtime.
other_errors (list[ManagedIntegrationRuntimeError]) – The errors that occurred on this integration runtime.
last_operation (ManagedIntegrationRuntimeOperationResult) – The last operation result that occurred on this integration runtime.

class azure.mgmt.datafactory.models.ManagedPrivateEndpoint(*, additional_properties=None, connection_state=None, fqdns=None, group_id: str = None, private_link_resource_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of a managed private endpoint.

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 this collection
connection_state (ConnectionStateProperties) – The managed private endpoint connection state
fqdns (list[str]) – Fully qualified domain names
group_id (str) – The groupId to which the managed private endpoint is created
private_link_resource_id (str) – The ARM resource ID of the resource to which the managed private endpoint is created

Variables

is_reserved (bool) – Denotes whether the managed private endpoint is reserved
provisioning_state (str) – The managed private endpoint provisioning state

class azure.mgmt.datafactory.models.ManagedPrivateEndpointResource(*, properties, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResource

Managed private endpoint resource type.

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

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
etag (str) – Etag identifies change in the resource.

Parameters

properties (ManagedPrivateEndpoint) – Required. Managed private endpoint properties.

class azure.mgmt.datafactory.models.ManagedVirtualNetwork(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A managed Virtual Network associated with the Azure Data Factory.

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 this collection

Variables

v_net_id (str) – Managed Virtual Network ID.
alias (str) – Managed Virtual Network alias.

class azure.mgmt.datafactory.models.ManagedVirtualNetworkResource(*, properties, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResource

Managed Virtual Network resource type.

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

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
etag (str) – Etag identifies change in the resource.

Parameters

properties (ManagedVirtualNetwork) – Required. Managed Virtual Network properties.

class azure.mgmt.datafactory.models.MappingDataFlow(*, description: str = None, annotations=None, folder=None, sources=None, sinks=None, transformations=None, script: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DataFlow

Mapping data flow.

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

Parameters

description (str) – The description of the data flow.
annotations (list[object]) – List of tags that can be used for describing the data flow.
folder (DataFlowFolder) – The folder that this data flow is in. If not specified, Data flow will appear at the root level.
type (str) – Required. Constant filled by server.
sources (list[DataFlowSource]) – List of sources in data flow.
sinks (list[DataFlowSink]) – List of sinks in data flow.
transformations (list[Transformation]) – List of transformations in data flow.
script (str) – DataFlow script.

class azure.mgmt.datafactory.models.MariaDBLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, pwd=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

MariaDB server 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.MariaDBSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity MariaDB server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.MariaDBTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

MariaDB 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MarketoLinkedService(*, endpoint, client_id, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, client_secret=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Marketo server 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 this collection
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.
type (str) – Required. Constant filled by server.
endpoint (object) – Required. The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)
client_id (object) – Required. The client Id of your Marketo service.
client_secret (SecretBase) – The client secret of your Marketo service.
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).

class azure.mgmt.datafactory.models.MarketoObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Marketo 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MarketoSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Marketo server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.MicrosoftAccessLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, authentication_type=None, credential=None, user_name=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Microsoft Access 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.
authentication_type (object) – Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
credential (SecretBase) – The access credential portion of the connection string specified in driver-specific property-value format.
user_name (object) – User name for Basic authentication. Type: string (or Expression with resultType string).
password (SecretBase) – Password for Basic authentication.
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).

class azure.mgmt.datafactory.models.MicrosoftAccessSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, pre_copy_script=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Microsoft Access 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 this collection
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).
type (str) – Required. Constant filled by server.
pre_copy_script (object) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MicrosoftAccessSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity source for Microsoft Access.

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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – Database query. Type: string (or Expression with resultType string).
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).

class azure.mgmt.datafactory.models.MicrosoftAccessTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Microsoft Access 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The Microsoft Access table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MongoDbCollectionDataset(*, linked_service_name, collection_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The MongoDB database 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 this collection
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.
type (str) – Required. Constant filled by server.
collection_name (object) – Required. The table name of the MongoDB database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MongoDbCursorMethodsProperties(*, additional_properties=None, project=None, sort=None, skip=None, limit=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Cursor methods for Mongodb query.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
project (object) – Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string).
sort (object) – Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).
skip (object) – Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer).
limit (object) – Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer).

class azure.mgmt.datafactory.models.MongoDbLinkedService(*, server, database_name, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, authentication_type=None, username=None, password=None, auth_source=None, port=None, enable_ssl=None, allow_self_signed_server_cert=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for MongoDb data 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 this collection
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.
type (str) – Required. Constant filled by server.
server (object) – Required. The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).
authentication_type (str or MongoDbAuthenticationType) – The authentication type to be used to connect to the MongoDB database. Possible values include: ‘Basic’, ‘Anonymous’
database_name (object) – Required. The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).
username (object) – Username for authentication. Type: string (or Expression with resultType string).
password (SecretBase) – Password for authentication.
auth_source (object) – Database to verify the username and password. Type: string (or Expression with resultType string).
port (object) – The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.
enable_ssl (object) – Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).
allow_self_signed_server_cert (object) – Specifies whether to allow self-signed certificates from the server. The default value is false. 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).

class azure.mgmt.datafactory.models.MongoDbSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity source for a MongoDB database.

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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string).
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).

class azure.mgmt.datafactory.models.MongoDbV2CollectionDataset(*, linked_service_name, collection, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The MongoDB database 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 this collection
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.
type (str) – Required. Constant filled by server.
collection (object) – Required. The collection name of the MongoDB database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MongoDbV2LinkedService(*, connection_string, database, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for MongoDB data 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
database (object) – Required. The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MongoDbV2Source(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, filter=None, cursor_methods=None, batch_size=None, query_timeout=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity source for a MongoDB database.

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 this collection
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).
type (str) – Required. Constant filled by server.
filter (object) – Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).
cursor_methods (MongoDbCursorMethodsProperties) – Cursor methods for Mongodb query
batch_size (object) – Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property’s main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).
query_timeout (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).

class azure.mgmt.datafactory.models.MultiplePipelineTrigger(*, additional_properties=None, description: str = None, annotations=None, pipelines=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Trigger

Base class for all triggers that support one to many model for trigger to pipeline.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BlobEventsTrigger, BlobTrigger, ScheduleTrigger

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Trigger description.
annotations (list[object]) – List of tags that can be used for describing the trigger.
type (str) – Required. Constant filled by server.
pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.

Variables

runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: ‘Started’, ‘Stopped’, ‘Disabled’

class azure.mgmt.datafactory.models.MySqlLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for MySQL data 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The connection string.
password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.MySqlSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for MySQL databases.

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.MySqlTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The MySQL 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The MySQL table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.NetezzaLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, pwd=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Netezza 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.NetezzaPartitionSettings(*, partition_column_name=None, partition_upper_bound=None, partition_lower_bound=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The settings that will be leveraged for Netezza source partitioning.

Parameters

partition_column_name (object) – The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partition_upper_bound (object) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partition_lower_bound (object) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.NetezzaSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, partition_option=None, partition_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Netezza 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
partition_option (str or NetezzaPartitionOption) – The partition mechanism that will be used for Netezza read in parallel. Possible values include: ‘None’, ‘DataSlice’, ‘DynamicRange’
partition_settings (NetezzaPartitionSettings) – The settings that will be leveraged for Netezza source partitioning.

class azure.mgmt.datafactory.models.NetezzaTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, netezza_table_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Netezza 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
table (object) – The table name of the Netezza. Type: string (or Expression with resultType string).
netezza_table_dataset_schema (object) – The schema name of the Netezza. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ODataLinkedService(*, url, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, authentication_type=None, user_name=None, password=None, tenant=None, service_principal_id=None, azure_cloud_type=None, aad_resource_id=None, aad_service_principal_credential_type=None, service_principal_key=None, service_principal_embedded_cert=None, service_principal_embedded_cert_password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Open Data Protocol (OData) 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 this collection
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.
type (str) – Required. Constant filled by server.
url (object) – Required. The URL of the OData service endpoint. Type: string (or Expression with resultType string).
authentication_type (str or ODataAuthenticationType) – Type of authentication used to connect to the OData service. Possible values include: ‘Basic’, ‘Anonymous’, ‘Windows’, ‘AadServicePrincipal’, ‘ManagedServiceIdentity’
user_name (object) – User name of the OData service. Type: string (or Expression with resultType string).
password (SecretBase) – Password of the OData service.
tenant (object) – Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).
service_principal_id (object) – Specify the application id of your application registered in Azure Active Directory. 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).
aad_resource_id (object) – Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string).
aad_service_principal_credential_type (str or ODataAadServicePrincipalCredentialType) – Specify the credential type (key or cert) is used for service principal. Possible values include: ‘ServicePrincipalKey’, ‘ServicePrincipalCert’
service_principal_key (SecretBase) – Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
service_principal_embedded_cert (SecretBase) – Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
service_principal_embedded_cert_password (SecretBase) – Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ODataResourceDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, path=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Open Data Protocol (OData) resource 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 this collection
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.
type (str) – Required. Constant filled by server.
path (object) – The OData resource path. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ODataSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, http_request_timeout=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity source for OData 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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – OData query. For example, “$top=1”. Type: string (or Expression with resultType string).
http_request_timeout (object) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
additional_columns (list[AdditionalColumns]) – Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).

class azure.mgmt.datafactory.models.OdbcLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, authentication_type=None, credential=None, user_name=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Open Database Connectivity (ODBC) 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.
authentication_type (object) – Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).
credential (SecretBase) – The access credential portion of the connection string specified in driver-specific property-value format.
user_name (object) – User name for Basic authentication. Type: string (or Expression with resultType string).
password (SecretBase) – Password for Basic authentication.
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).

class azure.mgmt.datafactory.models.OdbcSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, pre_copy_script=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity ODBC 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 this collection
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).
type (str) – Required. Constant filled by server.
pre_copy_script (object) – A query to execute before starting the copy. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.OdbcSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for ODBC databases.

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.OdbcTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The ODBC 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The ODBC table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.Office365Dataset(*, linked_service_name, table_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, predicate=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Office365 account.

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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – Required. Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string).
predicate (object) – A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.Office365LinkedService(*, office365_tenant_id, service_principal_tenant_id, service_principal_id, service_principal_key, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Office365 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 this collection
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.
type (str) – Required. Constant filled by server.
office365_tenant_id (object) – Required. Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string).
service_principal_tenant_id (object) – Required. Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string).
service_principal_id (object) – Required. Specify the application’s client ID. Type: string (or Expression with resultType string).
service_principal_key (SecretBase) – Required. Specify the application’s key.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.Office365Source(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, allowed_groups=None, user_scope_filter_uri=None, date_filter_column=None, start_time=None, end_time=None, output_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity source for an Office 365 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 this collection
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).
type (str) – Required. Constant filled by server.
allowed_groups (object) – The groups containing all the users. Type: array of strings (or Expression with resultType array of strings).
user_scope_filter_uri (object) – The user scope uri. Type: string (or Expression with resultType string).
date_filter_column (object) – The Column to apply the <paramref name=”StartTime”/> and <paramref name=”EndTime”/>. Type: string (or Expression with resultType string).
start_time (object) – Start time of the requested range for this dataset. Type: string (or Expression with resultType string).
end_time (object) – End time of the requested range for this dataset. Type: string (or Expression with resultType string).
output_columns (object) – The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). Example: [ { “name”: “Id” }, { “name”: “CreatedDateTime” } ]

class azure.mgmt.datafactory.models.Operation(*, name: str = None, origin: str = None, display=None, service_specification=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure Data Factory API operation definition.

Parameters

name (str) – Operation name: {provider}/{resource}/{operation}
origin (str) – The intended executor of the operation.
display (OperationDisplay) – Metadata associated with the operation.
service_specification (OperationServiceSpecification) – Details about a service operation.

class azure.mgmt.datafactory.models.OperationDisplay(*, description: str = None, provider: str = None, resource: str = None, operation: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Metadata associated with the operation.

Parameters

description (str) – The description of the operation.
provider (str) – The name of the provider.
resource (str) – The name of the resource type on which the operation is performed.
operation (str) – The type of operation: get, read, delete, etc.

class azure.mgmt.datafactory.models.OperationLogSpecification(*, name: str = None, display_name: str = None, blob_duration: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Details about an operation related to logs.

Parameters

name (str) – The name of the log category.
display_name (str) – Localized display name.
blob_duration (str) – Blobs created in the customer storage account, per hour.

class azure.mgmt.datafactory.models.OperationMetricAvailability(*, time_grain: str = None, blob_duration: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines how often data for a metric becomes available.

Parameters

time_grain (str) – The granularity for the metric.
blob_duration (str) – Blob created in the customer storage account, per hour.

class azure.mgmt.datafactory.models.OperationMetricDimension(*, name: str = None, display_name: str = None, to_be_exported_for_shoebox: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines the metric dimension.

Parameters

name (str) – The name of the dimension for the metric.
display_name (str) – The display name of the metric dimension.
to_be_exported_for_shoebox (bool) – Whether the dimension should be exported to Azure Monitor.

class azure.mgmt.datafactory.models.OperationMetricSpecification(*, name: str = None, display_name: str = None, display_description: str = None, unit: str = None, aggregation_type: str = None, enable_regional_mdm_account: str = None, source_mdm_account: str = None, source_mdm_namespace: str = None, availabilities=None, dimensions=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Details about an operation related to metrics.

Parameters

name (str) – The name of the metric.
display_name (str) – Localized display name of the metric.
display_description (str) – The description of the metric.
unit (str) – The unit that the metric is measured in.
aggregation_type (str) – The type of metric aggregation.
enable_regional_mdm_account (str) – Whether or not the service is using regional MDM accounts.
source_mdm_account (str) – The name of the MDM account.
source_mdm_namespace (str) – The name of the MDM namespace.
availabilities (list[OperationMetricAvailability]) – Defines how often data for metrics becomes available.
dimensions (list[OperationMetricDimension]) – Defines the metric dimension.

class azure.mgmt.datafactory.models.OperationServiceSpecification(*, log_specifications=None, metric_specifications=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Details about a service operation.

Parameters

log_specifications (list[OperationLogSpecification]) – Details about operations related to logs.
metric_specifications (list[OperationMetricSpecification]) – Details about operations related to metrics.

class azure.mgmt.datafactory.models.OracleLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Oracle database.

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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.OraclePartitionSettings(*, partition_names=None, partition_column_name=None, partition_upper_bound=None, partition_lower_bound=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The settings that will be leveraged for Oracle source partitioning.

Parameters

partition_names (object) – Names of the physical partitions of Oracle table.
partition_column_name (object) – The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partition_upper_bound (object) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partition_lower_bound (object) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.OracleServiceCloudLinkedService(*, host, username, password, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Oracle Service Cloud 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. The URL of the Oracle Service Cloud instance.
username (object) – Required. The user name that you use to access Oracle Service Cloud server.
password (SecretBase) – Required. The password corresponding to the user name that you provided in the username key.
use_encrypted_endpoints (object) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
use_host_verification (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. Type: boolean (or Expression with resultType boolean).
use_peer_verification (object) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.OracleServiceCloudObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Oracle Service Cloud 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.OracleServiceCloudSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Oracle Service Cloud 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.OracleSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, pre_copy_script=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Oracle 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 this collection
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).
type (str) – Required. Constant filled by server.
pre_copy_script (object) – SQL pre-copy script. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.OracleSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, oracle_reader_query=None, query_timeout=None, partition_option=None, partition_settings=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Oracle 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 this collection
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).
type (str) – Required. Constant filled by server.
oracle_reader_query (object) – Oracle reader query. Type: string (or Expression with resultType string).
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])).
partition_option (str or OraclePartitionOption) – The partition mechanism that will be used for Oracle read in parallel. Possible values include: ‘None’, ‘PhysicalPartitionsOfTable’, ‘DynamicRange’
partition_settings (OraclePartitionSettings) – The settings that will be leveraged for Oracle source partitioning.
additional_columns (list[AdditionalColumns]) – Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).

class azure.mgmt.datafactory.models.OracleTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, oracle_table_dataset_schema=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The on-premises Oracle database 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
oracle_table_dataset_schema (object) – The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string).
table (object) – The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.OrcDataset(*, linked_service_name, location, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, orc_compression_codec=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

ORC 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 this collection
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.
type (str) – Required. Constant filled by server.
location (DatasetLocation) – Required. The location of the ORC data storage.
orc_compression_codec (str or OrcCompressionCodec) – Possible values include: ‘none’, ‘zlib’, ‘snappy’

class azure.mgmt.datafactory.models.OrcFormat(*, additional_properties=None, serializer=None, deserializer=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetStorageFormat

The data stored in Optimized Row Columnar (ORC) 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 this collection
serializer (object) – Serializer. Type: string (or Expression with resultType string).
deserializer (object) – Deserializer. Type: string (or Expression with resultType string).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.OrcSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, store_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity ORC 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreWriteSettings) – ORC store settings.

class azure.mgmt.datafactory.models.OrcSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, store_settings=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity ORC 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreReadSettings) – ORC 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).

class azure.mgmt.datafactory.models.PackageStore(*, name: str, package_store_linked_service, **kwargs)[source]¶

Bases: msrest.serialization.Model

Package store for the SSIS integration runtime.

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

Parameters

name (str) – Required. The name of the package store
package_store_linked_service (EntityReference) – Required. The package store linked service reference.

class azure.mgmt.datafactory.models.ParameterSpecification(*, type, default_value=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Definition of a single parameter for an entity.

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

Parameters

type (str or ParameterType) – Required. Parameter type. Possible values include: ‘Object’, ‘String’, ‘Int’, ‘Float’, ‘Bool’, ‘Array’, ‘SecureString’
default_value (object) – Default value of parameter.

class azure.mgmt.datafactory.models.ParquetDataset(*, linked_service_name, location, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, compression_codec=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Parquet 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 this collection
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.
type (str) – Required. Constant filled by server.
location (DatasetLocation) – Required. The location of the parquet storage.
compression_codec (object) –

class azure.mgmt.datafactory.models.ParquetFormat(*, additional_properties=None, serializer=None, deserializer=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetStorageFormat

The data stored in Parquet 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 this collection
serializer (object) – Serializer. Type: string (or Expression with resultType string).
deserializer (object) – Deserializer. Type: string (or Expression with resultType string).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.ParquetSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, store_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Parquet 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreWriteSettings) – Parquet store settings.

class azure.mgmt.datafactory.models.ParquetSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, store_settings=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Parquet 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreReadSettings) – Parquet 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).

class azure.mgmt.datafactory.models.PaypalLinkedService(*, host, client_id, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, client_secret=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Paypal 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)
client_id (object) – Required. The client ID associated with your PayPal application.
client_secret (SecretBase) – The client secret associated with your PayPal application.
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).

class azure.mgmt.datafactory.models.PaypalObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Paypal 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.PaypalSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Paypal 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.PhoenixLinkedService(*, host, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, port=None, http_path=None, username=None, password=None, enable_ssl=None, trusted_cert_path=None, use_system_trust_store=None, allow_host_name_cn_mismatch=None, allow_self_signed_server_cert=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Phoenix server 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)
port (object) – The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.
http_path (object) – The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.
authentication_type (str or PhoenixAuthenticationType) – Required. The authentication mechanism used to connect to the Phoenix server. Possible values include: ‘Anonymous’, ‘UsernameAndPassword’, ‘WindowsAzureHDInsightService’
username (object) – The user name used to connect to the Phoenix server.
password (SecretBase) – The password corresponding to the user name.
enable_ssl (object) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.
trusted_cert_path (object) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
use_system_trust_store (object) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
allow_host_name_cn_mismatch (object) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
allow_self_signed_server_cert (object) – Specifies whether to allow self-signed certificates from the server. The default value is false.
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).

class azure.mgmt.datafactory.models.PhoenixObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, phoenix_object_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Phoenix 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
table (object) – The table name of the Phoenix. Type: string (or Expression with resultType string).
phoenix_object_dataset_schema (object) – The schema name of the Phoenix. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.PhoenixSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Phoenix server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.PipelineFolder(*, name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.

Parameters: name (str) – The name of the folder that this Pipeline is in.

class azure.mgmt.datafactory.models.PipelineReference(*, reference_name: str, name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Pipeline reference type.

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

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

Variables

type (str) – Required. Pipeline reference type. Default value: “PipelineReference” .

Parameters

reference_name (str) – Required. Reference pipeline name.
name (str) – Reference name.

type = 'PipelineReference'¶

class azure.mgmt.datafactory.models.PipelineResource(*, additional_properties=None, description: str = None, activities=None, parameters=None, variables=None, concurrency: int = None, annotations=None, run_dimensions=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResource

Pipeline resource type.

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
etag (str) – Etag identifies change in the resource.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – The description of the pipeline.
activities (list[Activity]) – List of activities in pipeline.
parameters (dict[str, ParameterSpecification]) – List of parameters for pipeline.
variables (dict[str, VariableSpecification]) – List of variables for pipeline.
concurrency (int) – The max number of concurrent runs for the pipeline.
annotations (list[object]) – List of tags that can be used for describing the Pipeline.
run_dimensions (dict[str, object]) – Dimensions emitted by Pipeline.
folder (PipelineFolder) – The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.

class azure.mgmt.datafactory.models.PipelineRun(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Information about a pipeline run.

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 this collection

Variables

run_id (str) – Identifier of a run.
run_group_id (str) – Identifier that correlates all the recovery runs of a pipeline run.
is_latest (bool) – Indicates if the recovered pipeline run is the latest in its group.
pipeline_name (str) – The pipeline name.
parameters (dict[str, str]) – The full or partial list of parameter name, value pair used in the pipeline run.
run_dimensions (dict[str, str]) – Run dimensions emitted by Pipeline run.
invoked_by (PipelineRunInvokedBy) – Entity that started the pipeline run.
last_updated (datetime) – The last updated timestamp for the pipeline run event in ISO8601 format.
run_start (datetime) – The start time of a pipeline run in ISO8601 format.
run_end (datetime) – The end time of a pipeline run in ISO8601 format.
duration_in_ms (int) – The duration of a pipeline run.
status (str) – The status of a pipeline run.
message (str) – The message from a pipeline run.

class azure.mgmt.datafactory.models.PipelineRunInvokedBy(**kwargs)[source]¶

Bases: msrest.serialization.Model

Provides entity name and id that started the pipeline run.

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

Variables

name (str) – Name of the entity that started the pipeline run.
id (str) – The ID of the entity that started the run.
invoked_by_type (str) – The type of the entity that started the run.

class azure.mgmt.datafactory.models.PipelineRunsQueryResponse(*, value, continuation_token: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list pipeline runs.

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

Parameters

value (list[PipelineRun]) – Required. List of pipeline runs.
continuation_token (str) – The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

class azure.mgmt.datafactory.models.PolybaseSettings(*, additional_properties=None, reject_type=None, reject_value=None, reject_sample_value=None, use_type_default=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

PolyBase settings.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
reject_type (str or PolybaseSettingsRejectType) – Reject type. Possible values include: ‘value’, ‘percentage’
reject_value (object) – Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0.
reject_sample_value (object) – Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0.
use_type_default (object) – Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.PostgreSqlLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for PostgreSQL data 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The connection string.
password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.PostgreSqlSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for PostgreSQL databases.

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.PostgreSqlTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, postgre_sql_table_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The PostgreSQL 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
table (object) – The PostgreSQL table name. Type: string (or Expression with resultType string).
postgre_sql_table_dataset_schema (object) – The PostgreSQL schema name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.PrestoLinkedService(*, host, server_version, catalog, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, port=None, username=None, password=None, enable_ssl=None, trusted_cert_path=None, use_system_trust_store=None, allow_host_name_cn_mismatch=None, allow_self_signed_server_cert=None, time_zone_id=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Presto server 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. The IP address or host name of the Presto server. (i.e. 192.168.222.160)
server_version (object) – Required. The version of the Presto server. (i.e. 0.148-t)
catalog (object) – Required. The catalog context for all request against the server.
port (object) – The TCP port that the Presto server uses to listen for client connections. The default value is 8080.
authentication_type (str or PrestoAuthenticationType) – Required. The authentication mechanism used to connect to the Presto server. Possible values include: ‘Anonymous’, ‘LDAP’
username (object) – The user name used to connect to the Presto server.
password (SecretBase) – The password corresponding to the user name.
enable_ssl (object) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.
trusted_cert_path (object) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
use_system_trust_store (object) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
allow_host_name_cn_mismatch (object) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
allow_self_signed_server_cert (object) – Specifies whether to allow self-signed certificates from the server. The default value is false.
time_zone_id (object) – The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.PrestoObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, presto_object_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Presto 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
table (object) – The table name of the Presto. Type: string (or Expression with resultType string).
presto_object_dataset_schema (object) – The schema name of the Presto. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.PrestoSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Presto server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.QuickBooksLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_properties=None, endpoint=None, company_id=None, consumer_key=None, consumer_secret=None, access_token=None, access_token_secret=None, use_encrypted_endpoints=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

QuickBooks server 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_properties (object) – Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.
endpoint (object) – The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)
company_id (object) – The company ID of the QuickBooks company to authorize.
consumer_key (object) – The consumer key for OAuth 1.0 authentication.
consumer_secret (SecretBase) – The consumer secret for OAuth 1.0 authentication.
access_token (SecretBase) – The access token for OAuth 1.0 authentication.
access_token_secret (SecretBase) – The access token secret for OAuth 1.0 authentication.
use_encrypted_endpoints (object) – Specifies whether the data source endpoints are encrypted using HTTPS. 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).

class azure.mgmt.datafactory.models.QuickBooksObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

QuickBooks 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.QuickBooksSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity QuickBooks server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.RecurrenceSchedule(*, additional_properties=None, minutes=None, hours=None, week_days=None, month_days=None, monthly_occurrences=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The recurrence schedule.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
minutes (list[int]) – The minutes.
hours (list[int]) – The hours.
week_days (list[str or DaysOfWeek]) – The days of the week.
month_days (list[int]) – The month days.
monthly_occurrences (list[RecurrenceScheduleOccurrence]) – The monthly occurrences.

class azure.mgmt.datafactory.models.RecurrenceScheduleOccurrence(*, additional_properties=None, day=None, occurrence: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The recurrence schedule occurrence.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
day (str or DayOfWeek) – The day of the week. Possible values include: ‘Sunday’, ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’, ‘Saturday’
occurrence (int) – The occurrence.

class azure.mgmt.datafactory.models.RedirectIncompatibleRowSettings(*, linked_service_name, additional_properties=None, path=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Redirect incompatible row 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 this collection
linked_service_name (object) – Required. Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string).
path (object) – The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.RedshiftUnloadSettings(*, s3_linked_service_name, bucket_name, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

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

Parameters

s3_linked_service_name (LinkedServiceReference) – Required. The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.
bucket_name (object) – Required. The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.RelationalSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity source for various relational databases.

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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – Database query. Type: string (or Expression with resultType string).
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).

class azure.mgmt.datafactory.models.RelationalTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The relational 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The relational table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.RerunTumblingWindowTrigger(*, parent_trigger, requested_start_time, requested_end_time, rerun_concurrency: int, additional_properties=None, description: str = None, annotations=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Trigger

Trigger that schedules pipeline reruns for all fixed time interval windows from a requested start time to requested end time.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Trigger description.
annotations (list[object]) – List of tags that can be used for describing the trigger.
type (str) – Required. Constant filled by server.
parent_trigger (object) – Required. The parent trigger reference.
requested_start_time (datetime) – Required. The start time for the time period for which restatement is initiated. Only UTC time is currently supported.
requested_end_time (datetime) – Required. The end time for the time period for which restatement is initiated. Only UTC time is currently supported.
rerun_concurrency (int) – Required. The max number of parallel time windows (ready for execution) for which a rerun is triggered.

Variables

runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: ‘Started’, ‘Stopped’, ‘Disabled’

class azure.mgmt.datafactory.models.Resource(*, location: str = None, tags=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure Data Factory top-level resource.

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
e_tag (str) – Etag identifies change in the resource.

Parameters

location (str) – The resource location.
tags (dict[str, str]) – The resource tags.

class azure.mgmt.datafactory.models.ResponsysLinkedService(*, endpoint, client_id, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, client_secret=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Responsys 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 this collection
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.
type (str) – Required. Constant filled by server.
endpoint (object) – Required. The endpoint of the Responsys server.
client_id (object) – Required. The client ID associated with the Responsys application. Type: string (or Expression with resultType string).
client_secret (SecretBase) – The client secret associated with the Responsys application. Type: string (or Expression with resultType string).
use_encrypted_endpoints (object) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
use_host_verification (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. Type: boolean (or Expression with resultType boolean).
use_peer_verification (object) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ResponsysObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Responsys 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ResponsysSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Responsys 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.RestResourceDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, relative_url=None, request_method=None, request_body=None, additional_headers=None, pagination_rules=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

A Rest 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 this collection
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.
type (str) – Required. Constant filled by server.
relative_url (object) – The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).
request_method (object) – The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
request_body (object) – The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
additional_headers (object) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
pagination_rules (object) – The pagination rules to compose next page requests. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.RestServiceLinkedService(*, url, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, enable_server_certificate_validation=None, user_name=None, password=None, service_principal_id=None, service_principal_key=None, tenant=None, azure_cloud_type=None, aad_resource_id=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Rest 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 this collection
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.
type (str) – Required. Constant filled by server.
url (object) – Required. The base URL of the REST service.
enable_server_certificate_validation (object) – Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).
authentication_type (str or RestServiceAuthenticationType) – Required. Type of authentication used to connect to the REST service. Possible values include: ‘Anonymous’, ‘Basic’, ‘AadServicePrincipal’, ‘ManagedServiceIdentity’
user_name (object) – The user name used in Basic authentication type.
password (SecretBase) – The password used in Basic authentication type.
service_principal_id (object) – The application’s client ID used in AadServicePrincipal authentication type.
service_principal_key (SecretBase) – The application’s key used in AadServicePrincipal authentication type.
tenant (object) – The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.
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).
aad_resource_id (object) – The resource you are requesting authorization to use.
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).

class azure.mgmt.datafactory.models.RestSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, request_method=None, additional_headers=None, http_request_timeout=None, request_interval=None, compression_type=None, wrap_request_json_in_an_object=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Rest service 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 this collection
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).
type (str) – Required. Constant filled by server.
request_method (object) – The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string).
additional_headers (object) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
http_request_timeout (object) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
request_interval (object) – The time to await before sending next request, in milliseconds
compression_type (object) – Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip.
wrap_request_json_in_an_object (object) – Wraps Request Array Json into an Object before calling the rest endpoint , Default is false. ex: if true request content sample format is { rows:[]} else the format is []

class azure.mgmt.datafactory.models.RestSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, request_method=None, request_body=None, additional_headers=None, pagination_rules=None, http_request_timeout=None, request_interval=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Rest 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 this collection
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).
type (str) – Required. Constant filled by server.
request_method (object) – The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
request_body (object) – The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
additional_headers (object) – The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
pagination_rules (object) – The pagination rules to compose next page requests. Type: string (or Expression with resultType string).
http_request_timeout (object) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
request_interval (object) – The time to await before sending next page request.
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).

class azure.mgmt.datafactory.models.RetryPolicy(*, count=None, interval_in_seconds: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Execution policy for an activity.

Parameters

count (object) – Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.
interval_in_seconds (int) – Interval between retries in seconds. Default is 30.

class azure.mgmt.datafactory.models.RunFilterParameters(*, last_updated_after, last_updated_before, continuation_token: str = None, filters=None, order_by=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Query parameters for listing runs.

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

Parameters

continuation_token (str) – The continuation token for getting the next page of results. Null for first page.
last_updated_after (datetime) – Required. The time at or after which the run event was updated in ‘ISO 8601’ format.
last_updated_before (datetime) – Required. The time at or before which the run event was updated in ‘ISO 8601’ format.
filters (list[RunQueryFilter]) – List of filters.
order_by (list[RunQueryOrderBy]) – List of OrderBy option.

class azure.mgmt.datafactory.models.RunQueryFilter(*, operand, operator, values, **kwargs)[source]¶

Bases: msrest.serialization.Model

Query filter option for listing runs.

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

Parameters

operand (str or RunQueryFilterOperand) – Required. Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. Possible values include: ‘PipelineName’, ‘Status’, ‘RunStart’, ‘RunEnd’, ‘ActivityName’, ‘ActivityRunStart’, ‘ActivityRunEnd’, ‘ActivityType’, ‘TriggerName’, ‘TriggerRunTimestamp’, ‘RunGroupId’, ‘LatestOnly’
operator (str or RunQueryFilterOperator) – Required. Operator to be used for filter. Possible values include: ‘Equals’, ‘NotEquals’, ‘In’, ‘NotIn’
values (list[str]) – Required. List of filter values.

class azure.mgmt.datafactory.models.RunQueryOrderBy(*, order_by, order, **kwargs)[source]¶

Bases: msrest.serialization.Model

An object to provide order by options for listing runs.

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

Parameters

order_by (str or RunQueryOrderByField) – Required. Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. Possible values include: ‘RunStart’, ‘RunEnd’, ‘PipelineName’, ‘Status’, ‘ActivityName’, ‘ActivityRunStart’, ‘ActivityRunEnd’, ‘TriggerName’, ‘TriggerRunTimestamp’
order (str or RunQueryOrder) – Required. Sorting order of the parameter. Possible values include: ‘ASC’, ‘DESC’

class azure.mgmt.datafactory.models.SalesforceLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, environment_url=None, username=None, password=None, security_token=None, api_version=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for Salesforce.

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 this collection
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.
type (str) – Required. Constant filled by server.
environment_url (object) – The URL of Salesforce instance. Default is ‘https://login.salesforce.com’. To copy data from sandbox, specify ‘https://test.salesforce.com’. To copy data from custom domain, specify, for example, ‘https://[domain].my.salesforce.com’. Type: string (or Expression with resultType string).
username (object) – The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).
password (SecretBase) – The password for Basic authentication of the Salesforce instance.
security_token (SecretBase) – The security token is optional to remotely access Salesforce instance.
api_version (object) – The Salesforce API version used in ADF. 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).

class azure.mgmt.datafactory.models.SalesforceMarketingCloudLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_properties=None, client_id=None, client_secret=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Salesforce Marketing Cloud 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_properties (object) – Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object.
client_id (object) – The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).
client_secret (SecretBase) – The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).
use_encrypted_endpoints (object) – Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).
use_host_verification (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. Type: boolean (or Expression with resultType boolean).
use_peer_verification (object) – Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SalesforceMarketingCloudObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Salesforce Marketing Cloud 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SalesforceMarketingCloudSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Salesforce Marketing Cloud 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.SalesforceObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, object_api_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Salesforce object 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 this collection
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.
type (str) – Required. Constant filled by server.
object_api_name (object) – The Salesforce object API name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SalesforceServiceCloudLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, environment_url=None, username=None, password=None, security_token=None, api_version=None, extended_properties=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for Salesforce Service Cloud.

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 this collection
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.
type (str) – Required. Constant filled by server.
environment_url (object) – The URL of Salesforce Service Cloud instance. Default is ‘https://login.salesforce.com’. To copy data from sandbox, specify ‘https://test.salesforce.com’. To copy data from custom domain, specify, for example, ‘https://[domain].my.salesforce.com’. Type: string (or Expression with resultType string).
username (object) – The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).
password (SecretBase) – The password for Basic authentication of the Salesforce instance.
security_token (SecretBase) – The security token is optional to remotely access Salesforce instance.
api_version (object) – The Salesforce API version used in ADF. Type: string (or Expression with resultType string).
extended_properties (object) – Extended properties appended to the connection string. 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).

class azure.mgmt.datafactory.models.SalesforceServiceCloudObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, object_api_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Salesforce Service Cloud object 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 this collection
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.
type (str) – Required. Constant filled by server.
object_api_name (object) – The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SalesforceServiceCloudSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, write_behavior=None, external_id_field_name=None, ignore_null_values=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Salesforce Service Cloud 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 this collection
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).
type (str) – Required. Constant filled by server.
write_behavior (str or SalesforceSinkWriteBehavior) – The write behavior for the operation. Default is Insert. Possible values include: ‘Insert’, ‘Upsert’
external_id_field_name (object) – The name of the external ID field for upsert operation. Default value is ‘Id’ column. Type: string (or Expression with resultType string).
ignore_null_values (object) – The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.SalesforceServiceCloudSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, read_behavior=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Salesforce Service Cloud 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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – Database query. Type: string (or Expression with resultType string).
read_behavior (str or SalesforceSourceReadBehavior) – The read behavior for the operation. Default is Query. Possible values include: ‘Query’, ‘QueryAll’
additional_columns (list[AdditionalColumns]) – Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).

class azure.mgmt.datafactory.models.SalesforceSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, write_behavior=None, external_id_field_name=None, ignore_null_values=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Salesforce 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 this collection
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).
type (str) – Required. Constant filled by server.
write_behavior (str or SalesforceSinkWriteBehavior) – The write behavior for the operation. Default is Insert. Possible values include: ‘Insert’, ‘Upsert’
external_id_field_name (object) – The name of the external ID field for upsert operation. Default value is ‘Id’ column. Type: string (or Expression with resultType string).
ignore_null_values (object) – The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.SalesforceSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, read_behavior=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Salesforce 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
read_behavior (str or SalesforceSourceReadBehavior) – The read behavior for the operation. Default is Query. Possible values include: ‘Query’, ‘QueryAll’

class azure.mgmt.datafactory.models.SapBwCubeDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The SAP BW cube 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 this collection
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.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.SapBWLinkedService(*, server, system_number, client_id, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, user_name=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

SAP Business Warehouse 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 this collection
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.
type (str) – Required. Constant filled by server.
server (object) – Required. Host name of the SAP BW instance. Type: string (or Expression with resultType string).
system_number (object) – Required. System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
client_id (object) – Required. Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
user_name (object) – Username to access the SAP BW server. Type: string (or Expression with resultType string).
password (SecretBase) – Password to access the SAP BW server.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapBwSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for SapBW server via MDX.

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 this collection
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).
type (str) – Required. Constant filled by server.
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) – MDX query. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapCloudForCustomerLinkedService(*, url, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, username=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for SAP Cloud for Customer.

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 this collection
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.
type (str) – Required. Constant filled by server.
url (object) – Required. The URL of SAP Cloud for Customer OData API. For example, ‘[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]’. Type: string (or Expression with resultType string).
username (object) – The username for Basic authentication. Type: string (or Expression with resultType string).
password (SecretBase) – The password for Basic authentication.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapCloudForCustomerResourceDataset(*, linked_service_name, path, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The path of the SAP Cloud for Customer OData entity.

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 this collection
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.
type (str) – Required. Constant filled by server.
path (object) – Required. The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapCloudForCustomerSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, write_behavior=None, http_request_timeout=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity SAP Cloud for Customer 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 this collection
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).
type (str) – Required. Constant filled by server.
write_behavior (str or SapCloudForCustomerSinkWriteBehavior) – The write behavior for the operation. Default is ‘Insert’. Possible values include: ‘Insert’, ‘Update’
http_request_timeout (object) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

class azure.mgmt.datafactory.models.SapCloudForCustomerSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, http_request_timeout=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for SAP Cloud for Customer 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 this collection
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).
type (str) – Required. Constant filled by server.
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) – SAP Cloud for Customer OData query. For example, “$top=1”. Type: string (or Expression with resultType string).
http_request_timeout (object) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

class azure.mgmt.datafactory.models.SapEccLinkedService(*, url: str, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, username: str = None, password=None, encrypted_credential: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for SAP ERP Central Component(SAP ECC).

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 this collection
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.
type (str) – Required. Constant filled by server.
url (str) – Required. The URL of SAP ECC OData API. For example, ‘[https://hostname:port/sap/opu/odata/sap/servicename/]’. Type: string (or Expression with resultType string).
username (str) – The username for Basic authentication. Type: string (or Expression with resultType string).
password (SecretBase) – The password for Basic authentication.
encrypted_credential (str) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapEccResourceDataset(*, linked_service_name, path, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The path of the SAP ECC OData entity.

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 this collection
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.
type (str) – Required. Constant filled by server.
path (object) – Required. The path of the SAP ECC OData entity. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapEccSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, http_request_timeout=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for SAP ECC 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 this collection
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).
type (str) – Required. Constant filled by server.
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) – SAP ECC OData query. For example, “$top=1”. Type: string (or Expression with resultType string).
http_request_timeout (object) – The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

class azure.mgmt.datafactory.models.SapHanaLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, server=None, authentication_type=None, user_name=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

SAP HANA 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
server (object) – Host name of the SAP HANA server. Type: string (or Expression with resultType string).
authentication_type (str or SapHanaAuthenticationType) – The authentication type to be used to connect to the SAP HANA server. Possible values include: ‘Basic’, ‘Windows’
user_name (object) – Username to access the SAP HANA server. Type: string (or Expression with resultType string).
password (SecretBase) – Password to access the SAP HANA server.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapHanaPartitionSettings(*, partition_column_name=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The settings that will be leveraged for SAP HANA source partitioning.

Parameters: partition_column_name (object) – The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapHanaSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, packet_size=None, partition_option=None, partition_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for SAP HANA 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 this collection
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).
type (str) – Required. Constant filled by server.
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) – SAP HANA Sql query. Type: string (or Expression with resultType string).
packet_size (object) – The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer).
partition_option (str or SapHanaPartitionOption) – The partition mechanism that will be used for SAP HANA read in parallel. Possible values include: ‘None’, ‘PhysicalPartitionsOfTable’, ‘SapHanaDynamicRange’
partition_settings (SapHanaPartitionSettings) – The settings that will be leveraged for SAP HANA source partitioning.

class azure.mgmt.datafactory.models.SapHanaTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, sap_hana_table_dataset_schema=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

SAP HANA Table properties.

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 this collection
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.
type (str) – Required. Constant filled by server.
sap_hana_table_dataset_schema (object) – The schema name of SAP HANA. Type: string (or Expression with resultType string).
table (object) – The table name of SAP HANA. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapOpenHubLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, server=None, system_number=None, client_id=None, language=None, system_id=None, user_name=None, password=None, message_server=None, message_server_service=None, logon_group=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

SAP Business Warehouse Open Hub Destination 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 this collection
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.
type (str) – Required. Constant filled by server.
server (object) – Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string).
system_number (object) – System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
client_id (object) – Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
language (object) – Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string).
system_id (object) – SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
user_name (object) – Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string).
password (SecretBase) – Password to access the SAP BW server where the open hub destination is located.
message_server (object) – The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
message_server_service (object) – The service name or port number of the Message Server. Type: string (or Expression with resultType string).
logon_group (object) – The Logon Group for the SAP System. 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).

class azure.mgmt.datafactory.models.SapOpenHubSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, exclude_last_request=None, base_request_id=None, custom_rfc_read_table_function_module=None, sap_data_column_delimiter=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for SAP Business Warehouse Open Hub Destination 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
exclude_last_request (object) – Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).
base_request_id (object) – The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).
custom_rfc_read_table_function_module (object) – Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).
sap_data_column_delimiter (object) – The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapOpenHubTableDataset(*, linked_service_name, open_hub_destination_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, exclude_last_request=None, base_request_id=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Sap Business Warehouse Open Hub Destination Table properties.

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 this collection
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.
type (str) – Required. Constant filled by server.
open_hub_destination_name (object) – Required. The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string).
exclude_last_request (object) – Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).
base_request_id (object) – The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).

class azure.mgmt.datafactory.models.SapTableLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, server=None, system_number=None, client_id=None, language=None, system_id=None, user_name=None, password=None, message_server=None, message_server_service=None, snc_mode=None, snc_my_name=None, snc_partner_name=None, snc_library_path=None, snc_qop=None, logon_group=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

SAP Table 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 this collection
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.
type (str) – Required. Constant filled by server.
server (object) – Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).
system_number (object) – System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).
client_id (object) – Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).
language (object) – Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).
system_id (object) – SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).
user_name (object) – Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).
password (SecretBase) – Password to access the SAP server where the table is located.
message_server (object) – The hostname of the SAP Message Server. Type: string (or Expression with resultType string).
message_server_service (object) – The service name or port number of the Message Server. Type: string (or Expression with resultType string).
snc_mode (object) – SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).
snc_my_name (object) – Initiator’s SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
snc_partner_name (object) – Communication partner’s SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).
snc_library_path (object) – External security product’s library to access the SAP server where the table is located. Type: string (or Expression with resultType string).
snc_qop (object) – SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).
logon_group (object) – The Logon Group for the SAP System. 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).

class azure.mgmt.datafactory.models.SapTablePartitionSettings(*, partition_column_name=None, partition_upper_bound=None, partition_lower_bound=None, max_partitions_number=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The settings that will be leveraged for SAP table source partitioning.

Parameters

partition_column_name (object) – The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partition_upper_bound (object) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partition_lower_bound (object) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
max_partitions_number (object) – The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapTableResourceDataset(*, linked_service_name, table_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

SAP Table Resource properties.

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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – Required. The name of the SAP Table. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapTableSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, row_count=None, row_skips=None, rfc_table_fields=None, rfc_table_options=None, batch_size=None, custom_rfc_read_table_function_module=None, sap_data_column_delimiter=None, partition_option=None, partition_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for SAP Table 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
row_count (object) – The number of rows to be retrieved. Type: integer(or Expression with resultType integer).
row_skips (object) – The number of rows that will be skipped. Type: integer (or Expression with resultType integer).
rfc_table_fields (object) – The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).
rfc_table_options (object) – The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).
batch_size (object) – Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).
custom_rfc_read_table_function_module (object) – Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).
sap_data_column_delimiter (object) – The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).
partition_option (str or SapTablePartitionOption) – The partition mechanism that will be used for SAP table read in parallel. Possible values include: ‘None’, ‘PartitionOnInt’, ‘PartitionOnCalendarYear’, ‘PartitionOnCalendarMonth’, ‘PartitionOnCalendarDate’, ‘PartitionOnTime’
partition_settings (SapTablePartitionSettings) – The settings that will be leveraged for SAP table source partitioning.

class azure.mgmt.datafactory.models.ScheduleTrigger(*, recurrence, additional_properties=None, description: str = None, annotations=None, pipelines=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.MultiplePipelineTrigger

Trigger that creates pipeline runs periodically, on schedule.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Trigger description.
annotations (list[object]) – List of tags that can be used for describing the trigger.
type (str) – Required. Constant filled by server.
pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.
recurrence (ScheduleTriggerRecurrence) – Required. Recurrence schedule configuration.

Variables

runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: ‘Started’, ‘Stopped’, ‘Disabled’

class azure.mgmt.datafactory.models.ScheduleTriggerRecurrence(*, additional_properties=None, frequency=None, interval: int = None, start_time=None, end_time=None, time_zone: str = None, schedule=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The workflow trigger recurrence.

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
frequency (str or RecurrenceFrequency) – The frequency. Possible values include: ‘NotSpecified’, ‘Minute’, ‘Hour’, ‘Day’, ‘Week’, ‘Month’, ‘Year’
interval (int) – The interval.
start_time (datetime) – The start time.
end_time (datetime) – The end time.
time_zone (str) – The time zone.
schedule (RecurrenceSchedule) – The recurrence schedule.

class azure.mgmt.datafactory.models.ScriptAction(*, name: str, uri: str, roles, parameters: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Custom script action to run on HDI ondemand cluster once it’s up.

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

Parameters

name (str) – Required. The user provided name of the script action.
uri (str) – Required. The URI for the script action.
roles (object) – Required. The node types on which the script action should be executed.
parameters (str) – The parameters for the script action.

class azure.mgmt.datafactory.models.SecretBase(**kwargs)[source]¶

Bases: msrest.serialization.Model

The base definition of a secret type.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SecureString, AzureKeyVaultSecretReference

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

Parameters: type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.SecureString(*, value: str, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SecretBase

Azure Data Factory secure string definition. The string value will be masked with asterisks ‘*’ during Get or List API calls.

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

Parameters

type (str) – Required. Constant filled by server.
value (str) – Required. Value of secure string.

class azure.mgmt.datafactory.models.SelfDependencyTumblingWindowTriggerReference(*, offset: str, size: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DependencyReference

Self referenced tumbling window trigger dependency.

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

Parameters

type (str) – Required. Constant filled by server.
offset (str) – Required. Timespan applied to the start time of a tumbling window when evaluating dependency.
size (str) – The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.

class azure.mgmt.datafactory.models.SelfHostedIntegrationRuntime(*, additional_properties=None, description: str = None, linked_info=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.IntegrationRuntime

Self-hosted integration runtime.

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 this collection
description (str) – Integration runtime description.
type (str) – Required. Constant filled by server.
linked_info (LinkedIntegrationRuntimeType) –

class azure.mgmt.datafactory.models.SelfHostedIntegrationRuntimeNode(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of Self-hosted integration runtime node.

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 this collection

Variables

node_name (str) – Name of the integration runtime node.
machine_name (str) – Machine name of the integration runtime node.
host_service_uri (str) – URI for the host machine of the integration runtime.
status (str or SelfHostedIntegrationRuntimeNodeStatus) – Status of the integration runtime node. Possible values include: ‘NeedRegistration’, ‘Online’, ‘Limited’, ‘Offline’, ‘Upgrading’, ‘Initializing’, ‘InitializeFailed’
capabilities (dict[str, str]) – The integration runtime capabilities dictionary
version_status (str) – Status of the integration runtime node version.
version (str) – Version of the integration runtime node.
register_time (datetime) – The time at which the integration runtime node was registered in ISO8601 format.
last_connect_time (datetime) – The most recent time at which the integration runtime was connected in ISO8601 format.
expiry_time (datetime) – The time at which the integration runtime will expire in ISO8601 format.
last_start_time (datetime) – The time the node last started up.
last_stop_time (datetime) – The integration runtime node last stop time.
last_update_result (str or IntegrationRuntimeUpdateResult) – The result of the last integration runtime node update. Possible values include: ‘None’, ‘Succeed’, ‘Fail’
last_start_update_time (datetime) – The last time for the integration runtime node update start.
last_end_update_time (datetime) – The last time for the integration runtime node update end.
is_active_dispatcher (bool) – Indicates whether this node is the active dispatcher for integration runtime requests.
concurrent_jobs_limit (int) – Maximum concurrent jobs on the integration runtime node.
max_concurrent_jobs (int) – The maximum concurrent jobs in this integration runtime.

class azure.mgmt.datafactory.models.SelfHostedIntegrationRuntimeStatus(*, additional_properties=None, nodes=None, links=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeStatus

Self-hosted integration runtime status.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
type (str) – Required. Constant filled by server.
nodes (list[SelfHostedIntegrationRuntimeNode]) – The list of nodes for this integration runtime.
links (list[LinkedIntegrationRuntime]) – The list of linked integration runtimes that are created to share with this integration runtime.

Variables

data_factory_name (str) – The data factory name which the integration runtime belong to.
state (str or IntegrationRuntimeState) – The state of integration runtime. Possible values include: ‘Initial’, ‘Stopped’, ‘Started’, ‘Starting’, ‘Stopping’, ‘NeedRegistration’, ‘Online’, ‘Limited’, ‘Offline’, ‘AccessDenied’
create_time (datetime) – The time at which the integration runtime was created, in ISO8601 format.
task_queue_id (str) – The task queue id of the integration runtime.
internal_channel_encryption (str or IntegrationRuntimeInternalChannelEncryptionMode) – It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist). Possible values include: ‘NotSet’, ‘SslEncrypted’, ‘NotEncrypted’
version (str) – Version of the integration runtime.
scheduled_update_date (datetime) – The date at which the integration runtime will be scheduled to update, in ISO8601 format.
update_delay_offset (str) – The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours
local_time_zone_offset (str) – The local time zone offset in hours.
capabilities (dict[str, str]) – Object with additional information about integration runtime capabilities.
service_urls (list[str]) – The URLs for the services used in integration runtime backend service.
auto_update (str or IntegrationRuntimeAutoUpdate) – Whether Self-hosted integration runtime auto update has been turned on. Possible values include: ‘On’, ‘Off’
version_status (str) – Status of the integration runtime version.
pushed_version (str) – The version that the integration runtime is going to update to.
latest_version (str) – The latest version on download center.
auto_update_eta (datetime) – The estimated time when the self-hosted integration runtime will be updated.

class azure.mgmt.datafactory.models.ServiceNowLinkedService(*, endpoint, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, username=None, password=None, client_id=None, client_secret=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

ServiceNow server 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 this collection
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.
type (str) – Required. Constant filled by server.
endpoint (object) – Required. The endpoint of the ServiceNow server. (i.e. <instance>.service-now.com)
authentication_type (str or ServiceNowAuthenticationType) – Required. The authentication type to use. Possible values include: ‘Basic’, ‘OAuth2’
username (object) – The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.
password (SecretBase) – The password corresponding to the user name for Basic and OAuth2 authentication.
client_id (object) – The client id for OAuth2 authentication.
client_secret (SecretBase) – The client secret for OAuth2 authentication.
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).

class azure.mgmt.datafactory.models.ServiceNowObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

ServiceNow 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ServiceNowSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity ServiceNow server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.SetVariableActivity(*, name: str, additional_properties=None, description: str = None, depends_on=None, user_properties=None, variable_name: str = None, value=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

Set value for a Variable.

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
variable_name (str) – Name of the variable whose value needs to be set.
value (object) – Value to be set. Could be a static value or Expression

class azure.mgmt.datafactory.models.SftpLocation(*, additional_properties=None, folder_path=None, file_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetLocation

The location of SFTP 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 this collection
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).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.SftpReadSettings(*, additional_properties=None, max_concurrent_connections=None, recursive=None, wildcard_folder_path=None, wildcard_file_name=None, enable_partition_discovery: bool = None, partition_root_path=None, file_list_path=None, delete_files_after_completion=None, modified_datetime_start=None, modified_datetime_end=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreReadSettings

Sftp 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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.
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) – Sftp wildcardFolderPath. Type: string (or Expression with resultType string).
wildcard_file_name (object) – Sftp wildcardFileName. 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).
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).
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).

class azure.mgmt.datafactory.models.SftpServerLinkedService(*, host, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, port=None, authentication_type=None, user_name=None, password=None, encrypted_credential=None, private_key_path=None, private_key_content=None, pass_phrase=None, skip_host_key_validation=None, host_key_fingerprint=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

A linked service for an SSH File Transfer Protocol (SFTP) server. .

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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. The SFTP server host name. Type: string (or Expression with resultType string).
port (object) – The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.
authentication_type (str or SftpAuthenticationType) – The authentication type to be used to connect to the FTP server. Possible values include: ‘Basic’, ‘SshPublicKey’
user_name (object) – The username used to log on to the SFTP server. Type: string (or Expression with resultType string).
password (SecretBase) – Password to logon the SFTP server for Basic authentication.
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
private_key_path (object) – The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).
private_key_content (SecretBase) – Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.
pass_phrase (SecretBase) – The password to decrypt the SSH private key if the SSH private key is encrypted.
skip_host_key_validation (object) – If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
host_key_fingerprint (object) – The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SftpWriteSettings(*, additional_properties=None, max_concurrent_connections=None, copy_behavior=None, operation_timeout=None, use_temp_file_rename=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.StoreWriteSettings

Sftp 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 this collection
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.
type (str) – Required. Constant filled by server.
operation_timeout (object) – Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).
use_temp_file_rename (object) – Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn’t support rename operation. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.SharePointOnlineListLinkedService(*, site_url, tenant_id, service_principal_id, service_principal_key, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

SharePoint Online List 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 this collection
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.
type (str) – Required. Constant filled by server.
site_url (object) – Required. The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string).
tenant_id (object) – Required. The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string).
service_principal_id (object) – Required. The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string).
service_principal_key (SecretBase) – Required. The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
encrypted_credential (object) – The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SharePointOnlineListResourceDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, list_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The sharepoint online list resource 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 this collection
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.
type (str) – Required. Constant filled by server.
list_name (object) – The name of the SharePoint Online list. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SharePointOnlineListSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, http_request_timeout=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity source for sharePoint online list 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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – The OData query to filter the data in SharePoint Online list. For example, “$top=1”. Type: string (or Expression with resultType string).
http_request_timeout (object) – The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

class azure.mgmt.datafactory.models.ShopifyLinkedService(*, host, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, access_token=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Shopify 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. The endpoint of the Shopify server. (i.e. mystore.myshopify.com)
access_token (SecretBase) – The API access token that can be used to access Shopify’s data. The token won’t expire if it is offline mode.
use_encrypted_endpoints (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).

class azure.mgmt.datafactory.models.ShopifyObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Shopify 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ShopifySource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Shopify 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.SkipErrorFile(*, file_missing=None, data_inconsistency=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Skip error file.

Parameters

file_missing (object) – Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean).
data_inconsistency (object) – Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.SnowflakeDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, snowflake_dataset_schema=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The snowflake 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 this collection
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.
type (str) – Required. Constant filled by server.
snowflake_dataset_schema (object) – The schema name of the Snowflake database. Type: string (or Expression with resultType string).
table (object) – The table name of the Snowflake database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SnowflakeExportCopyCommand(*, additional_properties=None, additional_copy_options=None, additional_format_options=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExportSettings

Snowflake 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 this collection
type (str) – Required. Constant filled by server.
additional_copy_options (dict[str, object]) – Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalCopyOptions”: { “DATE_FORMAT”: “MM/DD/YYYY”, “TIME_FORMAT”: “‘HH24:MI:SS.FF’” }
additional_format_options (dict[str, object]) – Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalFormatOptions”: { “OVERWRITE”: “TRUE”, “MAX_FILE_SIZE”: “‘FALSE’” }

class azure.mgmt.datafactory.models.SnowflakeImportCopyCommand(*, additional_properties=None, additional_copy_options=None, additional_format_options=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ImportSettings

Snowflake 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 this collection
type (str) – Required. Constant filled by server.
additional_copy_options (dict[str, object]) – Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalCopyOptions”: { “DATE_FORMAT”: “MM/DD/YYYY”, “TIME_FORMAT”: “‘HH24:MI:SS.FF’” }
additional_format_options (dict[str, object]) – Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: “additionalFormatOptions”: { “FORCE”: “TRUE”, “LOAD_UNCERTAIN_FILES”: “‘FALSE’” }

class azure.mgmt.datafactory.models.SnowflakeLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Snowflake 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The connection string of snowflake. Type: string, SecureString.
password (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.SnowflakeSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, pre_copy_script=None, import_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity snowflake 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 this collection
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).
type (str) – Required. Constant filled by server.
pre_copy_script (object) – SQL pre-copy script. Type: string (or Expression with resultType string).
import_settings (SnowflakeImportCopyCommand) – Snowflake import settings.

class azure.mgmt.datafactory.models.SnowflakeSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query=None, export_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity snowflake 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 this collection
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).
type (str) – Required. Constant filled by server.
query (object) – Snowflake Sql query. Type: string (or Expression with resultType string).
export_settings (SnowflakeExportCopyCommand) – Snowflake export settings.

class azure.mgmt.datafactory.models.SparkLinkedService(*, host, port, authentication_type, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, server_type=None, thrift_transport_protocol=None, username=None, password=None, http_path=None, enable_ssl=None, trusted_cert_path=None, use_system_trust_store=None, allow_host_name_cn_mismatch=None, allow_self_signed_server_cert=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Spark Server 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 this collection
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.
type (str) – Required. Constant filled by server.
host (object) – Required. IP address or host name of the Spark server
port (object) – Required. The TCP port that the Spark server uses to listen for client connections.
server_type (str or SparkServerType) – The type of Spark server. Possible values include: ‘SharkServer’, ‘SharkServer2’, ‘SparkThriftServer’
thrift_transport_protocol (str or SparkThriftTransportProtocol) – The transport protocol to use in the Thrift layer. Possible values include: ‘Binary’, ‘SASL’, ‘HTTP ‘
authentication_type (str or SparkAuthenticationType) – Required. The authentication method used to access the Spark server. Possible values include: ‘Anonymous’, ‘Username’, ‘UsernameAndPassword’, ‘WindowsAzureHDInsightService’
username (object) – The user name that you use to access Spark Server.
password (SecretBase) – The password corresponding to the user name that you provided in the Username field
http_path (object) – The partial URL corresponding to the Spark server.
enable_ssl (object) – Specifies whether the connections to the server are encrypted using SSL. The default value is false.
trusted_cert_path (object) – The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
use_system_trust_store (object) – Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
allow_host_name_cn_mismatch (object) – Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.
allow_self_signed_server_cert (object) – Specifies whether to allow self-signed certificates from the server. The default value is false.
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).

class azure.mgmt.datafactory.models.SparkObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, spark_object_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Spark 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
table (object) – The table name of the Spark. Type: string (or Expression with resultType string).
spark_object_dataset_schema (object) – The schema name of the Spark. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SparkSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Spark Server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.SqlDWSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, pre_copy_script=None, allow_poly_base=None, poly_base_settings=None, allow_copy_command=None, copy_command_settings=None, table_option=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity SQL Data Warehouse 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 this collection
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).
type (str) – Required. Constant filled by server.
pre_copy_script (object) – SQL pre-copy script. Type: string (or Expression with resultType string).
allow_poly_base (object) – Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
poly_base_settings (PolybaseSettings) – Specifies PolyBase-related settings when allowPolyBase is true.
allow_copy_command (object) – Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
copy_command_settings (DWCopyCommandSettings) – Specifies Copy Command related settings when allowCopyCommand is true.
table_option (object) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SqlDWSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, sql_reader_query=None, sql_reader_stored_procedure_name=None, stored_procedure_parameters=None, partition_option=None, partition_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity SQL Data Warehouse 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
sql_reader_query (object) – SQL Data Warehouse reader query. Type: string (or Expression with resultType string).
sql_reader_stored_procedure_name (object) – Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
stored_procedure_parameters (object) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”. Type: object (or Expression with resultType object), itemType: StoredProcedureParameter.
partition_option (str or SqlPartitionOption) – The partition mechanism that will be used for Sql read in parallel. Possible values include: ‘None’, ‘PhysicalPartitionsOfTable’, ‘DynamicRange’
partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

class azure.mgmt.datafactory.models.SqlMISink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, sql_writer_stored_procedure_name=None, sql_writer_table_type=None, pre_copy_script=None, stored_procedure_parameters=None, stored_procedure_table_type_parameter_name=None, table_option=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity Azure SQL Managed Instance 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 this collection
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).
type (str) – Required. Constant filled by server.
sql_writer_stored_procedure_name (object) – SQL writer stored procedure name. Type: string (or Expression with resultType string).
sql_writer_table_type (object) – SQL writer table type. Type: string (or Expression with resultType string).
pre_copy_script (object) – SQL pre-copy script. Type: string (or Expression with resultType string).
stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.
stored_procedure_table_type_parameter_name (object) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
table_option (object) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SqlMISource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, sql_reader_query=None, sql_reader_stored_procedure_name=None, stored_procedure_parameters=None, produce_additional_types=None, partition_option=None, partition_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Azure SQL Managed Instance 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
sql_reader_query (object) – SQL reader query. Type: string (or Expression with resultType string).
sql_reader_stored_procedure_name (object) – Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.
produce_additional_types (object) – Which additional types to produce.
partition_option (str or SqlPartitionOption) – The partition mechanism that will be used for Sql read in parallel. Possible values include: ‘None’, ‘PhysicalPartitionsOfTable’, ‘DynamicRange’
partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

class azure.mgmt.datafactory.models.SqlPartitionSettings(*, partition_column_name=None, partition_upper_bound=None, partition_lower_bound=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The settings that will be leveraged for Sql source partitioning.

Parameters

partition_column_name (object) – The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string).
partition_upper_bound (object) – The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).
partition_lower_bound (object) – The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SqlServerLinkedService(*, connection_string, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, user_name=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

SQL Server 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
user_name (object) – The on-premises Windows authentication user name. Type: string (or Expression with resultType string).
password (SecretBase) – The on-premises Windows authentication password.
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).

class azure.mgmt.datafactory.models.SqlServerSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, sql_writer_stored_procedure_name=None, sql_writer_table_type=None, pre_copy_script=None, stored_procedure_parameters=None, stored_procedure_table_type_parameter_name=None, table_option=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity SQL server 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 this collection
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).
type (str) – Required. Constant filled by server.
sql_writer_stored_procedure_name (object) – SQL writer stored procedure name. Type: string (or Expression with resultType string).
sql_writer_table_type (object) – SQL writer table type. Type: string (or Expression with resultType string).
pre_copy_script (object) – SQL pre-copy script. Type: string (or Expression with resultType string).
stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.
stored_procedure_table_type_parameter_name (object) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
table_option (object) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SqlServerSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, sql_reader_query=None, sql_reader_stored_procedure_name=None, stored_procedure_parameters=None, produce_additional_types=None, partition_option=None, partition_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity SQL server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
sql_reader_query (object) – SQL reader query. Type: string (or Expression with resultType string).
sql_reader_stored_procedure_name (object) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.
produce_additional_types (object) – Which additional types to produce.
partition_option (str or SqlPartitionOption) – The partition mechanism that will be used for Sql read in parallel. Possible values include: ‘None’, ‘PhysicalPartitionsOfTable’, ‘DynamicRange’
partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

class azure.mgmt.datafactory.models.SqlServerStoredProcedureActivity(*, name: str, stored_procedure_name, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, stored_procedure_parameters=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

SQL stored procedure activity type.

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
stored_procedure_name (object) – Required. Stored procedure name. Type: string (or Expression with resultType string).
stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.

class azure.mgmt.datafactory.models.SqlServerTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, sql_server_table_dataset_schema=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The on-premises SQL 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
sql_server_table_dataset_schema (object) – The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).
table (object) – The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SqlSink(*, additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, max_concurrent_connections=None, sql_writer_stored_procedure_name=None, sql_writer_table_type=None, pre_copy_script=None, stored_procedure_parameters=None, stored_procedure_table_type_parameter_name=None, table_option=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySink

A copy activity SQL 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 this collection
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).
type (str) – Required. Constant filled by server.
sql_writer_stored_procedure_name (object) – SQL writer stored procedure name. Type: string (or Expression with resultType string).
sql_writer_table_type (object) – SQL writer table type. Type: string (or Expression with resultType string).
pre_copy_script (object) – SQL pre-copy script. Type: string (or Expression with resultType string).
stored_procedure_parameters (dict[str, StoredProcedureParameter]) – SQL stored procedure parameters.
stored_procedure_table_type_parameter_name (object) – The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
table_option (object) – The option to handle sink table, such as autoCreate. For now only ‘autoCreate’ value is supported. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SqlSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, sql_reader_query=None, sql_reader_stored_procedure_name=None, stored_procedure_parameters=None, isolation_level=None, partition_option=None, partition_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity SQL 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 this collection
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).
type (str) – Required. Constant filled by server.
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).
sql_reader_query (object) – SQL reader query. Type: string (or Expression with resultType string).
sql_reader_stored_procedure_name (object) – Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
stored_procedure_parameters (dict[str, StoredProcedureParameter]) – Value and type setting for stored procedure parameters. Example: “{Parameter1: {value: “1”, type: “int”}}”.
isolation_level (object) – Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).
partition_option (str or SqlPartitionOption) – The partition mechanism that will be used for Sql read in parallel. Possible values include: ‘None’, ‘PhysicalPartitionsOfTable’, ‘DynamicRange’
partition_settings (SqlPartitionSettings) – The settings that will be leveraged for Sql source partitioning.

class azure.mgmt.datafactory.models.SquareLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_properties=None, host=None, client_id=None, client_secret=None, redirect_uri=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Square 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_properties (object) – Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object.
host (object) – The URL of the Square instance. (i.e. mystore.mysquare.com)
client_id (object) – The client ID associated with your Square application.
client_secret (SecretBase) – The client secret associated with your Square application.
redirect_uri (object) – The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)
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).

class azure.mgmt.datafactory.models.SquareObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Square 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SquareSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Square 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.SSISAccessCredential(*, domain, user_name, password, **kwargs)[source]¶

Bases: msrest.serialization.Model

SSIS access credential.

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

Parameters

domain (object) – Required. Domain for windows authentication.
user_name (object) – Required. UseName for windows authentication.
password (SecretBase) – Required. Password for windows authentication.

class azure.mgmt.datafactory.models.SSISChildPackage(*, package_path, package_content, package_name: str = None, package_last_modified_date: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SSIS embedded child package.

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

Parameters

package_path (object) – Required. Path for embedded child package. Type: string (or Expression with resultType string).
package_name (str) – Name for embedded child package.
package_content (object) – Required. Content for embedded child package. Type: string (or Expression with resultType string).
package_last_modified_date (str) – Last modified date for embedded child package.

class azure.mgmt.datafactory.models.SsisEnvironment(*, id: int = None, name: str = None, description: str = None, folder_id: int = None, variables=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SsisObjectMetadata

Ssis environment.

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

Parameters

id (long) – Metadata id.
name (str) – Metadata name.
description (str) – Metadata description.
type (str) – Required. Constant filled by server.
folder_id (long) – Folder id which contains environment.
variables (list[SsisVariable]) – Variable in environment

class azure.mgmt.datafactory.models.SsisEnvironmentReference(*, id: int = None, environment_folder_name: str = None, environment_name: str = None, reference_type: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Ssis environment reference.

Parameters

id (long) – Environment reference id.
environment_folder_name (str) – Environment folder name.
environment_name (str) – Environment name.
reference_type (str) – Reference type

class azure.mgmt.datafactory.models.SSISExecutionCredential(*, domain, user_name, password, **kwargs)[source]¶

Bases: msrest.serialization.Model

SSIS package execution credential.

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

Parameters

domain (object) – Required. Domain for windows authentication.
user_name (object) – Required. UseName for windows authentication.
password (SecureString) – Required. Password for windows authentication.

class azure.mgmt.datafactory.models.SSISExecutionParameter(*, value, **kwargs)[source]¶

Bases: msrest.serialization.Model

SSIS execution parameter.

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

Parameters: value (object) – Required. SSIS package execution parameter value. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SsisFolder(*, id: int = None, name: str = None, description: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SsisObjectMetadata

Ssis folder.

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

Parameters

id (long) – Metadata id.
name (str) – Metadata name.
description (str) – Metadata description.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.SSISLogLocation(*, log_path, access_credential=None, log_refresh_interval=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SSIS package execution log location.

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

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

Parameters

log_path (object) – Required. The SSIS package execution log path. Type: string (or Expression with resultType string).
access_credential (SSISAccessCredential) – The package execution log access credential.
log_refresh_interval (object) – Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

Variables

type (str) – Required. The type of SSIS log location. Default value: “File” .

type = 'File'¶

class azure.mgmt.datafactory.models.SsisObjectMetadata(*, id: int = None, name: str = None, description: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SSIS object metadata.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SsisEnvironment, SsisPackage, SsisProject, SsisFolder

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

Parameters

id (long) – Metadata id.
name (str) – Metadata name.
description (str) – Metadata description.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.SsisObjectMetadataListResponse(*, value=None, next_link: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of SSIS object metadata.

Parameters

value (list[SsisObjectMetadata]) – List of SSIS object metadata.
next_link (str) – The link to the next page of results, if any remaining results exist.

class azure.mgmt.datafactory.models.SsisObjectMetadataStatusResponse(*, status: str = None, name: str = None, properties: str = None, error: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The status of the operation.

Parameters

status (str) – The status of the operation.
name (str) – The operation name.
properties (str) – The operation properties.
error (str) – The operation error message.

class azure.mgmt.datafactory.models.SsisPackage(*, id: int = None, name: str = None, description: str = None, folder_id: int = None, project_version: int = None, project_id: int = None, parameters=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SsisObjectMetadata

Ssis Package.

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

Parameters

id (long) – Metadata id.
name (str) – Metadata name.
description (str) – Metadata description.
type (str) – Required. Constant filled by server.
folder_id (long) – Folder id which contains package.
project_version (long) – Project version which contains package.
project_id (long) – Project id which contains package.
parameters (list[SsisParameter]) – Parameters in package

class azure.mgmt.datafactory.models.SSISPackageLocation(*, package_path=None, type=None, package_password=None, access_credential=None, configuration_path=None, configuration_access_credential=None, package_name: str = None, package_content=None, package_last_modified_date: str = None, child_packages=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SSIS package location.

Parameters

package_path (object) – The SSIS package path. Type: string (or Expression with resultType string).
type (str or SsisPackageLocationType) – The type of SSIS package location. Possible values include: ‘SSISDB’, ‘File’, ‘InlinePackage’, ‘PackageStore’
package_password (SecretBase) – Password of the package.
access_credential (SSISAccessCredential) – The package access credential.
configuration_path (object) – The configuration file of the package execution. Type: string (or Expression with resultType string).
configuration_access_credential (SSISAccessCredential) – The configuration file access credential.
package_name (str) – The package name.
package_content (object) – The embedded package content. Type: string (or Expression with resultType string).
package_last_modified_date (str) – The embedded package last modified date.
child_packages (list[SSISChildPackage]) – The embedded child package list.

class azure.mgmt.datafactory.models.SsisParameter(*, id: int = None, name: str = None, description: str = None, data_type: str = None, required: bool = None, sensitive: bool = None, design_default_value: str = None, default_value: str = None, sensitive_default_value: str = None, value_type: str = None, value_set: bool = None, variable: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Ssis parameter.

Parameters

id (long) – Parameter id.
name (str) – Parameter name.
description (str) – Parameter description.
data_type (str) – Parameter type.
required (bool) – Whether parameter is required.
sensitive (bool) – Whether parameter is sensitive.
design_default_value (str) – Design default value of parameter.
default_value (str) – Default value of parameter.
sensitive_default_value (str) – Default sensitive value of parameter.
value_type (str) – Parameter value type.
value_set (bool) – Parameter value set.
variable (str) – Parameter reference variable.

class azure.mgmt.datafactory.models.SsisProject(*, id: int = None, name: str = None, description: str = None, folder_id: int = None, version: int = None, environment_refs=None, parameters=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SsisObjectMetadata

Ssis project.

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

Parameters

id (long) – Metadata id.
name (str) – Metadata name.
description (str) – Metadata description.
type (str) – Required. Constant filled by server.
folder_id (long) – Folder id which contains project.
version (long) – Project version.
environment_refs (list[SsisEnvironmentReference]) – Environment reference in project
parameters (list[SsisParameter]) – Parameters in project

class azure.mgmt.datafactory.models.SSISPropertyOverride(*, value, is_sensitive: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SSIS property override.

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

Parameters

value (object) – Required. SSIS package property override value. Type: string (or Expression with resultType string).
is_sensitive (bool) – Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true

class azure.mgmt.datafactory.models.SsisVariable(*, id: int = None, name: str = None, description: str = None, data_type: str = None, sensitive: bool = None, value: str = None, sensitive_value: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Ssis variable.

Parameters

id (long) – Variable id.
name (str) – Variable name.
description (str) – Variable description.
data_type (str) – Variable type.
sensitive (bool) – Whether variable is sensitive.
value (str) – Variable value.
sensitive_value (str) – Variable sensitive value.

class azure.mgmt.datafactory.models.StagingSettings(*, linked_service_name, additional_properties=None, path=None, enable_compression=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Staging 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 this collection
linked_service_name (LinkedServiceReference) – Required. Staging linked service reference.
path (object) – The path to storage for storing the interim data. Type: string (or Expression with resultType string).
enable_compression (object) – Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.StoredProcedureParameter(*, value=None, type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SQL stored procedure parameter.

Parameters

value (object) – Stored procedure parameter value. Type: string (or Expression with resultType string).
type (str or StoredProcedureParameterType) – Stored procedure parameter type. Possible values include: ‘String’, ‘Int’, ‘Int64’, ‘Decimal’, ‘Guid’, ‘Boolean’, ‘Date’

class azure.mgmt.datafactory.models.StoreReadSettings(*, additional_properties=None, max_concurrent_connections=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Connector read setting.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: HdfsReadSettings, HttpReadSettings, SftpReadSettings, FtpReadSettings, GoogleCloudStorageReadSettings, AzureFileStorageReadSettings, FileServerReadSettings, AmazonS3ReadSettings, AzureDataLakeStoreReadSettings, AzureBlobFSReadSettings, AzureBlobStorageReadSettings

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 this collection
max_concurrent_connections (object) – The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.StoreWriteSettings(*, additional_properties=None, max_concurrent_connections=None, copy_behavior=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Connector write settings.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureFileStorageWriteSettings, FileServerWriteSettings, AzureDataLakeStoreWriteSettings, AzureBlobFSWriteSettings, AzureBlobStorageWriteSettings, SftpWriteSettings

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 this collection
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.
type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.SubResource(**kwargs)[source]¶

Bases: msrest.serialization.Model

Azure Data Factory nested resource, which belongs to a factory.

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
etag (str) – Etag identifies change in the resource.

class azure.mgmt.datafactory.models.SubResourceDebugResource(*, name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure Data Factory nested debug resource.

Parameters: name (str) – The resource name.

class azure.mgmt.datafactory.models.SwitchActivity(*, name: str, on, additional_properties=None, description: str = None, depends_on=None, user_properties=None, cases=None, default_activities=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
on (Expression) – Required. An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.
cases (list[SwitchCase]) – List of cases that correspond to expected values of the ‘on’ property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.
default_activities (list[Activity]) – List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.

class azure.mgmt.datafactory.models.SwitchCase(*, value: str = None, activities=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Switch cases with have a value and corresponding activities.

Parameters

value (str) – Expected value that satisfies the expression result of the ‘on’ property.
activities (list[Activity]) – List of activities to execute for satisfied case condition.

class azure.mgmt.datafactory.models.SybaseLinkedService(*, server, database, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, schema=None, authentication_type=None, username=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for Sybase data 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 this collection
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.
type (str) – Required. Constant filled by server.
server (object) – Required. Server name for connection. Type: string (or Expression with resultType string).
database (object) – Required. Database name for connection. Type: string (or Expression with resultType string).
schema (object) – Schema name for connection. Type: string (or Expression with resultType string).
authentication_type (str or SybaseAuthenticationType) – AuthenticationType to be used for connection. Possible values include: ‘Basic’, ‘Windows’
username (object) – Username for authentication. Type: string (or Expression with resultType string).
password (SecretBase) – Password for authentication.
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).

class azure.mgmt.datafactory.models.SybaseSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity source for Sybase databases.

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.SybaseTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Sybase 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The Sybase table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.TabularSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

Copy activity sources of tabular type.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AmazonRedshiftSource, GoogleAdWordsSource, OracleServiceCloudSource, DynamicsAXSource, ResponsysSource, SalesforceMarketingCloudSource, VerticaSource, NetezzaSource, ZohoSource, XeroSource, SquareSource, SparkSource, ShopifySource, ServiceNowSource, QuickBooksSource, PrestoSource, PhoenixSource, PaypalSource, MarketoSource, AzureMariaDBSource, MariaDBSource, MagentoSource, JiraSource, ImpalaSource, HubspotSource, HiveSource, HBaseSource, GreenplumSource, GoogleBigQuerySource, EloquaSource, DrillSource, CouchbaseSource, ConcurSource, AzurePostgreSqlSource, AmazonMWSSource, CassandraSource, TeradataSource, AzureMySqlSource, SqlDWSource, SqlMISource, AzureSqlSource, SqlServerSource, SqlSource, SapTableSource, SapOpenHubSource, SapHanaSource, SapEccSource, SapCloudForCustomerSource, SalesforceSource, SapBwSource, SybaseSource, PostgreSqlSource, MySqlSource, OdbcSource, Db2Source, InformixSource, AzureTableSource

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.TeradataLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, server=None, authentication_type=None, username=None, password=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Linked service for Teradata data 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
server (object) – Server name for connection. Type: string (or Expression with resultType string).
authentication_type (str or TeradataAuthenticationType) – AuthenticationType to be used for connection. Possible values include: ‘Basic’, ‘Windows’
username (object) – Username for authentication. Type: string (or Expression with resultType string).
password (SecretBase) – Password for authentication.
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).

class azure.mgmt.datafactory.models.TeradataPartitionSettings(*, partition_column_name=None, partition_upper_bound=None, partition_lower_bound=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The settings that will be leveraged for teradata source partitioning.

Parameters

partition_column_name (object) – The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string).
partition_upper_bound (object) – The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partition_lower_bound (object) – The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.TeradataSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, partition_option=None, partition_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Teradata 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 this collection
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).
type (str) – Required. Constant filled by server.
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) – Teradata query. Type: string (or Expression with resultType string).
partition_option (str or TeradataPartitionOption) – The partition mechanism that will be used for teradata read in parallel. Possible values include: ‘None’, ‘Hash’, ‘DynamicRange’
partition_settings (TeradataPartitionSettings) – The settings that will be leveraged for teradata source partitioning.

class azure.mgmt.datafactory.models.TeradataTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, database=None, table=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The Teradata database 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 this collection
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.
type (str) – Required. Constant filled by server.
database (object) – The database name of Teradata. Type: string (or Expression with resultType string).
table (object) – The table name of Teradata. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.TextFormat(*, additional_properties=None, serializer=None, deserializer=None, column_delimiter=None, row_delimiter=None, escape_char=None, quote_char=None, null_value=None, encoding_name=None, treat_empty_as_null=None, skip_line_count=None, first_row_as_header=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DatasetStorageFormat

The data stored in text 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 this collection
serializer (object) – Serializer. Type: string (or Expression with resultType string).
deserializer (object) – Deserializer. Type: string (or Expression with resultType string).
type (str) – Required. Constant filled by server.
column_delimiter (object) – The column delimiter. Type: string (or Expression with resultType string).
row_delimiter (object) – The row delimiter. Type: string (or Expression with resultType string).
escape_char (object) – The escape character. Type: string (or Expression with resultType string).
quote_char (object) – The quote character. Type: string (or Expression with resultType string).
null_value (object) – The null value string. Type: string (or Expression with resultType string).
encoding_name (object) – The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
treat_empty_as_null (object) – Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).
skip_line_count (object) – The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).
first_row_as_header (object) – When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.Transformation(*, name: str, description: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A data flow transformation.

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

Parameters

name (str) – Required. Transformation name.
description (str) – Transformation description.

class azure.mgmt.datafactory.models.Trigger(*, additional_properties=None, description: str = None, annotations=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure data factory nested object which contains information about creating pipeline run.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ChainingTrigger, RerunTumblingWindowTrigger, TumblingWindowTrigger, MultiplePipelineTrigger

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Trigger description.
annotations (list[object]) – List of tags that can be used for describing the trigger.
type (str) – Required. Constant filled by server.

Variables

runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: ‘Started’, ‘Stopped’, ‘Disabled’

class azure.mgmt.datafactory.models.TriggerDependencyReference(*, reference_trigger, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.DependencyReference

Trigger referenced dependency.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: TumblingWindowTriggerDependencyReference

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

Parameters

type (str) – Required. Constant filled by server.
reference_trigger (TriggerReference) – Required. Referenced trigger.

class azure.mgmt.datafactory.models.TriggerFilterParameters(*, continuation_token: str = None, parent_trigger_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Query parameters for triggers.

Parameters

continuation_token (str) – The continuation token for getting the next page of results. Null for first page.
parent_trigger_name (str) – The name of the parent TumblingWindowTrigger to get the child rerun triggers

class azure.mgmt.datafactory.models.TriggerPipelineReference(*, pipeline_reference=None, parameters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Pipeline that needs to be triggered with the given parameters.

Parameters

pipeline_reference (PipelineReference) – Pipeline reference.
parameters (dict[str, object]) – Pipeline parameters.

class azure.mgmt.datafactory.models.TriggerQueryResponse(*, value, continuation_token: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A query of triggers.

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

Parameters

value (list[TriggerResource]) – Required. List of triggers.
continuation_token (str) – The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

class azure.mgmt.datafactory.models.TriggerReference(*, reference_name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Trigger reference type.

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

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

Variables: type (str) – Required. Trigger reference type. Default value: “TriggerReference” .
Parameters: reference_name (str) – Required. Reference trigger name.

type = 'TriggerReference'¶

class azure.mgmt.datafactory.models.TriggerResource(*, properties, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.SubResource

Trigger resource type.

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

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

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
etag (str) – Etag identifies change in the resource.

Parameters

properties (Trigger) – Required. Properties of the trigger.

class azure.mgmt.datafactory.models.TriggerRun(*, additional_properties=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Trigger runs.

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 this collection

Variables

trigger_run_id (str) – Trigger run id.
trigger_name (str) – Trigger name.
trigger_type (str) – Trigger type.
trigger_run_timestamp (datetime) – Trigger run start time.
status (str or TriggerRunStatus) – Trigger run status. Possible values include: ‘Succeeded’, ‘Failed’, ‘Inprogress’
message (str) – Trigger error message.
properties (dict[str, str]) – List of property name and value related to trigger run. Name, value pair depends on type of trigger.
triggered_pipelines (dict[str, str]) – List of pipeline name and run Id triggered by the trigger run.
run_dimension (dict[str, str]) – Run dimension for which trigger was fired.
dependency_status (dict[str, object]) – Status of the upstream pipelines.

class azure.mgmt.datafactory.models.TriggerRunsQueryResponse(*, value, continuation_token: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of trigger runs.

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

Parameters

value (list[TriggerRun]) – Required. List of trigger runs.
continuation_token (str) – The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

class azure.mgmt.datafactory.models.TriggerSubscriptionOperationStatus(**kwargs)[source]¶

Bases: msrest.serialization.Model

Defines the response of a trigger subscription operation.

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

Variables

trigger_name (str) – Trigger name.
status (str or EventSubscriptionStatus) – Event Subscription Status. Possible values include: ‘Enabled’, ‘Provisioning’, ‘Deprovisioning’, ‘Disabled’, ‘Unknown’

class azure.mgmt.datafactory.models.TumblingWindowTrigger(*, pipeline, frequency, interval: int, start_time, max_concurrency: int, additional_properties=None, description: str = None, annotations=None, end_time=None, delay=None, retry_policy=None, depends_on=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Trigger

Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Trigger description.
annotations (list[object]) – List of tags that can be used for describing the trigger.
type (str) – Required. Constant filled by server.
pipeline (TriggerPipelineReference) – Required. Pipeline for which runs are created when an event is fired for trigger window that is ready.
frequency (str or TumblingWindowFrequency) – Required. The frequency of the time windows. Possible values include: ‘Minute’, ‘Hour’
interval (int) – Required. The interval of the time windows. The minimum interval allowed is 15 Minutes.
start_time (datetime) – Required. The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.
end_time (datetime) – The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.
delay (object) – Specifies how long the trigger waits past due time before triggering new run. It doesn’t alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
max_concurrency (int) – Required. The max number of parallel time windows (ready for execution) for which a new run is triggered.
retry_policy (RetryPolicy) – Retry policy that will be applied for failed pipeline runs.
depends_on (list[DependencyReference]) – Triggers that this trigger depends on. Only tumbling window triggers are supported.

Variables

runtime_state (str or TriggerRuntimeState) – Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: ‘Started’, ‘Stopped’, ‘Disabled’

class azure.mgmt.datafactory.models.TumblingWindowTriggerDependencyReference(*, reference_trigger, offset: str = None, size: str = None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TriggerDependencyReference

Referenced tumbling window trigger dependency.

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

Parameters

type (str) – Required. Constant filled by server.
reference_trigger (TriggerReference) – Required. Referenced trigger.
offset (str) – Timespan applied to the start time of a tumbling window when evaluating dependency.
size (str) – The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.

class azure.mgmt.datafactory.models.UntilActivity(*, name: str, expression, activities, additional_properties=None, description: str = None, depends_on=None, user_properties=None, timeout=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
expression (Expression) – Required. An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true
timeout (object) – Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
activities (list[Activity]) – Required. List of activities to execute.

class azure.mgmt.datafactory.models.UpdateIntegrationRuntimeNodeRequest(*, concurrent_jobs_limit: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Update integration runtime node request.

Parameters: concurrent_jobs_limit (int) – The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.

class azure.mgmt.datafactory.models.UpdateIntegrationRuntimeRequest(*, auto_update=None, update_delay_offset: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Update integration runtime request.

Parameters

auto_update (str or IntegrationRuntimeAutoUpdate) – Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189. Possible values include: ‘On’, ‘Off’
update_delay_offset (str) – The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time.

class azure.mgmt.datafactory.models.UserAccessPolicy(*, permissions: str = None, access_resource_path: str = None, profile_name: str = None, start_time: str = None, expire_time: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Get Data Plane read only token request definition.

Parameters

permissions (str) – The string with permissions for Data Plane access. Currently only ‘r’ is supported which grants read only access.
access_resource_path (str) – The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource.
profile_name (str) – The name of the profile. Currently only the default is supported. The default value is DefaultProfile.
start_time (str) – Start time for the token. If not specified the current time will be used.
expire_time (str) – Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours.

class azure.mgmt.datafactory.models.UserProperty(*, name: str, value, **kwargs)[source]¶

Bases: msrest.serialization.Model

User property.

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

Parameters

name (str) – Required. User property name.
value (object) – Required. User property value. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ValidationActivity(*, name: str, dataset, additional_properties=None, description: str = None, depends_on=None, user_properties=None, timeout=None, sleep=None, minimum_size=None, child_items=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

This activity verifies that an external resource exists.

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
timeout (object) – Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
sleep (object) – A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer).
minimum_size (object) – Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer).
child_items (object) – Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean).
dataset (DatasetReference) – Required. Validation activity dataset reference.

class azure.mgmt.datafactory.models.VariableSpecification(*, type, default_value=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Definition of a single variable for a Pipeline.

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

Parameters

type (str or VariableType) – Required. Variable type. Possible values include: ‘String’, ‘Bool’, ‘Array’
default_value (object) – Default value of variable.

class azure.mgmt.datafactory.models.VerticaLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_string=None, pwd=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Vertica 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_string (object) – An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
pwd (AzureKeyVaultSecretReference) – The Azure key vault secret reference of password in connection 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).

class azure.mgmt.datafactory.models.VerticaSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Vertica 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.VerticaTableDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, table=None, vertica_table_dataset_schema=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Vertica 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – This property will be retired. Please consider using schema + table properties instead.
table (object) – The table name of the Vertica. Type: string (or Expression with resultType string).
vertica_table_dataset_schema (object) – The schema name of the Vertica. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.WaitActivity(*, name: str, wait_time_in_seconds, additional_properties=None, description: str = None, depends_on=None, user_properties=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

This activity suspends pipeline execution for the specified interval.

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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
wait_time_in_seconds (object) – Required. Duration in seconds.

class azure.mgmt.datafactory.models.WebActivity(*, name: str, method, url, additional_properties=None, description: str = None, depends_on=None, user_properties=None, linked_service_name=None, policy=None, headers=None, body=None, authentication=None, datasets=None, linked_services=None, connect_via=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ExecutionActivity

Web 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 this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
method (str or WebActivityMethod) – Required. Rest API method for target endpoint. Possible values include: ‘GET’, ‘POST’, ‘PUT’, ‘DELETE’
url (object) – Required. Web activity target endpoint and path. 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).
authentication (WebActivityAuthentication) – Authentication method used for calling the endpoint.
datasets (list[DatasetReference]) – List of datasets passed to web endpoint.
linked_services (list[LinkedServiceReference]) – List of linked services passed to web endpoint.
connect_via (IntegrationRuntimeReference) – The integration runtime reference.

class azure.mgmt.datafactory.models.WebActivityAuthentication(*, type: str, pfx=None, username: str = None, password=None, resource: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Web activity authentication properties.

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

Parameters

type (str) – Required. Web activity authentication (Basic/ClientCertificate/MSI)
pfx (SecretBase) – Base64-encoded contents of a PFX file.
username (str) – Web activity authentication user name for basic authentication.
password (SecretBase) – Password for the PFX file or basic authentication.
resource (str) – Resource for which Azure Auth token will be requested when using MSI Authentication.

class azure.mgmt.datafactory.models.WebAnonymousAuthentication(*, url, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.WebLinkedServiceTypeProperties

A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.

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

Parameters

url (object) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).
authentication_type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.WebBasicAuthentication(*, url, username, password, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.WebLinkedServiceTypeProperties

A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.

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

Parameters

url (object) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).
authentication_type (str) – Required. Constant filled by server.
username (object) – Required. User name for Basic authentication. Type: string (or Expression with resultType string).
password (SecretBase) – Required. The password for Basic authentication.

class azure.mgmt.datafactory.models.WebClientCertificateAuthentication(*, url, pfx, password, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.WebLinkedServiceTypeProperties

A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.

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

Parameters

url (object) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).
authentication_type (str) – Required. Constant filled by server.
pfx (SecretBase) – Required. Base64-encoded contents of a PFX file.
password (SecretBase) – Required. Password for the PFX file.

class azure.mgmt.datafactory.models.WebHookActivity(*, name: str, url, additional_properties=None, description: str = None, depends_on=None, user_properties=None, timeout: str = None, headers=None, body=None, authentication=None, report_status_on_call_back=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.ControlActivity

WebHook activity.

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

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

Parameters

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Required. Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
user_properties (list[UserProperty]) – Activity user properties.
type (str) – Required. Constant filled by server.
url (object) – Required. WebHook activity target endpoint and path. Type: string (or Expression with resultType string).
timeout (str) – The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
headers (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).
authentication (WebActivityAuthentication) – Authentication method used for calling the endpoint.
report_status_on_call_back (object) – When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).

Variables

method (str) – Required. Rest API method for target endpoint. Default value: “POST” .

method = 'POST'¶

class azure.mgmt.datafactory.models.WebLinkedService(*, type_properties, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Web 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 this collection
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.
type (str) – Required. Constant filled by server.
type_properties (WebLinkedServiceTypeProperties) – Required. Web linked service properties.

class azure.mgmt.datafactory.models.WebLinkedServiceTypeProperties(*, url, **kwargs)[source]¶

Bases: msrest.serialization.Model

Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: WebClientCertificateAuthentication, WebBasicAuthentication, WebAnonymousAuthentication

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

Parameters

url (object) – Required. The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).
authentication_type (str) – Required. Constant filled by server.

class azure.mgmt.datafactory.models.WebSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity source for web page table.

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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.WebTableDataset(*, linked_service_name, index, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, path=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

The dataset points to a HTML table in the web page.

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 this collection
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.
type (str) – Required. Constant filled by server.
index (object) – Required. The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0.
path (object) – The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.XeroLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_properties=None, host=None, consumer_key=None, private_key=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Xero 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_properties (object) – Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object.
host (object) – The endpoint of the Xero server. (i.e. api.xero.com)
consumer_key (SecretBase) – The consumer key associated with the Xero application.
private_key (SecretBase) – The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings( ).
use_encrypted_endpoints (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).

class azure.mgmt.datafactory.models.XeroObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Xero 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.XeroSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Xero 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.XmlDataset(*, linked_service_name, location, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, encoding_name=None, null_value=None, compression=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Xml 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 this collection
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.
type (str) – Required. Constant filled by server.
location (DatasetLocation) – Required. The location of the json data storage.
encoding_name (object) – The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
null_value (object) – The null value string. Type: string (or Expression with resultType string).
compression (DatasetCompression) – The data compression method used for the json dataset.

class azure.mgmt.datafactory.models.XmlReadSettings(*, additional_properties=None, compression_properties=None, validation_mode=None, detect_data_type=None, namespaces=None, namespace_prefixes=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.FormatReadSettings

Xml 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 this collection
type (str) – Required. Constant filled by server.
compression_properties (CompressionReadSettings) – Compression settings.
validation_mode (object) – Indicates what validation method is used when reading the xml files. Allowed values: ‘none’, ‘xsd’, or ‘dtd’. Type: string (or Expression with resultType string).
detect_data_type (object) – Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).
namespaces (object) – Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).
namespace_prefixes (object) – Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: “{“http://www.example.com/xml”:”prefix”}” Type: object (or Expression with resultType object).

class azure.mgmt.datafactory.models.XmlSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, store_settings=None, format_settings=None, additional_columns=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CopySource

A copy activity Xml 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 this collection
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).
type (str) – Required. Constant filled by server.
store_settings (StoreReadSettings) – Xml store settings.
format_settings (XmlReadSettings) – Xml format 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).

class azure.mgmt.datafactory.models.ZipDeflateReadSettings(*, additional_properties=None, preserve_zip_file_name_as_folder=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.CompressionReadSettings

The ZipDeflate compression 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 this collection
type (str) – Required. Constant filled by server.
preserve_zip_file_name_as_folder (object) – Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).

class azure.mgmt.datafactory.models.ZohoLinkedService(*, additional_properties=None, connect_via=None, description: str = None, parameters=None, annotations=None, connection_properties=None, endpoint=None, access_token=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.LinkedService

Zoho server 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 this collection
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.
type (str) – Required. Constant filled by server.
connection_properties (object) – Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object.
endpoint (object) – The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)
access_token (SecretBase) – The access token for Zoho authentication.
use_encrypted_endpoints (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).

class azure.mgmt.datafactory.models.ZohoObjectDataset(*, linked_service_name, additional_properties=None, description: str = None, structure=None, schema=None, parameters=None, annotations=None, folder=None, table_name=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.Dataset

Zoho 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 this collection
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.
type (str) – Required. Constant filled by server.
table_name (object) – The table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ZohoSource(*, additional_properties=None, source_retry_count=None, source_retry_wait=None, max_concurrent_connections=None, query_timeout=None, additional_columns=None, query=None, **kwargs)[source]¶

Bases: azure.mgmt.datafactory.models._models_py3.TabularSource

A copy activity Zoho server 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 this collection
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).
type (str) – Required. Constant filled by server.
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).

class azure.mgmt.datafactory.models.OperationPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.FactoryPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Factory object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.IntegrationRuntimeResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of IntegrationRuntimeResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.LinkedServiceResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of LinkedServiceResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.DatasetResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of DatasetResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.PipelineResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of PipelineResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.TriggerResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of TriggerResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.DataFlowResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of DataFlowResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.DataFlowDebugSessionInfoPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of DataFlowDebugSessionInfo object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.ManagedVirtualNetworkResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ManagedVirtualNetworkResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.ManagedPrivateEndpointResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ManagedPrivateEndpointResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.datafactory.models.GlobalParameterType[source]¶

Bases: str, enum.Enum

An enumeration.

array = 'Array'¶

bool_enum = 'Bool'¶

float_enum = 'Float'¶

int_enum = 'Int'¶

object_enum = 'Object'¶

string = 'String'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeState[source]¶

Bases: str, enum.Enum

An enumeration.

access_denied = 'AccessDenied'¶

initial = 'Initial'¶

limited = 'Limited'¶

need_registration = 'NeedRegistration'¶

offline = 'Offline'¶

online = 'Online'¶

started = 'Started'¶

starting = 'Starting'¶

stopped = 'Stopped'¶

stopping = 'Stopping'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeAutoUpdate[source]¶

Bases: str, enum.Enum

An enumeration.

off = 'Off'¶

on = 'On'¶

class azure.mgmt.datafactory.models.ParameterType[source]¶

Bases: str, enum.Enum

An enumeration.

array = 'Array'¶

bool_enum = 'Bool'¶

float_enum = 'Float'¶

int_enum = 'Int'¶

object_enum = 'Object'¶

secure_string = 'SecureString'¶

string = 'String'¶

class azure.mgmt.datafactory.models.DependencyCondition[source]¶

Bases: str, enum.Enum

An enumeration.

completed = 'Completed'¶

failed = 'Failed'¶

skipped = 'Skipped'¶

succeeded = 'Succeeded'¶

class azure.mgmt.datafactory.models.VariableType[source]¶

Bases: str, enum.Enum

An enumeration.

array = 'Array'¶

bool_enum = 'Bool'¶

string = 'String'¶

class azure.mgmt.datafactory.models.TriggerRuntimeState[source]¶

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'¶

started = 'Started'¶

stopped = 'Stopped'¶

class azure.mgmt.datafactory.models.EventSubscriptionStatus[source]¶

Bases: str, enum.Enum

An enumeration.

deprovisioning = 'Deprovisioning'¶

disabled = 'Disabled'¶

enabled = 'Enabled'¶

provisioning = 'Provisioning'¶

unknown = 'Unknown'¶

class azure.mgmt.datafactory.models.RunQueryFilterOperand[source]¶

Bases: str, enum.Enum

An enumeration.

activity_name = 'ActivityName'¶

activity_run_end = 'ActivityRunEnd'¶

activity_run_start = 'ActivityRunStart'¶

activity_type = 'ActivityType'¶

latest_only = 'LatestOnly'¶

pipeline_name = 'PipelineName'¶

run_end = 'RunEnd'¶

run_group_id = 'RunGroupId'¶

run_start = 'RunStart'¶

status = 'Status'¶

trigger_name = 'TriggerName'¶

trigger_run_timestamp = 'TriggerRunTimestamp'¶

class azure.mgmt.datafactory.models.RunQueryFilterOperator[source]¶

Bases: str, enum.Enum

An enumeration.

equals = 'Equals'¶

in_enum = 'In'¶

not_equals = 'NotEquals'¶

not_in = 'NotIn'¶

class azure.mgmt.datafactory.models.RunQueryOrderByField[source]¶

Bases: str, enum.Enum

An enumeration.

activity_name = 'ActivityName'¶

activity_run_end = 'ActivityRunEnd'¶

activity_run_start = 'ActivityRunStart'¶

pipeline_name = 'PipelineName'¶

run_end = 'RunEnd'¶

run_start = 'RunStart'¶

status = 'Status'¶

trigger_name = 'TriggerName'¶

trigger_run_timestamp = 'TriggerRunTimestamp'¶

class azure.mgmt.datafactory.models.RunQueryOrder[source]¶

Bases: str, enum.Enum

An enumeration.

asc = 'ASC'¶

desc = 'DESC'¶

class azure.mgmt.datafactory.models.TriggerRunStatus[source]¶

Bases: str, enum.Enum

An enumeration.

failed = 'Failed'¶

inprogress = 'Inprogress'¶

succeeded = 'Succeeded'¶

class azure.mgmt.datafactory.models.DataFlowDebugCommandType[source]¶

Bases: str, enum.Enum

An enumeration.

execute_expression_query = 'executeExpressionQuery'¶

execute_preview_query = 'executePreviewQuery'¶

execute_statistics_query = 'executeStatisticsQuery'¶

class azure.mgmt.datafactory.models.GoogleAdWordsAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

service_authentication = 'ServiceAuthentication'¶

user_authentication = 'UserAuthentication'¶

class azure.mgmt.datafactory.models.SparkServerType[source]¶

Bases: str, enum.Enum

An enumeration.

shark_server = 'SharkServer'¶

shark_server2 = 'SharkServer2'¶

spark_thrift_server = 'SparkThriftServer'¶

class azure.mgmt.datafactory.models.SparkThriftTransportProtocol[source]¶

Bases: str, enum.Enum

An enumeration.

binary = 'Binary'¶

http = 'HTTP '¶

sasl = 'SASL'¶

class azure.mgmt.datafactory.models.SparkAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

username = 'Username'¶

username_and_password = 'UsernameAndPassword'¶

windows_azure_hd_insight_service = 'WindowsAzureHDInsightService'¶

class azure.mgmt.datafactory.models.ServiceNowAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

oauth2 = 'OAuth2'¶

class azure.mgmt.datafactory.models.PrestoAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

ldap = 'LDAP'¶

class azure.mgmt.datafactory.models.PhoenixAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

username_and_password = 'UsernameAndPassword'¶

windows_azure_hd_insight_service = 'WindowsAzureHDInsightService'¶

class azure.mgmt.datafactory.models.ImpalaAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

sasl_username = 'SASLUsername'¶

username_and_password = 'UsernameAndPassword'¶

class azure.mgmt.datafactory.models.HiveServerType[source]¶

Bases: str, enum.Enum

An enumeration.

hive_server1 = 'HiveServer1'¶

hive_server2 = 'HiveServer2'¶

hive_thrift_server = 'HiveThriftServer'¶

class azure.mgmt.datafactory.models.HiveThriftTransportProtocol[source]¶

Bases: str, enum.Enum

An enumeration.

binary = 'Binary'¶

http = 'HTTP '¶

sasl = 'SASL'¶

class azure.mgmt.datafactory.models.HiveAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

username = 'Username'¶

username_and_password = 'UsernameAndPassword'¶

windows_azure_hd_insight_service = 'WindowsAzureHDInsightService'¶

class azure.mgmt.datafactory.models.HBaseAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

basic = 'Basic'¶

class azure.mgmt.datafactory.models.GoogleBigQueryAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

service_authentication = 'ServiceAuthentication'¶

user_authentication = 'UserAuthentication'¶

class azure.mgmt.datafactory.models.SapHanaAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

windows = 'Windows'¶

class azure.mgmt.datafactory.models.SftpAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

ssh_public_key = 'SshPublicKey'¶

class azure.mgmt.datafactory.models.FtpAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

basic = 'Basic'¶

class azure.mgmt.datafactory.models.HttpAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

basic = 'Basic'¶

client_certificate = 'ClientCertificate'¶

digest = 'Digest'¶

windows = 'Windows'¶

class azure.mgmt.datafactory.models.RestServiceAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

aad_service_principal = 'AadServicePrincipal'¶

anonymous = 'Anonymous'¶

basic = 'Basic'¶

managed_service_identity = 'ManagedServiceIdentity'¶

class azure.mgmt.datafactory.models.MongoDbAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

basic = 'Basic'¶

class azure.mgmt.datafactory.models.ODataAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

aad_service_principal = 'AadServicePrincipal'¶

anonymous = 'Anonymous'¶

basic = 'Basic'¶

managed_service_identity = 'ManagedServiceIdentity'¶

windows = 'Windows'¶

class azure.mgmt.datafactory.models.ODataAadServicePrincipalCredentialType[source]¶

Bases: str, enum.Enum

An enumeration.

service_principal_cert = 'ServicePrincipalCert'¶

service_principal_key = 'ServicePrincipalKey'¶

class azure.mgmt.datafactory.models.TeradataAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

windows = 'Windows'¶

class azure.mgmt.datafactory.models.Db2AuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

class azure.mgmt.datafactory.models.SybaseAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

windows = 'Windows'¶

class azure.mgmt.datafactory.models.DynamicsDeploymentType[source]¶

Bases: str, enum.Enum

An enumeration.

on_premises_with_ifd = 'OnPremisesWithIfd'¶

online = 'Online'¶

class azure.mgmt.datafactory.models.DynamicsAuthenticationType[source]¶

Bases: str, enum.Enum

An enumeration.

aad_service_principal = 'AADServicePrincipal'¶

ifd = 'Ifd'¶

office365 = 'Office365'¶

class azure.mgmt.datafactory.models.OrcCompressionCodec[source]¶

Bases: str, enum.Enum

An enumeration.

none = 'none'¶

snappy = 'snappy'¶

zlib = 'zlib'¶

class azure.mgmt.datafactory.models.AvroCompressionCodec[source]¶

Bases: str, enum.Enum

An enumeration.

bzip2 = 'bzip2'¶

deflate = 'deflate'¶

none = 'none'¶

snappy = 'snappy'¶

xz = 'xz'¶

class azure.mgmt.datafactory.models.TumblingWindowFrequency[source]¶

Bases: str, enum.Enum

An enumeration.

hour = 'Hour'¶

minute = 'Minute'¶

class azure.mgmt.datafactory.models.BlobEventTypes[source]¶

Bases: str, enum.Enum

An enumeration.

microsoft_storage_blob_created = 'Microsoft.Storage.BlobCreated'¶

microsoft_storage_blob_deleted = 'Microsoft.Storage.BlobDeleted'¶

class azure.mgmt.datafactory.models.DayOfWeek[source]¶

Bases: str, enum.Enum

An enumeration.

friday = 'Friday'¶

monday = 'Monday'¶

saturday = 'Saturday'¶

sunday = 'Sunday'¶

thursday = 'Thursday'¶

tuesday = 'Tuesday'¶

wednesday = 'Wednesday'¶

class azure.mgmt.datafactory.models.DaysOfWeek[source]¶

Bases: str, enum.Enum

An enumeration.

friday = 'Friday'¶

monday = 'Monday'¶

saturday = 'Saturday'¶

sunday = 'Sunday'¶

thursday = 'Thursday'¶

tuesday = 'Tuesday'¶

wednesday = 'Wednesday'¶

class azure.mgmt.datafactory.models.RecurrenceFrequency[source]¶

Bases: str, enum.Enum

An enumeration.

day = 'Day'¶

hour = 'Hour'¶

minute = 'Minute'¶

month = 'Month'¶

not_specified = 'NotSpecified'¶

week = 'Week'¶

year = 'Year'¶

class azure.mgmt.datafactory.models.DataFlowComputeType[source]¶

Bases: str, enum.Enum

An enumeration.

compute_optimized = 'ComputeOptimized'¶

general = 'General'¶

memory_optimized = 'MemoryOptimized'¶

class azure.mgmt.datafactory.models.AzureFunctionActivityMethod[source]¶

Bases: str, enum.Enum

An enumeration.

delete = 'DELETE'¶

get = 'GET'¶

head = 'HEAD'¶

options = 'OPTIONS'¶

post = 'POST'¶

put = 'PUT'¶

trace = 'TRACE'¶

class azure.mgmt.datafactory.models.WebActivityMethod[source]¶

Bases: str, enum.Enum

An enumeration.

delete = 'DELETE'¶

get = 'GET'¶

post = 'POST'¶

put = 'PUT'¶

class azure.mgmt.datafactory.models.OraclePartitionOption[source]¶

Bases: str, enum.Enum

An enumeration.

dynamic_range = 'DynamicRange'¶

none = 'None'¶

physical_partitions_of_table = 'PhysicalPartitionsOfTable'¶

class azure.mgmt.datafactory.models.SalesforceSourceReadBehavior[source]¶

Bases: str, enum.Enum

An enumeration.

query = 'Query'¶

query_all = 'QueryAll'¶

class azure.mgmt.datafactory.models.NetezzaPartitionOption[source]¶

Bases: str, enum.Enum

An enumeration.

data_slice = 'DataSlice'¶

dynamic_range = 'DynamicRange'¶

none = 'None'¶

class azure.mgmt.datafactory.models.CassandraSourceReadConsistencyLevels[source]¶

Bases: str, enum.Enum

An enumeration.

all = 'ALL'¶

each_quorum = 'EACH_QUORUM'¶

local_one = 'LOCAL_ONE'¶

local_quorum = 'LOCAL_QUORUM'¶

local_serial = 'LOCAL_SERIAL'¶

one = 'ONE'¶

quorum = 'QUORUM'¶

serial = 'SERIAL'¶

three = 'THREE'¶

two = 'TWO'¶

class azure.mgmt.datafactory.models.TeradataPartitionOption[source]¶

Bases: str, enum.Enum

An enumeration.

dynamic_range = 'DynamicRange'¶

hash = 'Hash'¶

none = 'None'¶

class azure.mgmt.datafactory.models.SqlPartitionOption[source]¶

Bases: str, enum.Enum

An enumeration.

dynamic_range = 'DynamicRange'¶

none = 'None'¶

physical_partitions_of_table = 'PhysicalPartitionsOfTable'¶

class azure.mgmt.datafactory.models.StoredProcedureParameterType[source]¶

Bases: str, enum.Enum

An enumeration.

boolean = 'Boolean'¶

date_enum = 'Date'¶

decimal_enum = 'Decimal'¶

guid = 'Guid'¶

int64 = 'Int64'¶

int_enum = 'Int'¶

string = 'String'¶

class azure.mgmt.datafactory.models.SapTablePartitionOption[source]¶

Bases: str, enum.Enum

An enumeration.

none = 'None'¶

partition_on_calendar_date = 'PartitionOnCalendarDate'¶

partition_on_calendar_month = 'PartitionOnCalendarMonth'¶

partition_on_calendar_year = 'PartitionOnCalendarYear'¶

partition_on_int = 'PartitionOnInt'¶

partition_on_time = 'PartitionOnTime'¶

class azure.mgmt.datafactory.models.SapHanaPartitionOption[source]¶

Bases: str, enum.Enum

An enumeration.

none = 'None'¶

physical_partitions_of_table = 'PhysicalPartitionsOfTable'¶

sap_hana_dynamic_range = 'SapHanaDynamicRange'¶

class azure.mgmt.datafactory.models.SsisPackageLocationType[source]¶

Bases: str, enum.Enum

An enumeration.

file = 'File'¶

inline_package = 'InlinePackage'¶

package_store = 'PackageStore'¶

ssisdb = 'SSISDB'¶

class azure.mgmt.datafactory.models.HDInsightActivityDebugInfoOption[source]¶

Bases: str, enum.Enum

An enumeration.

always = 'Always'¶

failure = 'Failure'¶

none = 'None'¶

class azure.mgmt.datafactory.models.SalesforceSinkWriteBehavior[source]¶

Bases: str, enum.Enum

An enumeration.

insert = 'Insert'¶

upsert = 'Upsert'¶

class azure.mgmt.datafactory.models.AzureSearchIndexWriteBehaviorType[source]¶

Bases: str, enum.Enum

An enumeration.

merge = 'Merge'¶

upload = 'Upload'¶

class azure.mgmt.datafactory.models.PolybaseSettingsRejectType[source]¶

Bases: str, enum.Enum

An enumeration.

percentage = 'percentage'¶

value = 'value'¶

class azure.mgmt.datafactory.models.JsonWriteFilePattern[source]¶

Bases: str, enum.Enum

An enumeration.

array_of_objects = 'arrayOfObjects'¶

set_of_objects = 'setOfObjects'¶

class azure.mgmt.datafactory.models.SapCloudForCustomerSinkWriteBehavior[source]¶

Bases: str, enum.Enum

An enumeration.

insert = 'Insert'¶

update = 'Update'¶

class azure.mgmt.datafactory.models.WebHookActivityMethod[source]¶

Bases: str, enum.Enum

An enumeration.

post = 'POST'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeType[source]¶

Bases: str, enum.Enum

An enumeration.

managed = 'Managed'¶

self_hosted = 'SelfHosted'¶

class azure.mgmt.datafactory.models.SelfHostedIntegrationRuntimeNodeStatus[source]¶

Bases: str, enum.Enum

An enumeration.

initialize_failed = 'InitializeFailed'¶

initializing = 'Initializing'¶

limited = 'Limited'¶

need_registration = 'NeedRegistration'¶

offline = 'Offline'¶

online = 'Online'¶

upgrading = 'Upgrading'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeUpdateResult[source]¶

Bases: str, enum.Enum

An enumeration.

fail = 'Fail'¶

none = 'None'¶

succeed = 'Succeed'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeInternalChannelEncryptionMode[source]¶

Bases: str, enum.Enum

An enumeration.

not_encrypted = 'NotEncrypted'¶

not_set = 'NotSet'¶

ssl_encrypted = 'SslEncrypted'¶

class azure.mgmt.datafactory.models.ManagedIntegrationRuntimeNodeStatus[source]¶

Bases: str, enum.Enum

An enumeration.

available = 'Available'¶

recycling = 'Recycling'¶

starting = 'Starting'¶

unavailable = 'Unavailable'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeEntityReferenceType[source]¶

Bases: str, enum.Enum

An enumeration.

integration_runtime_reference = 'IntegrationRuntimeReference'¶

linked_service_reference = 'LinkedServiceReference'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeSsisCatalogPricingTier[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

premium = 'Premium'¶

premium_rs = 'PremiumRS'¶

standard = 'Standard'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeLicenseType[source]¶

Bases: str, enum.Enum

An enumeration.

base_price = 'BasePrice'¶

license_included = 'LicenseIncluded'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeEdition[source]¶

Bases: str, enum.Enum

An enumeration.

enterprise = 'Enterprise'¶

standard = 'Standard'¶

class azure.mgmt.datafactory.models.SsisObjectMetadataType[source]¶

Bases: str, enum.Enum

An enumeration.

environment = 'Environment'¶

folder = 'Folder'¶

package = 'Package'¶

project = 'Project'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeAuthKeyName[source]¶

Bases: str, enum.Enum

An enumeration.

auth_key1 = 'authKey1'¶

auth_key2 = 'authKey2'¶