azure.mgmt.datafactory.models module¶

class azure.mgmt.datafactory.models.Resource(location=None, tags=None)[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.
Parameters:	location (str) – The resource location. tags (dict[str, str]) – The resource tags.

class azure.mgmt.datafactory.models.SubResource[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.Expression(value)[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.

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

type = 'Expression'¶

class azure.mgmt.datafactory.models.SecureString(value)[source]¶

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

Azure Data Factory secure string definition. The string value will be masked with asterisks ‘*’ during Get or List API calls.

Parameters:	type (str) – Constant filled by server. value (str) – Value of secure string.

class azure.mgmt.datafactory.models.LinkedServiceReference(reference_name, parameters=None)[source]¶

Bases: msrest.serialization.Model

Linked service reference type.

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

Variables:	type (str) – Linked service reference type. Default value: “LinkedServiceReference” .
Parameters:	reference_name (str) – Reference LinkedService name. parameters (dict[str, object]) – Arguments for LinkedService.

type = 'LinkedServiceReference'¶

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

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

Azure Key Vault secret reference.

Parameters:

type (str) – Constant filled by server.
store (LinkedServiceReference) – The Azure Key Vault linked service reference.
secret_name (object) – 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.SecretBase[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

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

class azure.mgmt.datafactory.models.FactoryIdentity[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.

Variables:	type (str) – 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.Factory(location=None, tags=None, additional_properties=None, identity=None)[source]¶

Bases: azure.mgmt.datafactory.models.resource.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. 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.

class azure.mgmt.datafactory.models.IntegrationRuntime(additional_properties=None, description=None)[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

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection description (str) – Integration runtime description. type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.IntegrationRuntimeResource(properties)[source]¶

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

Integration runtime 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:	properties (IntegrationRuntime) – Integration runtime properties.

class azure.mgmt.datafactory.models.IntegrationRuntimeReference(reference_name, parameters=None)[source]¶

Bases: msrest.serialization.Model

Integration runtime reference type.

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

Variables:	type (str) – Type of integration runtime. Default value: “IntegrationRuntimeReference” .
Parameters:	reference_name (str) – Reference integration runtime name. parameters (dict[str, object]) – Arguments for integration runtime.

type = 'IntegrationRuntimeReference'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeStatus(additional_properties=None)[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.

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection type (str) – 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’

class azure.mgmt.datafactory.models.IntegrationRuntimeStatusResponse(properties)[source]¶

Bases: msrest.serialization.Model

Integration runtime status response.

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

Variables:	name (str) – The integration runtime name.
Parameters:	properties (IntegrationRuntimeStatus) – Integration runtime properties.

class azure.mgmt.datafactory.models.IntegrationRuntimeStatusListResponse(value, next_link=None)[source]¶

Bases: msrest.serialization.Model

A list of integration runtime status.

Parameters:	value (list[IntegrationRuntimeStatusResponse]) – 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.UpdateIntegrationRuntimeRequest(auto_update=None, update_delay_offset=None)[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.UpdateIntegrationRuntimeNodeRequest(concurrent_jobs_limit=None)[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.ParameterSpecification(type, default_value=None)[source]¶

Bases: msrest.serialization.Model

Definition of a single parameter for an entity.

Parameters:	type (str or ParameterType) – Parameter type. Possible values include: ‘Object’, ‘String’, ‘Int’, ‘Float’, ‘Bool’, ‘Array’, ‘SecureString’ default_value (object) – Default value of parameter.

class azure.mgmt.datafactory.models.LinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None)[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: AzureDatabricksLinkedService, AzureDataLakeAnalyticsLinkedService, HDInsightOnDemandLinkedService, SalesforceMarketingCloudLinkedService, NetezzaLinkedService, VerticaLinkedService, ZohoLinkedService, XeroLinkedService, SquareLinkedService, SparkLinkedService, ShopifyLinkedService, ServiceNowLinkedService, QuickBooksLinkedService, PrestoLinkedService, PhoenixLinkedService, PaypalLinkedService, MarketoLinkedService, MariaDBLinkedService, MagentoLinkedService, JiraLinkedService, ImpalaLinkedService, HubspotLinkedService, HiveLinkedService, HBaseLinkedService, GreenplumLinkedService, GoogleBigQueryLinkedService, EloquaLinkedService, DrillLinkedService, CouchbaseLinkedService, ConcurLinkedService, AzurePostgreSqlLinkedService, AmazonMWSLinkedService, SapHanaLinkedService, SapBWLinkedService, SftpServerLinkedService, FtpServerLinkedService, HttpLinkedService, AzureSearchLinkedService, CustomDataSourceLinkedService, AmazonRedshiftLinkedService, AmazonS3LinkedService, SapEccLinkedService, SapCloudForCustomerLinkedService, SalesforceLinkedService, AzureDataLakeStoreLinkedService, MongoDbLinkedService, CassandraLinkedService, WebLinkedService, ODataLinkedService, HdfsLinkedService, OdbcLinkedService, AzureMLLinkedService, TeradataLinkedService, Db2LinkedService, SybaseLinkedService, PostgreSqlLinkedService, MySqlLinkedService, AzureMySqlLinkedService, OracleLinkedService, FileServerLinkedService, HDInsightLinkedService, DynamicsLinkedService, CosmosDbLinkedService, AzureKeyVaultLinkedService, AzureBatchLinkedService, AzureSqlDatabaseLinkedService, SqlServerLinkedService, AzureSqlDWLinkedService, AzureStorageLinkedService

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

class azure.mgmt.datafactory.models.LinkedServiceResource(properties)[source]¶

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

Linked service 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:	properties (LinkedService) – Properties of linked service.

class azure.mgmt.datafactory.models.Dataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[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: SalesforceMarketingCloudObjectDataset, VerticaTableDataset, NetezzaTableDataset, ZohoObjectDataset, XeroObjectDataset, SquareObjectDataset, SparkObjectDataset, ShopifyObjectDataset, ServiceNowObjectDataset, QuickBooksObjectDataset, PrestoObjectDataset, PhoenixObjectDataset, PaypalObjectDataset, MarketoObjectDataset, MariaDBTableDataset, MagentoObjectDataset, JiraObjectDataset, ImpalaObjectDataset, HubspotObjectDataset, HiveObjectDataset, HBaseObjectDataset, GreenplumTableDataset, GoogleBigQueryObjectDataset, EloquaObjectDataset, DrillTableDataset, CouchbaseTableDataset, ConcurObjectDataset, AzurePostgreSqlTableDataset, AmazonMWSObjectDataset, HttpDataset, AzureSearchIndexDataset, WebTableDataset, SqlServerTableDataset, SapEccResourceDataset, SapCloudForCustomerResourceDataset, SalesforceObjectDataset, RelationalTableDataset, AzureMySqlTableDataset, OracleTableDataset, ODataResourceDataset, MongoDbCollectionDataset, FileShareDataset, AzureDataLakeStoreDataset, DynamicsEntityDataset, DocumentDbCollectionDataset, CustomDataset, CassandraTableDataset, AzureSqlDWTableDataset, AzureSqlTableDataset, AzureTableDataset, AzureBlobDataset, AmazonS3Dataset

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

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

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

Dataset 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:	properties (Dataset) – Dataset properties.

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

Bases: msrest.serialization.Model

Activity dependency information.

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection activity (str) – Activity name. dependency_conditions (list[str or DependencyCondition]) – Match-Condition for the dependency.

class azure.mgmt.datafactory.models.Activity(name, additional_properties=None, description=None, depends_on=None)[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

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection name (str) – Activity name. description (str) – Activity description. depends_on (list[ActivityDependency]) – Activity depends on condition. type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.PipelineResource(additional_properties=None, description=None, activities=None, parameters=None, concurrency=None, annotations=None)[source]¶

Bases: azure.mgmt.datafactory.models.sub_resource.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.
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.

class azure.mgmt.datafactory.models.Trigger(additional_properties=None, description=None)[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: TumblingWindowTrigger, MultiplePipelineTrigger

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 description (str) – Trigger description. type (str) – 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.TriggerResource(properties)[source]¶

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

Trigger 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:	properties (Trigger) – Properties of the trigger.

class azure.mgmt.datafactory.models.CreateRunResponse(run_id)[source]¶

Bases: msrest.serialization.Model

Response body with a run identifier.

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

class azure.mgmt.datafactory.models.ErrorResponse(code, message, target=None, details=None)[source]¶

Bases: msrest.serialization.Model

The object that defines the structure of an Azure Data Factory response.

Parameters:	code (str) – Error code. message (str) – Error message. target (str) – Property name/path in request associated with error. details (list[ErrorResponse]) – Array with additional error details.

exception azure.mgmt.datafactory.models.ErrorResponseException(deserialize, response, *args)[source]¶

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters:	deserialize – A deserializer response – Server response to be deserialized.

class azure.mgmt.datafactory.models.PipelineReference(reference_name, name=None)[source]¶

Bases: msrest.serialization.Model

Pipeline reference type.

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

Variables:	type (str) – Pipeline reference type. Default value: “PipelineReference” .
Parameters:	reference_name (str) – Reference pipeline name. name (str) – Reference name.

type = 'PipelineReference'¶

class azure.mgmt.datafactory.models.TriggerPipelineReference(pipeline_reference=None, parameters=None)[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.FactoryUpdateParameters(tags=None, identity=None)[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.DatasetReference(reference_name, parameters=None)[source]¶

Bases: msrest.serialization.Model

Dataset reference type.

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

Variables:	type (str) – Dataset reference type. Default value: “DatasetReference” .
Parameters:	reference_name (str) – Reference dataset name. parameters (dict[str, object]) – Arguments for dataset.

type = 'DatasetReference'¶

class azure.mgmt.datafactory.models.PipelineRunQueryFilter(operand, operator, values)[source]¶

Bases: msrest.serialization.Model

Query filter option for listing pipeline runs.

Parameters:

operand (str or PipelineRunQueryFilterOperand) – Parameter name to be used for filter. Possible values include: ‘PipelineName’, ‘Status’, ‘RunStart’, ‘RunEnd’
operator (str or PipelineRunQueryFilterOperator) – Operator to be used for filter. Possible values include: ‘Equals’, ‘NotEquals’, ‘In’, ‘NotIn’
values (list[str]) – List of filter values.

class azure.mgmt.datafactory.models.PipelineRunQueryOrderBy(order_by, order)[source]¶

Bases: msrest.serialization.Model

An object to provide order by options for listing pipeline runs.

Parameters:	order_by (str or PipelineRunQueryOrderByField) – Parameter name to be used for order by. Possible values include: ‘RunStart’, ‘RunEnd’ order (str or PipelineRunQueryOrder) – Sorting order of the parameter. Possible values include: ‘ASC’, ‘DESC’

class azure.mgmt.datafactory.models.PipelineRunFilterParameters(last_updated_after, last_updated_before, continuation_token=None, filters=None, order_by=None)[source]¶

Bases: msrest.serialization.Model

Query parameters for listing pipeline runs.

Parameters:

continuation_token (str) – The continuation token for getting the next page of results. Null for first page.
last_updated_after (datetime) – The time at or after which the pipeline run event was updated in ‘ISO 8601’ format.
last_updated_before (datetime) – The time at or before which the pipeline run event was updated in ‘ISO 8601’ format.
filters (list[PipelineRunQueryFilter]) – List of filters.
order_by (list[PipelineRunQueryOrderBy]) – List of OrderBy option.

class azure.mgmt.datafactory.models.PipelineRunInvokedBy[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.

class azure.mgmt.datafactory.models.PipelineRun(additional_properties=None)[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.
pipeline_name (str) – The pipeline name.
parameters (dict[str, str]) – The full or partial list of parameter name, value pair used in the pipeline run.
invoked_by (PipelineRunInvokedBy) – Entity that started the pipeline run.
last_updated (datetime) – The last updated timestamp for the pipeline run event in ISO8601 format.
run_start (datetime) – The start time of a pipeline run in ISO8601 format.
run_end (datetime) – The end time of a pipeline run in ISO8601 format.
duration_in_ms (int) – The duration of a pipeline run.
status (str) – The status of a pipeline run.
message (str) – The message from a pipeline run.

class azure.mgmt.datafactory.models.PipelineRunQueryResponse(value, continuation_token=None)[source]¶

Bases: msrest.serialization.Model

A list pipeline runs.

Parameters:	value (list[PipelineRun]) – 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.ActivityRun(additional_properties=None)[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.TriggerRun(additional_properties=None)[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.

class azure.mgmt.datafactory.models.OperationDisplay(description=None, provider=None, resource=None, operation=None)[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=None, display_name=None, blob_duration=None)[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=None, blob_duration=None)[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.OperationMetricSpecification(name=None, display_name=None, display_description=None, unit=None, aggregation_type=None, enable_regional_mdm_account=None, source_mdm_account=None, source_mdm_namespace=None, availabilities=None)[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.

class azure.mgmt.datafactory.models.OperationServiceSpecification(log_specifications=None, metric_specifications=None)[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.Operation(name=None, origin=None, display=None, service_specification=None)[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.OperationListResponse(value=None, next_link=None)[source]¶

Bases: msrest.serialization.Model

A list of operations that can be performed by the Data Factory service.

Parameters:	value (list[Operation]) – List of Data Factory operations supported by the Data Factory resource provider. next_link (str) – The link to the next page of results, if any remaining results exist.

class azure.mgmt.datafactory.models.AzureDatabricksLinkedService(domain, access_token, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, existing_cluster_id=None, new_cluster_version=None, new_cluster_num_of_worker=None, new_cluster_node_type=None, new_cluster_spark_conf=None, encrypted_credential=None)[source]¶

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

Azure Databricks linked service.

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 Dataset.
type (str) – Constant filled by server.
domain (object) – <REGION>.azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).
access_token (SecretBase) – Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).
existing_cluster_id (object) – The id of an existing cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).
new_cluster_version (object) – The Spark version of new cluster. Type: string (or Expression with resultType string).
new_cluster_num_of_worker (object) – Number of worker nodes that new cluster should have. A string formatted Int32, like ‘1’ means numOfWorker is 1 or ‘1:10’ means auto-scale from 1 as min and 10 as max. Type: string (or Expression with resultType string).
new_cluster_node_type (object) – The node types of new cluster. 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.
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.AzureDataLakeAnalyticsLinkedService(account_name, tenant, additional_properties=None, connect_via=None, description=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)[source]¶

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

Azure Data Lake Analytics linked service.

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 Dataset.
type (str) – Constant filled by server.
account_name (object) – 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) – 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.HDInsightOnDemandLinkedService(cluster_size, time_to_live, version, linked_service_name, host_subscription_id, tenant, cluster_resource_group, additional_properties=None, connect_via=None, description=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)[source]¶

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

HDInsight ondemand linked service.

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 Dataset.
type (str) – Constant filled by server.
cluster_size (object) – Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).
time_to_live (object) – 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) – Version of the HDInsight cluster. Type: string (or Expression with resultType string).
linked_service_name (LinkedServiceReference) – Azure Storage linked service to be used by the on-demand cluster for storing and processing data.
host_subscription_id (object) – 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) – The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).
cluster_resource_group (object) – 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.

class azure.mgmt.datafactory.models.SalesforceMarketingCloudLinkedService(client_id, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, client_secret=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Salesforce Marketing Cloud linked service.

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 Dataset.
type (str) – Constant filled by server.
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.NetezzaLinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, connection_string=None, encrypted_credential=None)[source]¶

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

Netezza linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – An ODBC 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.VerticaLinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, connection_string=None, encrypted_credential=None)[source]¶

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

Vertica linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – An ODBC 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.ZohoLinkedService(endpoint, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, access_token=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Zoho server linked service.

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 Dataset.
type (str) – Constant filled by server.
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.XeroLinkedService(host, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, consumer_key=None, private_key=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Xero Serivce linked service.

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 Dataset.
type (str) – Constant filled by server.
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.SquareLinkedService(host, client_id, redirect_uri, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, client_secret=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Square Serivce linked service.

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 Dataset.
type (str) – Constant filled by server.
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.SparkLinkedService(host, port, authentication_type, additional_properties=None, connect_via=None, description=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)[source]¶

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

Spark Server linked service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – IP address or host name of the Spark server
port (object) – 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) – 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.ShopifyLinkedService(host, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, access_token=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Shopify Serivce linked service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – 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.ServiceNowLinkedService(endpoint, authentication_type, additional_properties=None, connect_via=None, description=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)[source]¶

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

ServiceNow server linked service.

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 Dataset.
type (str) – Constant filled by server.
endpoint (object) – The endpoint of the ServiceNow server. (i.e. ServiceNowData.com)
authentication_type (str or ServiceNowAuthenticationType) – 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.QuickBooksLinkedService(endpoint, company_id, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, access_token=None, access_token_secret=None, use_encrypted_endpoints=None, encrypted_credential=None)[source]¶

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

QuickBooks server linked service.

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 Dataset.
type (str) – Constant filled by server.
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.
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.PrestoLinkedService(host, server_version, catalog, authentication_type, additional_properties=None, connect_via=None, description=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)[source]¶

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

Presto server linked service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – The IP address or host name of the Presto server. (i.e. 192.168.222.160)
server_version (object) – The version of the Presto server. (i.e. 0.148-t)
catalog (object) – 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) – 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.PhoenixLinkedService(host, authentication_type, additional_properties=None, connect_via=None, description=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)[source]¶

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

Phoenix server linked service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – 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) – 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.PaypalLinkedService(host, client_id, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, client_secret=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Paypal Serivce linked service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)
client_id (object) – 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.MarketoLinkedService(endpoint, client_id, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, client_secret=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Marketo server linked service.

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 Dataset.
type (str) – Constant filled by server.
endpoint (object) – The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)
client_id (object) – 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.MariaDBLinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, connection_string=None, encrypted_credential=None)[source]¶

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

MariaDB server linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – An ODBC 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.MagentoLinkedService(host, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, access_token=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Magento server linked service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – 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.JiraLinkedService(host, username, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, port=None, password=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Jira Serivce linked service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – 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) – 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.ImpalaLinkedService(host, authentication_type, additional_properties=None, connect_via=None, description=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)[source]¶

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

Impala server linked service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – 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) – 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.HubspotLinkedService(client_id, additional_properties=None, connect_via=None, description=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)[source]¶

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

Hubspot Serivce linked service.

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 Dataset.
type (str) – Constant filled by server.
client_id (object) – 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.HiveLinkedService(host, authentication_type, additional_properties=None, connect_via=None, description=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)[source]¶

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

Hive Server linked service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – 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) – 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.HBaseLinkedService(host, authentication_type, additional_properties=None, connect_via=None, description=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)[source]¶

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

HBase server linked service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – 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) – 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.GreenplumLinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, connection_string=None, encrypted_credential=None)[source]¶

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

Greenplum Database linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – An ODBC 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.GoogleBigQueryLinkedService(project, authentication_type, additional_properties=None, connect_via=None, description=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)[source]¶

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

Google BigQuery service linked service.

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 Dataset.
type (str) – Constant filled by server.
project (object) – 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) – 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 (SecretBase) – The client id of the google application used to acquire the refresh token.
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.EloquaLinkedService(endpoint, username, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, password=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Eloqua server linked service.

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 Dataset.
type (str) – Constant filled by server.
endpoint (object) – The endpoint of the Eloqua server. (i.e. eloqua.example.com)
username (object) – 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.DrillLinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, connection_string=None, encrypted_credential=None)[source]¶

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

Drill server linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – An ODBC 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.CouchbaseLinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, connection_string=None, encrypted_credential=None)[source]¶

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

Couchbase server linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – An ODBC 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.ConcurLinkedService(client_id, username, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, password=None, use_encrypted_endpoints=None, use_host_verification=None, use_peer_verification=None, encrypted_credential=None)[source]¶

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

Concur Serivce linked service.

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 Dataset.
type (str) – Constant filled by server.
client_id (object) – Application client_id supplied by Concur App Management.
username (object) – 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.AzurePostgreSqlLinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, connection_string=None, encrypted_credential=None)[source]¶

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

Azure PostgreSQL linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – An ODBC 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.AmazonMWSLinkedService(endpoint, marketplace_id, seller_id, access_key_id, additional_properties=None, connect_via=None, description=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)[source]¶

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

Amazon Marketplace Web Service linked service.

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 Dataset.
type (str) – Constant filled by server.
endpoint (object) – The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)
marketplace_id (object) – The Amazon Marketplace ID you want to retrieve data from. To retrive data from multiple Marketplace IDs, seperate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)
seller_id (object) – The Amazon seller ID.
mws_auth_token (SecretBase) – The Amazon MWS authentication token.
access_key_id (object) – 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.SapHanaLinkedService(server, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, authentication_type=None, user_name=None, password=None, encrypted_credential=None)[source]¶

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

SAP HANA Linked Service.

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 Dataset.
type (str) – Constant filled by server.
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.SapBWLinkedService(server, system_number, client_id, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, user_name=None, password=None, encrypted_credential=None)[source]¶

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

SAP Business Warehouse Linked Service.

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 Dataset.
type (str) – Constant filled by server.
server (object) – Host name of the SAP BW instance. Type: string (or Expression with resultType string).
system_number (object) – 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) – 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.SftpServerLinkedService(host, additional_properties=None, connect_via=None, description=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)[source]¶

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

A linked service for an SSH File Transfer Protocol (SFTP) server. .

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 Dataset.
type (str) – Constant filled by server.
host (object) – 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.FtpServerLinkedService(host, additional_properties=None, connect_via=None, description=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)[source]¶

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

A FTP server Linked Service.

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 Dataset.
type (str) – Constant filled by server.
host (object) – 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.HttpLinkedService(url, additional_properties=None, connect_via=None, description=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)[source]¶

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

Linked service for an HTTP source.

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 Dataset.
type (str) – Constant filled by server.
url (object) – 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.AzureSearchLinkedService(url, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, key=None, encrypted_credential=None)[source]¶

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

Linked service for Windows Azure Search Service.

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 Dataset.
type (str) – Constant filled by server.
url (object) – 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.CustomDataSourceLinkedService(type_properties, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None)[source]¶

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

Custom linked service.

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

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

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

Linked service for Amazon Redshift.

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 Dataset.
type (str) – Constant filled by server.
server (object) – 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) – 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.AmazonS3LinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, access_key_id=None, secret_access_key=None, encrypted_credential=None)[source]¶

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

Linked service for Amazon S3.

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 Dataset.
type (str) – 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.
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.SapEccLinkedService(url, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, username=None, password=None, encrypted_credential=None)[source]¶

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

Linked service for SAP ERP Central Component(SAP ECC).

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 Dataset.
type (str) – Constant filled by server.
url (str) – 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.SapCloudForCustomerLinkedService(url, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, username=None, password=None, encrypted_credential=None)[source]¶

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

Linked service for SAP Cloud for Customer.

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 Dataset.
type (str) – Constant filled by server.
url (object) – 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.SalesforceLinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, environment_url=None, username=None, password=None, security_token=None, encrypted_credential=None)[source]¶

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

Linked service for Salesforce.

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 Dataset.
type (str) – 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 required to remotely access Salesforce instance.
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.AzureDataLakeStoreLinkedService(data_lake_store_uri, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, service_principal_id=None, service_principal_key=None, tenant=None, account_name=None, subscription_id=None, resource_group_name=None, encrypted_credential=None)[source]¶

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

Azure Data Lake Store linked service.

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 Dataset.
type (str) – Constant filled by server.
data_lake_store_uri (object) – 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).
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.MongoDbLinkedService(server, database_name, additional_properties=None, connect_via=None, description=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)[source]¶

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

Linked service for MongoDb data source.

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 Dataset.
type (str) – Constant filled by server.
server (object) – 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) – 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.CassandraLinkedService(host, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, authentication_type=None, port=None, username=None, password=None, encrypted_credential=None)[source]¶

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

Linked service for Cassandra data source.

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 Dataset.
type (str) – Constant filled by server.
host (object) – 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.WebClientCertificateAuthentication(url, pfx, password)[source]¶

Bases: azure.mgmt.datafactory.models.web_linked_service_type_properties.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.

Parameters:	url (object) – The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string). authentication_type (str) – Constant filled by server. pfx (SecretBase) – Base64-encoded contents of a PFX file. password (SecretBase) – Password for the PFX file.

class azure.mgmt.datafactory.models.WebBasicAuthentication(url, username, password)[source]¶

Bases: azure.mgmt.datafactory.models.web_linked_service_type_properties.WebLinkedServiceTypeProperties

A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.

Parameters:	url (object) – The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string). authentication_type (str) – Constant filled by server. username (object) – User name for Basic authentication. Type: string (or Expression with resultType string). password (SecretBase) – The password for Basic authentication.

class azure.mgmt.datafactory.models.WebAnonymousAuthentication(url)[source]¶

Bases: azure.mgmt.datafactory.models.web_linked_service_type_properties.WebLinkedServiceTypeProperties

A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.

Parameters:	url (object) – The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string). authentication_type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.WebLinkedServiceTypeProperties(url)[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

Parameters:	url (object) – The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string). authentication_type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.WebLinkedService(type_properties, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None)[source]¶

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

Web linked service.

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 Dataset.
type (str) – Constant filled by server.
type_properties (WebLinkedServiceTypeProperties) – Web linked service properties.

class azure.mgmt.datafactory.models.ODataLinkedService(url, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, authentication_type=None, user_name=None, password=None, encrypted_credential=None)[source]¶

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

Open Data Protocol (OData) linked service.

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 Dataset.
type (str) – Constant filled by server.
url (object) – 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’
user_name (object) – User name of the OData service. Type: string (or Expression with resultType string).
password (SecretBase) – Password of the OData 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.HdfsLinkedService(url, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, authentication_type=None, encrypted_credential=None, user_name=None, password=None)[source]¶

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

Hadoop Distributed File System (HDFS) linked service.

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 Dataset.
type (str) – Constant filled by server.
url (object) – 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.OdbcLinkedService(connection_string, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, authentication_type=None, credential=None, user_name=None, password=None, encrypted_credential=None)[source]¶

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

Open Database Connectivity (ODBC) linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – The non-access credential portion of the connection string as well as an optional encrypted credential.
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.AzureMLLinkedService(ml_endpoint, api_key, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, update_resource_endpoint=None, service_principal_id=None, service_principal_key=None, tenant=None, encrypted_credential=None)[source]¶

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

Azure ML Web Service linked service.

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 Dataset.
type (str) – Constant filled by server.
ml_endpoint (object) – The Batch Execution REST URL for an Azure ML Web Service endpoint. Type: string (or Expression with resultType string).
api_key (SecretBase) – The API key for accessing the Azure ML model endpoint.
update_resource_endpoint (object) – The Update Resource REST URL for an Azure ML 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 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 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.TeradataLinkedService(server, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, schema=None, authentication_type=None, username=None, password=None, encrypted_credential=None)[source]¶

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

Linked service for Teradata data source.

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 Dataset.
type (str) – Constant filled by server.
server (object) – Server 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 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.Db2LinkedService(server, database, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, schema=None, authentication_type=None, username=None, password=None, encrypted_credential=None)[source]¶

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

Linked service for DB2 data source.

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 Dataset.
type (str) – Constant filled by server.
server (object) – Server name for connection. Type: string (or Expression with resultType string).
database (object) – 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 Db2AuthenticationType) – AuthenticationType to be used for connection. Possible values include: ‘Basic’
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.SybaseLinkedService(server, database, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, schema=None, authentication_type=None, username=None, password=None, encrypted_credential=None)[source]¶

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

Linked service for Sybase data source.

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 Dataset.
type (str) – Constant filled by server.
server (object) – Server name for connection. Type: string (or Expression with resultType string).
database (object) – 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.PostgreSqlLinkedService(server, database, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, schema=None, username=None, password=None, encrypted_credential=None)[source]¶

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

Linked service for PostgreSQL data source.

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 Dataset.
type (str) – Constant filled by server.
server (object) – Server name for connection. Type: string (or Expression with resultType string).
database (object) – Database name for connection. Type: string (or Expression with resultType string).
schema (object) – Schema name for connection. Type: string (or Expression with resultType string).
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.MySqlLinkedService(server, database, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, schema=None, username=None, password=None, encrypted_credential=None)[source]¶

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

Linked service for MySQL data source.

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 Dataset.
type (str) – Constant filled by server.
server (object) – Server name for connection. Type: string (or Expression with resultType string).
database (object) – Database name for connection. Type: string (or Expression with resultType string).
schema (object) – Schema name for connection. Type: string (or Expression with resultType string).
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.AzureMySqlLinkedService(connection_string, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, encrypted_credential=None)[source]¶

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

Azure MySQL database linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – The 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.OracleLinkedService(connection_string, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, encrypted_credential=None)[source]¶

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

Oracle database.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – The 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.FileServerLinkedService(host, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, user_id=None, password=None, encrypted_credential=None)[source]¶

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

File system linked service.

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 Dataset.
type (str) – 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.
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.HDInsightLinkedService(cluster_uri, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, user_name=None, password=None, linked_service_name=None, hcatalog_linked_service_name=None, encrypted_credential=None)[source]¶

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

HDInsight linked service.

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 Dataset.
type (str) – Constant filled by server.
cluster_uri (object) – 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).

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

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

Dynamics linked service.

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 Dataset.
type (str) – Constant filled by server.
deployment_type (object) – 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) – The authentication type to connect to Dynamics server. ‘Office365’ for online scenario, ‘Ifd’ for on-premises with Ifd 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.
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.CosmosDbLinkedService(connection_string, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, encrypted_credential=None)[source]¶

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

Microsoft Azure Cosmos Database (CosmosDB) linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – The 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.AzureKeyVaultLinkedService(base_url, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None)[source]¶

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

Azure Key Vault linked service.

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 Dataset.
type (str) – Constant filled by server.
base_url (object) – 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.AzureBatchLinkedService(account_name, batch_uri, pool_name, linked_service_name, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, access_key=None, encrypted_credential=None)[source]¶

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

Azure Batch linked service.

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 Dataset.
type (str) – Constant filled by server.
account_name (object) – The Azure Batch account name. Type: string (or Expression with resultType string).
access_key (SecretBase) – The Azure Batch account access key.
batch_uri (object) – The Azure Batch URI. Type: string (or Expression with resultType string).
pool_name (object) – The Azure Batch pool name. Type: string (or Expression with resultType string).
linked_service_name (LinkedServiceReference) – 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.AzureSqlDatabaseLinkedService(connection_string, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, service_principal_id=None, service_principal_key=None, tenant=None, encrypted_credential=None)[source]¶

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

Microsoft Azure SQL Database linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – The 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).
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.SqlServerLinkedService(connection_string, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, user_name=None, password=None, encrypted_credential=None)[source]¶

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

SQL Server linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – The connection string.
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.AzureSqlDWLinkedService(connection_string, additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, service_principal_id=None, service_principal_key=None, tenant=None, encrypted_credential=None)[source]¶

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

Azure SQL Data Warehouse linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – The 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).
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.AzureStorageLinkedService(additional_properties=None, connect_via=None, description=None, parameters=None, annotations=None, connection_string=None, sas_uri=None, encrypted_credential=None)[source]¶

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

The storage account linked service.

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 Dataset.
type (str) – Constant filled by server.
connection_string (SecretBase) – The connection string. It is mutually exclusive with sasUri property.
sas_uri (SecretBase) – SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property.
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=None, structure=None, parameters=None, annotations=None)[source]¶

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

Salesforce Marketing Cloud dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.VerticaTableDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Vertica dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.NetezzaTableDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Netezza dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.ZohoObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Zoho server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.XeroObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Xero Serivce dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.SquareObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Square Serivce dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.SparkObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Spark Server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.ShopifyObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Shopify Serivce dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.ServiceNowObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

ServiceNow server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.QuickBooksObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

QuickBooks server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.PrestoObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Presto server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.PhoenixObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Phoenix server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.PaypalObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Paypal Serivce dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.MarketoObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Marketo server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.MariaDBTableDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

MariaDB server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.MagentoObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Magento server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.JiraObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Jira Serivce dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.ImpalaObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Impala server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.HubspotObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Hubspot Serivce dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.HiveObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Hive Server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.HBaseObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

HBase server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.GreenplumTableDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Greenplum Database dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.GoogleBigQueryObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Google BigQuery service dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.EloquaObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Eloqua server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.DrillTableDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Drill server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.CouchbaseTableDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Couchbase server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.ConcurObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Concur Serivce dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.AzurePostgreSqlTableDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Azure PostgreSQL dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.AmazonMWSObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Amazon Marketplace Web Service dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.

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

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

The ZipDeflate compression method used on a dataset.

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection type (str) – Constant filled by server. level (str or DatasetCompressionLevel) – The ZipDeflate compression level. Possible values include: ‘Optimal’, ‘Fastest’

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

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

The Deflate compression method used on a dataset.

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection type (str) – Constant filled by server. level (str or DatasetCompressionLevel) – The Deflate compression level. Possible values include: ‘Optimal’, ‘Fastest’

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

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

The GZip compression method used on a dataset.

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection type (str) – Constant filled by server. level (str or DatasetCompressionLevel) – The GZip compression level. Possible values include: ‘Optimal’, ‘Fastest’

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

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

The BZip2 compression method used on a dataset.

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.DatasetCompression(additional_properties=None)[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

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection type (str) – Constant filled by server.

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

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

The data stored in Parquet format.

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) – Constant filled by server.

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

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

The data stored in Optimized Row Columnar (ORC) format.

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) – Constant filled by server.

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

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

The data stored in Avro format.

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) – Constant filled by server.

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

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

The data stored in JSON format.

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) – Constant filled by server.
file_pattern (str or JsonFormatFilePattern) – 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. Possible values include: ‘setOfObjects’, ‘arrayOfObjects’
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.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)[source]¶

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

The data stored in text format.

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) – 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.DatasetStorageFormat(additional_properties=None, serializer=None, deserializer=None)[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

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) – Constant filled by server.

class azure.mgmt.datafactory.models.HttpDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, relative_url=None, request_method=None, request_body=None, additional_headers=None, format=None, compression=None)[source]¶

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

A file in an HTTP web server.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – 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.AzureSearchIndexDataset(linked_service_name, index_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

The Azure Search Index.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
index_name (object) – The name of the Azure Search Index. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.WebTableDataset(linked_service_name, index, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, path=None)[source]¶

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

The dataset points to a HTML table in the web page.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
index (object) – 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.SqlServerTableDataset(linked_service_name, table_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

The on-premises SQL Server dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
table_name (object) – The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapEccResourceDataset(linked_service_name, path, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

The path of the SAP ECC OData entity.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
path (str) – The path of the SAP ECC OData entity. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapCloudForCustomerResourceDataset(linked_service_name, path, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

The path of the SAP Cloud for Customer OData entity.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
path (object) – The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SalesforceObjectDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, object_api_name=None)[source]¶

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

The Salesforce object dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – 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.RelationalTableDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, table_name=None)[source]¶

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

The relational table dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
table_name (object) – The relational table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureMySqlTableDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, table_name=None)[source]¶

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

The Azure MySQL database dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
table_name (object) – The Azure MySQL database table name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.OracleTableDataset(linked_service_name, table_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

The on-premises Oracle database dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
table_name (object) – The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ODataResourceDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, path=None)[source]¶

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

The Open Data Protocol (OData) resource dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
path (object) – The OData resource path. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MongoDbCollectionDataset(linked_service_name, collection_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

The MongoDB database dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
collection_name (object) – The table name of the MongoDB database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.FileShareDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, folder_path=None, file_name=None, format=None, file_filter=None, compression=None)[source]¶

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

An on-premises file system dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – 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).
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.AzureDataLakeStoreDataset(linked_service_name, folder_path, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, file_name=None, format=None, compression=None)[source]¶

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

Azure Data Lake Store dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – 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.DynamicsEntityDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, entity_name=None)[source]¶

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

The Dynamics entity dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – 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.DocumentDbCollectionDataset(linked_service_name, collection_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

Microsoft Azure Document Database Collection dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
collection_name (object) – Document Database collection name. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CustomDataset(linked_service_name, type_properties, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

The custom dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
type_properties (object) – Custom dataset properties.

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

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

The Cassandra database dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – 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.AzureSqlDWTableDataset(linked_service_name, table_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

The Azure SQL Data Warehouse dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
table_name (object) – The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureSqlTableDataset(linked_service_name, table_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

The Azure SQL Server database dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
table_name (object) – The table name of the Azure SQL database. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureTableDataset(linked_service_name, table_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None)[source]¶

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

The Azure Table storage dataset.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
table_name (object) – The table name of the Azure Table storage. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.AzureBlobDataset(linked_service_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, folder_path=None, table_root_location=None, file_name=None, format=None, compression=None)[source]¶

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

The Azure Blob storage.

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – 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).
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.AmazonS3Dataset(linked_service_name, bucket_name, additional_properties=None, description=None, structure=None, parameters=None, annotations=None, key=None, prefix=None, version=None, format=None, compression=None)[source]¶

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

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

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.
linked_service_name (LinkedServiceReference) – Linked service reference.
parameters (dict[str, ParameterSpecification]) – Parameters for dataset.
annotations (list[object]) – List of tags that can be used for describing the Dataset.
type (str) – Constant filled by server.
bucket_name (object) – 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).
format (DatasetStorageFormat) – The format of files.
compression (DatasetCompression) – The data compression method used for the Amazon S3 object.

class azure.mgmt.datafactory.models.RetryPolicy(count=None, interval_in_seconds=None)[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.TumblingWindowTrigger(pipeline, frequency, interval, start_time, max_concurrency, additional_properties=None, description=None, end_time=None, delay=None, retry_policy=None)[source]¶

Bases: azure.mgmt.datafactory.models.trigger.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.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Trigger description.
type (str) – Constant filled by server.
pipeline (TriggerPipelineReference) – Pipeline for which runs are created when an event is fired for trigger window that is ready.
frequency (str or TumblingWindowFrequency) – The frequency of the time windows. Possible values include: ‘Minute’, ‘Hour’
interval (int) – The interval of the time windows. The minimum interval allowed is 15 Minutes.
start_time (datetime) – 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) – 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.

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.BlobTrigger(folder_path, max_concurrency, linked_service, additional_properties=None, description=None, pipelines=None)[source]¶

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

Trigger that runs everytime the selected Blob container changes.

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
description (str) – Trigger description.
type (str) – Constant filled by server.
pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.
folder_path (str) – The path of the container/folder that will trigger the pipeline.
max_concurrency (int) – The max number of parallel files to handle when it is triggered.
linked_service (LinkedServiceReference) – 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.RecurrenceScheduleOccurrence(additional_properties=None, day=None, occurrence=None)[source]¶

Bases: msrest.serialization.Model

The recurrence schedule occurence.

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.RecurrenceSchedule(additional_properties=None, minutes=None, hours=None, week_days=None, month_days=None, monthly_occurrences=None)[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.ScheduleTriggerRecurrence(additional_properties=None, frequency=None, interval=None, start_time=None, end_time=None, time_zone=None, schedule=None)[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.ScheduleTrigger(recurrence, additional_properties=None, description=None, pipelines=None)[source]¶

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

Trigger that creates pipeline runs periodically, on schedule.

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
description (str) – Trigger description.
type (str) – Constant filled by server.
pipelines (list[TriggerPipelineReference]) – Pipelines that need to be started.
recurrence (ScheduleTriggerRecurrence) – 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.MultiplePipelineTrigger(additional_properties=None, description=None, pipelines=None)[source]¶

Bases: azure.mgmt.datafactory.models.trigger.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: BlobTrigger, ScheduleTrigger

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 description (str) – Trigger description. type (str) – 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.ActivityPolicy(additional_properties=None, timeout=None, retry=None, retry_interval_in_seconds=None, secure_output=None)[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_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.DatabricksNotebookActivity(name, notebook_path, additional_properties=None, description=None, depends_on=None, linked_service_name=None, policy=None, base_parameters=None)[source]¶

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

DatabricksNotebook activity.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
notebook_path (object) – 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.

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

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

Data Lake Analytics U-SQL activity.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
script_path (object) – Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).
script_linked_service (LinkedServiceReference) – 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.AzureMLUpdateResourceActivity(name, trained_model_name, trained_model_linked_service_name, trained_model_file_path, additional_properties=None, description=None, depends_on=None, linked_service_name=None, policy=None)[source]¶

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

Azure ML Update Resource management activity.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
trained_model_name (object) – 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) – Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.
trained_model_file_path (object) – 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)[source]¶

Bases: msrest.serialization.Model

Azure ML WebService Input/Output file.

Parameters:	file_path (object) – 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) – Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.

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

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

Azure ML Batch Execution activity.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – 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.GetMetadataActivity(name, dataset, additional_properties=None, description=None, depends_on=None, linked_service_name=None, policy=None, field_list=None)[source]¶

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

Activity to get metadata of dataset.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
dataset (DatasetReference) – GetMetadata activity dataset reference.
field_list (list[object]) – Fields of metadata to get from dataset.

class azure.mgmt.datafactory.models.WebActivityAuthentication(type, pfx=None, username=None, password=None, resource=None)[source]¶

Bases: msrest.serialization.Model

Web activity authentication properties.

Parameters:

type (str) – Web activity authentication (Basic/ClientCertificate/MSI)
pfx (SecureString) – Base64-encoded contents of a PFX file.
username (str) – Web activity authentication user name for basic authentication.
password (SecureString) – 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.WebActivity(name, method, url, additional_properties=None, description=None, depends_on=None, linked_service_name=None, policy=None, headers=None, body=None, authentication=None, datasets=None, linked_services=None)[source]¶

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

Web activity.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
method (str or WebActivityMethod) – Rest API method for target endpoint. Possible values include: ‘GET’, ‘POST’, ‘PUT’, ‘DELETE’
url (object) – 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.

class azure.mgmt.datafactory.models.RedshiftUnloadSettings(s3_linked_service_name, bucket_name)[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.

Parameters:

s3_linked_service_name (LinkedServiceReference) – 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) – 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.AmazonRedshiftSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None, redshift_unload_settings=None)[source]¶

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

A copy activity source for Amazon Redshift Source.

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])).
type (str) – Constant filled by server.
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.SalesforceMarketingCloudSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Salesforce Marketing Cloud source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.VerticaSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Vertica source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.NetezzaSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Netezza source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ZohoSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Zoho server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.XeroSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Xero Serivce source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SquareSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Square Serivce source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SparkSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Spark Server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ShopifySource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Shopify Serivce source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ServiceNowSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity ServiceNow server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.QuickBooksSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity QuickBooks server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.PrestoSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Presto server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.PhoenixSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Phoenix server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.PaypalSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Paypal Serivce source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MarketoSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Marketo server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MariaDBSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity MariaDB server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.MagentoSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Magento server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.JiraSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Jira Serivce source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.ImpalaSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Impala server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HubspotSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Hubspot Serivce source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HiveSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity Hive Server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HBaseSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity HBase server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

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

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

A copy activity Greenplum Database source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

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

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

A copy activity Google BigQuery service source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

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

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

A copy activity Eloqua server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

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

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

A copy activity Drill server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

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

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

A copy activity Couchbase server source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

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

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

A copy activity Concur Serivce source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

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

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

A copy activity Azure PostgreSQL source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

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

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

A copy activity Amazon Marketplace Web Service source.

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])).
type (str) – Constant filled by server.
query (object) – A query to retrieve data from source. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.HttpSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, http_request_timeout=None)[source]¶

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

A copy activity source for an HTTP file.

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])).
type (str) – 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.AzureDataLakeStoreSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, recursive=None)[source]¶

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

A copy activity Azure Data Lake source.

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])).
type (str) – 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.MongoDbSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity source for a MongoDB database.

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])).
type (str) – Constant filled by server.
query (object) – Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string).

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

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

A copy activity source for a Cassandra database.

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])).
type (str) – Constant filled by server.
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.WebSource(additional_properties=None, source_retry_count=None, source_retry_wait=None)[source]¶

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

A copy activity source for web page table.

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

class azure.mgmt.datafactory.models.OracleSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, oracle_reader_query=None, query_timeout=None)[source]¶

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

A copy activity Oracle source.

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

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

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

A copy activity Azure MySQL source.

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])).
type (str) – Constant filled by server.
query (object) – Database query. Type: string (or Expression with resultType string).

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

Bases: msrest.serialization.Model

Distcp settings.

Parameters:

resource_manager_endpoint (object) – Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string).
temp_script_path (object) – 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.HdfsSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, recursive=None, distcp_settings=None)[source]¶

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

A copy activity HDFS source.

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])).
type (str) – 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.FileSystemSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, recursive=None)[source]¶

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

A copy activity file system source.

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])).
type (str) – 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.SqlDWSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, sql_reader_query=None, sql_reader_stored_procedure_name=None, stored_procedure_parameters=None)[source]¶

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

A copy activity SQL Data Warehouse source.

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

class azure.mgmt.datafactory.models.StoredProcedureParameter(value, type=None)[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’, ‘Decimal’, ‘Guid’, ‘Boolean’, ‘Date’

class azure.mgmt.datafactory.models.SqlSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, sql_reader_query=None, sql_reader_stored_procedure_name=None, stored_procedure_parameters=None)[source]¶

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

A copy activity SQL source.

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])).
type (str) – Constant filled by server.
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”}}”.

class azure.mgmt.datafactory.models.SapEccSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity source for SAP ECC source.

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])).
type (str) – Constant filled by server.
query (str) – SAP ECC OData query. For example, “$top=1”. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SapCloudForCustomerSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity source for SAP Cloud for Customer source.

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])).
type (str) – Constant filled by server.
query (object) – SAP Cloud for Customer OData query. For example, “$top=1”. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.SalesforceSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None, read_behavior=None)[source]¶

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

A copy activity Salesforce source.

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

class azure.mgmt.datafactory.models.RelationalSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, query=None)[source]¶

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

A copy activity source for various relational databases.

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])).
type (str) – Constant filled by server.
query (object) – Database query. Type: string (or Expression with resultType string).

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

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

A copy activity Dynamics source.

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

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

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

A copy activity Document Database Collection source.

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

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

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

A copy activity Azure Blob source.

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])).
type (str) – 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.AzureTableSource(additional_properties=None, source_retry_count=None, source_retry_wait=None, azure_table_source_query=None, azure_table_source_ignore_table_not_found=None)[source]¶

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

A copy activity Azure Table source.

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])).
type (str) – Constant filled by server.
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.CopySource(additional_properties=None, source_retry_count=None, source_retry_wait=None)[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: AmazonRedshiftSource, SalesforceMarketingCloudSource, VerticaSource, NetezzaSource, ZohoSource, XeroSource, SquareSource, SparkSource, ShopifySource, ServiceNowSource, QuickBooksSource, PrestoSource, PhoenixSource, PaypalSource, MarketoSource, MariaDBSource, MagentoSource, JiraSource, ImpalaSource, HubspotSource, HiveSource, HBaseSource, GreenplumSource, GoogleBigQuerySource, EloquaSource, DrillSource, CouchbaseSource, ConcurSource, AzurePostgreSqlSource, AmazonMWSSource, HttpSource, AzureDataLakeStoreSource, MongoDbSource, CassandraSource, WebSource, OracleSource, AzureMySqlSource, HdfsSource, FileSystemSource, SqlDWSource, SqlSource, SapEccSource, SapCloudForCustomerSource, SalesforceSource, RelationalSource, DynamicsSource, DocumentDbCollectionSource, BlobSource, AzureTableSource

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

class azure.mgmt.datafactory.models.LookupActivity(name, source, dataset, additional_properties=None, description=None, depends_on=None, linked_service_name=None, policy=None, first_row_only=None)[source]¶

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

Lookup activity.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
source (CopySource) – Dataset-specific source properties, same as copy activity source.
dataset (DatasetReference) – 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.SqlServerStoredProcedureActivity(name, stored_procedure_name, additional_properties=None, description=None, depends_on=None, linked_service_name=None, policy=None, stored_procedure_parameters=None)[source]¶

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

SQL stored procedure activity type.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
stored_procedure_name (object) – 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.CustomActivityReferenceObject(linked_services=None, datasets=None)[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.CustomActivity(name, command, additional_properties=None, description=None, depends_on=None, linked_service_name=None, policy=None, resource_linked_service=None, folder_path=None, reference_objects=None, extended_properties=None)[source]¶

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

Custom activity type.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
command (object) – 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.

class azure.mgmt.datafactory.models.SSISPackageLocation(package_path)[source]¶

Bases: msrest.serialization.Model

SSIS package location.

Parameters:	package_path (str) – The SSIS package path.

class azure.mgmt.datafactory.models.ExecuteSSISPackageActivity(name, package_location, connect_via, additional_properties=None, description=None, depends_on=None, linked_service_name=None, policy=None, runtime=None, logging_level=None, environment_path=None)[source]¶

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

Execute SSIS package activity.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
package_location (SSISPackageLocation) – SSIS package location.
runtime (str or SSISExecutionRuntime) – Specifies the runtime to execute SSIS package. Possible values include: ‘x64’, ‘x86’
logging_level (str) – The logging level of SSIS package execution.
environment_path (str) – The environment path to execution the SSIS package.
connect_via (IntegrationRuntimeReference) – The integration runtime reference.

class azure.mgmt.datafactory.models.HDInsightSparkActivity(name, root_path, entry_file_path, additional_properties=None, description=None, depends_on=None, linked_service_name=None, policy=None, arguments=None, get_debug_info=None, spark_job_linked_service=None, class_name=None, proxy_user=None, spark_config=None)[source]¶

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

HDInsight Spark activity.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
root_path (object) – The root path in ‘sparkJobLinkedService’ for all the job’s files. Type: string (or Expression with resultType string).
entry_file_path (object) – 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, mapper, reducer, input, output, file_paths, additional_properties=None, description=None, depends_on=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)[source]¶

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

HDInsight streaming activity type.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – 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) – Mapper executable name. Type: string (or Expression with resultType string).
reducer (object) – Reducer executable name. Type: string (or Expression with resultType string).
input (object) – Input blob path. Type: string (or Expression with resultType string).
output (object) – Output blob path. Type: string (or Expression with resultType string).
file_paths (list[object]) – 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.HDInsightMapReduceActivity(name, class_name, jar_file_path, additional_properties=None, description=None, depends_on=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)[source]¶

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

HDInsight MapReduce activity type.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – 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) – Class name. Type: string (or Expression with resultType string).
jar_file_path (object) – 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.HDInsightPigActivity(name, additional_properties=None, description=None, depends_on=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)[source]¶

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

HDInsight Pig activity type.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – 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 Pig job request.

class azure.mgmt.datafactory.models.HDInsightHiveActivity(name, additional_properties=None, description=None, depends_on=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)[source]¶

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

HDInsight Hive activity type.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – 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.

class azure.mgmt.datafactory.models.RedirectIncompatibleRowSettings(linked_service_name, additional_properties=None, path=None)[source]¶

Bases: msrest.serialization.Model

Redirect incompatible row settings.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
linked_service_name (object) – 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.StagingSettings(linked_service_name, additional_properties=None, path=None, enable_compression=None)[source]¶

Bases: msrest.serialization.Model

Staging settings.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
linked_service_name (LinkedServiceReference) – 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.TabularTranslator(additional_properties=None, column_mappings=None)[source]¶

Bases: azure.mgmt.datafactory.models.copy_translator.CopyTranslator

A copy activity tabular translator.

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection type (str) – Constant filled by server. column_mappings (object) – Column mappings. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.CopyTranslator(additional_properties=None)[source]¶

Bases: msrest.serialization.Model

A copy activity translator.

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

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection type (str) – Constant filled by server.

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, write_behavior=None, external_id_field_name=None, ignore_null_values=None)[source]¶

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

A copy activity Salesforce sink.

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])).
type (str) – 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.DynamicsSink(additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, ignore_null_values=None)[source]¶

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

A copy activity Dynamics sink.

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

Variables:

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

write_behavior = 'Upsert'¶

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, pre_copy_script=None)[source]¶

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

A copy activity ODBC sink.

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])).
type (str) – 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.AzureSearchIndexSink(additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, write_behavior=None)[source]¶

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

A copy activity Azure Search Index sink.

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])).
type (str) – 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.AzureDataLakeStoreSink(additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, copy_behavior=None)[source]¶

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

A copy activity Azure Data Lake Store sink.

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])).
type (str) – Constant filled by server.
copy_behavior (str or CopyBehaviorType) – The type of copy behavior for copy sink. Possible values include: ‘PreserveHierarchy’, ‘FlattenHierarchy’, ‘MergeFiles’

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, pre_copy_script=None)[source]¶

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

A copy activity Oracle sink.

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])).
type (str) – Constant filled by server.
pre_copy_script (object) – SQL pre-copy script. Type: string (or Expression with resultType string).

class azure.mgmt.datafactory.models.PolybaseSettings(additional_properties=None, reject_type=None, reject_value=None, reject_sample_value=None, use_type_default=None)[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.SqlDWSink(additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None, pre_copy_script=None, allow_poly_base=None, poly_base_settings=None)[source]¶

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

A copy activity SQL Data Warehouse sink.

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

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, sql_writer_stored_procedure_name=None, sql_writer_table_type=None, pre_copy_script=None, stored_procedure_parameters=None)[source]¶

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

A copy activity SQL sink.

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

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, nesting_separator=None)[source]¶

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

A copy activity Document Database Collection sink.

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])).
type (str) – Constant filled by server.
nesting_separator (object) – Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).

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, copy_behavior=None)[source]¶

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

A copy activity file system sink.

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])).
type (str) – Constant filled by server.
copy_behavior (str or CopyBehaviorType) – The type of copy behavior for copy sink. Possible values include: ‘PreserveHierarchy’, ‘FlattenHierarchy’, ‘MergeFiles’

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, blob_writer_overwrite_files=None, blob_writer_date_time_format=None, blob_writer_add_header=None, copy_behavior=None)[source]¶

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

A copy activity Azure Blob sink.

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])).
type (str) – 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 (str or CopyBehaviorType) – The type of copy behavior for copy sink. Possible values include: ‘PreserveHierarchy’, ‘FlattenHierarchy’, ‘MergeFiles’

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, azure_table_default_partition_key_value=None, azure_table_partition_key_name=None, azure_table_row_key_name=None, azure_table_insert_type=None)[source]¶

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

A copy activity Azure Table sink.

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])).
type (str) – 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.AzureQueueSink(additional_properties=None, write_batch_size=None, write_batch_timeout=None, sink_retry_count=None, sink_retry_wait=None)[source]¶

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

A copy activity Azure Queue sink.

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

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, write_behavior=None)[source]¶

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

A copy activity SAP Cloud for Customer sink.

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])).
type (str) – Constant filled by server.
write_behavior (str or SapCloudForCustomerSinkWriteBehavior) – The write behavior for the operation. Default is ‘Insert’. Possible values include: ‘Insert’, ‘Update’

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)[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: SalesforceSink, DynamicsSink, OdbcSink, AzureSearchIndexSink, AzureDataLakeStoreSink, OracleSink, SqlDWSink, SqlSink, DocumentDbCollectionSink, FileSystemSink, BlobSink, AzureTableSink, AzureQueueSink, SapCloudForCustomerSink

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

class azure.mgmt.datafactory.models.CopyActivity(name, source, sink, additional_properties=None, description=None, depends_on=None, linked_service_name=None, policy=None, translator=None, enable_staging=None, staging_settings=None, parallel_copies=None, cloud_data_movement_units=None, enable_skip_incompatible_row=None, redirect_incompatible_row_settings=None, inputs=None, outputs=None)[source]¶

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

Copy activity.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.
source (CopySource) – Copy activity source.
sink (CopySink) – Copy activity sink.
translator (CopyTranslator) – Copy activity translator. If not specificed, 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.
cloud_data_movement_units (object) – Maximum number of cloud data movement 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.
inputs (list[DatasetReference]) – List of inputs for the activity.
outputs (list[DatasetReference]) – List of outputs for the activity.

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

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

Base class for all execution activities.

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

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
linked_service_name (LinkedServiceReference) – Linked service reference.
policy (ActivityPolicy) – Activity policy.

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

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

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

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
items (Expression) – Input array on which filter should be applied.
condition (Expression) – Condition to be used for filtering the input.

class azure.mgmt.datafactory.models.UntilActivity(name, expression, activities, additional_properties=None, description=None, depends_on=None, timeout=None)[source]¶

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

This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
expression (Expression) – 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]) – List of activities to execute.

class azure.mgmt.datafactory.models.WaitActivity(name, wait_time_in_seconds, additional_properties=None, description=None, depends_on=None)[source]¶

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

This activity suspends pipeline execution for the specified interval.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
wait_time_in_seconds (int) – Duration in seconds.

class azure.mgmt.datafactory.models.ForEachActivity(name, items, activities, additional_properties=None, description=None, depends_on=None, is_sequential=None, batch_count=None)[source]¶

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

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

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – 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) – Collection to iterate.
activities (list[Activity]) – List of activities to execute .

class azure.mgmt.datafactory.models.IfConditionActivity(name, expression, additional_properties=None, description=None, depends_on=None, if_true_activities=None, if_false_activities=None)[source]¶

Bases: azure.mgmt.datafactory.models.control_activity.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.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
expression (Expression) – 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.ExecutePipelineActivity(name, pipeline, additional_properties=None, description=None, depends_on=None, parameters=None, wait_on_completion=None)[source]¶

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

Execute pipeline activity.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
name (str) – Activity name.
description (str) – Activity description.
depends_on (list[ActivityDependency]) – Activity depends on condition.
type (str) – Constant filled by server.
pipeline (PipelineReference) – 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.ControlActivity(name, additional_properties=None, description=None, depends_on=None)[source]¶

Bases: azure.mgmt.datafactory.models.activity.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: FilterActivity, UntilActivity, WaitActivity, ForEachActivity, IfConditionActivity, ExecutePipelineActivity

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection name (str) – Activity name. description (str) – Activity description. depends_on (list[ActivityDependency]) – Activity depends on condition. type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.LinkedIntegrationRuntime[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.SelfHostedIntegrationRuntimeNode(additional_properties=None)[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: ‘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)[source]¶

Bases: azure.mgmt.datafactory.models.integration_runtime_status.IntegrationRuntimeStatus

Self-hosted integration runtime status.

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

class azure.mgmt.datafactory.models.ManagedIntegrationRuntimeOperationResult(additional_properties=None)[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.ManagedIntegrationRuntimeError(additional_properties=None)[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)[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.ManagedIntegrationRuntimeStatus(additional_properties=None)[source]¶

Bases: azure.mgmt.datafactory.models.integration_runtime_status.IntegrationRuntimeStatus

Managed integration runtime status.

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
type (str) – 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’
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.LinkedIntegrationRuntimeRbac(resource_id)[source]¶

Bases: azure.mgmt.datafactory.models.linked_integration_runtime_properties.LinkedIntegrationRuntimeProperties

The base definition of a secret type.

Parameters:	authorization_type (str) – Constant filled by server. resource_id (str) – The resource ID of the integration runtime to be shared.

class azure.mgmt.datafactory.models.LinkedIntegrationRuntimeKey(key)[source]¶

Bases: azure.mgmt.datafactory.models.linked_integration_runtime_properties.LinkedIntegrationRuntimeProperties

The base definition of a secret type.

Parameters:	authorization_type (str) – Constant filled by server. key (SecureString) – Type of the secret.

class azure.mgmt.datafactory.models.LinkedIntegrationRuntimeProperties[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: LinkedIntegrationRuntimeRbac, LinkedIntegrationRuntimeKey

Parameters:	authorization_type (str) – Constant filled by server.

class azure.mgmt.datafactory.models.SelfHostedIntegrationRuntime(additional_properties=None, description=None, linked_info=None)[source]¶

Bases: azure.mgmt.datafactory.models.integration_runtime.IntegrationRuntime

Self-hosted integration runtime.

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection description (str) – Integration runtime description. type (str) – Constant filled by server. linked_info (LinkedIntegrationRuntimeProperties) –

class azure.mgmt.datafactory.models.IntegrationRuntimeCustomSetupScriptProperties(blob_container_uri=None, sas_token=None)[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.IntegrationRuntimeSsisCatalogInfo(additional_properties=None, catalog_server_endpoint=None, catalog_admin_user_name=None, catalog_admin_password=None, catalog_pricing_tier=None)[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, edition=None)[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.
edition (str or IntegrationRuntimeEdition) – The edition for the SSIS Integration Runtime. Possible values include: ‘Standard’, ‘Enterprise’

class azure.mgmt.datafactory.models.IntegrationRuntimeVNetProperties(additional_properties=None, v_net_id=None, subnet=None)[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.

class azure.mgmt.datafactory.models.IntegrationRuntimeComputeProperties(additional_properties=None, location=None, node_size=None, number_of_nodes=None, max_parallel_executions_per_node=None, v_net_properties=None)[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.
v_net_properties (IntegrationRuntimeVNetProperties) – VNet properties for managed integration runtime.

class azure.mgmt.datafactory.models.ManagedIntegrationRuntime(additional_properties=None, description=None, compute_properties=None, ssis_properties=None)[source]¶

Bases: azure.mgmt.datafactory.models.integration_runtime.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.

Parameters:

additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
description (str) – Integration runtime description.
type (str) – 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’

class azure.mgmt.datafactory.models.IntegrationRuntimeNodeIpAddress[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)[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 (float) – 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.IntegrationRuntimeMonitoringData(name=None, nodes=None)[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.IntegrationRuntimeRemoveNodeRequest(additional_properties=None, node_name=None)[source]¶

Bases: msrest.serialization.Model

Request to remove a node.

Parameters:	additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection node_name (str) – The name of the node to be removed.

class azure.mgmt.datafactory.models.IntegrationRuntimeAuthKeys(auth_key1=None, auth_key2=None)[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.IntegrationRuntimeRegenerateKeyParameters(key_name=None)[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.IntegrationRuntimeConnectionInfo(additional_properties=None)[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.FactoryPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Factory object

class azure.mgmt.datafactory.models.IntegrationRuntimeResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of IntegrationRuntimeResource object

class azure.mgmt.datafactory.models.LinkedServiceResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of LinkedServiceResource object

class azure.mgmt.datafactory.models.DatasetResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of DatasetResource object

class azure.mgmt.datafactory.models.PipelineResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of PipelineResource object

class azure.mgmt.datafactory.models.ActivityRunPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ActivityRun object

class azure.mgmt.datafactory.models.TriggerResourcePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of TriggerResource object

class azure.mgmt.datafactory.models.TriggerRunPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of TriggerRun object

class azure.mgmt.datafactory.models.IntegrationRuntimeState[source]¶

Bases: enum.Enum

An enumeration.

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: enum.Enum

An enumeration.

off = 'Off'¶

on = 'On'¶

class azure.mgmt.datafactory.models.ParameterType[source]¶

Bases: 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: enum.Enum

An enumeration.

completed = 'Completed'¶

failed = 'Failed'¶

skipped = 'Skipped'¶

succeeded = 'Succeeded'¶

class azure.mgmt.datafactory.models.TriggerRuntimeState[source]¶

Bases: enum.Enum

An enumeration.

disabled = 'Disabled'¶

started = 'Started'¶

stopped = 'Stopped'¶

class azure.mgmt.datafactory.models.PipelineRunQueryFilterOperand[source]¶

Bases: enum.Enum

An enumeration.

pipeline_name = 'PipelineName'¶

run_end = 'RunEnd'¶

run_start = 'RunStart'¶

status = 'Status'¶

class azure.mgmt.datafactory.models.PipelineRunQueryFilterOperator[source]¶

Bases: enum.Enum

An enumeration.

equals = 'Equals'¶

in_enum = 'In'¶

not_equals = 'NotEquals'¶

not_in = 'NotIn'¶

class azure.mgmt.datafactory.models.PipelineRunQueryOrderByField[source]¶

Bases: enum.Enum

An enumeration.

run_end = 'RunEnd'¶

run_start = 'RunStart'¶

class azure.mgmt.datafactory.models.PipelineRunQueryOrder[source]¶

Bases: enum.Enum

An enumeration.

asc = 'ASC'¶

desc = 'DESC'¶

class azure.mgmt.datafactory.models.TriggerRunStatus[source]¶

Bases: enum.Enum

An enumeration.

failed = 'Failed'¶

inprogress = 'Inprogress'¶

succeeded = 'Succeeded'¶

class azure.mgmt.datafactory.models.SparkServerType[source]¶

Bases: enum.Enum

An enumeration.

shark_server = 'SharkServer'¶

shark_server2 = 'SharkServer2'¶

spark_thrift_server = 'SparkThriftServer'¶

class azure.mgmt.datafactory.models.SparkThriftTransportProtocol[source]¶

Bases: enum.Enum

An enumeration.

binary = 'Binary'¶

http = 'HTTP '¶

sasl = 'SASL'¶

class azure.mgmt.datafactory.models.SparkAuthenticationType[source]¶

Bases: 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: enum.Enum

An enumeration.

basic = 'Basic'¶

oauth2 = 'OAuth2'¶

class azure.mgmt.datafactory.models.PrestoAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

ldap = 'LDAP'¶

class azure.mgmt.datafactory.models.PhoenixAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

username_and_password = 'UsernameAndPassword'¶

windows_azure_hd_insight_service = 'WindowsAzureHDInsightService'¶

class azure.mgmt.datafactory.models.ImpalaAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

sasl_username = 'SASLUsername'¶

username_and_password = 'UsernameAndPassword'¶

class azure.mgmt.datafactory.models.HiveServerType[source]¶

Bases: enum.Enum

An enumeration.

hive_server1 = 'HiveServer1'¶

hive_server2 = 'HiveServer2'¶

hive_thrift_server = 'HiveThriftServer'¶

class azure.mgmt.datafactory.models.HiveThriftTransportProtocol[source]¶

Bases: enum.Enum

An enumeration.

binary = 'Binary'¶

http = 'HTTP '¶

sasl = 'SASL'¶

class azure.mgmt.datafactory.models.HiveAuthenticationType[source]¶

Bases: 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: enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

basic = 'Basic'¶

class azure.mgmt.datafactory.models.GoogleBigQueryAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

service_authentication = 'ServiceAuthentication'¶

user_authentication = 'UserAuthentication'¶

class azure.mgmt.datafactory.models.SapHanaAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

basic = 'Basic'¶

windows = 'Windows'¶

class azure.mgmt.datafactory.models.SftpAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

basic = 'Basic'¶

ssh_public_key = 'SshPublicKey'¶

class azure.mgmt.datafactory.models.FtpAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

basic = 'Basic'¶

class azure.mgmt.datafactory.models.HttpAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

basic = 'Basic'¶

client_certificate = 'ClientCertificate'¶

digest = 'Digest'¶

windows = 'Windows'¶

class azure.mgmt.datafactory.models.MongoDbAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

basic = 'Basic'¶

class azure.mgmt.datafactory.models.ODataAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

anonymous = 'Anonymous'¶

basic = 'Basic'¶

class azure.mgmt.datafactory.models.TeradataAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

basic = 'Basic'¶

windows = 'Windows'¶

class azure.mgmt.datafactory.models.Db2AuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

basic = 'Basic'¶

class azure.mgmt.datafactory.models.SybaseAuthenticationType[source]¶

Bases: enum.Enum

An enumeration.

basic = 'Basic'¶

windows = 'Windows'¶

class azure.mgmt.datafactory.models.DatasetCompressionLevel[source]¶

Bases: enum.Enum

An enumeration.

fastest = 'Fastest'¶

optimal = 'Optimal'¶

class azure.mgmt.datafactory.models.JsonFormatFilePattern[source]¶

Bases: enum.Enum

An enumeration.

array_of_objects = 'arrayOfObjects'¶

set_of_objects = 'setOfObjects'¶

class azure.mgmt.datafactory.models.TumblingWindowFrequency[source]¶

Bases: enum.Enum

An enumeration.

hour = 'Hour'¶

minute = 'Minute'¶

class azure.mgmt.datafactory.models.DayOfWeek[source]¶

Bases: 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: 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: enum.Enum

An enumeration.

day = 'Day'¶

hour = 'Hour'¶

minute = 'Minute'¶

month = 'Month'¶

not_specified = 'NotSpecified'¶

week = 'Week'¶

year = 'Year'¶

class azure.mgmt.datafactory.models.WebActivityMethod[source]¶

Bases: enum.Enum

An enumeration.

delete = 'DELETE'¶

get = 'GET'¶

post = 'POST'¶

put = 'PUT'¶

class azure.mgmt.datafactory.models.CassandraSourceReadConsistencyLevels[source]¶

Bases: 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.StoredProcedureParameterType[source]¶

Bases: enum.Enum

An enumeration.

boolean = 'Boolean'¶

date_enum = 'Date'¶

decimal_enum = 'Decimal'¶

guid = 'Guid'¶

int_enum = 'Int'¶

string = 'String'¶

class azure.mgmt.datafactory.models.SalesforceSourceReadBehavior[source]¶

Bases: enum.Enum

An enumeration.

query = 'Query'¶

query_all = 'QueryAll'¶

class azure.mgmt.datafactory.models.SSISExecutionRuntime[source]¶

Bases: enum.Enum

An enumeration.

x64 = 'x64'¶

x86 = 'x86'¶

class azure.mgmt.datafactory.models.HDInsightActivityDebugInfoOption[source]¶

Bases: enum.Enum

An enumeration.

always = 'Always'¶

failure = 'Failure'¶

none = 'None'¶

class azure.mgmt.datafactory.models.SalesforceSinkWriteBehavior[source]¶

Bases: enum.Enum

An enumeration.

insert = 'Insert'¶

upsert = 'Upsert'¶

class azure.mgmt.datafactory.models.AzureSearchIndexWriteBehaviorType[source]¶

Bases: enum.Enum

An enumeration.

merge = 'Merge'¶

upload = 'Upload'¶

class azure.mgmt.datafactory.models.CopyBehaviorType[source]¶

Bases: enum.Enum

An enumeration.

flatten_hierarchy = 'FlattenHierarchy'¶

merge_files = 'MergeFiles'¶

preserve_hierarchy = 'PreserveHierarchy'¶

class azure.mgmt.datafactory.models.PolybaseSettingsRejectType[source]¶

Bases: enum.Enum

An enumeration.

percentage = 'percentage'¶

value = 'value'¶

class azure.mgmt.datafactory.models.SapCloudForCustomerSinkWriteBehavior[source]¶

Bases: enum.Enum

An enumeration.

insert = 'Insert'¶

update = 'Update'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeType[source]¶

Bases: enum.Enum

An enumeration.

managed = 'Managed'¶

self_hosted = 'SelfHosted'¶

class azure.mgmt.datafactory.models.SelfHostedIntegrationRuntimeNodeStatus[source]¶

Bases: 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: enum.Enum

An enumeration.

fail = 'Fail'¶

succeed = 'Succeed'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeInternalChannelEncryptionMode[source]¶

Bases: enum.Enum

An enumeration.

not_encrypted = 'NotEncrypted'¶

not_set = 'NotSet'¶

ssl_encrypted = 'SslEncrypted'¶

class azure.mgmt.datafactory.models.ManagedIntegrationRuntimeNodeStatus[source]¶

Bases: enum.Enum

An enumeration.

available = 'Available'¶

recycling = 'Recycling'¶

starting = 'Starting'¶

unavailable = 'Unavailable'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeSsisCatalogPricingTier[source]¶

Bases: enum.Enum

An enumeration.

basic = 'Basic'¶

premium = 'Premium'¶

premium_rs = 'PremiumRS'¶

standard = 'Standard'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeLicenseType[source]¶

Bases: enum.Enum

An enumeration.

base_price = 'BasePrice'¶

license_included = 'LicenseIncluded'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeEdition[source]¶

Bases: enum.Enum

An enumeration.

enterprise = 'Enterprise'¶

standard = 'Standard'¶

class azure.mgmt.datafactory.models.IntegrationRuntimeAuthKeyName[source]¶

Bases: enum.Enum

An enumeration.

auth_key1 = 'authKey1'¶

auth_key2 = 'authKey2'¶