From 0dabf36bff5b76c538662aa65eef505cbd239c93 Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Tue, 8 Jan 2019 11:55:33 -0800 Subject: [PATCH 01/11] webhook changes --- .../2018-06-01/entityTypes/Pipeline.json | 94 ++++++++++++++++++- 1 file changed, 93 insertions(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index c80e37c45c41..3bf683db9038 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -5469,6 +5469,98 @@ "url" ] }, + "WebHookActivity": { + "x-ms-discriminator-value": "WebHook", + "description": "WebHook activity.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "WebHook activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebHookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebHookActivityMethod": { + "description": "The list of HTTP methods supported by a WebHook activity.", + "type": "string", + "enum": [ + "POST" + ], + "x-ms-enum": { + "name": "WebHookActivityMethod", + "modelAsString": true + } + }, + "WebHookActivityAuthentication": { + "description": "WebHook activity authentication properties.", + "properties": { + "type": { + "description": "WebHook activity authentication (Basic/ClientCertificate/MSI)", + "type": "string" + }, + "pfx": { + "description": "Base64-encoded contents of a PFX file.", + "$ref": "../datafactory.json#/definitions/SecureString" + }, + "username": { + "description": "WebHook activity authentication user name for basic authentication.", + "type": "string" + }, + "password": { + "description": "Password for the PFX file or basic authentication.", + "$ref": "../datafactory.json#/definitions/SecureString" + }, + "resource": { + "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "WebHookActivityTypeProperties": { + "description": "WebHook activity type properties.", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebHookActivityMethod" + }, + "url": { + "type": "object", + "description": "WebHook activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "timeout": { + "type": "object", + "description": "Specifies the timeout within which the webhook should be called back. If there is no value specified, it takes the value of TimeSpan.FromMinutes(10) which is 10 minutes as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "headers": { + "type": "object", + "description": "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": { + "type": "object", + "description": "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": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebHookActivityAuthentication" + } + }, + "required": [ + "method", + "url", + "timeout" + ] + }, "GetMetadataActivity": { "x-ms-discriminator-value": "GetMetadata", "description": "Activity to get metadata of dataset", @@ -6464,4 +6556,4 @@ } } } -} +} \ No newline at end of file From c542ffdd85bcd7290b0a79c1d3a17034feea6672 Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Tue, 8 Jan 2019 14:31:46 -0800 Subject: [PATCH 02/11] remove timeout as required --- .../stable/2018-06-01/entityTypes/Pipeline.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 3bf683db9038..c34e8ff003fc 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -5557,8 +5557,7 @@ }, "required": [ "method", - "url", - "timeout" + "url" ] }, "GetMetadataActivity": { From a3424c0a63aecd1772b024d57df1ee2e6c4e4407 Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Wed, 9 Jan 2019 17:03:07 -0800 Subject: [PATCH 03/11] combine and update web auth definitions --- .../2018-06-01/entityTypes/Pipeline.json | 45 +++++++------------ 1 file changed, 15 insertions(+), 30 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index c34e8ff003fc..10c5a8017e1f 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -5394,12 +5394,25 @@ "typeProperties" ] }, + "WebActivityAuthenticationType": { + "description": "The list of Authentication types supported by a Web Activity.", + "type": "string", + "enum": [ + "Basic", + "ClientCertificate", + "MSI" + ], + "x-ms-enum": { + "name": "WebActivityAuthenticationType", + "modelAsString": true + } + }, "WebActivityAuthentication": { "description": "Web activity authentication properties.", "properties": { "type": { "description": "Web activity authentication (Basic/ClientCertificate/MSI)", - "type": "string" + "$ref": "#/definitions/WebActivityAuthenticationType" }, "pfx": { "description": "Base64-encoded contents of a PFX file.", @@ -5499,34 +5512,6 @@ "modelAsString": true } }, - "WebHookActivityAuthentication": { - "description": "WebHook activity authentication properties.", - "properties": { - "type": { - "description": "WebHook activity authentication (Basic/ClientCertificate/MSI)", - "type": "string" - }, - "pfx": { - "description": "Base64-encoded contents of a PFX file.", - "$ref": "../datafactory.json#/definitions/SecureString" - }, - "username": { - "description": "WebHook activity authentication user name for basic authentication.", - "type": "string" - }, - "password": { - "description": "Password for the PFX file or basic authentication.", - "$ref": "../datafactory.json#/definitions/SecureString" - }, - "resource": { - "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", - "type": "string" - } - }, - "required": [ - "type" - ] - }, "WebHookActivityTypeProperties": { "description": "WebHook activity type properties.", "properties": { @@ -5552,7 +5537,7 @@ }, "authentication": { "description": "Authentication method used for calling the endpoint.", - "$ref": "#/definitions/WebHookActivityAuthentication" + "$ref": "#/definitions/WebActivityAuthentication" } }, "required": [ From a4c799f437e023dc38ea0b4b6879a9a5799460a1 Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Thu, 10 Jan 2019 12:06:32 -0800 Subject: [PATCH 04/11] revert auth type enum change --- .../stable/2018-06-01/entityTypes/Pipeline.json | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 10c5a8017e1f..0e9f9b7bca9c 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -5394,25 +5394,12 @@ "typeProperties" ] }, - "WebActivityAuthenticationType": { - "description": "The list of Authentication types supported by a Web Activity.", - "type": "string", - "enum": [ - "Basic", - "ClientCertificate", - "MSI" - ], - "x-ms-enum": { - "name": "WebActivityAuthenticationType", - "modelAsString": true - } - }, "WebActivityAuthentication": { "description": "Web activity authentication properties.", "properties": { "type": { "description": "Web activity authentication (Basic/ClientCertificate/MSI)", - "$ref": "#/definitions/WebActivityAuthenticationType" + "type": "string" }, "pfx": { "description": "Base64-encoded contents of a PFX file.", From 27163033511f904db417d7e529580329bccde3bf Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Tue, 28 Apr 2020 17:18:04 -0700 Subject: [PATCH 05/11] Revert "revert auth type enum change" This reverts commit a4c799f437e023dc38ea0b4b6879a9a5799460a1. --- .../stable/2018-06-01/entityTypes/Pipeline.json | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 0e9f9b7bca9c..10c5a8017e1f 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -5394,12 +5394,25 @@ "typeProperties" ] }, + "WebActivityAuthenticationType": { + "description": "The list of Authentication types supported by a Web Activity.", + "type": "string", + "enum": [ + "Basic", + "ClientCertificate", + "MSI" + ], + "x-ms-enum": { + "name": "WebActivityAuthenticationType", + "modelAsString": true + } + }, "WebActivityAuthentication": { "description": "Web activity authentication properties.", "properties": { "type": { "description": "Web activity authentication (Basic/ClientCertificate/MSI)", - "type": "string" + "$ref": "#/definitions/WebActivityAuthenticationType" }, "pfx": { "description": "Base64-encoded contents of a PFX file.", From c9315a6159098d8b70a51b164119b870e0ff0a74 Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Tue, 28 Apr 2020 17:23:48 -0700 Subject: [PATCH 06/11] Reset to master --- .../2018-06-01/entityTypes/Pipeline.json | 12980 ++++++++-------- 1 file changed, 6452 insertions(+), 6528 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 10c5a8017e1f..4407658a1c7e 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -1,6543 +1,6467 @@ { - "swagger": "2.0", - "info": { - "title": "DataFactoryManagementClient", - "version": "2018-06-01" - }, - "paths": {}, - "definitions": { - "Pipeline": { - "description": "A data factory pipeline.", - "type": "object", - "properties": { - "description": { - "description": "The description of the pipeline.", - "type": "string" - }, - "activities": { - "type": "array", - "description": "List of activities in pipeline.", - "items": { - "$ref": "#/definitions/Activity" - } - }, - "parameters": { - "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", - "description": "List of parameters for pipeline." - }, - "variables": { - "$ref": "../datafactory.json#/definitions/VariableDefinitionSpecification", - "description": "List of variables for pipeline." - }, - "concurrency": { - "type": "integer", - "minimum": 1, - "description": "The max number of concurrent runs for the pipeline." - }, - "annotations": { - "description": "List of tags that can be used for describing the Pipeline.", - "type": "array", - "items": { - "type": "object" - } - }, - "runDimensions": { - "description": "Dimensions emitted by Pipeline.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "folder": { - "description": "The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.", - "type": "object", - "properties": { - "name": { - "description": "The name of the folder that this Pipeline is in.", - "type": "string" - } - } - } - } - }, - "Activity": { - "discriminator": "type", - "description": "A pipeline activity.", - "type": "object", - "properties": { - "name": { - "description": "Activity name.", - "type": "string" - }, - "type": { - "type": "string", - "description": "Type of activity." - }, - "description": { - "description": "Activity description.", - "type": "string" - }, - "dependsOn": { - "type": "array", - "description": "Activity depends on condition.", - "items": { - "$ref": "#/definitions/ActivityDependency" - } - }, - "userProperties": { - "type": "array", - "description": "Activity user properties.", - "items": { - "$ref": "#/definitions/UserProperty" - } - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "name", - "type" - ] - }, - "UserProperty": { - "description": "User property.", - "type": "object", - "properties": { - "name": { - "description": "User property name.", - "type": "string" - }, - "value": { - "description": "User property value. Type: string (or Expression with resultType string).", - "type": "object" - } - }, - "required": [ - "name", - "value" - ] - }, - "ActivityDependency": { - "description": "Activity dependency information.", - "type": "object", - "properties": { - "activity": { - "description": "Activity name.", - "type": "string" - }, - "dependencyConditions": { - "type": "array", - "description": "Match-Condition for the dependency.", - "items": { - "type": "string", - "enum": [ - "Succeeded", - "Failed", - "Skipped", - "Completed" + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2018-06-01" + }, + "paths": {}, + "definitions": { + "Pipeline": { + "description": "A data factory pipeline.", + "type": "object", + "properties": { + "description": { + "description": "The description of the pipeline.", + "type": "string" + }, + "activities": { + "type": "array", + "description": "List of activities in pipeline.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "parameters": { + "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", + "description": "List of parameters for pipeline." + }, + "variables": { + "$ref": "../datafactory.json#/definitions/VariableDefinitionSpecification", + "description": "List of variables for pipeline." + }, + "concurrency": { + "type": "integer", + "minimum": 1, + "description": "The max number of concurrent runs for the pipeline." + }, + "annotations": { + "description": "List of tags that can be used for describing the Pipeline.", + "type": "array", + "items": { + "type": "object" + } + }, + "runDimensions": { + "description": "Dimensions emitted by Pipeline.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "folder": { + "description": "The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.", + "type": "object", + "properties": { + "name": { + "description": "The name of the folder that this Pipeline is in.", + "type": "string" + } + } + } + } + }, + "Activity": { + "discriminator": "type", + "description": "A pipeline activity.", + "type": "object", + "properties": { + "name": { + "description": "Activity name.", + "type": "string" + }, + "type": { + "type": "string", + "description": "Type of activity." + }, + "description": { + "description": "Activity description.", + "type": "string" + }, + "dependsOn": { + "type": "array", + "description": "Activity depends on condition.", + "items": { + "$ref": "#/definitions/ActivityDependency" + } + }, + "userProperties": { + "type": "array", + "description": "Activity user properties.", + "items": { + "$ref": "#/definitions/UserProperty" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "name", + "type" + ] + }, + "UserProperty": { + "description": "User property.", + "type": "object", + "properties": { + "name": { + "description": "User property name.", + "type": "string" + }, + "value": { + "description": "User property value. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "name", + "value" + ] + }, + "ActivityDependency": { + "description": "Activity dependency information.", + "type": "object", + "properties": { + "activity": { + "description": "Activity name.", + "type": "string" + }, + "dependencyConditions": { + "type": "array", + "description": "Match-Condition for the dependency.", + "items": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Skipped", + "Completed" + ], + "x-ms-enum": { + "name": "DependencyCondition", + "modelAsString": true + } + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "activity", + "dependencyConditions" + ] + }, + "ControlActivity": { + "x-ms-discriminator-value": "Container", + "description": "Base class for all control activities like IfCondition, ForEach , Until.", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } ], - "x-ms-enum": { - "name": "DependencyCondition", - "modelAsString": true + "properties": {} + }, + "ExecutionActivity": { + "x-ms-discriminator-value": "Execution", + "description": "Base class for all execution activities.", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "linkedServiceName": { + "description": "Linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "policy": { + "$ref": "#/definitions/ActivityPolicy", + "description": "Activity policy." + } } - } - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "activity", - "dependencyConditions" - ] - }, - "ControlActivity": { - "x-ms-discriminator-value": "Container", - "description": "Base class for all control activities like IfCondition, ForEach , Until.", - "allOf": [ - { - "$ref": "#/definitions/Activity" - } - ], - "properties": {} - }, - "ExecutionActivity": { - "x-ms-discriminator-value": "Execution", - "description": "Base class for all execution activities.", - "allOf": [ - { - "$ref": "#/definitions/Activity" - } - ], - "properties": { - "linkedServiceName": { - "description": "Linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "policy": { - "$ref": "#/definitions/ActivityPolicy", - "description": "Activity policy." - } - } - }, - "ActivityPolicy": { - "description": "Execution policy for an activity.", - "type": "object", - "properties": { - "timeout": { - "type": "object", - "description": "Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "retry": { - "type": "object", - "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "retryIntervalInSeconds": { - "type": "integer", - "description": "Interval between each retry attempt (in seconds). The default is 30 sec.", - "minimum": 30, - "maximum": 86400 - }, - "secureInput": { - "type": "boolean", - "description": "When set to true, Input from activity is considered as secure and will not be logged to monitoring." - }, - "secureOutput": { - "type": "boolean", - "description": "When set to true, Output from activity is considered as secure and will not be logged to monitoring." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "StoreReadSettings": { - "description": "Connector read setting.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The read setting type." - }, - "maxConcurrentConnections": { - "type": "object", - "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "AzureBlobStorageReadSettings": { - "description": "Azure blob read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Azure blob wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Azure blob wildcardFileName. Type: string (or Expression with resultType string)." - }, - "prefix": { - "type": "object", - "description": "The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "AzureBlobFSReadSettings": { - "description": "Azure blobFS read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Azure blobFS wildcardFileName. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "AzureDataLakeStoreReadSettings": { - "description": "Azure data lake store read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "ADLS wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "ADLS wildcardFileName. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "AmazonS3ReadSettings": { - "description": "Azure data lake store read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "AmazonS3 wildcardFileName. Type: string (or Expression with resultType string)." - }, - "prefix": { - "type": "object", - "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "FileServerReadSettings": { - "description": "File server read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "FileServer wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "FileServer wildcardFileName. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "fileFilter": { - "type": "object", - "description": "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)." - } - } - }, - "AzureFileStorageReadSettings": { - "description": "Azure File Storage read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Azure File Storage wildcardFileName. Type: string (or Expression with resultType string)." - }, - "prefix": { - "type": "object", - "description": "The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "SftpWriteSettings": { - "description": "Sftp write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreWriteSettings" - } - ], - "properties": { - "operationTimeout": { - "description": "Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).", - "type": "object" - }, - "useTempFileRename": { - "description": "Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn't support rename operation. Type: boolean (or Expression with resultType boolean).", - "type": "object" - } - } - }, - "GoogleCloudStorageReadSettings": { - "description": "Google Cloud Storage read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string)." - }, - "prefix": { - "type": "object", - "description": "The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "FtpReadSettings": { - "description": "Ftp read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Ftp wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Ftp wildcardFileName. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "useBinaryTransfer": { - "type": "boolean", - "description": "Specify whether to use binary transfer mode for FTP stores." - } - } - }, - "SftpReadSettings": { - "description": "Sftp read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Sftp wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Sftp wildcardFileName. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "HttpReadSettings": { - "description": "Sftp read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "requestMethod": { - "type": "object", - "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." - }, - "requestBody": { - "type": "object", - "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." - }, - "additionalHeaders": { - "type": "object", - "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." - }, - "requestTimeout": { - "type": "object", - "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - } - } - }, - "HdfsReadSettings": { - "description": "HDFS read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "HDFS wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "HDFS wildcardFileName. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "distcpSettings": { - "description": "Specifies Distcp-related settings.", - "$ref": "#/definitions/DistcpSettings" - } - } - }, - "StoreWriteSettings": { - "description": "Connector write settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The write setting type." - }, - "maxConcurrentConnections": { - "type": "object", - "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." - }, - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "type": "object" - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "AzureBlobStorageWriteSettings": { - "description": "Azure blob write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreWriteSettings" - } - ], - "properties": { - "blockSizeInMB": { - "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", - "type": "object" - } - } - }, - "AzureBlobFSWriteSettings": { - "description": "Azure blobFS write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreWriteSettings" - } - ], - "properties": { - "blockSizeInMB": { - "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", - "type": "object" - } - } - }, - "AzureDataLakeStoreWriteSettings": { - "description": "Azure data lake store write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreWriteSettings" - } - ], - "properties": { - "expiryDateTime": { - "description": "Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of \"2018-12-01T05:00:00Z\". Default value is NULL. Type: integer (or Expression with resultType integer).", - "type": "object" - } - } - }, - "FileServerWriteSettings": { - "description": "File server write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreWriteSettings" - } - ] - }, - "FormatReadSettings": { - "description": "Format read settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The read setting type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "CompressionReadSettings": { - "description": "Compression read settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The Compression setting type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "ZipDeflateReadSettings": { - "description": "The ZipDeflate compression read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CompressionReadSettings" - } - ], - "properties": { - "preserveZipFileNameAsFolder": { - "description": "Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).", - "type": "object" - } - } - }, - "DelimitedTextReadSettings": { - "description": "Delimited text read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatReadSettings" - } - ], - "properties": { - "skipLineCount": { - "type": "object", - "description": "Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer)." - }, - "compressionProperties": { - "$ref": "#/definitions/CompressionReadSettings", - "description": "Compression settings." - } - } - }, - "JsonReadSettings": { - "description": "Json read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatReadSettings" - } - ], - "properties": { - "compressionProperties": { - "$ref": "#/definitions/CompressionReadSettings", - "description": "Compression settings." - } - } - }, - "BinaryReadSettings": { - "description": "Binary read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatReadSettings" - } - ], - "properties": { - "compressionProperties": { - "$ref": "#/definitions/CompressionReadSettings", - "description": "Compression settings." - } - } - }, - "FormatWriteSettings": { - "description": "Format write settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The write setting type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "AvroWriteSettings": { - "description": "Avro write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatWriteSettings" - } - ], - "properties": { - "recordName": { - "type": "string", - "description": "Top level record name in write result, which is required in AVRO spec." - }, - "recordNamespace": { - "type": "string", - "description": "Record namespace in the write result." - } - } - }, - "DelimitedTextWriteSettings": { - "description": "Delimited text write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatWriteSettings" - } - ], - "properties": { - "quoteAllText": { - "type": "object", - "description": "Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean)." - }, - "fileExtension": { - "type": "object", - "description": "The file extension used to create the files. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "fileExtension" - ] - }, - "JsonWriteSettings": { - "description": "Json write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatWriteSettings" - } - ], - "properties": { - "filePattern": { - "description": "File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is 'setOfObjects'. It is case-sensitive.", - "type": "string", - "enum": [ - "setOfObjects", - "arrayOfObjects" - ], - "x-ms-enum": { - "name": "JsonWriteFilePattern", - "modelAsString": true - } - } - } - }, - "AvroSource": { - "description": "A copy activity Avro source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "Avro store settings." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "ParquetSource": { - "description": "A copy activity Parquet source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "Parquet store settings." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "DelimitedTextSource": { - "description": "A copy activity DelimitedText source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "DelimitedText store settings." - }, - "formatSettings": { - "$ref": "#/definitions/DelimitedTextReadSettings", - "description": "DelimitedText format settings." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "JsonSource": { - "description": "A copy activity Json source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "Json store settings." - }, - "formatSettings": { - "$ref": "#/definitions/JsonReadSettings", - "description": "Json format settings." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "OrcSource": { - "description": "A copy activity ORC source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "ORC store settings." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "DelimitedTextSink": { - "description": "A copy activity DelimitedText sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "DelimitedText store settings." - }, - "formatSettings": { - "$ref": "#/definitions/DelimitedTextWriteSettings", - "description": "DelimitedText format settings." - } - } - }, - "JsonSink": { - "description": "A copy activity Json sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "Json store settings." - }, - "formatSettings": { - "$ref": "#/definitions/JsonWriteSettings", - "description": "Json format settings." - } - } - }, - "OrcSink": { - "description": "A copy activity ORC sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "ORC store settings." - } - } - }, - "CopyActivity": { - "x-ms-discriminator-value": "Copy", - "description": "Copy activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Copy activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/CopyActivityTypeProperties" - }, - "inputs": { - "type": "array", - "description": "List of inputs for the activity.", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - }, - "outputs": { - "type": "array", - "description": "List of outputs for the activity.", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - } - }, - "required": [ - "typeProperties" - ] - }, - "CopyActivityTypeProperties": { - "description": "Copy activity properties.", - "properties": { - "source": { - "description": "Copy activity source.", - "$ref": "#/definitions/CopySource" - }, - "sink": { - "description": "Copy activity sink.", - "$ref": "#/definitions/CopySink" - }, - "translator": { - "description": "Copy activity translator. If not specified, tabular translator is used.", - "type": "object" - }, - "enableStaging": { - "type": "object", - "description": "Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." - }, - "stagingSettings": { - "description": "Specifies interim staging settings when EnableStaging is true.", - "$ref": "#/definitions/StagingSettings" - }, - "parallelCopies": { - "type": "object", - "description": "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." - }, - "dataIntegrationUnits": { - "type": "object", - "description": "Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "enableSkipIncompatibleRow": { - "type": "object", - "description": "Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean)." - }, - "redirectIncompatibleRowSettings": { - "description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true.", - "$ref": "#/definitions/RedirectIncompatibleRowSettings" - }, - "logStorageSettings": { - "description": "Log storage settings customer need to provide when enabling session log.", - "$ref": "#/definitions/LogStorageSettings" - }, - "preserveRules": { - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - }, - "description": "Preserve Rules." - }, - "preserve": { - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - }, - "description": "Preserve rules." - }, - "validateDataConsistency": { - "type": "object", - "description": "Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean)." - }, - "skipErrorFile": { - "description": "Specify the fault tolerance for data consistency.", - "$ref": "#/definitions/SkipErrorFile" - } - }, - "required": [ - "source", - "sink" - ] - }, - "CopySource": { - "discriminator": "type", - "description": "A copy activity source.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Copy source type." - }, - "sourceRetryCount": { - "type": "object", - "description": "Source retry count. Type: integer (or Expression with resultType integer)." - }, - "sourceRetryWait": { - "type": "object", - "description": "Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "maxConcurrentConnections": { - "type": "object", - "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "BinarySource": { - "description": "A copy activity Binary source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "Binary store settings." - }, - "formatSettings": { - "$ref": "#/definitions/BinaryReadSettings", - "description": "Binary format settings." - } - } - }, - "TabularSource": { - "description": "Copy activity sources of tabular type.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "AzureTableSource": { - "description": "A copy activity Azure Table source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "azureTableSourceQuery": { - "type": "object", - "description": "Azure Table source query. Type: string (or Expression with resultType string)." - }, - "azureTableSourceIgnoreTableNotFound": { - "type": "object", - "description": "Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "BlobSource": { - "description": "A copy activity Azure Blob source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "treatEmptyAsNull": { - "type": "object", - "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." - }, - "skipHeaderLineCount": { - "type": "object", - "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." - }, - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "DocumentDbCollectionSource": { - "description": "A copy activity Document Database Collection source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Documents query. Type: string (or Expression with resultType string)." - }, - "nestingSeparator": { - "type": "object", - "description": "Nested properties separator. Type: string (or Expression with resultType string)." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "CosmosDbSqlApiSource": { - "description": "A copy activity Azure CosmosDB (SQL API) Collection source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "SQL API query. Type: string (or Expression with resultType string)." - }, - "pageSize": { - "type": "object", - "description": "Page size of the result. Type: integer (or Expression with resultType integer)." - }, - "preferredRegions": { - "type": "object", - "description": "Preferred regions. Type: array of strings (or Expression with resultType array of strings)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "DynamicsSource": { - "description": "A copy activity Dynamics source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "DynamicsCrmSource": { - "description": "A copy activity Dynamics CRM source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "CommonDataServiceForAppsSource": { - "description": "A copy activity Common Data Service for Apps source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "RelationalSource": { - "description": "A copy activity source for various relational databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "InformixSource": { - "description": "A copy activity source for Informix.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "MicrosoftAccessSource": { - "description": "A copy activity source for Microsoft Access.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "Db2Source": { - "description": "A copy activity source for Db2 databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "OdbcSource": { - "description": "A copy activity source for ODBC databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "MySqlSource": { - "description": "A copy activity source for MySQL databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "PostgreSqlSource": { - "description": "A copy activity source for PostgreSQL databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "SybaseSource": { - "description": "A copy activity source for Sybase databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "SapBwSource": { - "description": "A copy activity source for SapBW server via MDX.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "MDX query. Type: string (or Expression with resultType string)." - } - } - }, - "ODataSource": { - "description": "A copy activity source for OData source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "SalesforceSource": { - "description": "A copy activity Salesforce source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "readBehavior": { - "description": "The read behavior for the operation. Default is Query.", - "type": "string", - "enum": [ - "Query", - "QueryAll" - ], - "x-ms-enum": { - "name": "SalesforceSourceReadBehavior", - "modelAsString": true - } - } - } - }, - "SalesforceServiceCloudSource": { - "description": "A copy activity Salesforce Service Cloud source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "readBehavior": { - "description": "The read behavior for the operation. Default is Query.", - "type": "string", - "enum": [ - "Query", - "QueryAll" - ], - "x-ms-enum": { - "name": "SalesforceSourceReadBehavior", - "modelAsString": true - } - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "SapCloudForCustomerSource": { - "description": "A copy activity source for SAP Cloud for Customer source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "SAP Cloud for Customer OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "SapEccSource": { - "description": "A copy activity source for SAP ECC source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "SAP ECC OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "SapHanaSource": { - "description": "A copy activity source for SAP HANA source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "SAP HANA Sql query. Type: string (or Expression with resultType string)." - }, - "packetSize": { - "type": "object", - "description": "The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer)." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for SAP HANA read in parallel.", - "type": "string", - "enum": [ - "None", - "PhysicalPartitionsOfTable", - "SapHanaDynamicRange" - ], - "x-ms-enum": { - "name": "SapHanaPartitionOption", - "modelAsString": true - } - }, - "partitionSettings": { - "description": "The settings that will be leveraged for SAP HANA source partitioning.", - "$ref": "#/definitions/SapHanaPartitionSettings" - } - } - }, - "SapHanaPartitionSettings": { - "description": "The settings that will be leveraged for SAP HANA source partitioning.", - "type": "object", - "properties": { - "partitionColumnName": { - "type": "object", - "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - } - } - }, - "SapOpenHubSource": { - "description": "A copy activity source for SAP Business Warehouse Open Hub Destination source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "excludeLastRequest": { - "type": "object", - "description": "Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean)." - }, - "baseRequestId": { - "type": "object", - "description": "The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer )." - } - } - }, - "SapTableSource": { - "description": "A copy activity source for SAP Table source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "rowCount": { - "type": "object", - "description": "The number of rows to be retrieved. Type: integer(or Expression with resultType integer)." - }, - "rowSkips": { - "type": "object", - "description": "The number of rows that will be skipped. Type: integer (or Expression with resultType integer)." - }, - "rfcTableFields": { - "type": "object", - "description": "The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string)." - }, - "rfcTableOptions": { - "type": "object", - "description": "The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string)." - }, - "batchSize": { - "type": "object", - "description": "Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer)." - }, - "customRfcReadTableFunctionModule": { - "type": "object", - "description": "Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string)." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for SAP table read in parallel.", - "type": "string", - "enum": [ - "None", - "PartitionOnInt", - "PartitionOnCalendarYear", - "PartitionOnCalendarMonth", - "PartitionOnCalendarDate", - "PartitionOnTime" - ], - "x-ms-enum": { - "name": "SapTablePartitionOption", - "modelAsString": true - } - }, - "partitionSettings": { - "description": "The settings that will be leveraged for SAP table source partitioning.", - "$ref": "#/definitions/SapTablePartitionSettings" - } - } - }, - "SapTablePartitionSettings": { - "description": "The settings that will be leveraged for SAP table source partitioning.", - "type": "object", - "properties": { - "partitionColumnName": { - "type": "object", - "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionUpperBound": { - "type": "object", - "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionLowerBound": { - "type": "object", - "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "maxPartitionsNumber": { - "type": "object", - "description": "The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string)." - } - } - }, - "RestSource": { - "description": "A copy activity Rest service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "requestMethod": { - "type": "object", - "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." - }, - "requestBody": { - "type": "object", - "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." - }, - "additionalHeaders": { - "type": "object", - "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." - }, - "paginationRules": { - "type": "object", - "description": "The pagination rules to compose next page requests. Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "requestInterval": { - "type": "object", - "description": "The time to await before sending next page request. " - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "SqlSource": { - "description": "A copy activity SQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "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)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "isolationLevel": { - "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", - "type": "object" - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "$ref": "#/definitions/SqlPartitionOption" - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "$ref": "#/definitions/SqlPartitionSettings" - } - } - }, - "SqlServerSource": { - "description": "A copy activity SQL server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "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)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "produceAdditionalTypes": { - "description": "Which additional types to produce.", - "type": "object" - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "$ref": "#/definitions/SqlPartitionOption" - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "$ref": "#/definitions/SqlPartitionSettings" - } - } - }, - "AzureSqlSource": { - "description": "A copy activity Azure SQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "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)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "produceAdditionalTypes": { - "description": "Which additional types to produce.", - "type": "object" - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "$ref": "#/definitions/SqlPartitionOption" - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "$ref": "#/definitions/SqlPartitionSettings" - } - } - }, - "SqlMISource": { - "description": "A copy activity Azure SQL Managed Instance source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "produceAdditionalTypes": { - "description": "Which additional types to produce.", - "type": "object" - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "$ref": "#/definitions/SqlPartitionOption" - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "$ref": "#/definitions/SqlPartitionSettings" - } - } - }, - "SqlDWSource": { - "description": "A copy activity SQL Data Warehouse source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL Data Warehouse reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "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)." - }, - "storedProcedureParameters": { - "type": "object", - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "$ref": "#/definitions/SqlPartitionOption" - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "$ref": "#/definitions/SqlPartitionSettings" - } - } - }, - "SqlPartitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "type": "object", - "properties": { - "partitionColumnName": { - "type": "object", - "description": "The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string)." - }, - "partitionUpperBound": { - "type": "object", - "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionLowerBound": { - "type": "object", - "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - } - } - }, - "SqlPartitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "type": "string", - "enum": [ - "None", - "PhysicalPartitionsOfTable", - "DynamicRange" - ], - "x-ms-enum": { - "name": "SqlPartitionOption", - "modelAsString": true - } - }, - "FileSystemSource": { - "description": "A copy activity file system source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "HdfsSource": { - "description": "A copy activity HDFS source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "distcpSettings": { - "description": "Specifies Distcp-related settings.", - "$ref": "#/definitions/DistcpSettings" - } - } - }, - "DistcpSettings": { - "description": "Distcp settings.", - "type": "object", - "properties": { - "resourceManagerEndpoint": { - "type": "object", - "description": "Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string)." - }, - "tempScriptPath": { - "type": "object", - "description": "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)." - }, - "distcpOptions": { - "type": "object", - "description": "Specifies the Distcp options. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "resourceManagerEndpoint", - "tempScriptPath" - ] - }, - "AzureMySqlSource": { - "description": "A copy activity Azure MySQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "AzureDataExplorerSource": { - "description": "A copy activity Azure Data Explorer (Kusto) source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string)." - }, - "noTruncation": { - "type": "object", - "description": "The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - }, - "required": [ - "query" - ] - }, - "OracleSource": { - "description": "A copy activity Oracle source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "oracleReaderQuery": { - "type": "object", - "description": "Oracle reader query. Type: string (or Expression with resultType string)." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Oracle read in parallel.", - "type": "string", - "enum": [ - "None", - "PhysicalPartitionsOfTable", - "DynamicRange" - ], - "x-ms-enum": { - "name": "OraclePartitionOption", - "modelAsString": true - } - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Oracle source partitioning.", - "$ref": "#/definitions/OraclePartitionSettings" - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "OraclePartitionSettings": { - "description": "The settings that will be leveraged for Oracle source partitioning.", - "type": "object", - "properties": { - "partitionNames": { - "type": "object", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - }, - "description": "Names of the physical partitions of Oracle table. " - }, - "partitionColumnName": { - "type": "object", - "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionUpperBound": { - "type": "object", - "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionLowerBound": { - "type": "object", - "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - } - } - }, - "TeradataSource": { - "description": "A copy activity Teradata source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Teradata query. Type: string (or Expression with resultType string)." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for teradata read in parallel.", - "type": "string", - "enum": [ - "None", - "Hash", - "DynamicRange" - ], - "x-ms-enum": { - "name": "TeradataPartitionOption", - "modelAsString": true - } - }, - "partitionSettings": { - "description": "The settings that will be leveraged for teradata source partitioning.", - "$ref": "#/definitions/TeradataPartitionSettings" - } - } - }, - "TeradataPartitionSettings": { - "description": "The settings that will be leveraged for teradata source partitioning.", - "type": "object", - "properties": { - "partitionColumnName": { - "type": "object", - "description": "The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string)." - }, - "partitionUpperBound": { - "type": "object", - "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionLowerBound": { - "type": "object", - "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - } - } - }, - "WebSource": { - "description": "A copy activity source for web page table.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "CassandraSource": { - "description": "A copy activity source for a Cassandra database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string)." - }, - "consistencyLevel": { - "description": "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.", - "type": "string", - "enum": [ - "ALL", - "EACH_QUORUM", - "QUORUM", - "LOCAL_QUORUM", - "ONE", - "TWO", - "THREE", - "LOCAL_ONE", - "SERIAL", - "LOCAL_SERIAL" - ], - "x-ms-enum": { - "name": "CassandraSourceReadConsistencyLevels", - "modelAsString": true - } - } - } - }, - "MongoDbSource": { - "description": "A copy activity source for a MongoDB database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "MongoDbV2Source": { - "description": "A copy activity source for a MongoDB database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "filter": { - "type": "object", - "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." - }, - "cursorMethods": { - "description": "Cursor methods for Mongodb query", - "$ref": "#/definitions/MongoDbCursorMethodsProperties" - }, - "batchSize": { - "type": "object", - "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "CosmosDbMongoDbApiSource": { - "description": "A copy activity source for a CosmosDB (MongoDB API) database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "filter": { - "type": "object", - "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." - }, - "cursorMethods": { - "description": "Cursor methods for Mongodb query.", - "$ref": "#/definitions/MongoDbCursorMethodsProperties" - }, - "batchSize": { - "type": "object", - "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "MongoDbCursorMethodsProperties": { - "description": "Cursor methods for Mongodb query", - "type": "object", - "properties": { - "project": { - "type": "object", - "description": "Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string)." - }, - "sort": { - "type": "object", - "description": "Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." - }, - "skip": { - "type": "object", - "description": "Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer)." - }, - "limit": { - "type": "object", - "description": "Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer)." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "Office365Source": { - "description": "A copy activity source for an Office 365 service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "allowedGroups": { - "type": "object", - "description": "The groups containing all the users. Type: array of strings (or Expression with resultType array of strings)." - }, - "userScopeFilterUri": { - "type": "object", - "description": "The user scope uri. Type: string (or Expression with resultType string)." - }, - "dateFilterColumn": { - "type": "object", - "description": "The Column to apply the and . Type: string (or Expression with resultType string)." - }, - "startTime": { - "type": "object", - "description": "Start time of the requested range for this dataset. Type: string (or Expression with resultType string)." - }, - "endTime": { - "type": "object", - "description": "End time of the requested range for this dataset. Type: string (or Expression with resultType string)." - }, - "outputColumns": { - "type": "object", - "description": "The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). Example: [ { \"name\": \"Id\" }, { \"name\": \"CreatedDateTime\" } ]" - } - } - }, - "AzureDataLakeStoreSource": { - "description": "A copy activity Azure Data Lake source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "AzureBlobFSSource": { - "description": "A copy activity Azure BlobFS source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "treatEmptyAsNull": { - "type": "object", - "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." - }, - "skipHeaderLineCount": { - "type": "object", - "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." - }, - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "HttpSource": { - "description": "A copy activity source for an HTTP file.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "httpRequestTimeout": { - "type": "object", - "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "AmazonMWSSource": { - "description": "A copy activity Amazon Marketplace Web Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "AzurePostgreSqlSource": { - "description": "A copy activity Azure PostgreSQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "AzurePostgreSqlSink": { - "description": "A copy activity Azure PostgreSQL sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "AzureMySqlSink": { - "description": "A copy activity Azure MySql sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "ConcurSource": { - "description": "A copy activity Concur Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "CouchbaseSource": { - "description": "A copy activity Couchbase server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "DrillSource": { - "description": "A copy activity Drill server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "EloquaSource": { - "description": "A copy activity Eloqua server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "GoogleBigQuerySource": { - "description": "A copy activity Google BigQuery service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "GreenplumSource": { - "description": "A copy activity Greenplum Database source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HBaseSource": { - "description": "A copy activity HBase server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HiveSource": { - "description": "A copy activity Hive Server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HubspotSource": { - "description": "A copy activity Hubspot Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ImpalaSource": { - "description": "A copy activity Impala server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "JiraSource": { - "description": "A copy activity Jira Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MagentoSource": { - "description": "A copy activity Magento server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MariaDBSource": { - "description": "A copy activity MariaDB server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "AzureMariaDBSource": { - "description": "A copy activity Azure MariaDB source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MarketoSource": { - "description": "A copy activity Marketo server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PaypalSource": { - "description": "A copy activity Paypal Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PhoenixSource": { - "description": "A copy activity Phoenix server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PrestoSource": { - "description": "A copy activity Presto server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "QuickBooksSource": { - "description": "A copy activity QuickBooks server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ServiceNowSource": { - "description": "A copy activity ServiceNow server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ShopifySource": { - "description": "A copy activity Shopify Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SparkSource": { - "description": "A copy activity Spark Server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SquareSource": { - "description": "A copy activity Square Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "XeroSource": { - "description": "A copy activity Xero Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ZohoSource": { - "description": "A copy activity Zoho server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "NetezzaSource": { - "description": "A copy activity Netezza source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Netezza read in parallel.", - "type": "string", - "enum": [ - "None", - "DataSlice", - "DynamicRange" - ], - "x-ms-enum": { - "name": "NetezzaPartitionOption", - "modelAsString": true - } - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Netezza source partitioning.", - "$ref": "#/definitions/NetezzaPartitionSettings" - } - } - }, - "NetezzaPartitionSettings": { - "description": "The settings that will be leveraged for Netezza source partitioning.", - "type": "object", - "properties": { - "partitionColumnName": { - "type": "object", - "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionUpperBound": { - "type": "object", - "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionLowerBound": { - "type": "object", - "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - } - } - }, - "VerticaSource": { - "description": "A copy activity Vertica source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SalesforceMarketingCloudSource": { - "description": "A copy activity Salesforce Marketing Cloud source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ResponsysSource": { - "description": "A copy activity Responsys source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "DynamicsAXSource": { - "description": "A copy activity Dynamics AX source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "OracleServiceCloudSource": { - "description": "A copy activity Oracle Service Cloud source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "GoogleAdWordsSource": { - "description": "A copy activity Google AdWords service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "AmazonRedshiftSource": { - "description": "A copy activity source for Amazon Redshift Source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "redshiftUnloadSettings": { - "description": "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.", - "$ref": "#/definitions/RedshiftUnloadSettings" - } - } - }, - "RedshiftUnloadSettings": { - "description": "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.", - "type": "object", - "properties": { - "s3LinkedServiceName": { - "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "bucketName": { - "type": "object", - "description": "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)." - } - }, - "required": [ - "s3LinkedServiceName", - "bucketName" - ] - }, - "SnowflakeSource": { - "description": "A copy activity snowflake source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." - }, - "exportSettings": { - "$ref": "#/definitions/SnowflakeExportCopyCommand", - "description": "Snowflake export settings." - } - } - }, - "ExportSettings": { - "description": "Export command settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The export setting type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "SnowflakeExportCopyCommand": { - "description": "Snowflake export command settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ExportSettings" - } - ], - "properties": { - "additionalCopyOptions": { - "type": "object", - "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", - "additionalProperties": { - "type": "object" - } - }, - "additionalFormatOptions": { - "type": "object", - "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"OVERWRITE\": \"TRUE\", \"MAX_FILE_SIZE\": \"'FALSE'\" }", - "additionalProperties": { - "type": "object" - } - } - } - }, - "StoredProcedureParameter": { - "description": "SQL stored procedure parameter.", - "type": "object", - "properties": { - "value": { - "type": "object", - "description": "Stored procedure parameter value. Type: string (or Expression with resultType string)." - }, - "type": { - "description": "Stored procedure parameter type.", - "$ref": "#/definitions/StoredProcedureParameterType" - } - } - }, - "StoredProcedureParameterType": { - "description": "Stored procedure parameter type.", - "type": "string", - "enum": [ - "String", - "Int", - "Int64", - "Decimal", - "Guid", - "Boolean", - "Date" - ], - "x-ms-enum": { - "name": "StoredProcedureParameterType", - "modelAsString": true - } - }, - "CopySink": { - "discriminator": "type", - "description": "A copy activity sink.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Copy sink type." - }, - "writeBatchSize": { - "type": "object", - "description": "Write batch size. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "writeBatchTimeout": { - "type": "object", - "description": "Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "sinkRetryCount": { - "type": "object", - "description": "Sink retry count. Type: integer (or Expression with resultType integer)." - }, - "sinkRetryWait": { - "type": "object", - "description": "Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "maxConcurrentConnections": { - "type": "object", - "description": "The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "SapCloudForCustomerSink": { - "description": "A copy activity SAP Cloud for Customer sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation. Default is 'Insert'.", - "type": "string", - "enum": [ - "Insert", - "Update" - ], - "x-ms-enum": { - "name": "SapCloudForCustomerSinkWriteBehavior", - "modelAsString": true - } - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "AzureQueueSink": { - "description": "A copy activity Azure Queue sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": {} - }, - "CopyBehaviorType": { - "description": "All available types of copy behavior.", - "type": "string", - "enum": [ - "PreserveHierarchy", - "FlattenHierarchy", - "MergeFiles" - ], - "x-ms-enum": { - "name": "CopyBehaviorType", - "modelAsString": true - } - }, - "AzureTableSink": { - "description": "A copy activity Azure Table sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "azureTableDefaultPartitionKeyValue": { - "type": "object", - "description": "Azure Table default partition key value. Type: string (or Expression with resultType string)." - }, - "azureTablePartitionKeyName": { - "type": "object", - "description": "Azure Table partition key name. Type: string (or Expression with resultType string)." - }, - "azureTableRowKeyName": { - "type": "object", - "description": "Azure Table row key name. Type: string (or Expression with resultType string)." - }, - "azureTableInsertType": { - "type": "object", - "description": "Azure Table insert type. Type: string (or Expression with resultType string)." - } - } - }, - "AvroSink": { - "description": "A copy activity Avro sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "Avro store settings." - }, - "formatSettings": { - "$ref": "#/definitions/AvroWriteSettings", - "description": "Avro format settings." - } - } - }, - "ParquetSink": { - "description": "A copy activity Parquet sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "Parquet store settings." - } - } - }, - "BinarySink": { - "description": "A copy activity Binary sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "Binary store settings." - } - } - }, - "BlobSink": { - "description": "A copy activity Azure Blob sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "blobWriterOverwriteFiles": { - "type": "object", - "description": "Blob writer overwrite files. Type: boolean (or Expression with resultType boolean)." - }, - "blobWriterDateTimeFormat": { - "type": "object", - "description": "Blob writer date time format. Type: string (or Expression with resultType string)." - }, - "blobWriterAddHeader": { - "type": "object", - "description": "Blob writer add header. Type: boolean (or Expression with resultType boolean)." - }, - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "type": "object" - } - } - }, - "FileSystemSink": { - "description": "A copy activity file system sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "type": "object" - } - } - }, - "DocumentDbCollectionSink": { - "description": "A copy activity Document Database Collection sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "nestingSeparator": { - "type": "object", - "description": "Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string)." - }, - "writeBehavior": { - "type": "object", - "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." - } - } - }, - "CosmosDbSqlApiSink": { - "description": "A copy activity Azure CosmosDB (SQL API) Collection sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "type": "object", - "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." - } - } - }, - "SqlSink": { - "description": "A copy activity SQL sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "sqlWriterStoredProcedureName": { - "type": "object", - "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." - }, - "sqlWriterTableType": { - "type": "object", - "description": "SQL writer table type. Type: string (or Expression with resultType string)." - }, - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "storedProcedureTableTypeParameterName": { - "type": "object", - "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." - }, - "tableOption": { - "type": "object", - "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." - } - } - }, - "SqlServerSink": { - "description": "A copy activity SQL server sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "sqlWriterStoredProcedureName": { - "type": "object", - "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." - }, - "sqlWriterTableType": { - "type": "object", - "description": "SQL writer table type. Type: string (or Expression with resultType string)." - }, - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "storedProcedureTableTypeParameterName": { - "type": "object", - "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." - }, - "tableOption": { - "type": "object", - "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." - } - } - }, - "AzureSqlSink": { - "description": "A copy activity Azure SQL sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "sqlWriterStoredProcedureName": { - "type": "object", - "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." - }, - "sqlWriterTableType": { - "type": "object", - "description": "SQL writer table type. Type: string (or Expression with resultType string)." - }, - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "storedProcedureTableTypeParameterName": { - "type": "object", - "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." - }, - "tableOption": { - "type": "object", - "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." - } - } - }, - "SqlMISink": { - "description": "A copy activity Azure SQL Managed Instance sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "sqlWriterStoredProcedureName": { - "type": "object", - "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." - }, - "sqlWriterTableType": { - "type": "object", - "description": "SQL writer table type. Type: string (or Expression with resultType string)." - }, - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "storedProcedureTableTypeParameterName": { - "type": "object", - "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." - }, - "tableOption": { - "type": "object", - "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." - } - } - }, - "SqlDWSink": { - "description": "A copy activity SQL Data Warehouse sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "allowPolyBase": { - "type": "object", - "description": "Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean)." - }, - "polyBaseSettings": { - "description": "Specifies PolyBase-related settings when allowPolyBase is true.", - "$ref": "#/definitions/PolybaseSettings" - }, - "allowCopyCommand": { - "type": "object", - "description": "Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean)." - }, - "copyCommandSettings": { - "description": "Specifies Copy Command related settings when allowCopyCommand is true.", - "$ref": "#/definitions/DWCopyCommandSettings" - }, - "tableOption": { - "type": "object", - "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." - } - } - }, - "PolybaseSettings": { - "description": "PolyBase settings.", - "type": "object", - "properties": { - "rejectType": { - "$ref": "#/definitions/PolybaseSettingsRejectType", - "description": "Reject type." - }, - "rejectValue": { - "type": "object", - "description": "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." - }, - "rejectSampleValue": { - "type": "object", - "description": "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." - }, - "useTypeDefault": { - "type": "object", - "description": "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)." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "PolybaseSettingsRejectType": { - "description": "Indicates whether the RejectValue property is specified as a literal value or a percentage.", - "type": "string", - "enum": [ - "value", - "percentage" - ], - "x-ms-enum": { - "name": "PolybaseSettingsRejectType", - "modelAsString": true - } - }, - "DWCopyCommandSettings": { - "description": "DW Copy Command settings.", - "type": "object", - "properties": { - "defaultValues": { - "type": "array", - "description": "Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/DWCopyCommandDefaultValue" - } - }, - "additionalOptions": { - "type": "object", - "description": "Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalOptions\": { \"MAXERRORS\": \"1000\", \"DATEFORMAT\": \"'ymd'\" }", - "additionalProperties": { - "type": "string" - } - } - } - }, - "DWCopyCommandDefaultValue": { - "description": "Default value.", - "type": "object", - "properties": { - "columnName": { - "type": "object", - "description": "Column name. Type: object (or Expression with resultType string)." - }, - "defaultValue": { - "type": "object", - "description": "The default value of the column. Type: object (or Expression with resultType string)." - } - } - }, - "SnowflakeSink": { - "description": "A copy activity snowflake sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "importSettings": { - "$ref": "#/definitions/SnowflakeImportCopyCommand", - "description": "Snowflake import settings." - } - } - }, - "ImportSettings": { - "description": "Import command settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The import setting type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "SnowflakeImportCopyCommand": { - "description": "Snowflake import command settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ImportSettings" - } - ], - "properties": { - "additionalCopyOptions": { - "type": "object", - "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", - "additionalProperties": { - "type": "object" - } - }, - "additionalFormatOptions": { - "type": "object", - "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"FORCE\": \"TRUE\", \"LOAD_UNCERTAIN_FILES\": \"'FALSE'\" }", - "additionalProperties": { - "type": "object" - } - } - } - }, - "LogStorageSettings": { - "description": "Log storage settings.", - "type": "object", - "properties": { - "linkedServiceName": { - "description": "Log storage linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "path": { - "type": "object", - "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "linkedServiceName" - ] - }, - "StagingSettings": { - "description": "Staging settings.", - "type": "object", - "properties": { - "linkedServiceName": { - "description": "Staging linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "path": { - "type": "object", - "description": "The path to storage for storing the interim data. Type: string (or Expression with resultType string)." - }, - "enableCompression": { - "type": "object", - "description": "Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "linkedServiceName" - ] - }, - "RedirectIncompatibleRowSettings": { - "description": "Redirect incompatible row settings", - "type": "object", - "properties": { - "linkedServiceName": { - "type": "object", - "description": "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": { - "type": "object", - "description": "The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "linkedServiceName" - ] - }, - "SkipErrorFile": { - "description": "Skip error file.", - "type": "object", - "properties": { - "fileMissing": { - "type": "object", - "description": "Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "dataInconsistency": { - "type": "object", - "description": "Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "AdditionalColumns": { - "description": "Specify the column name and value of additional columns.", - "type": "object", - "properties": { - "name": { - "type": "object", - "description": "Additional column name. Type: string (or Expression with resultType string)." - }, - "value": { - "type": "object", - "description": "Additional column value. Type: string (or Expression with resultType string)." - } - } - }, - "OracleSink": { - "description": "A copy activity Oracle sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - } - } - }, - "AzureDataLakeStoreSink": { - "description": "A copy activity Azure Data Lake Store sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "type": "object" - }, - "enableAdlsSingleFileParallel": { - "description": "Single File Parallel.", - "type": "object" - } - } - }, - "AzureBlobFSSink": { - "description": "A copy activity Azure Data Lake Storage Gen2 sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "type": "object" - } - } - }, - "AzureSearchIndexSink": { - "description": "A copy activity Azure Search Index sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "Specify the write behavior when upserting documents into Azure Search Index.", - "type": "string", - "enum": [ - "Merge", - "Upload" - ], - "x-ms-enum": { - "name": "AzureSearchIndexWriteBehaviorType", - "modelAsString": true - } - } - } - }, - "OdbcSink": { - "description": "A copy activity ODBC sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "InformixSink": { - "description": "A copy activity Informix sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "MicrosoftAccessSink": { - "description": "A copy activity Microsoft Access sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "DynamicsSink": { - "description": "A copy activity Dynamics sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation.", - "type": "string", - "enum": [ - "Upsert" - ], - "x-ms-enum": { - "name": "DynamicsSinkWriteBehavior", - "modelAsString": true - } - }, - "ignoreNullValues": { - "type": "object", - "description": "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)." - }, - "alternateKeyName": { - "type": "object", - "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "writeBehavior" - ] - }, - "DynamicsCrmSink": { - "description": "A copy activity Dynamics CRM sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation.", - "type": "string", - "enum": [ - "Upsert" - ], - "x-ms-enum": { - "name": "DynamicsSinkWriteBehavior", - "modelAsString": true - } - }, - "ignoreNullValues": { - "type": "object", - "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." - }, - "alternateKeyName": { - "type": "object", - "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "writeBehavior" - ] - }, - "CommonDataServiceForAppsSink": { - "description": "A copy activity Common Data Service for Apps sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation.", - "type": "string", - "enum": [ - "Upsert" - ], - "x-ms-enum": { - "name": "DynamicsSinkWriteBehavior", - "modelAsString": true - } - }, - "ignoreNullValues": { - "type": "object", - "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." - }, - "alternateKeyName": { - "type": "object", - "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "writeBehavior" - ] - }, - "AzureDataExplorerSink": { - "description": "A copy activity Azure Data Explorer sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "ingestionMappingName": { - "type": "object", - "description": "A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string." - }, - "ingestionMappingAsJson": { - "type": "object", - "description": "An explicit column mapping description provided in a json format. Type: string." - }, - "flushImmediately": { - "type": "object", - "description": "If set to true, any aggregation will be skipped. Default is false. Type: boolean." - } - } - }, - "SalesforceSink": { - "description": "A copy activity Salesforce sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation. Default is Insert.", - "type": "string", - "enum": [ - "Insert", - "Upsert" - ], - "x-ms-enum": { - "name": "SalesforceSinkWriteBehavior", - "modelAsString": true - } - }, - "externalIdFieldName": { - "type": "object", - "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." - }, - "ignoreNullValues": { - "type": "object", - "description": "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)." - } - } - }, - "SalesforceServiceCloudSink": { - "description": "A copy activity Salesforce Service Cloud sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation. Default is Insert.", - "type": "string", - "enum": [ - "Insert", - "Upsert" - ], - "x-ms-enum": { - "name": "SalesforceSinkWriteBehavior", - "modelAsString": true - } - }, - "externalIdFieldName": { - "type": "object", - "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." - }, - "ignoreNullValues": { - "type": "object", - "description": "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)." - } - } - }, - "CosmosDbMongoDbApiSink": { - "description": "A copy activity sink for a CosmosDB (MongoDB API) database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "type": "object", - "description": "Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is \"insert\". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." - } - } - }, - "CopyTranslator": { - "discriminator": "type", - "description": "A copy activity translator.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Copy translator type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "TabularTranslator": { - "description": "A copy activity tabular translator.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopyTranslator" - } - ], - "properties": { - "columnMappings": { - "type": "object", - "description": "Column mappings. Example: \"UserId: MyUserId, Group: MyGroup, Name: MyName\" Type: string (or Expression with resultType string). This property will be retired. Please use mappings property." - }, - "schemaMapping": { - "type": "object", - "description": "The schema mapping to map between tabular data and hierarchical data. Example: {\"Column1\": \"$.Column1\", \"Column2\": \"$.Column2.Property1\", \"Column3\": \"$.Column2.Property2\"}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property." - }, - "collectionReference": { - "type": "object", - "description": "The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object)." - }, - "mapComplexValuesToString": { - "type": "object", - "description": "Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean)." - }, - "mappings": { - "type": "object", - "description": "Column mappings with logical types. Tabular->tabular example: [{\"source\":{\"name\":\"CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"name\":\"CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Hierarchical->tabular example: [{\"source\":{\"path\":\"$.CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"path\":\"$.CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Type: object (or Expression with resultType object)." - } - } - }, - "HDInsightHiveActivity": { - "description": "HDInsight Hive activity type.", - "x-ms-discriminator-value": "HDInsightHive", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight Hive activity properties.", - "$ref": "#/definitions/HDInsightHiveActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightHiveActivityTypeProperties": { - "description": "HDInsight Hive activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "description": "User specified arguments to HDInsightActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "scriptPath": { - "type": "object", - "description": "Script path. Type: string (or Expression with resultType string)." - }, - "scriptLinkedService": { - "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "defines": { - "description": "Allows user to specify defines for Hive job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "variables": { - "description": "User specified arguments under hivevar namespace.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "queryTimeout": { - "type": "integer", - "description": "Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)" - } - } - }, - "HDInsightActivityDebugInfoOption": { - "description": "The HDInsightActivityDebugInfoOption settings to use.", - "type": "string", - "enum": [ - "None", - "Always", - "Failure" - ], - "x-ms-enum": { - "name": "HDInsightActivityDebugInfoOption", - "modelAsString": true - } - }, - "HDInsightPigActivity": { - "description": "HDInsight Pig activity type.", - "x-ms-discriminator-value": "HDInsightPig", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight Pig activity properties.", - "$ref": "#/definitions/HDInsightPigActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightPigActivityTypeProperties": { - "description": "HDInsight Pig activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "type": "object", - "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "scriptPath": { - "type": "object", - "description": "Script path. Type: string (or Expression with resultType string)." - }, - "scriptLinkedService": { - "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "defines": { - "description": "Allows user to specify defines for Pig job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - } - }, - "HDInsightMapReduceActivity": { - "description": "HDInsight MapReduce activity type.", - "x-ms-discriminator-value": "HDInsightMapReduce", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight MapReduce activity properties.", - "$ref": "#/definitions/HDInsightMapReduceActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightMapReduceActivityTypeProperties": { - "description": "HDInsight MapReduce activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "description": "User specified arguments to HDInsightActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "className": { - "type": "object", - "description": "Class name. Type: string (or Expression with resultType string)." - }, - "jarFilePath": { - "type": "object", - "description": "Jar path. Type: string (or Expression with resultType string)." - }, - "jarLinkedService": { - "description": "Jar linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "jarLibs": { - "description": "Jar libs.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "defines": { - "description": "Allows user to specify defines for the MapReduce job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "className", - "jarFilePath" - ] - }, - "HDInsightStreamingActivity": { - "description": "HDInsight streaming activity type.", - "x-ms-discriminator-value": "HDInsightStreaming", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight streaming activity properties.", - "$ref": "#/definitions/HDInsightStreamingActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightStreamingActivityTypeProperties": { - "description": "HDInsight streaming activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "description": "User specified arguments to HDInsightActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "mapper": { - "type": "object", - "description": "Mapper executable name. Type: string (or Expression with resultType string)." - }, - "reducer": { - "type": "object", - "description": "Reducer executable name. Type: string (or Expression with resultType string)." - }, - "input": { - "type": "object", - "description": "Input blob path. Type: string (or Expression with resultType string)." - }, - "output": { - "type": "object", - "description": "Output blob path. Type: string (or Expression with resultType string)." - }, - "filePaths": { - "description": "Paths to streaming job files. Can be directories.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "fileLinkedService": { - "description": "Linked service reference where the files are located.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "combiner": { - "type": "object", - "description": "Combiner executable name. Type: string (or Expression with resultType string)." - }, - "commandEnvironment": { - "description": "Command line environment values.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "defines": { - "description": "Allows user to specify defines for streaming job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "mapper", - "reducer", - "input", - "output", - "filePaths" - ] - }, - "HDInsightSparkActivity": { - "description": "HDInsight Spark activity.", - "x-ms-discriminator-value": "HDInsightSpark", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight spark activity properties.", - "$ref": "#/definitions/HDInsightSparkActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightSparkActivityTypeProperties": { - "description": "HDInsight spark activity properties.", - "properties": { - "rootPath": { - "type": "object", - "description": "The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string)." - }, - "entryFilePath": { - "type": "object", - "description": "The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string)." - }, - "arguments": { - "description": "The user-specified arguments to HDInsightSparkActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "sparkJobLinkedService": { - "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "className": { - "description": "The application's Java/Spark main class.", - "type": "string" - }, - "proxyUser": { - "type": "object", - "description": "The user to impersonate that will execute the job. Type: string (or Expression with resultType string)." - }, - "sparkConfig": { - "description": "Spark configuration property.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "rootPath", - "entryFilePath" - ] - }, - "ExecuteSSISPackageActivity": { - "description": "Execute SSIS package activity.", - "x-ms-discriminator-value": "ExecuteSSISPackage", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Execute SSIS package activity properties.", - "$ref": "#/definitions/ExecuteSSISPackageActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ExecuteSSISPackageActivityTypeProperties": { - "description": "Execute SSIS package activity properties.", - "properties": { - "packageLocation": { - "description": "SSIS package location.", - "$ref": "#/definitions/SSISPackageLocation" - }, - "runtime": { - "description": "Specifies the runtime to execute SSIS package. The value should be \"x86\" or \"x64\". Type: string (or Expression with resultType string).", - "type": "object" - }, - "loggingLevel": { - "description": "The logging level of SSIS package execution. Type: string (or Expression with resultType string).", - "type": "object" - }, - "environmentPath": { - "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string).", - "type": "object" - }, - "executionCredential": { - "description": "The package execution credential.", - "$ref": "#/definitions/SSISExecutionCredential" - }, - "connectVia": { - "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" - }, - "projectParameters": { - "description": "The project level parameters to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISExecutionParameter" - } - }, - "packageParameters": { - "description": "The package level parameters to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISExecutionParameter" - } - }, - "projectConnectionManagers": { - "description": "The project level connection managers to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISConnectionManager" - } - }, - "packageConnectionManagers": { - "description": "The package level connection managers to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISConnectionManager" - } - }, - "propertyOverrides": { - "description": "The property overrides to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISPropertyOverride" - } - }, - "logLocation": { - "description": "SSIS package execution log location.", - "$ref": "#/definitions/SSISLogLocation" - } - }, - "required": [ - "packageLocation", - "connectVia" - ] - }, - "SSISPackageLocation": { - "description": "SSIS package location.", - "type": "object", - "properties": { - "packagePath": { - "description": "The SSIS package path. Type: string (or Expression with resultType string).", - "type": "object" - }, - "type": { - "description": "The type of SSIS package location.", - "type": "string", - "enum": [ - "SSISDB", - "File", - "InlinePackage", - "PackageStore" - ], - "x-ms-enum": { - "name": "SsisPackageLocationType", - "modelAsString": true - } - }, - "typeProperties": { - "x-ms-client-flatten": true, - "description": "SSIS package location properties.", - "$ref": "#/definitions/SSISPackageLocationTypeProperties" - } - } - }, - "SSISPackageLocationTypeProperties": { - "description": "SSIS package location properties.", - "type": "object", - "properties": { - "packagePassword": { - "$ref": "../datafactory.json#/definitions/SecretBase", - "description": "Password of the package." - }, - "accessCredential": { - "description": "The package access credential.", - "$ref": "#/definitions/SSISAccessCredential" - }, - "configurationPath": { - "description": "The configuration file of the package execution. Type: string (or Expression with resultType string).", - "type": "object" - }, - "configurationAccessCredential": { - "description": "The configuration file access credential.", - "$ref": "#/definitions/SSISAccessCredential" - }, - "packageName": { - "description": "The package name.", - "type": "string" - }, - "packageContent": { - "description": "The embedded package content. Type: string (or Expression with resultType string).", - "type": "object" - }, - "packageLastModifiedDate": { - "description": "The embedded package last modified date.", - "type": "string" - }, - "childPackages": { - "description": "The embedded child package list.", - "type": "array", - "items": { - "$ref": "#/definitions/SSISChildPackage" - } - } - } - }, - "SSISConnectionManager": { - "description": "SSIS Connection Manager.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISExecutionParameter" - } - }, - "SSISExecutionParameter": { - "description": "SSIS execution parameter.", - "type": "object", - "properties": { - "value": { - "type": "object", - "description": "SSIS package execution parameter value. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "value" - ] - }, - "SSISPropertyOverride": { - "description": "SSIS property override.", - "type": "object", - "properties": { - "value": { - "type": "object", - "description": "SSIS package property override value. Type: string (or Expression with resultType string)." - }, - "isSensitive": { - "type": "boolean", - "description": "Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true" - } - }, - "required": [ - "value" - ] - }, - "SSISExecutionCredential": { - "description": "SSIS package execution credential.", - "type": "object", - "properties": { - "domain": { - "type": "object", - "description": "Domain for windows authentication." - }, - "userName": { - "type": "object", - "description": "UseName for windows authentication." - }, - "password": { - "$ref": "../datafactory.json#/definitions/SecureString", - "description": "Password for windows authentication." - } - }, - "required": [ - "domain", - "userName", - "password" - ] - }, - "SSISAccessCredential": { - "description": "SSIS access credential.", - "type": "object", - "properties": { - "domain": { - "type": "object", - "description": "Domain for windows authentication." - }, - "userName": { - "type": "object", - "description": "UseName for windows authentication." - }, - "password": { - "$ref": "../datafactory.json#/definitions/SecretBase", - "description": "Password for windows authentication." - } - }, - "required": [ - "domain", - "userName", - "password" - ] - }, - "SSISChildPackage": { - "description": "SSIS embedded child package.", - "type": "object", - "properties": { - "packagePath": { - "type": "object", - "description": "Path for embedded child package. Type: string (or Expression with resultType string)." - }, - "packageName": { - "type": "string", - "description": "Name for embedded child package." - }, - "packageContent": { - "type": "object", - "description": "Content for embedded child package. Type: string (or Expression with resultType string)." - }, - "packageLastModifiedDate": { - "type": "string", - "description": "Last modified date for embedded child package." - } - }, - "required": [ - "packagePath", - "packageContent" - ] - }, - "SSISLogLocation": { - "description": "SSIS package execution log location", - "type": "object", - "properties": { - "logPath": { - "description": "The SSIS package execution log path. Type: string (or Expression with resultType string).", - "type": "object" - }, - "type": { - "description": "The type of SSIS log location.", - "type": "string", - "enum": [ - "File" - ], - "x-ms-enum": { - "name": "SsisLogLocationType", - "modelAsString": true - } - }, - "typeProperties": { - "x-ms-client-flatten": true, - "description": "SSIS package execution log location properties.", - "$ref": "#/definitions/SSISLogLocationTypeProperties" - } - }, - "required": [ - "logPath", - "type", - "typeProperties" - ] - }, - "SSISLogLocationTypeProperties": { - "description": "SSIS package execution log location properties.", - "type": "object", - "properties": { - "accessCredential": { - "description": "The package execution log access credential.", - "$ref": "#/definitions/SSISAccessCredential" - }, - "logRefreshInterval": { - "type": "object", - "description": "Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "CustomActivity": { - "description": "Custom activity type.", - "x-ms-discriminator-value": "Custom", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Custom activity properties.", - "$ref": "#/definitions/CustomActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "CustomActivityTypeProperties": { - "description": "Custom activity properties.", - "properties": { - "command": { - "type": "object", - "description": "Command for custom activity Type: string (or Expression with resultType string)." - }, - "resourceLinkedService": { - "description": "Resource linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "folderPath": { - "type": "object", - "description": "Folder path for resource files Type: string (or Expression with resultType string)." - }, - "referenceObjects": { - "description": "Reference objects", - "$ref": "#/definitions/CustomActivityReferenceObject" - }, - "extendedProperties": { - "description": "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.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "retentionTimeInDays": { - "type": "object", - "description": "The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double)." - } - }, - "required": [ - "command" - ] - }, - "CustomActivityReferenceObject": { - "description": "Reference objects for custom activity", - "properties": { - "linkedServices": { - "description": "Linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "datasets": { - "description": "Dataset references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - } - } - }, - "SqlServerStoredProcedureActivity": { - "description": "SQL stored procedure activity type.", - "x-ms-discriminator-value": "SqlServerStoredProcedure", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "SQL stored procedure activity properties.", - "$ref": "#/definitions/SqlServerStoredProcedureActivityTypeProperties" - } - }, - "required": [ - "typeProperties", - "linkedServiceName" - ] - }, - "SqlServerStoredProcedureActivityTypeProperties": { - "description": "SQL stored procedure activity properties.", - "properties": { - "storedProcedureName": { - "type": "object", - "description": "Stored procedure name. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - } - }, - "required": [ - "storedProcedureName" - ] - }, - "ExecutePipelineActivity": { - "x-ms-discriminator-value": "ExecutePipeline", - "description": "Execute pipeline activity.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Execute pipeline activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExecutePipelineActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ExecutePipelineActivityTypeProperties": { - "description": "Execute pipeline activity properties.", - "properties": { - "pipeline": { - "description": "Pipeline reference.", - "$ref": "../datafactory.json#/definitions/PipelineReference" - }, - "parameters": { - "description": "Pipeline parameters.", - "$ref": "../datafactory.json#/definitions/ParameterValueSpecification" - }, - "waitOnCompletion": { - "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.", - "type": "boolean" - } - }, - "required": [ - "pipeline" - ] - }, - "DeleteActivity": { - "x-ms-discriminator-value": "Delete", - "description": "Delete activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Delete activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DeleteActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DeleteActivityTypeProperties": { - "description": "Delete activity properties.", - "properties": { - "recursive": { - "type": "object", - "description": "If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean)." - }, - "maxConcurrentConnections": { - "type": "integer", - "minimum": 1, - "description": "The max concurrent connections to connect data source at the same time." - }, - "enableLogging": { - "type": "object", - "description": "Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean)." - }, - "logStorageSettings": { - "description": "Log storage settings customer need to provide when enableLogging is true.", - "$ref": "#/definitions/LogStorageSettings" - }, - "dataset": { - "description": "Delete activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - }, - "required": [ - "dataset" - ] - }, - "AzureDataExplorerCommandActivity": { - "x-ms-discriminator-value": "AzureDataExplorerCommand", - "description": "Azure Data Explorer command activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Azure Data Explorer command activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureDataExplorerCommandActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureDataExplorerCommandActivityTypeProperties": { - "description": "Azure Data Explorer command activity properties.", - "properties": { - "command": { - "type": "object", - "description": "A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string)." - }, - "commandTimeout": { - "type": "object", - "description": "Control command timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))..)" - } - }, - "required": [ - "command" - ] - }, - "LookupActivity": { - "x-ms-discriminator-value": "Lookup", - "description": "Lookup activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Lookup activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/LookupActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "LookupActivityTypeProperties": { - "description": "Lookup activity properties.", - "properties": { - "source": { - "description": "Dataset-specific source properties, same as copy activity source.", - "$ref": "#/definitions/CopySource" - }, - "dataset": { - "description": "Lookup activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" - }, - "firstRowOnly": { - "type": "object", - "description": "Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean)." - } - }, - "required": [ - "source", - "dataset" - ] - }, - "WebActivityMethod": { - "description": "The list of HTTP methods supported by a WebActivity.", - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ], - "x-ms-enum": { - "name": "WebActivityMethod", - "modelAsString": true - } - }, - "WebActivity": { - "x-ms-discriminator-value": "WebActivity", - "description": "Web activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Web activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WebActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "WebActivityAuthenticationType": { - "description": "The list of Authentication types supported by a Web Activity.", - "type": "string", - "enum": [ - "Basic", - "ClientCertificate", - "MSI" - ], - "x-ms-enum": { - "name": "WebActivityAuthenticationType", - "modelAsString": true - } - }, - "WebActivityAuthentication": { - "description": "Web activity authentication properties.", - "properties": { - "type": { - "description": "Web activity authentication (Basic/ClientCertificate/MSI)", - "$ref": "#/definitions/WebActivityAuthenticationType" - }, - "pfx": { - "description": "Base64-encoded contents of a PFX file.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "username": { - "description": "Web activity authentication user name for basic authentication.", - "type": "string" - }, - "password": { - "description": "Password for the PFX file or basic authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "resource": { - "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", - "type": "string" - } - }, - "required": [ - "type" - ] - }, - "WebActivityTypeProperties": { - "description": "Web activity type properties.", - "properties": { - "method": { - "description": "Rest API method for target endpoint.", - "$ref": "#/definitions/WebActivityMethod" - }, - "url": { - "type": "object", - "description": "Web activity target endpoint and path. Type: string (or Expression with resultType string)." - }, - "headers": { - "type": "object", - "description": "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": { - "type": "object", - "description": "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": { - "description": "Authentication method used for calling the endpoint.", - "$ref": "#/definitions/WebActivityAuthentication" - }, - "datasets": { - "type": "array", - "description": "List of datasets passed to web endpoint.", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - }, - "linkedServices": { - "type": "array", - "description": "List of linked services passed to web endpoint.", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "connectVia": { - "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" - } - }, - "required": [ - "method", - "url" - ] - }, - "WebHookActivity": { - "x-ms-discriminator-value": "WebHook", - "description": "WebHook activity.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "WebHook activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WebHookActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "WebHookActivityMethod": { - "description": "The list of HTTP methods supported by a WebHook activity.", - "type": "string", - "enum": [ - "POST" - ], - "x-ms-enum": { - "name": "WebHookActivityMethod", - "modelAsString": true - } - }, - "WebHookActivityTypeProperties": { - "description": "WebHook activity type properties.", - "properties": { - "method": { - "description": "Rest API method for target endpoint.", - "$ref": "#/definitions/WebHookActivityMethod" - }, - "url": { - "type": "object", - "description": "WebHook activity target endpoint and path. Type: string (or Expression with resultType string)." - }, - "timeout": { - "type": "object", - "description": "Specifies the timeout within which the webhook should be called back. If there is no value specified, it takes the value of TimeSpan.FromMinutes(10) which is 10 minutes as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "headers": { - "type": "object", - "description": "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": { - "type": "object", - "description": "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": { - "description": "Authentication method used for calling the endpoint.", - "$ref": "#/definitions/WebActivityAuthentication" - } - }, - "required": [ - "method", - "url" - ] - }, - "GetMetadataActivity": { - "x-ms-discriminator-value": "GetMetadata", - "description": "Activity to get metadata of dataset", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "GetMetadata activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/GetMetadataActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "GetMetadataActivityTypeProperties": { - "description": "GetMetadata activity properties.", - "properties": { - "dataset": { - "description": "GetMetadata activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" - }, - "fieldList": { - "description": "Fields of metadata to get from dataset.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "dataset" - ] - }, - "IfConditionActivity": { - "x-ms-discriminator-value": "IfCondition", - "description": "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.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "IfCondition activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/IfConditionActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "IfConditionActivityTypeProperties": { - "description": "IfCondition activity properties.", - "properties": { - "expression": { - "description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "ifTrueActivities": { - "type": "array", - "description": "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.", - "items": { - "$ref": "#/definitions/Activity" - } - }, - "ifFalseActivities": { - "type": "array", - "description": "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.", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "expression" - ] - }, - "SwitchActivity": { - "x-ms-discriminator-value": "Switch", - "description": "This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Switch activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SwitchActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "SwitchActivityTypeProperties": { - "description": "Switch activity properties.", - "properties": { - "on": { - "description": "An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "cases": { - "type": "array", - "description": "List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.", - "items": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SwitchCase" - } - }, - "defaultActivities": { - "type": "array", - "description": "List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "on" - ] - }, - "SwitchCase": { - "description": "Switch cases with have a value and corresponding activities.", - "properties": { - "value": { - "description": "Expected value that satisfies the expression result of the 'on' property.", - "type": "string" - }, - "activities": { - "type": "array", - "description": "List of activities to execute for satisfied case condition.", - "items": { - "$ref": "#/definitions/Activity" - } - } - } - }, - "ForEachActivity": { - "x-ms-discriminator-value": "ForEach", - "description": "This activity is used for iterating over a collection and execute given activities.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "ForEach activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ForEachActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ForEachActivityTypeProperties": { - "description": "ForEach activity properties.", - "properties": { - "isSequential": { - "description": "Should the loop be executed in sequence or in parallel (max 50)", - "type": "boolean" - }, - "batchCount": { - "description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).", - "type": "integer", - "maximum": 50 - }, - "items": { - "description": "Collection to iterate.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "activities": { - "type": "array", - "description": "List of activities to execute .", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "items", - "activities" - ] - }, - "AzureMLBatchExecutionActivity": { - "description": "Azure ML Batch Execution activity.", - "x-ms-discriminator-value": "AzureMLBatchExecution", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Azure ML Batch Execution activity properties.", - "$ref": "#/definitions/AzureMLBatchExecutionActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureMLBatchExecutionActivityTypeProperties": { - "description": "Azure ML Batch Execution activity properties.", - "properties": { - "globalParameters": { - "description": "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.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "webServiceOutputs": { - "description": "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.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AzureMLWebServiceFile" - } - }, - "webServiceInputs": { - "description": "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.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AzureMLWebServiceFile" - } - } - } - }, - "AzureMLWebServiceFile": { - "description": "Azure ML WebService Input/Output file", - "type": "object", - "properties": { - "filePath": { - "type": "object", - "description": "The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string)." - }, - "linkedServiceName": { - "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "required": [ - "linkedServiceName", - "filePath" - ] - }, - "AzureMLUpdateResourceActivity": { - "description": "Azure ML Update Resource management activity.", - "x-ms-discriminator-value": "AzureMLUpdateResource", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Azure ML Update Resource management activity properties.", - "$ref": "#/definitions/AzureMLUpdateResourceActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureMLUpdateResourceActivityTypeProperties": { - "description": "Azure ML Update Resource activity properties.", - "properties": { - "trainedModelName": { - "type": "object", - "description": "Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string)." - }, - "trainedModelLinkedServiceName": { - "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "trainedModelFilePath": { - "type": "object", - "description": "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)." - } - }, - "required": [ - "trainedModelName", - "trainedModelLinkedServiceName", - "trainedModelFilePath" - ] - }, - "AzureMLExecutePipelineActivity": { - "description": "Azure ML Execute Pipeline activity.", - "x-ms-discriminator-value": "AzureMLExecutePipeline", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Azure ML Execute Pipeline activity properties.", - "$ref": "#/definitions/AzureMLExecutePipelineActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureMLExecutePipelineActivityTypeProperties": { - "description": "Azure ML Execute Pipeline activity properties.", - "properties": { - "mlPipelineId": { - "description": "ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).", - "type": "object" - }, - "experimentName": { - "description": "Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).", - "type": "object" - }, - "mlPipelineParameters": { - "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).", - "type": "object" - }, - "mlParentRunId": { - "description": "The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).", - "type": "object" - }, - "continueOnStepFailure": { - "description": "Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).", - "type": "object" - } - }, - "required": [ - "mlPipelineId" - ] - }, - "AzureMLPipelineParameters": { - "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "DataLakeAnalyticsUSQLActivity": { - "description": "Data Lake Analytics U-SQL activity.", - "x-ms-discriminator-value": "DataLakeAnalyticsU-SQL", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Data Lake Analytics U-SQL activity properties.", - "$ref": "#/definitions/DataLakeAnalyticsUSQLActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DataLakeAnalyticsUSQLActivityTypeProperties": { - "description": "DataLakeAnalyticsU-SQL activity properties.", - "properties": { - "scriptPath": { - "type": "object", - "description": "Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string)." - }, - "scriptLinkedService": { - "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "degreeOfParallelism": { - "type": "object", - "description": "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": { - "type": "object", - "description": "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": { - "description": "Parameters for U-SQL job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "runtimeVersion": { - "type": "object", - "description": "Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string)." - }, - "compilationMode": { - "type": "object", - "description": "Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "scriptPath", - "scriptLinkedService" - ] - }, - "WaitActivity": { - "x-ms-discriminator-value": "Wait", - "description": "This activity suspends pipeline execution for the specified interval.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Wait activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WaitActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "WaitActivityTypeProperties": { - "description": "Wait activity properties.", - "properties": { - "waitTimeInSeconds": { - "description": "Duration in seconds.", - "type": "integer" - } - }, - "required": [ - "waitTimeInSeconds" - ] - }, - "UntilActivity": { - "x-ms-discriminator-value": "Until", - "description": "This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Until activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/UntilActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "UntilActivityTypeProperties": { - "description": "Until activity properties.", - "properties": { - "expression": { - "description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "timeout": { - "type": "object", - "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "activities": { - "type": "array", - "description": "List of activities to execute.", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "expression", - "activities" - ] - }, - "ValidationActivity": { - "x-ms-discriminator-value": "Validation", - "description": "This activity verifies that an external resource exists.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Validation activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ValidationActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ValidationActivityTypeProperties": { - "description": "Validation activity properties.", - "properties": { - "timeout": { - "type": "object", - "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "sleep": { - "type": "object", - "description": "A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer)." - }, - "minimumSize": { - "type": "object", - "description": "Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer)." - }, - "childItems": { - "type": "object", - "description": "Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean)." - }, - "dataset": { - "description": "Validation activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - }, - "required": [ - "dataset" - ] - }, - "FilterActivity": { - "x-ms-discriminator-value": "Filter", - "description": "Filter and return results from input array based on the conditions.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Filter activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/FilterActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "FilterActivityTypeProperties": { - "description": "Filter activity properties.", - "properties": { - "items": { - "description": "Input array on which filter should be applied.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "condition": { - "description": "Condition to be used for filtering the input.", - "$ref": "../datafactory.json#/definitions/Expression" - } - }, - "required": [ - "condition", - "items" - ] - }, - "DatabricksNotebookActivity": { - "description": "DatabricksNotebook activity.", - "x-ms-discriminator-value": "DatabricksNotebook", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Databricks Notebook activity properties.", - "$ref": "#/definitions/DatabricksNotebookActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DatabricksNotebookActivityTypeProperties": { - "description": "Databricks Notebook activity properties.", - "properties": { - "notebookPath": { - "type": "object", - "description": "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)." - }, - "baseParameters": { - "description": "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.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "libraries": { - "description": "A list of libraries to be installed on the cluster that will execute the job.", - "type": "array", - "items": { - "type": "object", - "description": "Databricks library definition.", + }, + "ActivityPolicy": { + "description": "Execution policy for an activity.", + "type": "object", + "properties": { + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "retry": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "retryIntervalInSeconds": { + "type": "integer", + "description": "Interval between each retry attempt (in seconds). The default is 30 sec.", + "minimum": 30, + "maximum": 86400 + }, + "secureInput": { + "type": "boolean", + "description": "When set to true, Input from activity is considered as secure and will not be logged to monitoring." + }, + "secureOutput": { + "type": "boolean", + "description": "When set to true, Output from activity is considered as secure and will not be logged to monitoring." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "StoreReadSettings": { + "description": "Connector read setting.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The read setting type." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureBlobStorageReadSettings": { + "description": "Azure blob read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure blob wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure blob wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AzureBlobFSReadSettings": { + "description": "Azure blobFS read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure blobFS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreReadSettings": { + "description": "Azure data lake store read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "ADLS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "ADLS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonS3ReadSettings": { + "description": "Azure data lake store read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "AmazonS3 wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "FileServerReadSettings": { + "description": "File server read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "FileServer wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "FileServer wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "fileFilter": { + "type": "object", + "description": "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)." + } + } + }, + "AzureFileStorageReadSettings": { + "description": "Azure File Storage read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure File Storage wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "SftpWriteSettings": { + "description": "Sftp write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "operationTimeout": { + "description": "Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).", + "type": "object" + }, + "useTempFileRename": { + "description": "Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn't support rename operation. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "GoogleCloudStorageReadSettings": { + "description": "Google Cloud Storage read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "FtpReadSettings": { + "description": "Ftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Ftp wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Ftp wildcardFileName. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "useBinaryTransfer": { + "type": "boolean", + "description": "Specify whether to use binary transfer mode for FTP stores." + } + } + }, + "SftpReadSettings": { + "description": "Sftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Sftp wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Sftp wildcardFileName. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "HttpReadSettings": { + "description": "Sftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "requestTimeout": { + "type": "object", + "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + } + } + }, + "HdfsReadSettings": { + "description": "HDFS read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "HDFS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "HDFS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "distcpSettings": { + "description": "Specifies Distcp-related settings.", + "$ref": "#/definitions/DistcpSettings" + } + } + }, + "StoreWriteSettings": { + "description": "Connector write settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The write setting type." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + }, + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureBlobStorageWriteSettings": { + "description": "Azure blob write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "blockSizeInMB": { + "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "AzureBlobFSWriteSettings": { + "description": "Azure blobFS write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "blockSizeInMB": { + "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "AzureDataLakeStoreWriteSettings": { + "description": "Azure data lake store write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "expiryDateTime": { + "description": "Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of \"2018-12-01T05:00:00Z\". Default value is NULL. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "FileServerWriteSettings": { + "description": "File server write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ] + }, + "FormatReadSettings": { + "description": "Format read settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The read setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "CompressionReadSettings": { + "description": "Compression read settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The Compression setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "ZipDeflateReadSettings": { + "description": "The ZipDeflate compression read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CompressionReadSettings" + } + ], + "properties": { + "preserveZipFileNameAsFolder": { + "description": "Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "DelimitedTextReadSettings": { + "description": "Delimited text read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "skipLineCount": { + "type": "object", + "description": "Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer)." + }, + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "JsonReadSettings": { + "description": "Json read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "BinaryReadSettings": { + "description": "Binary read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "FormatWriteSettings": { + "description": "Format write settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The write setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AvroWriteSettings": { + "description": "Avro write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "recordName": { + "type": "string", + "description": "Top level record name in write result, which is required in AVRO spec." + }, + "recordNamespace": { + "type": "string", + "description": "Record namespace in the write result." + } + } + }, + "DelimitedTextWriteSettings": { + "description": "Delimited text write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "quoteAllText": { + "type": "object", + "description": "Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean)." + }, + "fileExtension": { + "type": "object", + "description": "The file extension used to create the files. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "fileExtension" + ] + }, + "JsonWriteSettings": { + "description": "Json write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "filePattern": { + "description": "File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is 'setOfObjects'. It is case-sensitive.", + "type": "string", + "enum": [ + "setOfObjects", + "arrayOfObjects" + ], + "x-ms-enum": { + "name": "JsonWriteFilePattern", + "modelAsString": true + } + } + } + }, + "AvroSource": { + "description": "A copy activity Avro source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Avro store settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "ParquetSource": { + "description": "A copy activity Parquet source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Parquet store settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "DelimitedTextSource": { + "description": "A copy activity DelimitedText source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "DelimitedText store settings." + }, + "formatSettings": { + "$ref": "#/definitions/DelimitedTextReadSettings", + "description": "DelimitedText format settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "JsonSource": { + "description": "A copy activity Json source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Json store settings." + }, + "formatSettings": { + "$ref": "#/definitions/JsonReadSettings", + "description": "Json format settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "OrcSource": { + "description": "A copy activity ORC source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "ORC store settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "DelimitedTextSink": { + "description": "A copy activity DelimitedText sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "DelimitedText store settings." + }, + "formatSettings": { + "$ref": "#/definitions/DelimitedTextWriteSettings", + "description": "DelimitedText format settings." + } + } + }, + "JsonSink": { + "description": "A copy activity Json sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Json store settings." + }, + "formatSettings": { + "$ref": "#/definitions/JsonWriteSettings", + "description": "Json format settings." + } + } + }, + "OrcSink": { + "description": "A copy activity ORC sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "ORC store settings." + } + } + }, + "CopyActivity": { + "x-ms-discriminator-value": "Copy", + "description": "Copy activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Copy activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CopyActivityTypeProperties" + }, + "inputs": { + "type": "array", + "description": "List of inputs for the activity.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "outputs": { + "type": "array", + "description": "List of outputs for the activity.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + } + }, + "required": [ + "typeProperties" + ] + }, + "CopyActivityTypeProperties": { + "description": "Copy activity properties.", + "properties": { + "source": { + "description": "Copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "sink": { + "description": "Copy activity sink.", + "$ref": "#/definitions/CopySink" + }, + "translator": { + "description": "Copy activity translator. If not specified, tabular translator is used.", + "type": "object" + }, + "enableStaging": { + "type": "object", + "description": "Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "stagingSettings": { + "description": "Specifies interim staging settings when EnableStaging is true.", + "$ref": "#/definitions/StagingSettings" + }, + "parallelCopies": { + "type": "object", + "description": "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." + }, + "dataIntegrationUnits": { + "type": "object", + "description": "Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "enableSkipIncompatibleRow": { + "type": "object", + "description": "Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "redirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true.", + "$ref": "#/definitions/RedirectIncompatibleRowSettings" + }, + "logStorageSettings": { + "description": "Log storage settings customer need to provide when enabling session log.", + "$ref": "#/definitions/LogStorageSettings" + }, + "preserveRules": { + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Preserve Rules." + }, + "preserve": { + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Preserve rules." + }, + "validateDataConsistency": { + "type": "object", + "description": "Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean)." + }, + "skipErrorFile": { + "description": "Specify the fault tolerance for data consistency.", + "$ref": "#/definitions/SkipErrorFile" + } + }, + "required": [ + "source", + "sink" + ] + }, + "CopySource": { + "discriminator": "type", + "description": "A copy activity source.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy source type." + }, + "sourceRetryCount": { + "type": "object", + "description": "Source retry count. Type: integer (or Expression with resultType integer)." + }, + "sourceRetryWait": { + "type": "object", + "description": "Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "BinarySource": { + "description": "A copy activity Binary source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Binary store settings." + }, + "formatSettings": { + "$ref": "#/definitions/BinaryReadSettings", + "description": "Binary format settings." + } + } + }, + "TabularSource": { + "description": "Copy activity sources of tabular type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "AzureTableSource": { + "description": "A copy activity Azure Table source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "azureTableSourceQuery": { + "type": "object", + "description": "Azure Table source query. Type: string (or Expression with resultType string)." + }, + "azureTableSourceIgnoreTableNotFound": { + "type": "object", + "description": "Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "BlobSource": { + "description": "A copy activity Azure Blob source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." + }, + "skipHeaderLineCount": { + "type": "object", + "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." + }, + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "DocumentDbCollectionSource": { + "description": "A copy activity Document Database Collection source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Documents query. Type: string (or Expression with resultType string)." + }, + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Type: string (or Expression with resultType string)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "CosmosDbSqlApiSource": { + "description": "A copy activity Azure CosmosDB (SQL API) Collection source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SQL API query. Type: string (or Expression with resultType string)." + }, + "pageSize": { + "type": "object", + "description": "Page size of the result. Type: integer (or Expression with resultType integer)." + }, + "preferredRegions": { + "type": "object", + "description": "Preferred regions. Type: array of strings (or Expression with resultType array of strings)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "DynamicsSource": { + "description": "A copy activity Dynamics source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "DynamicsCrmSource": { + "description": "A copy activity Dynamics CRM source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "CommonDataServiceForAppsSource": { + "description": "A copy activity Common Data Service for Apps source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "RelationalSource": { + "description": "A copy activity source for various relational databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "InformixSource": { + "description": "A copy activity source for Informix.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "MicrosoftAccessSource": { + "description": "A copy activity source for Microsoft Access.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "Db2Source": { + "description": "A copy activity source for Db2 databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "OdbcSource": { + "description": "A copy activity source for ODBC databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "MySqlSource": { + "description": "A copy activity source for MySQL databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "PostgreSqlSource": { + "description": "A copy activity source for PostgreSQL databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "SybaseSource": { + "description": "A copy activity source for Sybase databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "SapBwSource": { + "description": "A copy activity source for SapBW server via MDX.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "MDX query. Type: string (or Expression with resultType string)." + } + } + }, + "ODataSource": { + "description": "A copy activity source for OData source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "SalesforceSource": { + "description": "A copy activity Salesforce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "readBehavior": { + "description": "The read behavior for the operation. Default is Query.", + "type": "string", + "enum": [ + "Query", + "QueryAll" + ], + "x-ms-enum": { + "name": "SalesforceSourceReadBehavior", + "modelAsString": true + } + } + } + }, + "SalesforceServiceCloudSource": { + "description": "A copy activity Salesforce Service Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "readBehavior": { + "description": "The read behavior for the operation. Default is Query.", + "type": "string", + "enum": [ + "Query", + "QueryAll" + ], + "x-ms-enum": { + "name": "SalesforceSourceReadBehavior", + "modelAsString": true + } + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "SapCloudForCustomerSource": { + "description": "A copy activity source for SAP Cloud for Customer source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP Cloud for Customer OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "SapEccSource": { + "description": "A copy activity source for SAP ECC source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP ECC OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "SapHanaSource": { + "description": "A copy activity source for SAP HANA source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP HANA Sql query. Type: string (or Expression with resultType string)." + }, + "packetSize": { + "type": "object", + "description": "The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for SAP HANA read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "SapHanaDynamicRange" + ], + "x-ms-enum": { + "name": "SapHanaPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for SAP HANA source partitioning.", + "$ref": "#/definitions/SapHanaPartitionSettings" + } + } + }, + "SapHanaPartitionSettings": { + "description": "The settings that will be leveraged for SAP HANA source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "SapOpenHubSource": { + "description": "A copy activity source for SAP Business Warehouse Open Hub Destination source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "excludeLastRequest": { + "type": "object", + "description": "Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "baseRequestId": { + "type": "object", + "description": "The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer )." + } + } + }, + "SapTableSource": { + "description": "A copy activity source for SAP Table source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "rowCount": { + "type": "object", + "description": "The number of rows to be retrieved. Type: integer(or Expression with resultType integer)." + }, + "rowSkips": { + "type": "object", + "description": "The number of rows that will be skipped. Type: integer (or Expression with resultType integer)." + }, + "rfcTableFields": { + "type": "object", + "description": "The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string)." + }, + "rfcTableOptions": { + "type": "object", + "description": "The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string)." + }, + "batchSize": { + "type": "object", + "description": "Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer)." + }, + "customRfcReadTableFunctionModule": { + "type": "object", + "description": "Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for SAP table read in parallel.", + "type": "string", + "enum": [ + "None", + "PartitionOnInt", + "PartitionOnCalendarYear", + "PartitionOnCalendarMonth", + "PartitionOnCalendarDate", + "PartitionOnTime" + ], + "x-ms-enum": { + "name": "SapTablePartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for SAP table source partitioning.", + "$ref": "#/definitions/SapTablePartitionSettings" + } + } + }, + "SapTablePartitionSettings": { + "description": "The settings that will be leveraged for SAP table source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "maxPartitionsNumber": { + "type": "object", + "description": "The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string)." + } + } + }, + "RestSource": { + "description": "A copy activity Rest service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "paginationRules": { + "type": "object", + "description": "The pagination rules to compose next page requests. Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "requestInterval": { + "type": "object", + "description": "The time to await before sending next page request. " + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "SqlSource": { + "description": "A copy activity SQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "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)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "isolationLevel": { + "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlServerSource": { + "description": "A copy activity SQL server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "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)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "AzureSqlSource": { + "description": "A copy activity Azure SQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "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)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlMISource": { + "description": "A copy activity Azure SQL Managed Instance source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlDWSource": { + "description": "A copy activity SQL Data Warehouse source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL Data Warehouse reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "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)." + }, + "storedProcedureParameters": { + "type": "object", + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlPartitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "SqlPartitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "SqlPartitionOption", + "modelAsString": true + } + }, + "FileSystemSource": { + "description": "A copy activity file system source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "HdfsSource": { + "description": "A copy activity HDFS source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "distcpSettings": { + "description": "Specifies Distcp-related settings.", + "$ref": "#/definitions/DistcpSettings" + } + } + }, + "DistcpSettings": { + "description": "Distcp settings.", + "type": "object", + "properties": { + "resourceManagerEndpoint": { + "type": "object", + "description": "Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string)." + }, + "tempScriptPath": { + "type": "object", + "description": "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)." + }, + "distcpOptions": { + "type": "object", + "description": "Specifies the Distcp options. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "resourceManagerEndpoint", + "tempScriptPath" + ] + }, + "AzureMySqlSource": { + "description": "A copy activity Azure MySQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataExplorerSource": { + "description": "A copy activity Azure Data Explorer (Kusto) source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string)." + }, + "noTruncation": { + "type": "object", + "description": "The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + }, + "required": [ + "query" + ] + }, + "OracleSource": { + "description": "A copy activity Oracle source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "oracleReaderQuery": { + "type": "object", + "description": "Oracle reader query. Type: string (or Expression with resultType string)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Oracle read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "OraclePartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Oracle source partitioning.", + "$ref": "#/definitions/OraclePartitionSettings" + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "OraclePartitionSettings": { + "description": "The settings that will be leveraged for Oracle source partitioning.", + "type": "object", + "properties": { + "partitionNames": { + "type": "object", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Names of the physical partitions of Oracle table. " + }, + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "TeradataSource": { + "description": "A copy activity Teradata source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Teradata query. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for teradata read in parallel.", + "type": "string", + "enum": [ + "None", + "Hash", + "DynamicRange" + ], + "x-ms-enum": { + "name": "TeradataPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for teradata source partitioning.", + "$ref": "#/definitions/TeradataPartitionSettings" + } + } + }, + "TeradataPartitionSettings": { + "description": "The settings that will be leveraged for teradata source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "WebSource": { + "description": "A copy activity source for web page table.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "CassandraSource": { + "description": "A copy activity source for a Cassandra database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string)." + }, + "consistencyLevel": { + "description": "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.", + "type": "string", + "enum": [ + "ALL", + "EACH_QUORUM", + "QUORUM", + "LOCAL_QUORUM", + "ONE", + "TWO", + "THREE", + "LOCAL_ONE", + "SERIAL", + "LOCAL_SERIAL" + ], + "x-ms-enum": { + "name": "CassandraSourceReadConsistencyLevels", + "modelAsString": true + } + } + } + }, + "MongoDbSource": { + "description": "A copy activity source for a MongoDB database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "MongoDbV2Source": { + "description": "A copy activity source for a MongoDB database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "CosmosDbMongoDbApiSource": { + "description": "A copy activity source for a CosmosDB (MongoDB API) database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query.", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "MongoDbCursorMethodsProperties": { + "description": "Cursor methods for Mongodb query", + "type": "object", + "properties": { + "project": { + "type": "object", + "description": "Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string)." + }, + "sort": { + "type": "object", + "description": "Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." + }, + "skip": { + "type": "object", + "description": "Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer)." + }, + "limit": { + "type": "object", + "description": "Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "Office365Source": { + "description": "A copy activity source for an Office 365 service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "allowedGroups": { + "type": "object", + "description": "The groups containing all the users. Type: array of strings (or Expression with resultType array of strings)." + }, + "userScopeFilterUri": { + "type": "object", + "description": "The user scope uri. Type: string (or Expression with resultType string)." + }, + "dateFilterColumn": { + "type": "object", + "description": "The Column to apply the and . Type: string (or Expression with resultType string)." + }, + "startTime": { + "type": "object", + "description": "Start time of the requested range for this dataset. Type: string (or Expression with resultType string)." + }, + "endTime": { + "type": "object", + "description": "End time of the requested range for this dataset. Type: string (or Expression with resultType string)." + }, + "outputColumns": { + "type": "object", + "description": "The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). Example: [ { \"name\": \"Id\" }, { \"name\": \"CreatedDateTime\" } ]" + } + } + }, + "AzureDataLakeStoreSource": { + "description": "A copy activity Azure Data Lake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "AzureBlobFSSource": { + "description": "A copy activity Azure BlobFS source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." + }, + "skipHeaderLineCount": { + "type": "object", + "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." + }, + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "HttpSource": { + "description": "A copy activity source for an HTTP file.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "httpRequestTimeout": { + "type": "object", + "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "AmazonMWSSource": { + "description": "A copy activity Amazon Marketplace Web Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSource": { + "description": "A copy activity Azure PostgreSQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSink": { + "description": "A copy activity Azure PostgreSQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMySqlSink": { + "description": "A copy activity Azure MySql sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "ConcurSource": { + "description": "A copy activity Concur Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "CouchbaseSource": { + "description": "A copy activity Couchbase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DrillSource": { + "description": "A copy activity Drill server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "EloquaSource": { + "description": "A copy activity Eloqua server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleBigQuerySource": { + "description": "A copy activity Google BigQuery service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GreenplumSource": { + "description": "A copy activity Greenplum Database source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HBaseSource": { + "description": "A copy activity HBase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HiveSource": { + "description": "A copy activity Hive Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HubspotSource": { + "description": "A copy activity Hubspot Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ImpalaSource": { + "description": "A copy activity Impala server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "JiraSource": { + "description": "A copy activity Jira Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MagentoSource": { + "description": "A copy activity Magento server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MariaDBSource": { + "description": "A copy activity MariaDB server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMariaDBSource": { + "description": "A copy activity Azure MariaDB source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MarketoSource": { + "description": "A copy activity Marketo server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PaypalSource": { + "description": "A copy activity Paypal Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PhoenixSource": { + "description": "A copy activity Phoenix server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PrestoSource": { + "description": "A copy activity Presto server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "QuickBooksSource": { + "description": "A copy activity QuickBooks server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ServiceNowSource": { + "description": "A copy activity ServiceNow server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ShopifySource": { + "description": "A copy activity Shopify Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SparkSource": { + "description": "A copy activity Spark Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SquareSource": { + "description": "A copy activity Square Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "XeroSource": { + "description": "A copy activity Xero Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ZohoSource": { + "description": "A copy activity Zoho server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "NetezzaSource": { + "description": "A copy activity Netezza source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Netezza read in parallel.", + "type": "string", + "enum": [ + "None", + "DataSlice", + "DynamicRange" + ], + "x-ms-enum": { + "name": "NetezzaPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Netezza source partitioning.", + "$ref": "#/definitions/NetezzaPartitionSettings" + } + } + }, + "NetezzaPartitionSettings": { + "description": "The settings that will be leveraged for Netezza source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "VerticaSource": { + "description": "A copy activity Vertica source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceMarketingCloudSource": { + "description": "A copy activity Salesforce Marketing Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ResponsysSource": { + "description": "A copy activity Responsys source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsAXSource": { + "description": "A copy activity Dynamics AX source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "OracleServiceCloudSource": { + "description": "A copy activity Oracle Service Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleAdWordsSource": { + "description": "A copy activity Google AdWords service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonRedshiftSource": { + "description": "A copy activity source for Amazon Redshift Source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "redshiftUnloadSettings": { + "description": "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.", + "$ref": "#/definitions/RedshiftUnloadSettings" + } + } + }, + "RedshiftUnloadSettings": { + "description": "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.", + "type": "object", + "properties": { + "s3LinkedServiceName": { + "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "bucketName": { + "type": "object", + "description": "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)." + } + }, + "required": [ + "s3LinkedServiceName", + "bucketName" + ] + }, + "SnowflakeSource": { + "description": "A copy activity snowflake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." + }, + "exportSettings": { + "$ref": "#/definitions/SnowflakeExportCopyCommand", + "description": "Snowflake export settings." + } + } + }, + "ExportSettings": { + "description": "Export command settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The export setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SnowflakeExportCopyCommand": { + "description": "Snowflake export command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSettings" + } + ], + "properties": { + "additionalCopyOptions": { + "type": "object", + "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", + "additionalProperties": { + "type": "object" + } + }, + "additionalFormatOptions": { + "type": "object", + "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"OVERWRITE\": \"TRUE\", \"MAX_FILE_SIZE\": \"'FALSE'\" }", + "additionalProperties": { + "type": "object" + } + } + } + }, + "StoredProcedureParameter": { + "description": "SQL stored procedure parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "Stored procedure parameter value. Type: string (or Expression with resultType string)." + }, + "type": { + "description": "Stored procedure parameter type.", + "$ref": "#/definitions/StoredProcedureParameterType" + } + } + }, + "StoredProcedureParameterType": { + "description": "Stored procedure parameter type.", + "type": "string", + "enum": [ + "String", + "Int", + "Int64", + "Decimal", + "Guid", + "Boolean", + "Date" + ], + "x-ms-enum": { + "name": "StoredProcedureParameterType", + "modelAsString": true + } + }, + "CopySink": { + "discriminator": "type", + "description": "A copy activity sink.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy sink type." + }, + "writeBatchSize": { + "type": "object", + "description": "Write batch size. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "writeBatchTimeout": { + "type": "object", + "description": "Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "sinkRetryCount": { + "type": "object", + "description": "Sink retry count. Type: integer (or Expression with resultType integer)." + }, + "sinkRetryWait": { + "type": "object", + "description": "Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SapCloudForCustomerSink": { + "description": "A copy activity SAP Cloud for Customer sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is 'Insert'.", + "type": "string", + "enum": [ + "Insert", + "Update" + ], + "x-ms-enum": { + "name": "SapCloudForCustomerSinkWriteBehavior", + "modelAsString": true + } + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "AzureQueueSink": { + "description": "A copy activity Azure Queue sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": {} + }, + "CopyBehaviorType": { + "description": "All available types of copy behavior.", + "type": "string", + "enum": [ + "PreserveHierarchy", + "FlattenHierarchy", + "MergeFiles" + ], + "x-ms-enum": { + "name": "CopyBehaviorType", + "modelAsString": true + } + }, + "AzureTableSink": { + "description": "A copy activity Azure Table sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "azureTableDefaultPartitionKeyValue": { + "type": "object", + "description": "Azure Table default partition key value. Type: string (or Expression with resultType string)." + }, + "azureTablePartitionKeyName": { + "type": "object", + "description": "Azure Table partition key name. Type: string (or Expression with resultType string)." + }, + "azureTableRowKeyName": { + "type": "object", + "description": "Azure Table row key name. Type: string (or Expression with resultType string)." + }, + "azureTableInsertType": { + "type": "object", + "description": "Azure Table insert type. Type: string (or Expression with resultType string)." + } + } + }, + "AvroSink": { + "description": "A copy activity Avro sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Avro store settings." + }, + "formatSettings": { + "$ref": "#/definitions/AvroWriteSettings", + "description": "Avro format settings." + } + } + }, + "ParquetSink": { + "description": "A copy activity Parquet sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Parquet store settings." + } + } + }, + "BinarySink": { + "description": "A copy activity Binary sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Binary store settings." + } + } + }, + "BlobSink": { + "description": "A copy activity Azure Blob sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "blobWriterOverwriteFiles": { + "type": "object", + "description": "Blob writer overwrite files. Type: boolean (or Expression with resultType boolean)." + }, + "blobWriterDateTimeFormat": { + "type": "object", + "description": "Blob writer date time format. Type: string (or Expression with resultType string)." + }, + "blobWriterAddHeader": { + "type": "object", + "description": "Blob writer add header. Type: boolean (or Expression with resultType boolean)." + }, + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "FileSystemSink": { + "description": "A copy activity file system sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "DocumentDbCollectionSink": { + "description": "A copy activity Document Database Collection sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string)." + }, + "writeBehavior": { + "type": "object", + "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." + } + } + }, + "CosmosDbSqlApiSink": { + "description": "A copy activity Azure CosmosDB (SQL API) Collection sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "type": "object", + "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." + } + } + }, + "SqlSink": { + "description": "A copy activity SQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlServerSink": { + "description": "A copy activity SQL server sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlSink": { + "description": "A copy activity Azure SQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlMISink": { + "description": "A copy activity Azure SQL Managed Instance sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlDWSink": { + "description": "A copy activity SQL Data Warehouse sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "allowPolyBase": { + "type": "object", + "description": "Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean)." + }, + "polyBaseSettings": { + "description": "Specifies PolyBase-related settings when allowPolyBase is true.", + "$ref": "#/definitions/PolybaseSettings" + }, + "allowCopyCommand": { + "type": "object", + "description": "Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean)." + }, + "copyCommandSettings": { + "description": "Specifies Copy Command related settings when allowCopyCommand is true.", + "$ref": "#/definitions/DWCopyCommandSettings" + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "PolybaseSettings": { + "description": "PolyBase settings.", + "type": "object", + "properties": { + "rejectType": { + "$ref": "#/definitions/PolybaseSettingsRejectType", + "description": "Reject type." + }, + "rejectValue": { + "type": "object", + "description": "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." + }, + "rejectSampleValue": { + "type": "object", + "description": "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." + }, + "useTypeDefault": { + "type": "object", + "description": "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)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "PolybaseSettingsRejectType": { + "description": "Indicates whether the RejectValue property is specified as a literal value or a percentage.", + "type": "string", + "enum": [ + "value", + "percentage" + ], + "x-ms-enum": { + "name": "PolybaseSettingsRejectType", + "modelAsString": true + } + }, + "DWCopyCommandSettings": { + "description": "DW Copy Command settings.", + "type": "object", + "properties": { + "defaultValues": { + "type": "array", + "description": "Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/DWCopyCommandDefaultValue" + } + }, + "additionalOptions": { + "type": "object", + "description": "Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalOptions\": { \"MAXERRORS\": \"1000\", \"DATEFORMAT\": \"'ymd'\" }", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DWCopyCommandDefaultValue": { + "description": "Default value.", + "type": "object", + "properties": { + "columnName": { + "type": "object", + "description": "Column name. Type: object (or Expression with resultType string)." + }, + "defaultValue": { + "type": "object", + "description": "The default value of the column. Type: object (or Expression with resultType string)." + } + } + }, + "SnowflakeSink": { + "description": "A copy activity snowflake sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "importSettings": { + "$ref": "#/definitions/SnowflakeImportCopyCommand", + "description": "Snowflake import settings." + } + } + }, + "ImportSettings": { + "description": "Import command settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The import setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SnowflakeImportCopyCommand": { + "description": "Snowflake import command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImportSettings" + } + ], + "properties": { + "additionalCopyOptions": { + "type": "object", + "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", + "additionalProperties": { + "type": "object" + } + }, + "additionalFormatOptions": { + "type": "object", + "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"FORCE\": \"TRUE\", \"LOAD_UNCERTAIN_FILES\": \"'FALSE'\" }", + "additionalProperties": { + "type": "object" + } + } + } + }, + "LogStorageSettings": { + "description": "Log storage settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Log storage linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "StagingSettings": { + "description": "Staging settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Staging linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing the interim data. Type: string (or Expression with resultType string)." + }, + "enableCompression": { + "type": "object", + "description": "Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "RedirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings", + "type": "object", + "properties": { + "linkedServiceName": { + "type": "object", + "description": "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": { + "type": "object", + "description": "The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "SkipErrorFile": { + "description": "Skip error file.", + "type": "object", + "properties": { + "fileMissing": { + "type": "object", + "description": "Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "dataInconsistency": { + "type": "object", + "description": "Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "AdditionalColumns": { + "description": "Specify the column name and value of additional columns.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Additional column name. Type: string (or Expression with resultType string)." + }, + "value": { + "type": "object", + "description": "Additional column value. Type: string (or Expression with resultType string)." + } + } + }, + "OracleSink": { + "description": "A copy activity Oracle sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreSink": { + "description": "A copy activity Azure Data Lake Store sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + }, + "enableAdlsSingleFileParallel": { + "description": "Single File Parallel.", + "type": "object" + } + } + }, + "AzureBlobFSSink": { + "description": "A copy activity Azure Data Lake Storage Gen2 sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "AzureSearchIndexSink": { + "description": "A copy activity Azure Search Index sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "Specify the write behavior when upserting documents into Azure Search Index.", + "type": "string", + "enum": [ + "Merge", + "Upload" + ], + "x-ms-enum": { + "name": "AzureSearchIndexWriteBehaviorType", + "modelAsString": true + } + } + } + }, + "OdbcSink": { + "description": "A copy activity ODBC sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "InformixSink": { + "description": "A copy activity Informix sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "MicrosoftAccessSink": { + "description": "A copy activity Microsoft Access sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsSink": { + "description": "A copy activity Dynamics sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, + "ignoreNullValues": { + "type": "object", + "description": "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)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "DynamicsCrmSink": { + "description": "A copy activity Dynamics CRM sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "CommonDataServiceForAppsSink": { + "description": "A copy activity Common Data Service for Apps sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "AzureDataExplorerSink": { + "description": "A copy activity Azure Data Explorer sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "ingestionMappingName": { + "type": "object", + "description": "A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string." + }, + "ingestionMappingAsJson": { + "type": "object", + "description": "An explicit column mapping description provided in a json format. Type: string." + }, + "flushImmediately": { + "type": "object", + "description": "If set to true, any aggregation will be skipped. Default is false. Type: boolean." + } + } + }, + "SalesforceSink": { + "description": "A copy activity Salesforce sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is Insert.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SalesforceSinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." + }, + "ignoreNullValues": { + "type": "object", + "description": "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)." + } + } + }, + "SalesforceServiceCloudSink": { + "description": "A copy activity Salesforce Service Cloud sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is Insert.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SalesforceSinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." + }, + "ignoreNullValues": { + "type": "object", + "description": "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)." + } + } + }, + "CosmosDbMongoDbApiSink": { + "description": "A copy activity sink for a CosmosDB (MongoDB API) database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "type": "object", + "description": "Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is \"insert\". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." + } + } + }, + "CopyTranslator": { + "discriminator": "type", + "description": "A copy activity translator.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy translator type." + } + }, "additionalProperties": { - "type": "object" + "type": "object" + }, + "required": [ + "type" + ] + }, + "TabularTranslator": { + "description": "A copy activity tabular translator.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyTranslator" + } + ], + "properties": { + "columnMappings": { + "type": "object", + "description": "Column mappings. Example: \"UserId: MyUserId, Group: MyGroup, Name: MyName\" Type: string (or Expression with resultType string). This property will be retired. Please use mappings property." + }, + "schemaMapping": { + "type": "object", + "description": "The schema mapping to map between tabular data and hierarchical data. Example: {\"Column1\": \"$.Column1\", \"Column2\": \"$.Column2.Property1\", \"Column3\": \"$.Column2.Property2\"}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property." + }, + "collectionReference": { + "type": "object", + "description": "The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object)." + }, + "mapComplexValuesToString": { + "type": "object", + "description": "Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean)." + }, + "mappings": { + "type": "object", + "description": "Column mappings with logical types. Tabular->tabular example: [{\"source\":{\"name\":\"CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"name\":\"CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Hierarchical->tabular example: [{\"source\":{\"path\":\"$.CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"path\":\"$.CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Type: object (or Expression with resultType object)." + } } - } - } - }, - "required": [ - "notebookPath" - ] - }, - "DatabricksSparkJarActivity": { - "description": "DatabricksSparkJar activity.", - "x-ms-discriminator-value": "DatabricksSparkJar", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Databricks SparkJar activity properties.", - "$ref": "#/definitions/DatabricksSparkJarActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DatabricksSparkJarActivityTypeProperties": { - "description": "Databricks SparkJar activity properties.", - "properties": { - "mainClassName": { - "type": "object", - "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string)." - }, - "parameters": { - "description": "Parameters that will be passed to the main method.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "libraries": { - "description": "A list of libraries to be installed on the cluster that will execute the job.", - "type": "array", - "items": { - "type": "object", - "description": "Databricks library definition.", + }, + "HDInsightHiveActivity": { + "description": "HDInsight Hive activity type.", + "x-ms-discriminator-value": "HDInsightHive", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Hive activity properties.", + "$ref": "#/definitions/HDInsightHiveActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightHiveActivityTypeProperties": { + "description": "HDInsight Hive activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Hive job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "variables": { + "description": "User specified arguments under hivevar namespace.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "queryTimeout": { + "type": "integer", + "description": "Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)" + } + } + }, + "HDInsightActivityDebugInfoOption": { + "description": "The HDInsightActivityDebugInfoOption settings to use.", + "type": "string", + "enum": [ + "None", + "Always", + "Failure" + ], + "x-ms-enum": { + "name": "HDInsightActivityDebugInfoOption", + "modelAsString": true + } + }, + "HDInsightPigActivity": { + "description": "HDInsight Pig activity type.", + "x-ms-discriminator-value": "HDInsightPig", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Pig activity properties.", + "$ref": "#/definitions/HDInsightPigActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightPigActivityTypeProperties": { + "description": "HDInsight Pig activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "type": "object", + "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Pig job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + } + }, + "HDInsightMapReduceActivity": { + "description": "HDInsight MapReduce activity type.", + "x-ms-discriminator-value": "HDInsightMapReduce", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight MapReduce activity properties.", + "$ref": "#/definitions/HDInsightMapReduceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightMapReduceActivityTypeProperties": { + "description": "HDInsight MapReduce activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "className": { + "type": "object", + "description": "Class name. Type: string (or Expression with resultType string)." + }, + "jarFilePath": { + "type": "object", + "description": "Jar path. Type: string (or Expression with resultType string)." + }, + "jarLinkedService": { + "description": "Jar linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "jarLibs": { + "description": "Jar libs.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for the MapReduce job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "className", + "jarFilePath" + ] + }, + "HDInsightStreamingActivity": { + "description": "HDInsight streaming activity type.", + "x-ms-discriminator-value": "HDInsightStreaming", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight streaming activity properties.", + "$ref": "#/definitions/HDInsightStreamingActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightStreamingActivityTypeProperties": { + "description": "HDInsight streaming activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "mapper": { + "type": "object", + "description": "Mapper executable name. Type: string (or Expression with resultType string)." + }, + "reducer": { + "type": "object", + "description": "Reducer executable name. Type: string (or Expression with resultType string)." + }, + "input": { + "type": "object", + "description": "Input blob path. Type: string (or Expression with resultType string)." + }, + "output": { + "type": "object", + "description": "Output blob path. Type: string (or Expression with resultType string)." + }, + "filePaths": { + "description": "Paths to streaming job files. Can be directories.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "fileLinkedService": { + "description": "Linked service reference where the files are located.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "combiner": { + "type": "object", + "description": "Combiner executable name. Type: string (or Expression with resultType string)." + }, + "commandEnvironment": { + "description": "Command line environment values.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for streaming job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "mapper", + "reducer", + "input", + "output", + "filePaths" + ] + }, + "HDInsightSparkActivity": { + "description": "HDInsight Spark activity.", + "x-ms-discriminator-value": "HDInsightSpark", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight spark activity properties.", + "$ref": "#/definitions/HDInsightSparkActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightSparkActivityTypeProperties": { + "description": "HDInsight spark activity properties.", + "properties": { + "rootPath": { + "type": "object", + "description": "The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string)." + }, + "entryFilePath": { + "type": "object", + "description": "The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string)." + }, + "arguments": { + "description": "The user-specified arguments to HDInsightSparkActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "sparkJobLinkedService": { + "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "className": { + "description": "The application's Java/Spark main class.", + "type": "string" + }, + "proxyUser": { + "type": "object", + "description": "The user to impersonate that will execute the job. Type: string (or Expression with resultType string)." + }, + "sparkConfig": { + "description": "Spark configuration property.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "rootPath", + "entryFilePath" + ] + }, + "ExecuteSSISPackageActivity": { + "description": "Execute SSIS package activity.", + "x-ms-discriminator-value": "ExecuteSSISPackage", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute SSIS package activity properties.", + "$ref": "#/definitions/ExecuteSSISPackageActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecuteSSISPackageActivityTypeProperties": { + "description": "Execute SSIS package activity properties.", + "properties": { + "packageLocation": { + "description": "SSIS package location.", + "$ref": "#/definitions/SSISPackageLocation" + }, + "runtime": { + "description": "Specifies the runtime to execute SSIS package. The value should be \"x86\" or \"x64\". Type: string (or Expression with resultType string).", + "type": "object" + }, + "loggingLevel": { + "description": "The logging level of SSIS package execution. Type: string (or Expression with resultType string).", + "type": "object" + }, + "environmentPath": { + "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string).", + "type": "object" + }, + "executionCredential": { + "description": "The package execution credential.", + "$ref": "#/definitions/SSISExecutionCredential" + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + }, + "projectParameters": { + "description": "The project level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "packageParameters": { + "description": "The package level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "projectConnectionManagers": { + "description": "The project level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "packageConnectionManagers": { + "description": "The package level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "propertyOverrides": { + "description": "The property overrides to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISPropertyOverride" + } + }, + "logLocation": { + "description": "SSIS package execution log location.", + "$ref": "#/definitions/SSISLogLocation" + } + }, + "required": [ + "packageLocation", + "connectVia" + ] + }, + "SSISPackageLocation": { + "description": "SSIS package location.", + "type": "object", + "properties": { + "packagePath": { + "description": "The SSIS package path. Type: string (or Expression with resultType string).", + "type": "object" + }, + "type": { + "description": "The type of SSIS package location.", + "type": "string", + "enum": [ + "SSISDB", + "File", + "InlinePackage", + "PackageStore" + ], + "x-ms-enum": { + "name": "SsisPackageLocationType", + "modelAsString": true + } + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SSIS package location properties.", + "$ref": "#/definitions/SSISPackageLocationTypeProperties" + } + } + }, + "SSISPackageLocationTypeProperties": { + "description": "SSIS package location properties.", + "type": "object", + "properties": { + "packagePassword": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "Password of the package." + }, + "accessCredential": { + "description": "The package access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "configurationPath": { + "description": "The configuration file of the package execution. Type: string (or Expression with resultType string).", + "type": "object" + }, + "configurationAccessCredential": { + "description": "The configuration file access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "packageName": { + "description": "The package name.", + "type": "string" + }, + "packageContent": { + "description": "The embedded package content. Type: string (or Expression with resultType string).", + "type": "object" + }, + "packageLastModifiedDate": { + "description": "The embedded package last modified date.", + "type": "string" + }, + "childPackages": { + "description": "The embedded child package list.", + "type": "array", + "items": { + "$ref": "#/definitions/SSISChildPackage" + } + } + } + }, + "SSISConnectionManager": { + "description": "SSIS Connection Manager.", + "type": "object", "additionalProperties": { - "type": "object" + "$ref": "#/definitions/SSISExecutionParameter" } - } - } - }, - "required": [ - "mainClassName" - ] - }, - "DatabricksSparkPythonActivity": { - "description": "DatabricksSparkPython activity.", - "x-ms-discriminator-value": "DatabricksSparkPython", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Databricks SparkPython activity properties.", - "$ref": "#/definitions/DatabricksSparkPythonActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DatabricksSparkPythonActivityTypeProperties": { - "description": "Databricks SparkPython activity properties.", - "properties": { - "pythonFile": { - "type": "object", - "description": "The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string)." - }, - "parameters": { - "description": "Command line parameters that will be passed to the Python file.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "libraries": { - "description": "A list of libraries to be installed on the cluster that will execute the job.", - "type": "array", - "items": { - "type": "object", - "description": "Databricks library definition.", + }, + "SSISExecutionParameter": { + "description": "SSIS execution parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package execution parameter value. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "value" + ] + }, + "SSISPropertyOverride": { + "description": "SSIS property override.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package property override value. Type: string (or Expression with resultType string)." + }, + "isSensitive": { + "type": "boolean", + "description": "Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true" + } + }, + "required": [ + "value" + ] + }, + "SSISExecutionCredential": { + "description": "SSIS package execution credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../datafactory.json#/definitions/SecureString", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, + "SSISAccessCredential": { + "description": "SSIS access credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, + "SSISChildPackage": { + "description": "SSIS embedded child package.", + "type": "object", + "properties": { + "packagePath": { + "type": "object", + "description": "Path for embedded child package. Type: string (or Expression with resultType string)." + }, + "packageName": { + "type": "string", + "description": "Name for embedded child package." + }, + "packageContent": { + "type": "object", + "description": "Content for embedded child package. Type: string (or Expression with resultType string)." + }, + "packageLastModifiedDate": { + "type": "string", + "description": "Last modified date for embedded child package." + } + }, + "required": [ + "packagePath", + "packageContent" + ] + }, + "SSISLogLocation": { + "description": "SSIS package execution log location", + "type": "object", + "properties": { + "logPath": { + "description": "The SSIS package execution log path. Type: string (or Expression with resultType string).", + "type": "object" + }, + "type": { + "description": "The type of SSIS log location.", + "type": "string", + "enum": [ + "File" + ], + "x-ms-enum": { + "name": "SsisLogLocationType", + "modelAsString": true + } + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SSIS package execution log location properties.", + "$ref": "#/definitions/SSISLogLocationTypeProperties" + } + }, + "required": [ + "logPath", + "type", + "typeProperties" + ] + }, + "SSISLogLocationTypeProperties": { + "description": "SSIS package execution log location properties.", + "type": "object", + "properties": { + "accessCredential": { + "description": "The package execution log access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "logRefreshInterval": { + "type": "object", + "description": "Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "CustomActivity": { + "description": "Custom activity type.", + "x-ms-discriminator-value": "Custom", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Custom activity properties.", + "$ref": "#/definitions/CustomActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CustomActivityTypeProperties": { + "description": "Custom activity properties.", + "properties": { + "command": { + "type": "object", + "description": "Command for custom activity Type: string (or Expression with resultType string)." + }, + "resourceLinkedService": { + "description": "Resource linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "folderPath": { + "type": "object", + "description": "Folder path for resource files Type: string (or Expression with resultType string)." + }, + "referenceObjects": { + "description": "Reference objects", + "$ref": "#/definitions/CustomActivityReferenceObject" + }, + "extendedProperties": { + "description": "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.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "retentionTimeInDays": { + "type": "object", + "description": "The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double)." + } + }, + "required": [ + "command" + ] + }, + "CustomActivityReferenceObject": { + "description": "Reference objects for custom activity", + "properties": { + "linkedServices": { + "description": "Linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "datasets": { + "description": "Dataset references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + } + } + }, + "SqlServerStoredProcedureActivity": { + "description": "SQL stored procedure activity type.", + "x-ms-discriminator-value": "SqlServerStoredProcedure", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SQL stored procedure activity properties.", + "$ref": "#/definitions/SqlServerStoredProcedureActivityTypeProperties" + } + }, + "required": [ + "typeProperties", + "linkedServiceName" + ] + }, + "SqlServerStoredProcedureActivityTypeProperties": { + "description": "SQL stored procedure activity properties.", + "properties": { + "storedProcedureName": { + "type": "object", + "description": "Stored procedure name. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + }, + "required": [ + "storedProcedureName" + ] + }, + "ExecutePipelineActivity": { + "x-ms-discriminator-value": "ExecutePipeline", + "description": "Execute pipeline activity.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Execute pipeline activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExecutePipelineActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecutePipelineActivityTypeProperties": { + "description": "Execute pipeline activity properties.", + "properties": { + "pipeline": { + "description": "Pipeline reference.", + "$ref": "../datafactory.json#/definitions/PipelineReference" + }, + "parameters": { + "description": "Pipeline parameters.", + "$ref": "../datafactory.json#/definitions/ParameterValueSpecification" + }, + "waitOnCompletion": { + "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.", + "type": "boolean" + } + }, + "required": [ + "pipeline" + ] + }, + "DeleteActivity": { + "x-ms-discriminator-value": "Delete", + "description": "Delete activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Delete activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeleteActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DeleteActivityTypeProperties": { + "description": "Delete activity properties.", + "properties": { + "recursive": { + "type": "object", + "description": "If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "maxConcurrentConnections": { + "type": "integer", + "minimum": 1, + "description": "The max concurrent connections to connect data source at the same time." + }, + "enableLogging": { + "type": "object", + "description": "Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "logStorageSettings": { + "description": "Log storage settings customer need to provide when enableLogging is true.", + "$ref": "#/definitions/LogStorageSettings" + }, + "dataset": { + "description": "Delete activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "required": [ + "dataset" + ] + }, + "AzureDataExplorerCommandActivity": { + "x-ms-discriminator-value": "AzureDataExplorerCommand", + "description": "Azure Data Explorer command activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Explorer command activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataExplorerCommandActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataExplorerCommandActivityTypeProperties": { + "description": "Azure Data Explorer command activity properties.", + "properties": { + "command": { + "type": "object", + "description": "A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string)." + }, + "commandTimeout": { + "type": "object", + "description": "Control command timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))..)" + } + }, + "required": [ + "command" + ] + }, + "LookupActivity": { + "x-ms-discriminator-value": "Lookup", + "description": "Lookup activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Lookup activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LookupActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "LookupActivityTypeProperties": { + "description": "Lookup activity properties.", + "properties": { + "source": { + "description": "Dataset-specific source properties, same as copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "dataset": { + "description": "Lookup activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + }, + "firstRowOnly": { + "type": "object", + "description": "Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "source", + "dataset" + ] + }, + "WebActivityMethod": { + "description": "The list of HTTP methods supported by a WebActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE" + ], + "x-ms-enum": { + "name": "WebActivityMethod", + "modelAsString": true + } + }, + "WebActivity": { + "x-ms-discriminator-value": "WebActivity", + "description": "Web activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Web activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebActivityAuthentication": { + "description": "Web activity authentication properties.", + "properties": { + "type": { + "description": "Web activity authentication (Basic/ClientCertificate/MSI)", + "type": "string" + }, + "pfx": { + "description": "Base64-encoded contents of a PFX file.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "username": { + "description": "Web activity authentication user name for basic authentication.", + "type": "string" + }, + "password": { + "description": "Password for the PFX file or basic authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "resource": { + "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "WebActivityTypeProperties": { + "description": "Web activity type properties.", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebActivityMethod" + }, + "url": { + "type": "object", + "description": "Web activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "headers": { + "type": "object", + "description": "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": { + "type": "object", + "description": "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": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebActivityAuthentication" + }, + "datasets": { + "type": "array", + "description": "List of datasets passed to web endpoint.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "linkedServices": { + "type": "array", + "description": "List of linked services passed to web endpoint.", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + } + }, + "required": [ + "method", + "url" + ] + }, + "GetMetadataActivity": { + "x-ms-discriminator-value": "GetMetadata", + "description": "Activity to get metadata of dataset", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "GetMetadata activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GetMetadataActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GetMetadataActivityTypeProperties": { + "description": "GetMetadata activity properties.", + "properties": { + "dataset": { + "description": "GetMetadata activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + }, + "fieldList": { + "description": "Fields of metadata to get from dataset.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "dataset" + ] + }, + "IfConditionActivity": { + "x-ms-discriminator-value": "IfCondition", + "description": "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.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "IfCondition activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/IfConditionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "IfConditionActivityTypeProperties": { + "description": "IfCondition activity properties.", + "properties": { + "expression": { + "description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "ifTrueActivities": { + "type": "array", + "description": "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.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "ifFalseActivities": { + "type": "array", + "description": "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.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression" + ] + }, + "SwitchActivity": { + "x-ms-discriminator-value": "Switch", + "description": "This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Switch activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SwitchActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SwitchActivityTypeProperties": { + "description": "Switch activity properties.", + "properties": { + "on": { + "description": "An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "cases": { + "type": "array", + "description": "List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.", + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SwitchCase" + } + }, + "defaultActivities": { + "type": "array", + "description": "List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "on" + ] + }, + "SwitchCase": { + "description": "Switch cases with have a value and corresponding activities.", + "properties": { + "value": { + "description": "Expected value that satisfies the expression result of the 'on' property.", + "type": "string" + }, + "activities": { + "type": "array", + "description": "List of activities to execute for satisfied case condition.", + "items": { + "$ref": "#/definitions/Activity" + } + } + } + }, + "ForEachActivity": { + "x-ms-discriminator-value": "ForEach", + "description": "This activity is used for iterating over a collection and execute given activities.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "ForEach activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ForEachActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ForEachActivityTypeProperties": { + "description": "ForEach activity properties.", + "properties": { + "isSequential": { + "description": "Should the loop be executed in sequence or in parallel (max 50)", + "type": "boolean" + }, + "batchCount": { + "description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).", + "type": "integer", + "maximum": 50 + }, + "items": { + "description": "Collection to iterate.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "activities": { + "type": "array", + "description": "List of activities to execute .", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "items", + "activities" + ] + }, + "AzureMLBatchExecutionActivity": { + "description": "Azure ML Batch Execution activity.", + "x-ms-discriminator-value": "AzureMLBatchExecution", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Batch Execution activity properties.", + "$ref": "#/definitions/AzureMLBatchExecutionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLBatchExecutionActivityTypeProperties": { + "description": "Azure ML Batch Execution activity properties.", + "properties": { + "globalParameters": { + "description": "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.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "webServiceOutputs": { + "description": "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.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + }, + "webServiceInputs": { + "description": "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.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + } + } + }, + "AzureMLWebServiceFile": { + "description": "Azure ML WebService Input/Output file", + "type": "object", + "properties": { + "filePath": { + "type": "object", + "description": "The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "required": [ + "linkedServiceName", + "filePath" + ] + }, + "AzureMLUpdateResourceActivity": { + "description": "Azure ML Update Resource management activity.", + "x-ms-discriminator-value": "AzureMLUpdateResource", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Update Resource management activity properties.", + "$ref": "#/definitions/AzureMLUpdateResourceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLUpdateResourceActivityTypeProperties": { + "description": "Azure ML Update Resource activity properties.", + "properties": { + "trainedModelName": { + "type": "object", + "description": "Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string)." + }, + "trainedModelLinkedServiceName": { + "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "trainedModelFilePath": { + "type": "object", + "description": "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)." + } + }, + "required": [ + "trainedModelName", + "trainedModelLinkedServiceName", + "trainedModelFilePath" + ] + }, + "AzureMLExecutePipelineActivity": { + "description": "Azure ML Execute Pipeline activity.", + "x-ms-discriminator-value": "AzureMLExecutePipeline", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Execute Pipeline activity properties.", + "$ref": "#/definitions/AzureMLExecutePipelineActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLExecutePipelineActivityTypeProperties": { + "description": "Azure ML Execute Pipeline activity properties.", + "properties": { + "mlPipelineId": { + "description": "ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).", + "type": "object" + }, + "experimentName": { + "description": "Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).", + "type": "object" + }, + "mlPipelineParameters": { + "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).", + "type": "object" + }, + "mlParentRunId": { + "description": "The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).", + "type": "object" + }, + "continueOnStepFailure": { + "description": "Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + }, + "required": [ + "mlPipelineId" + ] + }, + "AzureMLPipelineParameters": { + "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request.", + "type": "object", "additionalProperties": { - "type": "object" + "type": "object", + "description": "Type: string (or Expression with resultType string)." } - } - } - }, - "required": [ - "pythonFile" - ] - }, - "SetVariableActivity": { - "x-ms-discriminator-value": "SetVariable", - "description": "Set value for a Variable.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Set Variable activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SetVariableActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "SetVariableActivityTypeProperties": { - "description": "SetVariable activity properties.", - "properties": { - "variableName": { - "description": "Name of the variable whose value needs to be set.", - "type": "string" - }, - "value": { - "description": "Value to be set. Could be a static value or Expression", - "type": "object" - } - } - }, - "AppendVariableActivity": { - "x-ms-discriminator-value": "AppendVariable", - "description": "Append value for a Variable of type Array.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Append Variable activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AppendVariableActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AppendVariableActivityTypeProperties": { - "description": "AppendVariable activity properties.", - "properties": { - "variableName": { - "description": "Name of the variable whose value needs to be appended to.", - "type": "string" - }, - "value": { - "description": "Value to be appended. Could be a static value or Expression", - "type": "object" - } - } - }, - "AzureFunctionActivityMethod": { - "description": "The list of HTTP methods supported by a AzureFunctionActivity.", - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE", - "OPTIONS", - "HEAD", - "TRACE" - ], - "x-ms-enum": { - "name": "AzureFunctionActivityMethod", - "modelAsString": true - } - }, - "AzureFunctionActivity": { - "x-ms-discriminator-value": "AzureFunctionActivity", - "description": "Azure Function activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Azure Function activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureFunctionActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureFunctionActivityTypeProperties": { - "description": "Azure Function activity type properties.", - "properties": { - "method": { - "description": "Rest API method for target endpoint.", - "$ref": "#/definitions/AzureFunctionActivityMethod" - }, - "functionName": { - "type": "object", - "description": "Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string)" - }, - "headers": { - "type": "object", - "description": "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": { - "type": "object", - "description": "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)." - } - }, - "required": [ - "method", - "functionName" - ] - }, - "WebHookActivity": { - "x-ms-discriminator-value": "WebHook", - "description": "WebHook activity.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "WebHook activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WebHookActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "WebHookActivityMethod": { - "description": "The list of HTTP methods supported by a WebHook activity.", - "type": "string", - "enum": [ - "POST" - ], - "x-ms-enum": { - "name": "WebHookActivityMethod", - "modelAsString": true - } - }, - "WebHookActivityTypeProperties": { - "description": "WebHook activity type properties.", - "properties": { - "method": { - "description": "Rest API method for target endpoint.", - "$ref": "#/definitions/WebHookActivityMethod" - }, - "url": { - "type": "object", - "description": "WebHook activity target endpoint and path. Type: string (or Expression with resultType string)." - }, - "timeout": { - "type": "string", - "description": "The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "headers": { - "type": "object", - "description": "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": { - "type": "object", - "description": "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": { - "description": "Authentication method used for calling the endpoint.", - "$ref": "#/definitions/WebActivityAuthentication" - }, - "reportStatusOnCallBack": { - "type": "object", - "description": "When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean)." - } - }, - "required": [ - "method", - "url" - ] - }, - "ExecuteDataFlowActivity": { - "description": "Execute data flow activity.", - "x-ms-discriminator-value": "ExecuteDataFlow", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Execute data flow activity properties.", - "$ref": "#/definitions/ExecuteDataFlowActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ExecuteDataFlowActivityTypeProperties": { - "description": "Execute data flow activity properties.", - "properties": { - "dataFlow": { - "description": "Data flow reference.", - "$ref": "../datafactory.json#/definitions/DataFlowReference" - }, - "staging": { - "description": "Staging info for execute data flow activity.", - "$ref": "../datafactory.json#/definitions/DataFlowStagingInfo" - }, - "integrationRuntime": { - "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" - }, - "compute": { - "description": "Compute properties for data flow activity.", - "type": "object", - "properties": { - "computeType": { - "description": "Compute type of the cluster which will execute data flow job.", - "type": "string", - "enum": [ - "General", - "MemoryOptimized", - "ComputeOptimized" - ], - "x-ms-enum": { - "name": "DataFlowComputeType", + }, + "DataLakeAnalyticsUSQLActivity": { + "description": "Data Lake Analytics U-SQL activity.", + "x-ms-discriminator-value": "DataLakeAnalyticsU-SQL", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Data Lake Analytics U-SQL activity properties.", + "$ref": "#/definitions/DataLakeAnalyticsUSQLActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DataLakeAnalyticsUSQLActivityTypeProperties": { + "description": "DataLakeAnalyticsU-SQL activity properties.", + "properties": { + "scriptPath": { + "type": "object", + "description": "Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "degreeOfParallelism": { + "type": "object", + "description": "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": { + "type": "object", + "description": "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": { + "description": "Parameters for U-SQL job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "runtimeVersion": { + "type": "object", + "description": "Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string)." + }, + "compilationMode": { + "type": "object", + "description": "Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "scriptPath", + "scriptLinkedService" + ] + }, + "WaitActivity": { + "x-ms-discriminator-value": "Wait", + "description": "This activity suspends pipeline execution for the specified interval.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Wait activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WaitActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WaitActivityTypeProperties": { + "description": "Wait activity properties.", + "properties": { + "waitTimeInSeconds": { + "description": "Duration in seconds.", + "type": "integer" + } + }, + "required": [ + "waitTimeInSeconds" + ] + }, + "UntilActivity": { + "x-ms-discriminator-value": "Until", + "description": "This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Until activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UntilActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "UntilActivityTypeProperties": { + "description": "Until activity properties.", + "properties": { + "expression": { + "description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "timeout": { + "type": "object", + "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "activities": { + "type": "array", + "description": "List of activities to execute.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression", + "activities" + ] + }, + "ValidationActivity": { + "x-ms-discriminator-value": "Validation", + "description": "This activity verifies that an external resource exists.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Validation activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ValidationActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ValidationActivityTypeProperties": { + "description": "Validation activity properties.", + "properties": { + "timeout": { + "type": "object", + "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "sleep": { + "type": "object", + "description": "A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer)." + }, + "minimumSize": { + "type": "object", + "description": "Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer)." + }, + "childItems": { + "type": "object", + "description": "Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean)." + }, + "dataset": { + "description": "Validation activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "required": [ + "dataset" + ] + }, + "FilterActivity": { + "x-ms-discriminator-value": "Filter", + "description": "Filter and return results from input array based on the conditions.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Filter activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FilterActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FilterActivityTypeProperties": { + "description": "Filter activity properties.", + "properties": { + "items": { + "description": "Input array on which filter should be applied.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "condition": { + "description": "Condition to be used for filtering the input.", + "$ref": "../datafactory.json#/definitions/Expression" + } + }, + "required": [ + "condition", + "items" + ] + }, + "DatabricksNotebookActivity": { + "description": "DatabricksNotebook activity.", + "x-ms-discriminator-value": "DatabricksNotebook", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks Notebook activity properties.", + "$ref": "#/definitions/DatabricksNotebookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksNotebookActivityTypeProperties": { + "description": "Databricks Notebook activity properties.", + "properties": { + "notebookPath": { + "type": "object", + "description": "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)." + }, + "baseParameters": { + "description": "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.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "notebookPath" + ] + }, + "DatabricksSparkJarActivity": { + "description": "DatabricksSparkJar activity.", + "x-ms-discriminator-value": "DatabricksSparkJar", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks SparkJar activity properties.", + "$ref": "#/definitions/DatabricksSparkJarActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksSparkJarActivityTypeProperties": { + "description": "Databricks SparkJar activity properties.", + "properties": { + "mainClassName": { + "type": "object", + "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string)." + }, + "parameters": { + "description": "Parameters that will be passed to the main method.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "mainClassName" + ] + }, + "DatabricksSparkPythonActivity": { + "description": "DatabricksSparkPython activity.", + "x-ms-discriminator-value": "DatabricksSparkPython", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks SparkPython activity properties.", + "$ref": "#/definitions/DatabricksSparkPythonActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksSparkPythonActivityTypeProperties": { + "description": "Databricks SparkPython activity properties.", + "properties": { + "pythonFile": { + "type": "object", + "description": "The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string)." + }, + "parameters": { + "description": "Command line parameters that will be passed to the Python file.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "pythonFile" + ] + }, + "SetVariableActivity": { + "x-ms-discriminator-value": "SetVariable", + "description": "Set value for a Variable.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Set Variable activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SetVariableActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SetVariableActivityTypeProperties": { + "description": "SetVariable activity properties.", + "properties": { + "variableName": { + "description": "Name of the variable whose value needs to be set.", + "type": "string" + }, + "value": { + "description": "Value to be set. Could be a static value or Expression", + "type": "object" + } + } + }, + "AppendVariableActivity": { + "x-ms-discriminator-value": "AppendVariable", + "description": "Append value for a Variable of type Array.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Append Variable activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AppendVariableActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AppendVariableActivityTypeProperties": { + "description": "AppendVariable activity properties.", + "properties": { + "variableName": { + "description": "Name of the variable whose value needs to be appended to.", + "type": "string" + }, + "value": { + "description": "Value to be appended. Could be a static value or Expression", + "type": "object" + } + } + }, + "AzureFunctionActivityMethod": { + "description": "The list of HTTP methods supported by a AzureFunctionActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE", + "OPTIONS", + "HEAD", + "TRACE" + ], + "x-ms-enum": { + "name": "AzureFunctionActivityMethod", + "modelAsString": true + } + }, + "AzureFunctionActivity": { + "x-ms-discriminator-value": "AzureFunctionActivity", + "description": "Azure Function activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Function activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFunctionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureFunctionActivityTypeProperties": { + "description": "Azure Function activity type properties.", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/AzureFunctionActivityMethod" + }, + "functionName": { + "type": "object", + "description": "Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string)" + }, + "headers": { + "type": "object", + "description": "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": { + "type": "object", + "description": "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)." + } + }, + "required": [ + "method", + "functionName" + ] + }, + "WebHookActivity": { + "x-ms-discriminator-value": "WebHook", + "description": "WebHook activity.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "WebHook activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebHookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebHookActivityMethod": { + "description": "The list of HTTP methods supported by a WebHook activity.", + "type": "string", + "enum": [ + "POST" + ], + "x-ms-enum": { + "name": "WebHookActivityMethod", "modelAsString": true - } + } + }, + "WebHookActivityTypeProperties": { + "description": "WebHook activity type properties.", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebHookActivityMethod" + }, + "url": { + "type": "object", + "description": "WebHook activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "timeout": { + "type": "string", + "description": "The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "headers": { + "type": "object", + "description": "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": { + "type": "object", + "description": "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": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebActivityAuthentication" + }, + "reportStatusOnCallBack": { + "type": "object", + "description": "When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "method", + "url" + ] + }, + "ExecuteDataFlowActivity": { + "description": "Execute data flow activity.", + "x-ms-discriminator-value": "ExecuteDataFlow", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute data flow activity properties.", + "$ref": "#/definitions/ExecuteDataFlowActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecuteDataFlowActivityTypeProperties": { + "description": "Execute data flow activity properties.", + "properties": { + "dataFlow": { + "description": "Data flow reference.", + "$ref": "../datafactory.json#/definitions/DataFlowReference" + }, + "staging": { + "description": "Staging info for execute data flow activity.", + "$ref": "../datafactory.json#/definitions/DataFlowStagingInfo" + }, + "integrationRuntime": { + "description": "The integration runtime reference.", + "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + }, + "compute": { + "description": "Compute properties for data flow activity.", + "type": "object", + "properties": { + "computeType": { + "description": "Compute type of the cluster which will execute data flow job.", + "type": "string", + "enum": [ + "General", + "MemoryOptimized", + "ComputeOptimized" + ], + "x-ms-enum": { + "name": "DataFlowComputeType", + "modelAsString": true + } + }, + "coreCount": { + "description": "Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.", + "type": "integer" + } + } + } }, - "coreCount": { - "description": "Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.", - "type": "integer" + "required": [ + "dataFlow" + ] + }, + "SharePointOnlineListSource": { + "description": "A copy activity source for sharePoint online list source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "The OData query to filter the data in SharePoint Online list. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } } - } - } - }, - "required": [ - "dataFlow" - ] - }, - "SharePointOnlineListSource": { - "description": "A copy activity source for sharePoint online list source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "The OData query to filter the data in SharePoint Online list. For example, \"$top=1\". Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." } - } } - } } \ No newline at end of file From 96b5934520809c2b499114d88bba12da83682e61 Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Tue, 28 Apr 2020 17:26:34 -0700 Subject: [PATCH 07/11] whitespace --- .../2018-06-01/entityTypes/Pipeline.json | 12904 ++++++++-------- 1 file changed, 6452 insertions(+), 6452 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 4407658a1c7e..ad80ec326b1b 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -1,6467 +1,6467 @@ { - "swagger": "2.0", - "info": { - "title": "DataFactoryManagementClient", - "version": "2018-06-01" - }, - "paths": {}, - "definitions": { - "Pipeline": { - "description": "A data factory pipeline.", - "type": "object", - "properties": { - "description": { - "description": "The description of the pipeline.", - "type": "string" - }, - "activities": { - "type": "array", - "description": "List of activities in pipeline.", - "items": { - "$ref": "#/definitions/Activity" - } - }, - "parameters": { - "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", - "description": "List of parameters for pipeline." - }, - "variables": { - "$ref": "../datafactory.json#/definitions/VariableDefinitionSpecification", - "description": "List of variables for pipeline." - }, - "concurrency": { - "type": "integer", - "minimum": 1, - "description": "The max number of concurrent runs for the pipeline." - }, - "annotations": { - "description": "List of tags that can be used for describing the Pipeline.", - "type": "array", - "items": { - "type": "object" - } - }, - "runDimensions": { - "description": "Dimensions emitted by Pipeline.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "folder": { - "description": "The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.", - "type": "object", - "properties": { - "name": { - "description": "The name of the folder that this Pipeline is in.", - "type": "string" - } - } - } - } - }, - "Activity": { - "discriminator": "type", - "description": "A pipeline activity.", - "type": "object", - "properties": { - "name": { - "description": "Activity name.", - "type": "string" - }, - "type": { - "type": "string", - "description": "Type of activity." - }, - "description": { - "description": "Activity description.", - "type": "string" - }, - "dependsOn": { - "type": "array", - "description": "Activity depends on condition.", - "items": { - "$ref": "#/definitions/ActivityDependency" - } - }, - "userProperties": { - "type": "array", - "description": "Activity user properties.", - "items": { - "$ref": "#/definitions/UserProperty" - } - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "name", - "type" - ] - }, - "UserProperty": { - "description": "User property.", - "type": "object", - "properties": { - "name": { - "description": "User property name.", - "type": "string" - }, - "value": { - "description": "User property value. Type: string (or Expression with resultType string).", - "type": "object" - } - }, - "required": [ - "name", - "value" - ] - }, - "ActivityDependency": { - "description": "Activity dependency information.", - "type": "object", - "properties": { - "activity": { - "description": "Activity name.", - "type": "string" - }, - "dependencyConditions": { - "type": "array", - "description": "Match-Condition for the dependency.", - "items": { - "type": "string", - "enum": [ - "Succeeded", - "Failed", - "Skipped", - "Completed" - ], - "x-ms-enum": { - "name": "DependencyCondition", - "modelAsString": true - } - } - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "activity", - "dependencyConditions" - ] - }, - "ControlActivity": { - "x-ms-discriminator-value": "Container", - "description": "Base class for all control activities like IfCondition, ForEach , Until.", - "allOf": [ - { - "$ref": "#/definitions/Activity" - } - ], - "properties": {} - }, - "ExecutionActivity": { - "x-ms-discriminator-value": "Execution", - "description": "Base class for all execution activities.", - "allOf": [ - { - "$ref": "#/definitions/Activity" - } - ], - "properties": { - "linkedServiceName": { - "description": "Linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "policy": { - "$ref": "#/definitions/ActivityPolicy", - "description": "Activity policy." - } - } - }, - "ActivityPolicy": { - "description": "Execution policy for an activity.", - "type": "object", - "properties": { - "timeout": { - "type": "object", - "description": "Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "retry": { - "type": "object", - "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "retryIntervalInSeconds": { - "type": "integer", - "description": "Interval between each retry attempt (in seconds). The default is 30 sec.", - "minimum": 30, - "maximum": 86400 - }, - "secureInput": { - "type": "boolean", - "description": "When set to true, Input from activity is considered as secure and will not be logged to monitoring." - }, - "secureOutput": { - "type": "boolean", - "description": "When set to true, Output from activity is considered as secure and will not be logged to monitoring." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "StoreReadSettings": { - "description": "Connector read setting.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The read setting type." - }, - "maxConcurrentConnections": { - "type": "object", - "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "AzureBlobStorageReadSettings": { - "description": "Azure blob read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Azure blob wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Azure blob wildcardFileName. Type: string (or Expression with resultType string)." - }, - "prefix": { - "type": "object", - "description": "The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "AzureBlobFSReadSettings": { - "description": "Azure blobFS read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Azure blobFS wildcardFileName. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "AzureDataLakeStoreReadSettings": { - "description": "Azure data lake store read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "ADLS wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "ADLS wildcardFileName. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "AmazonS3ReadSettings": { - "description": "Azure data lake store read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "AmazonS3 wildcardFileName. Type: string (or Expression with resultType string)." - }, - "prefix": { - "type": "object", - "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "FileServerReadSettings": { - "description": "File server read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "FileServer wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "FileServer wildcardFileName. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "fileFilter": { - "type": "object", - "description": "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)." - } - } - }, - "AzureFileStorageReadSettings": { - "description": "Azure File Storage read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Azure File Storage wildcardFileName. Type: string (or Expression with resultType string)." - }, - "prefix": { - "type": "object", - "description": "The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "SftpWriteSettings": { - "description": "Sftp write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreWriteSettings" - } - ], - "properties": { - "operationTimeout": { - "description": "Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).", - "type": "object" - }, - "useTempFileRename": { - "description": "Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn't support rename operation. Type: boolean (or Expression with resultType boolean).", - "type": "object" - } - } - }, - "GoogleCloudStorageReadSettings": { - "description": "Google Cloud Storage read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string)." - }, - "prefix": { - "type": "object", - "description": "The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "FtpReadSettings": { - "description": "Ftp read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Ftp wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Ftp wildcardFileName. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "useBinaryTransfer": { - "type": "boolean", - "description": "Specify whether to use binary transfer mode for FTP stores." - } - } - }, - "SftpReadSettings": { - "description": "Sftp read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "Sftp wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "Sftp wildcardFileName. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - } - } - }, - "HttpReadSettings": { - "description": "Sftp read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "requestMethod": { - "type": "object", - "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." - }, - "requestBody": { - "type": "object", - "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." - }, - "additionalHeaders": { - "type": "object", - "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." - }, - "requestTimeout": { - "type": "object", - "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - } - } - }, - "HdfsReadSettings": { - "description": "HDFS read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreReadSettings" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "wildcardFolderPath": { - "type": "object", - "description": "HDFS wildcardFolderPath. Type: string (or Expression with resultType string)." - }, - "wildcardFileName": { - "type": "object", - "description": "HDFS wildcardFileName. Type: string (or Expression with resultType string)." - }, - "fileListPath": { - "type": "object", - "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." - }, - "enablePartitionDiscovery": { - "type": "boolean", - "description": "Indicates whether to enable partition discovery." - }, - "partitionRootPath": { - "type": "object", - "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeStart": { - "type": "object", - "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "modifiedDatetimeEnd": { - "type": "object", - "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." - }, - "distcpSettings": { - "description": "Specifies Distcp-related settings.", - "$ref": "#/definitions/DistcpSettings" - } - } - }, - "StoreWriteSettings": { - "description": "Connector write settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The write setting type." - }, - "maxConcurrentConnections": { - "type": "object", - "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." - }, - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "type": "object" - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "AzureBlobStorageWriteSettings": { - "description": "Azure blob write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreWriteSettings" - } - ], - "properties": { - "blockSizeInMB": { - "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", - "type": "object" - } - } - }, - "AzureBlobFSWriteSettings": { - "description": "Azure blobFS write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreWriteSettings" - } - ], - "properties": { - "blockSizeInMB": { - "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", - "type": "object" - } - } - }, - "AzureDataLakeStoreWriteSettings": { - "description": "Azure data lake store write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreWriteSettings" - } - ], - "properties": { - "expiryDateTime": { - "description": "Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of \"2018-12-01T05:00:00Z\". Default value is NULL. Type: integer (or Expression with resultType integer).", - "type": "object" - } - } - }, - "FileServerWriteSettings": { - "description": "File server write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StoreWriteSettings" - } - ] - }, - "FormatReadSettings": { - "description": "Format read settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The read setting type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "CompressionReadSettings": { - "description": "Compression read settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The Compression setting type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "ZipDeflateReadSettings": { - "description": "The ZipDeflate compression read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CompressionReadSettings" - } - ], - "properties": { - "preserveZipFileNameAsFolder": { - "description": "Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).", - "type": "object" - } - } - }, - "DelimitedTextReadSettings": { - "description": "Delimited text read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatReadSettings" - } - ], - "properties": { - "skipLineCount": { - "type": "object", - "description": "Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer)." - }, - "compressionProperties": { - "$ref": "#/definitions/CompressionReadSettings", - "description": "Compression settings." - } - } - }, - "JsonReadSettings": { - "description": "Json read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatReadSettings" - } - ], - "properties": { - "compressionProperties": { - "$ref": "#/definitions/CompressionReadSettings", - "description": "Compression settings." - } - } - }, - "BinaryReadSettings": { - "description": "Binary read settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatReadSettings" - } - ], - "properties": { - "compressionProperties": { - "$ref": "#/definitions/CompressionReadSettings", - "description": "Compression settings." - } - } - }, - "FormatWriteSettings": { - "description": "Format write settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The write setting type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "AvroWriteSettings": { - "description": "Avro write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatWriteSettings" - } - ], - "properties": { - "recordName": { - "type": "string", - "description": "Top level record name in write result, which is required in AVRO spec." - }, - "recordNamespace": { - "type": "string", - "description": "Record namespace in the write result." - } - } - }, - "DelimitedTextWriteSettings": { - "description": "Delimited text write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatWriteSettings" - } - ], - "properties": { - "quoteAllText": { - "type": "object", - "description": "Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean)." - }, - "fileExtension": { - "type": "object", - "description": "The file extension used to create the files. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "fileExtension" - ] - }, - "JsonWriteSettings": { - "description": "Json write settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FormatWriteSettings" - } - ], - "properties": { - "filePattern": { - "description": "File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is 'setOfObjects'. It is case-sensitive.", - "type": "string", - "enum": [ - "setOfObjects", - "arrayOfObjects" - ], - "x-ms-enum": { - "name": "JsonWriteFilePattern", - "modelAsString": true - } - } - } - }, - "AvroSource": { - "description": "A copy activity Avro source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "Avro store settings." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "ParquetSource": { - "description": "A copy activity Parquet source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "Parquet store settings." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "DelimitedTextSource": { - "description": "A copy activity DelimitedText source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "DelimitedText store settings." - }, - "formatSettings": { - "$ref": "#/definitions/DelimitedTextReadSettings", - "description": "DelimitedText format settings." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "JsonSource": { - "description": "A copy activity Json source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "Json store settings." - }, - "formatSettings": { - "$ref": "#/definitions/JsonReadSettings", - "description": "Json format settings." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "OrcSource": { - "description": "A copy activity ORC source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "ORC store settings." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "DelimitedTextSink": { - "description": "A copy activity DelimitedText sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "DelimitedText store settings." - }, - "formatSettings": { - "$ref": "#/definitions/DelimitedTextWriteSettings", - "description": "DelimitedText format settings." - } - } - }, - "JsonSink": { - "description": "A copy activity Json sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "Json store settings." - }, - "formatSettings": { - "$ref": "#/definitions/JsonWriteSettings", - "description": "Json format settings." - } - } - }, - "OrcSink": { - "description": "A copy activity ORC sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "ORC store settings." - } - } - }, - "CopyActivity": { - "x-ms-discriminator-value": "Copy", - "description": "Copy activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Copy activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/CopyActivityTypeProperties" - }, - "inputs": { - "type": "array", - "description": "List of inputs for the activity.", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - }, - "outputs": { - "type": "array", - "description": "List of outputs for the activity.", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - } - }, - "required": [ - "typeProperties" - ] - }, - "CopyActivityTypeProperties": { - "description": "Copy activity properties.", - "properties": { - "source": { - "description": "Copy activity source.", - "$ref": "#/definitions/CopySource" - }, - "sink": { - "description": "Copy activity sink.", - "$ref": "#/definitions/CopySink" - }, - "translator": { - "description": "Copy activity translator. If not specified, tabular translator is used.", - "type": "object" - }, - "enableStaging": { - "type": "object", - "description": "Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." - }, - "stagingSettings": { - "description": "Specifies interim staging settings when EnableStaging is true.", - "$ref": "#/definitions/StagingSettings" - }, - "parallelCopies": { - "type": "object", - "description": "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." - }, - "dataIntegrationUnits": { - "type": "object", - "description": "Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "enableSkipIncompatibleRow": { - "type": "object", - "description": "Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean)." - }, - "redirectIncompatibleRowSettings": { - "description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true.", - "$ref": "#/definitions/RedirectIncompatibleRowSettings" - }, - "logStorageSettings": { - "description": "Log storage settings customer need to provide when enabling session log.", - "$ref": "#/definitions/LogStorageSettings" - }, - "preserveRules": { - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - }, - "description": "Preserve Rules." - }, - "preserve": { - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - }, - "description": "Preserve rules." - }, - "validateDataConsistency": { - "type": "object", - "description": "Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean)." - }, - "skipErrorFile": { - "description": "Specify the fault tolerance for data consistency.", - "$ref": "#/definitions/SkipErrorFile" - } - }, - "required": [ - "source", - "sink" - ] - }, - "CopySource": { - "discriminator": "type", - "description": "A copy activity source.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Copy source type." - }, - "sourceRetryCount": { - "type": "object", - "description": "Source retry count. Type: integer (or Expression with resultType integer)." - }, - "sourceRetryWait": { - "type": "object", - "description": "Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "maxConcurrentConnections": { - "type": "object", - "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "BinarySource": { - "description": "A copy activity Binary source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreReadSettings", - "description": "Binary store settings." - }, - "formatSettings": { - "$ref": "#/definitions/BinaryReadSettings", - "description": "Binary format settings." - } - } - }, - "TabularSource": { - "description": "Copy activity sources of tabular type.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "AzureTableSource": { - "description": "A copy activity Azure Table source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "azureTableSourceQuery": { - "type": "object", - "description": "Azure Table source query. Type: string (or Expression with resultType string)." - }, - "azureTableSourceIgnoreTableNotFound": { - "type": "object", - "description": "Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "BlobSource": { - "description": "A copy activity Azure Blob source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "treatEmptyAsNull": { - "type": "object", - "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." - }, - "skipHeaderLineCount": { - "type": "object", - "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." - }, - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "DocumentDbCollectionSource": { - "description": "A copy activity Document Database Collection source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Documents query. Type: string (or Expression with resultType string)." - }, - "nestingSeparator": { - "type": "object", - "description": "Nested properties separator. Type: string (or Expression with resultType string)." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "CosmosDbSqlApiSource": { - "description": "A copy activity Azure CosmosDB (SQL API) Collection source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "SQL API query. Type: string (or Expression with resultType string)." - }, - "pageSize": { - "type": "object", - "description": "Page size of the result. Type: integer (or Expression with resultType integer)." - }, - "preferredRegions": { - "type": "object", - "description": "Preferred regions. Type: array of strings (or Expression with resultType array of strings)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "DynamicsSource": { - "description": "A copy activity Dynamics source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "DynamicsCrmSource": { - "description": "A copy activity Dynamics CRM source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "CommonDataServiceForAppsSource": { - "description": "A copy activity Common Data Service for Apps source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "RelationalSource": { - "description": "A copy activity source for various relational databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "InformixSource": { - "description": "A copy activity source for Informix.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "MicrosoftAccessSource": { - "description": "A copy activity source for Microsoft Access.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "Db2Source": { - "description": "A copy activity source for Db2 databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "OdbcSource": { - "description": "A copy activity source for ODBC databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "MySqlSource": { - "description": "A copy activity source for MySQL databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "PostgreSqlSource": { - "description": "A copy activity source for PostgreSQL databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "SybaseSource": { - "description": "A copy activity source for Sybase databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "SapBwSource": { - "description": "A copy activity source for SapBW server via MDX.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2018-06-01" + }, + "paths": {}, + "definitions": { + "Pipeline": { + "description": "A data factory pipeline.", + "type": "object", + "properties": { + "description": { + "description": "The description of the pipeline.", + "type": "string" + }, + "activities": { + "type": "array", + "description": "List of activities in pipeline.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "parameters": { + "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", + "description": "List of parameters for pipeline." + }, + "variables": { + "$ref": "../datafactory.json#/definitions/VariableDefinitionSpecification", + "description": "List of variables for pipeline." + }, + "concurrency": { + "type": "integer", + "minimum": 1, + "description": "The max number of concurrent runs for the pipeline." + }, + "annotations": { + "description": "List of tags that can be used for describing the Pipeline.", + "type": "array", + "items": { + "type": "object" + } + }, + "runDimensions": { + "description": "Dimensions emitted by Pipeline.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "folder": { + "description": "The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.", + "type": "object", + "properties": { + "name": { + "description": "The name of the folder that this Pipeline is in.", + "type": "string" + } + } + } + } + }, + "Activity": { + "discriminator": "type", + "description": "A pipeline activity.", + "type": "object", + "properties": { + "name": { + "description": "Activity name.", + "type": "string" + }, + "type": { + "type": "string", + "description": "Type of activity." + }, + "description": { + "description": "Activity description.", + "type": "string" + }, + "dependsOn": { + "type": "array", + "description": "Activity depends on condition.", + "items": { + "$ref": "#/definitions/ActivityDependency" + } + }, + "userProperties": { + "type": "array", + "description": "Activity user properties.", + "items": { + "$ref": "#/definitions/UserProperty" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "name", + "type" + ] + }, + "UserProperty": { + "description": "User property.", + "type": "object", + "properties": { + "name": { + "description": "User property name.", + "type": "string" + }, + "value": { + "description": "User property value. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "name", + "value" + ] + }, + "ActivityDependency": { + "description": "Activity dependency information.", + "type": "object", + "properties": { + "activity": { + "description": "Activity name.", + "type": "string" + }, + "dependencyConditions": { + "type": "array", + "description": "Match-Condition for the dependency.", + "items": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Skipped", + "Completed" ], - "properties": { - "query": { - "type": "object", - "description": "MDX query. Type: string (or Expression with resultType string)." - } + "x-ms-enum": { + "name": "DependencyCondition", + "modelAsString": true } - }, - "ODataSource": { - "description": "A copy activity source for OData source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "SalesforceSource": { - "description": "A copy activity Salesforce source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "readBehavior": { - "description": "The read behavior for the operation. Default is Query.", - "type": "string", - "enum": [ - "Query", - "QueryAll" - ], - "x-ms-enum": { - "name": "SalesforceSourceReadBehavior", - "modelAsString": true - } - } - } - }, - "SalesforceServiceCloudSource": { - "description": "A copy activity Salesforce Service Cloud source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "readBehavior": { - "description": "The read behavior for the operation. Default is Query.", - "type": "string", - "enum": [ - "Query", - "QueryAll" - ], - "x-ms-enum": { - "name": "SalesforceSourceReadBehavior", - "modelAsString": true - } - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "SapCloudForCustomerSource": { - "description": "A copy activity source for SAP Cloud for Customer source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "SAP Cloud for Customer OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "SapEccSource": { - "description": "A copy activity source for SAP ECC source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "SAP ECC OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "SapHanaSource": { - "description": "A copy activity source for SAP HANA source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "SAP HANA Sql query. Type: string (or Expression with resultType string)." - }, - "packetSize": { - "type": "object", - "description": "The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer)." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for SAP HANA read in parallel.", - "type": "string", - "enum": [ - "None", - "PhysicalPartitionsOfTable", - "SapHanaDynamicRange" - ], - "x-ms-enum": { - "name": "SapHanaPartitionOption", - "modelAsString": true - } - }, - "partitionSettings": { - "description": "The settings that will be leveraged for SAP HANA source partitioning.", - "$ref": "#/definitions/SapHanaPartitionSettings" - } - } - }, - "SapHanaPartitionSettings": { - "description": "The settings that will be leveraged for SAP HANA source partitioning.", - "type": "object", - "properties": { - "partitionColumnName": { - "type": "object", - "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - } - } - }, - "SapOpenHubSource": { - "description": "A copy activity source for SAP Business Warehouse Open Hub Destination source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "excludeLastRequest": { - "type": "object", - "description": "Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean)." - }, - "baseRequestId": { - "type": "object", - "description": "The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer )." - } - } - }, - "SapTableSource": { - "description": "A copy activity source for SAP Table source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "rowCount": { - "type": "object", - "description": "The number of rows to be retrieved. Type: integer(or Expression with resultType integer)." - }, - "rowSkips": { - "type": "object", - "description": "The number of rows that will be skipped. Type: integer (or Expression with resultType integer)." - }, - "rfcTableFields": { - "type": "object", - "description": "The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string)." - }, - "rfcTableOptions": { - "type": "object", - "description": "The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string)." - }, - "batchSize": { - "type": "object", - "description": "Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer)." - }, - "customRfcReadTableFunctionModule": { - "type": "object", - "description": "Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string)." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for SAP table read in parallel.", - "type": "string", - "enum": [ - "None", - "PartitionOnInt", - "PartitionOnCalendarYear", - "PartitionOnCalendarMonth", - "PartitionOnCalendarDate", - "PartitionOnTime" - ], - "x-ms-enum": { - "name": "SapTablePartitionOption", - "modelAsString": true - } - }, - "partitionSettings": { - "description": "The settings that will be leveraged for SAP table source partitioning.", - "$ref": "#/definitions/SapTablePartitionSettings" - } - } - }, - "SapTablePartitionSettings": { - "description": "The settings that will be leveraged for SAP table source partitioning.", - "type": "object", - "properties": { - "partitionColumnName": { - "type": "object", - "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionUpperBound": { - "type": "object", - "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionLowerBound": { - "type": "object", - "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "maxPartitionsNumber": { - "type": "object", - "description": "The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string)." - } - } - }, - "RestSource": { - "description": "A copy activity Rest service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "requestMethod": { - "type": "object", - "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." - }, - "requestBody": { - "type": "object", - "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." - }, - "additionalHeaders": { - "type": "object", - "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." - }, - "paginationRules": { - "type": "object", - "description": "The pagination rules to compose next page requests. Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "requestInterval": { - "type": "object", - "description": "The time to await before sending next page request. " - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "SqlSource": { - "description": "A copy activity SQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "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)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "isolationLevel": { - "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", - "type": "object" - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "$ref": "#/definitions/SqlPartitionOption" - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "$ref": "#/definitions/SqlPartitionSettings" - } - } - }, - "SqlServerSource": { - "description": "A copy activity SQL server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "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)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "produceAdditionalTypes": { - "description": "Which additional types to produce.", - "type": "object" - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "$ref": "#/definitions/SqlPartitionOption" - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "$ref": "#/definitions/SqlPartitionSettings" - } - } - }, - "AzureSqlSource": { - "description": "A copy activity Azure SQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "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)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "produceAdditionalTypes": { - "description": "Which additional types to produce.", - "type": "object" - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "$ref": "#/definitions/SqlPartitionOption" - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "$ref": "#/definitions/SqlPartitionSettings" - } - } - }, - "SqlMISource": { - "description": "A copy activity Azure SQL Managed Instance source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "produceAdditionalTypes": { - "description": "Which additional types to produce.", - "type": "object" - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "$ref": "#/definitions/SqlPartitionOption" - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "$ref": "#/definitions/SqlPartitionSettings" - } - } - }, - "SqlDWSource": { - "description": "A copy activity SQL Data Warehouse source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL Data Warehouse reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "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)." - }, - "storedProcedureParameters": { - "type": "object", - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "$ref": "#/definitions/SqlPartitionOption" - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "$ref": "#/definitions/SqlPartitionSettings" - } - } - }, - "SqlPartitionSettings": { - "description": "The settings that will be leveraged for Sql source partitioning.", - "type": "object", - "properties": { - "partitionColumnName": { - "type": "object", - "description": "The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string)." - }, - "partitionUpperBound": { - "type": "object", - "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionLowerBound": { - "type": "object", - "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - } - } - }, - "SqlPartitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel.", - "type": "string", - "enum": [ - "None", - "PhysicalPartitionsOfTable", - "DynamicRange" - ], - "x-ms-enum": { - "name": "SqlPartitionOption", - "modelAsString": true - } - }, - "FileSystemSource": { - "description": "A copy activity file system source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "HdfsSource": { - "description": "A copy activity HDFS source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "distcpSettings": { - "description": "Specifies Distcp-related settings.", - "$ref": "#/definitions/DistcpSettings" - } - } - }, - "DistcpSettings": { - "description": "Distcp settings.", - "type": "object", - "properties": { - "resourceManagerEndpoint": { - "type": "object", - "description": "Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string)." - }, - "tempScriptPath": { - "type": "object", - "description": "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)." - }, - "distcpOptions": { - "type": "object", - "description": "Specifies the Distcp options. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "resourceManagerEndpoint", - "tempScriptPath" - ] - }, - "AzureMySqlSource": { - "description": "A copy activity Azure MySQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "AzureDataExplorerSource": { - "description": "A copy activity Azure Data Explorer (Kusto) source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string)." - }, - "noTruncation": { - "type": "object", - "description": "The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - }, - "required": [ - "query" - ] - }, - "OracleSource": { - "description": "A copy activity Oracle source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "oracleReaderQuery": { - "type": "object", - "description": "Oracle reader query. Type: string (or Expression with resultType string)." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Oracle read in parallel.", - "type": "string", - "enum": [ - "None", - "PhysicalPartitionsOfTable", - "DynamicRange" - ], - "x-ms-enum": { - "name": "OraclePartitionOption", - "modelAsString": true - } - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Oracle source partitioning.", - "$ref": "#/definitions/OraclePartitionSettings" - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "OraclePartitionSettings": { - "description": "The settings that will be leveraged for Oracle source partitioning.", - "type": "object", - "properties": { - "partitionNames": { - "type": "object", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - }, - "description": "Names of the physical partitions of Oracle table. " - }, - "partitionColumnName": { - "type": "object", - "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionUpperBound": { - "type": "object", - "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionLowerBound": { - "type": "object", - "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - } - } - }, - "TeradataSource": { - "description": "A copy activity Teradata source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Teradata query. Type: string (or Expression with resultType string)." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for teradata read in parallel.", - "type": "string", - "enum": [ - "None", - "Hash", - "DynamicRange" - ], - "x-ms-enum": { - "name": "TeradataPartitionOption", - "modelAsString": true - } - }, - "partitionSettings": { - "description": "The settings that will be leveraged for teradata source partitioning.", - "$ref": "#/definitions/TeradataPartitionSettings" - } - } - }, - "TeradataPartitionSettings": { - "description": "The settings that will be leveraged for teradata source partitioning.", - "type": "object", - "properties": { - "partitionColumnName": { - "type": "object", - "description": "The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string)." - }, - "partitionUpperBound": { - "type": "object", - "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionLowerBound": { - "type": "object", - "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - } - } - }, - "WebSource": { - "description": "A copy activity source for web page table.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "CassandraSource": { - "description": "A copy activity source for a Cassandra database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string)." - }, - "consistencyLevel": { - "description": "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.", - "type": "string", - "enum": [ - "ALL", - "EACH_QUORUM", - "QUORUM", - "LOCAL_QUORUM", - "ONE", - "TWO", - "THREE", - "LOCAL_ONE", - "SERIAL", - "LOCAL_SERIAL" - ], - "x-ms-enum": { - "name": "CassandraSourceReadConsistencyLevels", - "modelAsString": true - } - } - } - }, - "MongoDbSource": { - "description": "A copy activity source for a MongoDB database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "MongoDbV2Source": { - "description": "A copy activity source for a MongoDB database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "filter": { - "type": "object", - "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." - }, - "cursorMethods": { - "description": "Cursor methods for Mongodb query", - "$ref": "#/definitions/MongoDbCursorMethodsProperties" - }, - "batchSize": { - "type": "object", - "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "CosmosDbMongoDbApiSource": { - "description": "A copy activity source for a CosmosDB (MongoDB API) database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "filter": { - "type": "object", - "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." - }, - "cursorMethods": { - "description": "Cursor methods for Mongodb query.", - "$ref": "#/definitions/MongoDbCursorMethodsProperties" - }, - "batchSize": { - "type": "object", - "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/AdditionalColumns" - } - } - } - }, - "MongoDbCursorMethodsProperties": { - "description": "Cursor methods for Mongodb query", - "type": "object", - "properties": { - "project": { - "type": "object", - "description": "Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string)." - }, - "sort": { - "type": "object", - "description": "Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." - }, - "skip": { - "type": "object", - "description": "Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer)." - }, - "limit": { - "type": "object", - "description": "Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer)." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "Office365Source": { - "description": "A copy activity source for an Office 365 service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "allowedGroups": { - "type": "object", - "description": "The groups containing all the users. Type: array of strings (or Expression with resultType array of strings)." - }, - "userScopeFilterUri": { - "type": "object", - "description": "The user scope uri. Type: string (or Expression with resultType string)." - }, - "dateFilterColumn": { - "type": "object", - "description": "The Column to apply the and . Type: string (or Expression with resultType string)." - }, - "startTime": { - "type": "object", - "description": "Start time of the requested range for this dataset. Type: string (or Expression with resultType string)." - }, - "endTime": { - "type": "object", - "description": "End time of the requested range for this dataset. Type: string (or Expression with resultType string)." - }, - "outputColumns": { - "type": "object", - "description": "The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). Example: [ { \"name\": \"Id\" }, { \"name\": \"CreatedDateTime\" } ]" - } - } - }, - "AzureDataLakeStoreSource": { - "description": "A copy activity Azure Data Lake source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "AzureBlobFSSource": { - "description": "A copy activity Azure BlobFS source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "treatEmptyAsNull": { - "type": "object", - "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." - }, - "skipHeaderLineCount": { - "type": "object", - "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." - }, - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "HttpSource": { - "description": "A copy activity source for an HTTP file.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "httpRequestTimeout": { - "type": "object", - "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "AmazonMWSSource": { - "description": "A copy activity Amazon Marketplace Web Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "AzurePostgreSqlSource": { - "description": "A copy activity Azure PostgreSQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "AzurePostgreSqlSink": { - "description": "A copy activity Azure PostgreSQL sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "AzureMySqlSink": { - "description": "A copy activity Azure MySql sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "ConcurSource": { - "description": "A copy activity Concur Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "CouchbaseSource": { - "description": "A copy activity Couchbase server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "DrillSource": { - "description": "A copy activity Drill server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "EloquaSource": { - "description": "A copy activity Eloqua server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "GoogleBigQuerySource": { - "description": "A copy activity Google BigQuery service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "GreenplumSource": { - "description": "A copy activity Greenplum Database source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HBaseSource": { - "description": "A copy activity HBase server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HiveSource": { - "description": "A copy activity Hive Server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HubspotSource": { - "description": "A copy activity Hubspot Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ImpalaSource": { - "description": "A copy activity Impala server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "JiraSource": { - "description": "A copy activity Jira Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MagentoSource": { - "description": "A copy activity Magento server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MariaDBSource": { - "description": "A copy activity MariaDB server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "AzureMariaDBSource": { - "description": "A copy activity Azure MariaDB source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MarketoSource": { - "description": "A copy activity Marketo server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PaypalSource": { - "description": "A copy activity Paypal Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PhoenixSource": { - "description": "A copy activity Phoenix server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PrestoSource": { - "description": "A copy activity Presto server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "QuickBooksSource": { - "description": "A copy activity QuickBooks server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ServiceNowSource": { - "description": "A copy activity ServiceNow server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ShopifySource": { - "description": "A copy activity Shopify Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SparkSource": { - "description": "A copy activity Spark Server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SquareSource": { - "description": "A copy activity Square Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "XeroSource": { - "description": "A copy activity Xero Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ZohoSource": { - "description": "A copy activity Zoho server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "NetezzaSource": { - "description": "A copy activity Netezza source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - }, - "partitionOption": { - "description": "The partition mechanism that will be used for Netezza read in parallel.", - "type": "string", - "enum": [ - "None", - "DataSlice", - "DynamicRange" - ], - "x-ms-enum": { - "name": "NetezzaPartitionOption", - "modelAsString": true - } - }, - "partitionSettings": { - "description": "The settings that will be leveraged for Netezza source partitioning.", - "$ref": "#/definitions/NetezzaPartitionSettings" - } - } - }, - "NetezzaPartitionSettings": { - "description": "The settings that will be leveraged for Netezza source partitioning.", - "type": "object", - "properties": { - "partitionColumnName": { - "type": "object", - "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionUpperBound": { - "type": "object", - "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - }, - "partitionLowerBound": { - "type": "object", - "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." - } - } - }, - "VerticaSource": { - "description": "A copy activity Vertica source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SalesforceMarketingCloudSource": { - "description": "A copy activity Salesforce Marketing Cloud source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ResponsysSource": { - "description": "A copy activity Responsys source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "DynamicsAXSource": { - "description": "A copy activity Dynamics AX source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "OracleServiceCloudSource": { - "description": "A copy activity Oracle Service Cloud source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "GoogleAdWordsSource": { - "description": "A copy activity Google AdWords service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "AmazonRedshiftSource": { - "description": "A copy activity source for Amazon Redshift Source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TabularSource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "redshiftUnloadSettings": { - "description": "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.", - "$ref": "#/definitions/RedshiftUnloadSettings" - } - } - }, - "RedshiftUnloadSettings": { - "description": "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.", - "type": "object", - "properties": { - "s3LinkedServiceName": { - "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "bucketName": { - "type": "object", - "description": "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)." - } - }, - "required": [ - "s3LinkedServiceName", - "bucketName" - ] - }, - "SnowflakeSource": { - "description": "A copy activity snowflake source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." - }, - "exportSettings": { - "$ref": "#/definitions/SnowflakeExportCopyCommand", - "description": "Snowflake export settings." - } - } - }, - "ExportSettings": { - "description": "Export command settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The export setting type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "SnowflakeExportCopyCommand": { - "description": "Snowflake export command settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ExportSettings" - } - ], - "properties": { - "additionalCopyOptions": { - "type": "object", - "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", - "additionalProperties": { - "type": "object" - } - }, - "additionalFormatOptions": { - "type": "object", - "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"OVERWRITE\": \"TRUE\", \"MAX_FILE_SIZE\": \"'FALSE'\" }", - "additionalProperties": { - "type": "object" - } - } - } - }, - "StoredProcedureParameter": { - "description": "SQL stored procedure parameter.", - "type": "object", - "properties": { - "value": { - "type": "object", - "description": "Stored procedure parameter value. Type: string (or Expression with resultType string)." - }, - "type": { - "description": "Stored procedure parameter type.", - "$ref": "#/definitions/StoredProcedureParameterType" - } - } - }, - "StoredProcedureParameterType": { - "description": "Stored procedure parameter type.", - "type": "string", - "enum": [ - "String", - "Int", - "Int64", - "Decimal", - "Guid", - "Boolean", - "Date" - ], - "x-ms-enum": { - "name": "StoredProcedureParameterType", - "modelAsString": true - } - }, - "CopySink": { - "discriminator": "type", - "description": "A copy activity sink.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Copy sink type." - }, - "writeBatchSize": { - "type": "object", - "description": "Write batch size. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "writeBatchTimeout": { - "type": "object", - "description": "Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "sinkRetryCount": { - "type": "object", - "description": "Sink retry count. Type: integer (or Expression with resultType integer)." - }, - "sinkRetryWait": { - "type": "object", - "description": "Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "maxConcurrentConnections": { - "type": "object", - "description": "The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "SapCloudForCustomerSink": { - "description": "A copy activity SAP Cloud for Customer sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation. Default is 'Insert'.", - "type": "string", - "enum": [ - "Insert", - "Update" - ], - "x-ms-enum": { - "name": "SapCloudForCustomerSinkWriteBehavior", - "modelAsString": true - } - }, - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "AzureQueueSink": { - "description": "A copy activity Azure Queue sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": {} - }, - "CopyBehaviorType": { - "description": "All available types of copy behavior.", - "type": "string", - "enum": [ - "PreserveHierarchy", - "FlattenHierarchy", - "MergeFiles" - ], - "x-ms-enum": { - "name": "CopyBehaviorType", - "modelAsString": true - } - }, - "AzureTableSink": { - "description": "A copy activity Azure Table sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "azureTableDefaultPartitionKeyValue": { - "type": "object", - "description": "Azure Table default partition key value. Type: string (or Expression with resultType string)." - }, - "azureTablePartitionKeyName": { - "type": "object", - "description": "Azure Table partition key name. Type: string (or Expression with resultType string)." - }, - "azureTableRowKeyName": { - "type": "object", - "description": "Azure Table row key name. Type: string (or Expression with resultType string)." - }, - "azureTableInsertType": { - "type": "object", - "description": "Azure Table insert type. Type: string (or Expression with resultType string)." - } - } - }, - "AvroSink": { - "description": "A copy activity Avro sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "Avro store settings." - }, - "formatSettings": { - "$ref": "#/definitions/AvroWriteSettings", - "description": "Avro format settings." - } - } - }, - "ParquetSink": { - "description": "A copy activity Parquet sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "Parquet store settings." - } - } - }, - "BinarySink": { - "description": "A copy activity Binary sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "storeSettings": { - "$ref": "#/definitions/StoreWriteSettings", - "description": "Binary store settings." - } - } - }, - "BlobSink": { - "description": "A copy activity Azure Blob sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "blobWriterOverwriteFiles": { - "type": "object", - "description": "Blob writer overwrite files. Type: boolean (or Expression with resultType boolean)." - }, - "blobWriterDateTimeFormat": { - "type": "object", - "description": "Blob writer date time format. Type: string (or Expression with resultType string)." - }, - "blobWriterAddHeader": { - "type": "object", - "description": "Blob writer add header. Type: boolean (or Expression with resultType boolean)." - }, - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "type": "object" - } - } - }, - "FileSystemSink": { - "description": "A copy activity file system sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "type": "object" - } - } - }, - "DocumentDbCollectionSink": { - "description": "A copy activity Document Database Collection sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "nestingSeparator": { - "type": "object", - "description": "Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string)." - }, - "writeBehavior": { - "type": "object", - "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." - } - } - }, - "CosmosDbSqlApiSink": { - "description": "A copy activity Azure CosmosDB (SQL API) Collection sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "type": "object", - "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." - } - } - }, - "SqlSink": { - "description": "A copy activity SQL sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "sqlWriterStoredProcedureName": { - "type": "object", - "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." - }, - "sqlWriterTableType": { - "type": "object", - "description": "SQL writer table type. Type: string (or Expression with resultType string)." - }, - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "storedProcedureTableTypeParameterName": { - "type": "object", - "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." - }, - "tableOption": { - "type": "object", - "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." - } - } - }, - "SqlServerSink": { - "description": "A copy activity SQL server sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "sqlWriterStoredProcedureName": { - "type": "object", - "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." - }, - "sqlWriterTableType": { - "type": "object", - "description": "SQL writer table type. Type: string (or Expression with resultType string)." - }, - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "storedProcedureTableTypeParameterName": { - "type": "object", - "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." - }, - "tableOption": { - "type": "object", - "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." - } - } - }, - "AzureSqlSink": { - "description": "A copy activity Azure SQL sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "sqlWriterStoredProcedureName": { - "type": "object", - "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." - }, - "sqlWriterTableType": { - "type": "object", - "description": "SQL writer table type. Type: string (or Expression with resultType string)." - }, - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "storedProcedureTableTypeParameterName": { - "type": "object", - "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." - }, - "tableOption": { - "type": "object", - "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." - } - } - }, - "SqlMISink": { - "description": "A copy activity Azure SQL Managed Instance sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "sqlWriterStoredProcedureName": { - "type": "object", - "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." - }, - "sqlWriterTableType": { - "type": "object", - "description": "SQL writer table type. Type: string (or Expression with resultType string)." - }, - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - }, - "storedProcedureTableTypeParameterName": { - "type": "object", - "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." - }, - "tableOption": { - "type": "object", - "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." - } - } - }, - "SqlDWSink": { - "description": "A copy activity SQL Data Warehouse sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "allowPolyBase": { - "type": "object", - "description": "Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean)." - }, - "polyBaseSettings": { - "description": "Specifies PolyBase-related settings when allowPolyBase is true.", - "$ref": "#/definitions/PolybaseSettings" - }, - "allowCopyCommand": { - "type": "object", - "description": "Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean)." - }, - "copyCommandSettings": { - "description": "Specifies Copy Command related settings when allowCopyCommand is true.", - "$ref": "#/definitions/DWCopyCommandSettings" - }, - "tableOption": { - "type": "object", - "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." - } - } - }, - "PolybaseSettings": { - "description": "PolyBase settings.", - "type": "object", - "properties": { - "rejectType": { - "$ref": "#/definitions/PolybaseSettingsRejectType", - "description": "Reject type." - }, - "rejectValue": { - "type": "object", - "description": "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." - }, - "rejectSampleValue": { - "type": "object", - "description": "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." - }, - "useTypeDefault": { - "type": "object", - "description": "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)." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "PolybaseSettingsRejectType": { - "description": "Indicates whether the RejectValue property is specified as a literal value or a percentage.", - "type": "string", - "enum": [ - "value", - "percentage" - ], - "x-ms-enum": { - "name": "PolybaseSettingsRejectType", - "modelAsString": true - } - }, - "DWCopyCommandSettings": { - "description": "DW Copy Command settings.", - "type": "object", - "properties": { - "defaultValues": { - "type": "array", - "description": "Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/DWCopyCommandDefaultValue" - } - }, - "additionalOptions": { - "type": "object", - "description": "Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalOptions\": { \"MAXERRORS\": \"1000\", \"DATEFORMAT\": \"'ymd'\" }", - "additionalProperties": { - "type": "string" - } - } - } - }, - "DWCopyCommandDefaultValue": { - "description": "Default value.", - "type": "object", - "properties": { - "columnName": { - "type": "object", - "description": "Column name. Type: object (or Expression with resultType string)." - }, - "defaultValue": { - "type": "object", - "description": "The default value of the column. Type: object (or Expression with resultType string)." - } - } - }, - "SnowflakeSink": { - "description": "A copy activity snowflake sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "importSettings": { - "$ref": "#/definitions/SnowflakeImportCopyCommand", - "description": "Snowflake import settings." - } - } - }, - "ImportSettings": { - "description": "Import command settings.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The import setting type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "SnowflakeImportCopyCommand": { - "description": "Snowflake import command settings.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ImportSettings" - } - ], - "properties": { - "additionalCopyOptions": { - "type": "object", - "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", - "additionalProperties": { - "type": "object" - } - }, - "additionalFormatOptions": { - "type": "object", - "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"FORCE\": \"TRUE\", \"LOAD_UNCERTAIN_FILES\": \"'FALSE'\" }", - "additionalProperties": { - "type": "object" - } - } - } - }, - "LogStorageSettings": { - "description": "Log storage settings.", - "type": "object", - "properties": { - "linkedServiceName": { - "description": "Log storage linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "path": { - "type": "object", - "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "linkedServiceName" - ] - }, - "StagingSettings": { - "description": "Staging settings.", - "type": "object", - "properties": { - "linkedServiceName": { - "description": "Staging linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "path": { - "type": "object", - "description": "The path to storage for storing the interim data. Type: string (or Expression with resultType string)." - }, - "enableCompression": { - "type": "object", - "description": "Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "linkedServiceName" - ] - }, - "RedirectIncompatibleRowSettings": { - "description": "Redirect incompatible row settings", - "type": "object", - "properties": { - "linkedServiceName": { - "type": "object", - "description": "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": { - "type": "object", - "description": "The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "linkedServiceName" - ] - }, - "SkipErrorFile": { - "description": "Skip error file.", - "type": "object", - "properties": { - "fileMissing": { - "type": "object", - "description": "Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "dataInconsistency": { - "type": "object", - "description": "Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "AdditionalColumns": { - "description": "Specify the column name and value of additional columns.", - "type": "object", - "properties": { - "name": { - "type": "object", - "description": "Additional column name. Type: string (or Expression with resultType string)." - }, - "value": { - "type": "object", - "description": "Additional column value. Type: string (or Expression with resultType string)." - } - } - }, - "OracleSink": { - "description": "A copy activity Oracle sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - } - } - }, - "AzureDataLakeStoreSink": { - "description": "A copy activity Azure Data Lake Store sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "type": "object" - }, - "enableAdlsSingleFileParallel": { - "description": "Single File Parallel.", - "type": "object" - } - } - }, - "AzureBlobFSSink": { - "description": "A copy activity Azure Data Lake Storage Gen2 sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "type": "object" - } - } - }, - "AzureSearchIndexSink": { - "description": "A copy activity Azure Search Index sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "Specify the write behavior when upserting documents into Azure Search Index.", - "type": "string", - "enum": [ - "Merge", - "Upload" - ], - "x-ms-enum": { - "name": "AzureSearchIndexWriteBehaviorType", - "modelAsString": true - } - } - } - }, - "OdbcSink": { - "description": "A copy activity ODBC sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "InformixSink": { - "description": "A copy activity Informix sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "MicrosoftAccessSink": { - "description": "A copy activity Microsoft Access sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "DynamicsSink": { - "description": "A copy activity Dynamics sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation.", - "type": "string", - "enum": [ - "Upsert" - ], - "x-ms-enum": { - "name": "DynamicsSinkWriteBehavior", - "modelAsString": true - } - }, - "ignoreNullValues": { - "type": "object", - "description": "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)." - }, - "alternateKeyName": { - "type": "object", - "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "writeBehavior" - ] - }, - "DynamicsCrmSink": { - "description": "A copy activity Dynamics CRM sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation.", - "type": "string", - "enum": [ - "Upsert" - ], - "x-ms-enum": { - "name": "DynamicsSinkWriteBehavior", - "modelAsString": true - } - }, - "ignoreNullValues": { - "type": "object", - "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." - }, - "alternateKeyName": { - "type": "object", - "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "writeBehavior" - ] - }, - "CommonDataServiceForAppsSink": { - "description": "A copy activity Common Data Service for Apps sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation.", - "type": "string", - "enum": [ - "Upsert" - ], - "x-ms-enum": { - "name": "DynamicsSinkWriteBehavior", - "modelAsString": true - } - }, - "ignoreNullValues": { - "type": "object", - "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." - }, - "alternateKeyName": { - "type": "object", - "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "writeBehavior" - ] - }, - "AzureDataExplorerSink": { - "description": "A copy activity Azure Data Explorer sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "ingestionMappingName": { - "type": "object", - "description": "A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string." - }, - "ingestionMappingAsJson": { - "type": "object", - "description": "An explicit column mapping description provided in a json format. Type: string." - }, - "flushImmediately": { - "type": "object", - "description": "If set to true, any aggregation will be skipped. Default is false. Type: boolean." - } - } - }, - "SalesforceSink": { - "description": "A copy activity Salesforce sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation. Default is Insert.", - "type": "string", - "enum": [ - "Insert", - "Upsert" - ], - "x-ms-enum": { - "name": "SalesforceSinkWriteBehavior", - "modelAsString": true - } - }, - "externalIdFieldName": { - "type": "object", - "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." - }, - "ignoreNullValues": { - "type": "object", - "description": "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)." - } - } - }, - "SalesforceServiceCloudSink": { - "description": "A copy activity Salesforce Service Cloud sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation. Default is Insert.", - "type": "string", - "enum": [ - "Insert", - "Upsert" - ], - "x-ms-enum": { - "name": "SalesforceSinkWriteBehavior", - "modelAsString": true - } - }, - "externalIdFieldName": { - "type": "object", - "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." - }, - "ignoreNullValues": { - "type": "object", - "description": "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)." - } - } - }, - "CosmosDbMongoDbApiSink": { - "description": "A copy activity sink for a CosmosDB (MongoDB API) database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "type": "object", - "description": "Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is \"insert\". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." - } - } - }, - "CopyTranslator": { - "discriminator": "type", - "description": "A copy activity translator.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Copy translator type." - } - }, + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "activity", + "dependencyConditions" + ] + }, + "ControlActivity": { + "x-ms-discriminator-value": "Container", + "description": "Base class for all control activities like IfCondition, ForEach , Until.", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": {} + }, + "ExecutionActivity": { + "x-ms-discriminator-value": "Execution", + "description": "Base class for all execution activities.", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "linkedServiceName": { + "description": "Linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "policy": { + "$ref": "#/definitions/ActivityPolicy", + "description": "Activity policy." + } + } + }, + "ActivityPolicy": { + "description": "Execution policy for an activity.", + "type": "object", + "properties": { + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "retry": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "retryIntervalInSeconds": { + "type": "integer", + "description": "Interval between each retry attempt (in seconds). The default is 30 sec.", + "minimum": 30, + "maximum": 86400 + }, + "secureInput": { + "type": "boolean", + "description": "When set to true, Input from activity is considered as secure and will not be logged to monitoring." + }, + "secureOutput": { + "type": "boolean", + "description": "When set to true, Output from activity is considered as secure and will not be logged to monitoring." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "StoreReadSettings": { + "description": "Connector read setting.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The read setting type." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureBlobStorageReadSettings": { + "description": "Azure blob read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure blob wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure blob wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AzureBlobFSReadSettings": { + "description": "Azure blobFS read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure blobFS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreReadSettings": { + "description": "Azure data lake store read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "ADLS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "ADLS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonS3ReadSettings": { + "description": "Azure data lake store read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "AmazonS3 wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "FileServerReadSettings": { + "description": "File server read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "FileServer wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "FileServer wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "fileFilter": { + "type": "object", + "description": "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)." + } + } + }, + "AzureFileStorageReadSettings": { + "description": "Azure File Storage read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure File Storage wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "SftpWriteSettings": { + "description": "Sftp write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "operationTimeout": { + "description": "Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).", + "type": "object" + }, + "useTempFileRename": { + "description": "Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn't support rename operation. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "GoogleCloudStorageReadSettings": { + "description": "Google Cloud Storage read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "FtpReadSettings": { + "description": "Ftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Ftp wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Ftp wildcardFileName. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "useBinaryTransfer": { + "type": "boolean", + "description": "Specify whether to use binary transfer mode for FTP stores." + } + } + }, + "SftpReadSettings": { + "description": "Sftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Sftp wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Sftp wildcardFileName. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "HttpReadSettings": { + "description": "Sftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "requestTimeout": { + "type": "object", + "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + } + } + }, + "HdfsReadSettings": { + "description": "HDFS read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "HDFS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "HDFS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "distcpSettings": { + "description": "Specifies Distcp-related settings.", + "$ref": "#/definitions/DistcpSettings" + } + } + }, + "StoreWriteSettings": { + "description": "Connector write settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The write setting type." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + }, + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureBlobStorageWriteSettings": { + "description": "Azure blob write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "blockSizeInMB": { + "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "AzureBlobFSWriteSettings": { + "description": "Azure blobFS write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "blockSizeInMB": { + "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "AzureDataLakeStoreWriteSettings": { + "description": "Azure data lake store write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "expiryDateTime": { + "description": "Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of \"2018-12-01T05:00:00Z\". Default value is NULL. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "FileServerWriteSettings": { + "description": "File server write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ] + }, + "FormatReadSettings": { + "description": "Format read settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The read setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "CompressionReadSettings": { + "description": "Compression read settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The Compression setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "ZipDeflateReadSettings": { + "description": "The ZipDeflate compression read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CompressionReadSettings" + } + ], + "properties": { + "preserveZipFileNameAsFolder": { + "description": "Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "DelimitedTextReadSettings": { + "description": "Delimited text read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "skipLineCount": { + "type": "object", + "description": "Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer)." + }, + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "JsonReadSettings": { + "description": "Json read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "BinaryReadSettings": { + "description": "Binary read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "FormatWriteSettings": { + "description": "Format write settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The write setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AvroWriteSettings": { + "description": "Avro write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "recordName": { + "type": "string", + "description": "Top level record name in write result, which is required in AVRO spec." + }, + "recordNamespace": { + "type": "string", + "description": "Record namespace in the write result." + } + } + }, + "DelimitedTextWriteSettings": { + "description": "Delimited text write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "quoteAllText": { + "type": "object", + "description": "Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean)." + }, + "fileExtension": { + "type": "object", + "description": "The file extension used to create the files. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "fileExtension" + ] + }, + "JsonWriteSettings": { + "description": "Json write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "filePattern": { + "description": "File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is 'setOfObjects'. It is case-sensitive.", + "type": "string", + "enum": [ + "setOfObjects", + "arrayOfObjects" + ], + "x-ms-enum": { + "name": "JsonWriteFilePattern", + "modelAsString": true + } + } + } + }, + "AvroSource": { + "description": "A copy activity Avro source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Avro store settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "ParquetSource": { + "description": "A copy activity Parquet source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Parquet store settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "DelimitedTextSource": { + "description": "A copy activity DelimitedText source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "DelimitedText store settings." + }, + "formatSettings": { + "$ref": "#/definitions/DelimitedTextReadSettings", + "description": "DelimitedText format settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "JsonSource": { + "description": "A copy activity Json source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Json store settings." + }, + "formatSettings": { + "$ref": "#/definitions/JsonReadSettings", + "description": "Json format settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "OrcSource": { + "description": "A copy activity ORC source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "ORC store settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "DelimitedTextSink": { + "description": "A copy activity DelimitedText sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "DelimitedText store settings." + }, + "formatSettings": { + "$ref": "#/definitions/DelimitedTextWriteSettings", + "description": "DelimitedText format settings." + } + } + }, + "JsonSink": { + "description": "A copy activity Json sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Json store settings." + }, + "formatSettings": { + "$ref": "#/definitions/JsonWriteSettings", + "description": "Json format settings." + } + } + }, + "OrcSink": { + "description": "A copy activity ORC sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "ORC store settings." + } + } + }, + "CopyActivity": { + "x-ms-discriminator-value": "Copy", + "description": "Copy activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Copy activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CopyActivityTypeProperties" + }, + "inputs": { + "type": "array", + "description": "List of inputs for the activity.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "outputs": { + "type": "array", + "description": "List of outputs for the activity.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + } + }, + "required": [ + "typeProperties" + ] + }, + "CopyActivityTypeProperties": { + "description": "Copy activity properties.", + "properties": { + "source": { + "description": "Copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "sink": { + "description": "Copy activity sink.", + "$ref": "#/definitions/CopySink" + }, + "translator": { + "description": "Copy activity translator. If not specified, tabular translator is used.", + "type": "object" + }, + "enableStaging": { + "type": "object", + "description": "Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "stagingSettings": { + "description": "Specifies interim staging settings when EnableStaging is true.", + "$ref": "#/definitions/StagingSettings" + }, + "parallelCopies": { + "type": "object", + "description": "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." + }, + "dataIntegrationUnits": { + "type": "object", + "description": "Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "enableSkipIncompatibleRow": { + "type": "object", + "description": "Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "redirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true.", + "$ref": "#/definitions/RedirectIncompatibleRowSettings" + }, + "logStorageSettings": { + "description": "Log storage settings customer need to provide when enabling session log.", + "$ref": "#/definitions/LogStorageSettings" + }, + "preserveRules": { + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Preserve Rules." + }, + "preserve": { + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Preserve rules." + }, + "validateDataConsistency": { + "type": "object", + "description": "Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean)." + }, + "skipErrorFile": { + "description": "Specify the fault tolerance for data consistency.", + "$ref": "#/definitions/SkipErrorFile" + } + }, + "required": [ + "source", + "sink" + ] + }, + "CopySource": { + "discriminator": "type", + "description": "A copy activity source.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy source type." + }, + "sourceRetryCount": { + "type": "object", + "description": "Source retry count. Type: integer (or Expression with resultType integer)." + }, + "sourceRetryWait": { + "type": "object", + "description": "Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "BinarySource": { + "description": "A copy activity Binary source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Binary store settings." + }, + "formatSettings": { + "$ref": "#/definitions/BinaryReadSettings", + "description": "Binary format settings." + } + } + }, + "TabularSource": { + "description": "Copy activity sources of tabular type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "AzureTableSource": { + "description": "A copy activity Azure Table source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "azureTableSourceQuery": { + "type": "object", + "description": "Azure Table source query. Type: string (or Expression with resultType string)." + }, + "azureTableSourceIgnoreTableNotFound": { + "type": "object", + "description": "Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "BlobSource": { + "description": "A copy activity Azure Blob source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." + }, + "skipHeaderLineCount": { + "type": "object", + "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." + }, + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "DocumentDbCollectionSource": { + "description": "A copy activity Document Database Collection source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Documents query. Type: string (or Expression with resultType string)." + }, + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Type: string (or Expression with resultType string)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "CosmosDbSqlApiSource": { + "description": "A copy activity Azure CosmosDB (SQL API) Collection source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SQL API query. Type: string (or Expression with resultType string)." + }, + "pageSize": { + "type": "object", + "description": "Page size of the result. Type: integer (or Expression with resultType integer)." + }, + "preferredRegions": { + "type": "object", + "description": "Preferred regions. Type: array of strings (or Expression with resultType array of strings)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "DynamicsSource": { + "description": "A copy activity Dynamics source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "DynamicsCrmSource": { + "description": "A copy activity Dynamics CRM source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "CommonDataServiceForAppsSource": { + "description": "A copy activity Common Data Service for Apps source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "RelationalSource": { + "description": "A copy activity source for various relational databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "InformixSource": { + "description": "A copy activity source for Informix.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "MicrosoftAccessSource": { + "description": "A copy activity source for Microsoft Access.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "Db2Source": { + "description": "A copy activity source for Db2 databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "OdbcSource": { + "description": "A copy activity source for ODBC databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "MySqlSource": { + "description": "A copy activity source for MySQL databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "PostgreSqlSource": { + "description": "A copy activity source for PostgreSQL databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "SybaseSource": { + "description": "A copy activity source for Sybase databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "SapBwSource": { + "description": "A copy activity source for SapBW server via MDX.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "MDX query. Type: string (or Expression with resultType string)." + } + } + }, + "ODataSource": { + "description": "A copy activity source for OData source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "SalesforceSource": { + "description": "A copy activity Salesforce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "readBehavior": { + "description": "The read behavior for the operation. Default is Query.", + "type": "string", + "enum": [ + "Query", + "QueryAll" + ], + "x-ms-enum": { + "name": "SalesforceSourceReadBehavior", + "modelAsString": true + } + } + } + }, + "SalesforceServiceCloudSource": { + "description": "A copy activity Salesforce Service Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "readBehavior": { + "description": "The read behavior for the operation. Default is Query.", + "type": "string", + "enum": [ + "Query", + "QueryAll" + ], + "x-ms-enum": { + "name": "SalesforceSourceReadBehavior", + "modelAsString": true + } + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "SapCloudForCustomerSource": { + "description": "A copy activity source for SAP Cloud for Customer source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP Cloud for Customer OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "SapEccSource": { + "description": "A copy activity source for SAP ECC source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP ECC OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "SapHanaSource": { + "description": "A copy activity source for SAP HANA source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP HANA Sql query. Type: string (or Expression with resultType string)." + }, + "packetSize": { + "type": "object", + "description": "The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for SAP HANA read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "SapHanaDynamicRange" + ], + "x-ms-enum": { + "name": "SapHanaPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for SAP HANA source partitioning.", + "$ref": "#/definitions/SapHanaPartitionSettings" + } + } + }, + "SapHanaPartitionSettings": { + "description": "The settings that will be leveraged for SAP HANA source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "SapOpenHubSource": { + "description": "A copy activity source for SAP Business Warehouse Open Hub Destination source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "excludeLastRequest": { + "type": "object", + "description": "Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "baseRequestId": { + "type": "object", + "description": "The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer )." + } + } + }, + "SapTableSource": { + "description": "A copy activity source for SAP Table source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "rowCount": { + "type": "object", + "description": "The number of rows to be retrieved. Type: integer(or Expression with resultType integer)." + }, + "rowSkips": { + "type": "object", + "description": "The number of rows that will be skipped. Type: integer (or Expression with resultType integer)." + }, + "rfcTableFields": { + "type": "object", + "description": "The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string)." + }, + "rfcTableOptions": { + "type": "object", + "description": "The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string)." + }, + "batchSize": { + "type": "object", + "description": "Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer)." + }, + "customRfcReadTableFunctionModule": { + "type": "object", + "description": "Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for SAP table read in parallel.", + "type": "string", + "enum": [ + "None", + "PartitionOnInt", + "PartitionOnCalendarYear", + "PartitionOnCalendarMonth", + "PartitionOnCalendarDate", + "PartitionOnTime" + ], + "x-ms-enum": { + "name": "SapTablePartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for SAP table source partitioning.", + "$ref": "#/definitions/SapTablePartitionSettings" + } + } + }, + "SapTablePartitionSettings": { + "description": "The settings that will be leveraged for SAP table source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "maxPartitionsNumber": { + "type": "object", + "description": "The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string)." + } + } + }, + "RestSource": { + "description": "A copy activity Rest service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "paginationRules": { + "type": "object", + "description": "The pagination rules to compose next page requests. Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "requestInterval": { + "type": "object", + "description": "The time to await before sending next page request. " + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "SqlSource": { + "description": "A copy activity SQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "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)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "isolationLevel": { + "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlServerSource": { + "description": "A copy activity SQL server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "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)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "AzureSqlSource": { + "description": "A copy activity Azure SQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "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)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlMISource": { + "description": "A copy activity Azure SQL Managed Instance source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlDWSource": { + "description": "A copy activity SQL Data Warehouse source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL Data Warehouse reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "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)." + }, + "storedProcedureParameters": { + "type": "object", + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlPartitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "SqlPartitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "SqlPartitionOption", + "modelAsString": true + } + }, + "FileSystemSource": { + "description": "A copy activity file system source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "HdfsSource": { + "description": "A copy activity HDFS source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "distcpSettings": { + "description": "Specifies Distcp-related settings.", + "$ref": "#/definitions/DistcpSettings" + } + } + }, + "DistcpSettings": { + "description": "Distcp settings.", + "type": "object", + "properties": { + "resourceManagerEndpoint": { + "type": "object", + "description": "Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string)." + }, + "tempScriptPath": { + "type": "object", + "description": "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)." + }, + "distcpOptions": { + "type": "object", + "description": "Specifies the Distcp options. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "resourceManagerEndpoint", + "tempScriptPath" + ] + }, + "AzureMySqlSource": { + "description": "A copy activity Azure MySQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataExplorerSource": { + "description": "A copy activity Azure Data Explorer (Kusto) source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string)." + }, + "noTruncation": { + "type": "object", + "description": "The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + }, + "required": [ + "query" + ] + }, + "OracleSource": { + "description": "A copy activity Oracle source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "oracleReaderQuery": { + "type": "object", + "description": "Oracle reader query. Type: string (or Expression with resultType string)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Oracle read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "OraclePartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Oracle source partitioning.", + "$ref": "#/definitions/OraclePartitionSettings" + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "OraclePartitionSettings": { + "description": "The settings that will be leveraged for Oracle source partitioning.", + "type": "object", + "properties": { + "partitionNames": { + "type": "object", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Names of the physical partitions of Oracle table. " + }, + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "TeradataSource": { + "description": "A copy activity Teradata source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Teradata query. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for teradata read in parallel.", + "type": "string", + "enum": [ + "None", + "Hash", + "DynamicRange" + ], + "x-ms-enum": { + "name": "TeradataPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for teradata source partitioning.", + "$ref": "#/definitions/TeradataPartitionSettings" + } + } + }, + "TeradataPartitionSettings": { + "description": "The settings that will be leveraged for teradata source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "WebSource": { + "description": "A copy activity source for web page table.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "CassandraSource": { + "description": "A copy activity source for a Cassandra database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string)." + }, + "consistencyLevel": { + "description": "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.", + "type": "string", + "enum": [ + "ALL", + "EACH_QUORUM", + "QUORUM", + "LOCAL_QUORUM", + "ONE", + "TWO", + "THREE", + "LOCAL_ONE", + "SERIAL", + "LOCAL_SERIAL" + ], + "x-ms-enum": { + "name": "CassandraSourceReadConsistencyLevels", + "modelAsString": true + } + } + } + }, + "MongoDbSource": { + "description": "A copy activity source for a MongoDB database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "MongoDbV2Source": { + "description": "A copy activity source for a MongoDB database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "CosmosDbMongoDbApiSource": { + "description": "A copy activity source for a CosmosDB (MongoDB API) database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query.", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, + "MongoDbCursorMethodsProperties": { + "description": "Cursor methods for Mongodb query", + "type": "object", + "properties": { + "project": { + "type": "object", + "description": "Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string)." + }, + "sort": { + "type": "object", + "description": "Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." + }, + "skip": { + "type": "object", + "description": "Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer)." + }, + "limit": { + "type": "object", + "description": "Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "Office365Source": { + "description": "A copy activity source for an Office 365 service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "allowedGroups": { + "type": "object", + "description": "The groups containing all the users. Type: array of strings (or Expression with resultType array of strings)." + }, + "userScopeFilterUri": { + "type": "object", + "description": "The user scope uri. Type: string (or Expression with resultType string)." + }, + "dateFilterColumn": { + "type": "object", + "description": "The Column to apply the and . Type: string (or Expression with resultType string)." + }, + "startTime": { + "type": "object", + "description": "Start time of the requested range for this dataset. Type: string (or Expression with resultType string)." + }, + "endTime": { + "type": "object", + "description": "End time of the requested range for this dataset. Type: string (or Expression with resultType string)." + }, + "outputColumns": { + "type": "object", + "description": "The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). Example: [ { \"name\": \"Id\" }, { \"name\": \"CreatedDateTime\" } ]" + } + } + }, + "AzureDataLakeStoreSource": { + "description": "A copy activity Azure Data Lake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "AzureBlobFSSource": { + "description": "A copy activity Azure BlobFS source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." + }, + "skipHeaderLineCount": { + "type": "object", + "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." + }, + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "HttpSource": { + "description": "A copy activity source for an HTTP file.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "httpRequestTimeout": { + "type": "object", + "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "AmazonMWSSource": { + "description": "A copy activity Amazon Marketplace Web Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSource": { + "description": "A copy activity Azure PostgreSQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSink": { + "description": "A copy activity Azure PostgreSQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMySqlSink": { + "description": "A copy activity Azure MySql sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "ConcurSource": { + "description": "A copy activity Concur Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "CouchbaseSource": { + "description": "A copy activity Couchbase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DrillSource": { + "description": "A copy activity Drill server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "EloquaSource": { + "description": "A copy activity Eloqua server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleBigQuerySource": { + "description": "A copy activity Google BigQuery service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GreenplumSource": { + "description": "A copy activity Greenplum Database source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HBaseSource": { + "description": "A copy activity HBase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HiveSource": { + "description": "A copy activity Hive Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HubspotSource": { + "description": "A copy activity Hubspot Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ImpalaSource": { + "description": "A copy activity Impala server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "JiraSource": { + "description": "A copy activity Jira Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MagentoSource": { + "description": "A copy activity Magento server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MariaDBSource": { + "description": "A copy activity MariaDB server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMariaDBSource": { + "description": "A copy activity Azure MariaDB source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MarketoSource": { + "description": "A copy activity Marketo server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PaypalSource": { + "description": "A copy activity Paypal Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PhoenixSource": { + "description": "A copy activity Phoenix server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PrestoSource": { + "description": "A copy activity Presto server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "QuickBooksSource": { + "description": "A copy activity QuickBooks server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ServiceNowSource": { + "description": "A copy activity ServiceNow server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ShopifySource": { + "description": "A copy activity Shopify Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SparkSource": { + "description": "A copy activity Spark Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SquareSource": { + "description": "A copy activity Square Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "XeroSource": { + "description": "A copy activity Xero Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ZohoSource": { + "description": "A copy activity Zoho server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "NetezzaSource": { + "description": "A copy activity Netezza source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Netezza read in parallel.", + "type": "string", + "enum": [ + "None", + "DataSlice", + "DynamicRange" + ], + "x-ms-enum": { + "name": "NetezzaPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Netezza source partitioning.", + "$ref": "#/definitions/NetezzaPartitionSettings" + } + } + }, + "NetezzaPartitionSettings": { + "description": "The settings that will be leveraged for Netezza source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "VerticaSource": { + "description": "A copy activity Vertica source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceMarketingCloudSource": { + "description": "A copy activity Salesforce Marketing Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ResponsysSource": { + "description": "A copy activity Responsys source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsAXSource": { + "description": "A copy activity Dynamics AX source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "OracleServiceCloudSource": { + "description": "A copy activity Oracle Service Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleAdWordsSource": { + "description": "A copy activity Google AdWords service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonRedshiftSource": { + "description": "A copy activity source for Amazon Redshift Source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "redshiftUnloadSettings": { + "description": "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.", + "$ref": "#/definitions/RedshiftUnloadSettings" + } + } + }, + "RedshiftUnloadSettings": { + "description": "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.", + "type": "object", + "properties": { + "s3LinkedServiceName": { + "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "bucketName": { + "type": "object", + "description": "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)." + } + }, + "required": [ + "s3LinkedServiceName", + "bucketName" + ] + }, + "SnowflakeSource": { + "description": "A copy activity snowflake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." + }, + "exportSettings": { + "$ref": "#/definitions/SnowflakeExportCopyCommand", + "description": "Snowflake export settings." + } + } + }, + "ExportSettings": { + "description": "Export command settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The export setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SnowflakeExportCopyCommand": { + "description": "Snowflake export command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSettings" + } + ], + "properties": { + "additionalCopyOptions": { + "type": "object", + "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", + "additionalProperties": { + "type": "object" + } + }, + "additionalFormatOptions": { + "type": "object", + "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"OVERWRITE\": \"TRUE\", \"MAX_FILE_SIZE\": \"'FALSE'\" }", + "additionalProperties": { + "type": "object" + } + } + } + }, + "StoredProcedureParameter": { + "description": "SQL stored procedure parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "Stored procedure parameter value. Type: string (or Expression with resultType string)." + }, + "type": { + "description": "Stored procedure parameter type.", + "$ref": "#/definitions/StoredProcedureParameterType" + } + } + }, + "StoredProcedureParameterType": { + "description": "Stored procedure parameter type.", + "type": "string", + "enum": [ + "String", + "Int", + "Int64", + "Decimal", + "Guid", + "Boolean", + "Date" + ], + "x-ms-enum": { + "name": "StoredProcedureParameterType", + "modelAsString": true + } + }, + "CopySink": { + "discriminator": "type", + "description": "A copy activity sink.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy sink type." + }, + "writeBatchSize": { + "type": "object", + "description": "Write batch size. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "writeBatchTimeout": { + "type": "object", + "description": "Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "sinkRetryCount": { + "type": "object", + "description": "Sink retry count. Type: integer (or Expression with resultType integer)." + }, + "sinkRetryWait": { + "type": "object", + "description": "Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SapCloudForCustomerSink": { + "description": "A copy activity SAP Cloud for Customer sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is 'Insert'.", + "type": "string", + "enum": [ + "Insert", + "Update" + ], + "x-ms-enum": { + "name": "SapCloudForCustomerSinkWriteBehavior", + "modelAsString": true + } + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "AzureQueueSink": { + "description": "A copy activity Azure Queue sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": {} + }, + "CopyBehaviorType": { + "description": "All available types of copy behavior.", + "type": "string", + "enum": [ + "PreserveHierarchy", + "FlattenHierarchy", + "MergeFiles" + ], + "x-ms-enum": { + "name": "CopyBehaviorType", + "modelAsString": true + } + }, + "AzureTableSink": { + "description": "A copy activity Azure Table sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "azureTableDefaultPartitionKeyValue": { + "type": "object", + "description": "Azure Table default partition key value. Type: string (or Expression with resultType string)." + }, + "azureTablePartitionKeyName": { + "type": "object", + "description": "Azure Table partition key name. Type: string (or Expression with resultType string)." + }, + "azureTableRowKeyName": { + "type": "object", + "description": "Azure Table row key name. Type: string (or Expression with resultType string)." + }, + "azureTableInsertType": { + "type": "object", + "description": "Azure Table insert type. Type: string (or Expression with resultType string)." + } + } + }, + "AvroSink": { + "description": "A copy activity Avro sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Avro store settings." + }, + "formatSettings": { + "$ref": "#/definitions/AvroWriteSettings", + "description": "Avro format settings." + } + } + }, + "ParquetSink": { + "description": "A copy activity Parquet sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Parquet store settings." + } + } + }, + "BinarySink": { + "description": "A copy activity Binary sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Binary store settings." + } + } + }, + "BlobSink": { + "description": "A copy activity Azure Blob sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "blobWriterOverwriteFiles": { + "type": "object", + "description": "Blob writer overwrite files. Type: boolean (or Expression with resultType boolean)." + }, + "blobWriterDateTimeFormat": { + "type": "object", + "description": "Blob writer date time format. Type: string (or Expression with resultType string)." + }, + "blobWriterAddHeader": { + "type": "object", + "description": "Blob writer add header. Type: boolean (or Expression with resultType boolean)." + }, + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "FileSystemSink": { + "description": "A copy activity file system sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "DocumentDbCollectionSink": { + "description": "A copy activity Document Database Collection sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string)." + }, + "writeBehavior": { + "type": "object", + "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." + } + } + }, + "CosmosDbSqlApiSink": { + "description": "A copy activity Azure CosmosDB (SQL API) Collection sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "type": "object", + "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." + } + } + }, + "SqlSink": { + "description": "A copy activity SQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlServerSink": { + "description": "A copy activity SQL server sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlSink": { + "description": "A copy activity Azure SQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlMISink": { + "description": "A copy activity Azure SQL Managed Instance sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlDWSink": { + "description": "A copy activity SQL Data Warehouse sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "allowPolyBase": { + "type": "object", + "description": "Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean)." + }, + "polyBaseSettings": { + "description": "Specifies PolyBase-related settings when allowPolyBase is true.", + "$ref": "#/definitions/PolybaseSettings" + }, + "allowCopyCommand": { + "type": "object", + "description": "Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean)." + }, + "copyCommandSettings": { + "description": "Specifies Copy Command related settings when allowCopyCommand is true.", + "$ref": "#/definitions/DWCopyCommandSettings" + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "PolybaseSettings": { + "description": "PolyBase settings.", + "type": "object", + "properties": { + "rejectType": { + "$ref": "#/definitions/PolybaseSettingsRejectType", + "description": "Reject type." + }, + "rejectValue": { + "type": "object", + "description": "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." + }, + "rejectSampleValue": { + "type": "object", + "description": "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." + }, + "useTypeDefault": { + "type": "object", + "description": "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)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "PolybaseSettingsRejectType": { + "description": "Indicates whether the RejectValue property is specified as a literal value or a percentage.", + "type": "string", + "enum": [ + "value", + "percentage" + ], + "x-ms-enum": { + "name": "PolybaseSettingsRejectType", + "modelAsString": true + } + }, + "DWCopyCommandSettings": { + "description": "DW Copy Command settings.", + "type": "object", + "properties": { + "defaultValues": { + "type": "array", + "description": "Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/DWCopyCommandDefaultValue" + } + }, + "additionalOptions": { + "type": "object", + "description": "Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalOptions\": { \"MAXERRORS\": \"1000\", \"DATEFORMAT\": \"'ymd'\" }", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DWCopyCommandDefaultValue": { + "description": "Default value.", + "type": "object", + "properties": { + "columnName": { + "type": "object", + "description": "Column name. Type: object (or Expression with resultType string)." + }, + "defaultValue": { + "type": "object", + "description": "The default value of the column. Type: object (or Expression with resultType string)." + } + } + }, + "SnowflakeSink": { + "description": "A copy activity snowflake sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "importSettings": { + "$ref": "#/definitions/SnowflakeImportCopyCommand", + "description": "Snowflake import settings." + } + } + }, + "ImportSettings": { + "description": "Import command settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The import setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SnowflakeImportCopyCommand": { + "description": "Snowflake import command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImportSettings" + } + ], + "properties": { + "additionalCopyOptions": { + "type": "object", + "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", + "additionalProperties": { + "type": "object" + } + }, + "additionalFormatOptions": { + "type": "object", + "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"FORCE\": \"TRUE\", \"LOAD_UNCERTAIN_FILES\": \"'FALSE'\" }", + "additionalProperties": { + "type": "object" + } + } + } + }, + "LogStorageSettings": { + "description": "Log storage settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Log storage linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "StagingSettings": { + "description": "Staging settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Staging linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing the interim data. Type: string (or Expression with resultType string)." + }, + "enableCompression": { + "type": "object", + "description": "Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "RedirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings", + "type": "object", + "properties": { + "linkedServiceName": { + "type": "object", + "description": "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": { + "type": "object", + "description": "The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "SkipErrorFile": { + "description": "Skip error file.", + "type": "object", + "properties": { + "fileMissing": { + "type": "object", + "description": "Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "dataInconsistency": { + "type": "object", + "description": "Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "AdditionalColumns": { + "description": "Specify the column name and value of additional columns.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Additional column name. Type: string (or Expression with resultType string)." + }, + "value": { + "type": "object", + "description": "Additional column value. Type: string (or Expression with resultType string)." + } + } + }, + "OracleSink": { + "description": "A copy activity Oracle sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreSink": { + "description": "A copy activity Azure Data Lake Store sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + }, + "enableAdlsSingleFileParallel": { + "description": "Single File Parallel.", + "type": "object" + } + } + }, + "AzureBlobFSSink": { + "description": "A copy activity Azure Data Lake Storage Gen2 sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "AzureSearchIndexSink": { + "description": "A copy activity Azure Search Index sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "Specify the write behavior when upserting documents into Azure Search Index.", + "type": "string", + "enum": [ + "Merge", + "Upload" + ], + "x-ms-enum": { + "name": "AzureSearchIndexWriteBehaviorType", + "modelAsString": true + } + } + } + }, + "OdbcSink": { + "description": "A copy activity ODBC sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "InformixSink": { + "description": "A copy activity Informix sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "MicrosoftAccessSink": { + "description": "A copy activity Microsoft Access sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsSink": { + "description": "A copy activity Dynamics sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, + "ignoreNullValues": { + "type": "object", + "description": "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)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "DynamicsCrmSink": { + "description": "A copy activity Dynamics CRM sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "CommonDataServiceForAppsSink": { + "description": "A copy activity Common Data Service for Apps sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "AzureDataExplorerSink": { + "description": "A copy activity Azure Data Explorer sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "ingestionMappingName": { + "type": "object", + "description": "A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string." + }, + "ingestionMappingAsJson": { + "type": "object", + "description": "An explicit column mapping description provided in a json format. Type: string." + }, + "flushImmediately": { + "type": "object", + "description": "If set to true, any aggregation will be skipped. Default is false. Type: boolean." + } + } + }, + "SalesforceSink": { + "description": "A copy activity Salesforce sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is Insert.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SalesforceSinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." + }, + "ignoreNullValues": { + "type": "object", + "description": "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)." + } + } + }, + "SalesforceServiceCloudSink": { + "description": "A copy activity Salesforce Service Cloud sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is Insert.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SalesforceSinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." + }, + "ignoreNullValues": { + "type": "object", + "description": "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)." + } + } + }, + "CosmosDbMongoDbApiSink": { + "description": "A copy activity sink for a CosmosDB (MongoDB API) database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "type": "object", + "description": "Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is \"insert\". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." + } + } + }, + "CopyTranslator": { + "discriminator": "type", + "description": "A copy activity translator.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy translator type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TabularTranslator": { + "description": "A copy activity tabular translator.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyTranslator" + } + ], + "properties": { + "columnMappings": { + "type": "object", + "description": "Column mappings. Example: \"UserId: MyUserId, Group: MyGroup, Name: MyName\" Type: string (or Expression with resultType string). This property will be retired. Please use mappings property." + }, + "schemaMapping": { + "type": "object", + "description": "The schema mapping to map between tabular data and hierarchical data. Example: {\"Column1\": \"$.Column1\", \"Column2\": \"$.Column2.Property1\", \"Column3\": \"$.Column2.Property2\"}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property." + }, + "collectionReference": { + "type": "object", + "description": "The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object)." + }, + "mapComplexValuesToString": { + "type": "object", + "description": "Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean)." + }, + "mappings": { + "type": "object", + "description": "Column mappings with logical types. Tabular->tabular example: [{\"source\":{\"name\":\"CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"name\":\"CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Hierarchical->tabular example: [{\"source\":{\"path\":\"$.CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"path\":\"$.CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Type: object (or Expression with resultType object)." + } + } + }, + "HDInsightHiveActivity": { + "description": "HDInsight Hive activity type.", + "x-ms-discriminator-value": "HDInsightHive", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Hive activity properties.", + "$ref": "#/definitions/HDInsightHiveActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightHiveActivityTypeProperties": { + "description": "HDInsight Hive activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Hive job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "variables": { + "description": "User specified arguments under hivevar namespace.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "queryTimeout": { + "type": "integer", + "description": "Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)" + } + } + }, + "HDInsightActivityDebugInfoOption": { + "description": "The HDInsightActivityDebugInfoOption settings to use.", + "type": "string", + "enum": [ + "None", + "Always", + "Failure" + ], + "x-ms-enum": { + "name": "HDInsightActivityDebugInfoOption", + "modelAsString": true + } + }, + "HDInsightPigActivity": { + "description": "HDInsight Pig activity type.", + "x-ms-discriminator-value": "HDInsightPig", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Pig activity properties.", + "$ref": "#/definitions/HDInsightPigActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightPigActivityTypeProperties": { + "description": "HDInsight Pig activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "type": "object", + "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Pig job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + } + }, + "HDInsightMapReduceActivity": { + "description": "HDInsight MapReduce activity type.", + "x-ms-discriminator-value": "HDInsightMapReduce", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight MapReduce activity properties.", + "$ref": "#/definitions/HDInsightMapReduceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightMapReduceActivityTypeProperties": { + "description": "HDInsight MapReduce activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "className": { + "type": "object", + "description": "Class name. Type: string (or Expression with resultType string)." + }, + "jarFilePath": { + "type": "object", + "description": "Jar path. Type: string (or Expression with resultType string)." + }, + "jarLinkedService": { + "description": "Jar linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "jarLibs": { + "description": "Jar libs.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for the MapReduce job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "className", + "jarFilePath" + ] + }, + "HDInsightStreamingActivity": { + "description": "HDInsight streaming activity type.", + "x-ms-discriminator-value": "HDInsightStreaming", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight streaming activity properties.", + "$ref": "#/definitions/HDInsightStreamingActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightStreamingActivityTypeProperties": { + "description": "HDInsight streaming activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "mapper": { + "type": "object", + "description": "Mapper executable name. Type: string (or Expression with resultType string)." + }, + "reducer": { + "type": "object", + "description": "Reducer executable name. Type: string (or Expression with resultType string)." + }, + "input": { + "type": "object", + "description": "Input blob path. Type: string (or Expression with resultType string)." + }, + "output": { + "type": "object", + "description": "Output blob path. Type: string (or Expression with resultType string)." + }, + "filePaths": { + "description": "Paths to streaming job files. Can be directories.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "fileLinkedService": { + "description": "Linked service reference where the files are located.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "combiner": { + "type": "object", + "description": "Combiner executable name. Type: string (or Expression with resultType string)." + }, + "commandEnvironment": { + "description": "Command line environment values.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for streaming job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "mapper", + "reducer", + "input", + "output", + "filePaths" + ] + }, + "HDInsightSparkActivity": { + "description": "HDInsight Spark activity.", + "x-ms-discriminator-value": "HDInsightSpark", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight spark activity properties.", + "$ref": "#/definitions/HDInsightSparkActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightSparkActivityTypeProperties": { + "description": "HDInsight spark activity properties.", + "properties": { + "rootPath": { + "type": "object", + "description": "The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string)." + }, + "entryFilePath": { + "type": "object", + "description": "The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string)." + }, + "arguments": { + "description": "The user-specified arguments to HDInsightSparkActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "sparkJobLinkedService": { + "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "className": { + "description": "The application's Java/Spark main class.", + "type": "string" + }, + "proxyUser": { + "type": "object", + "description": "The user to impersonate that will execute the job. Type: string (or Expression with resultType string)." + }, + "sparkConfig": { + "description": "Spark configuration property.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "rootPath", + "entryFilePath" + ] + }, + "ExecuteSSISPackageActivity": { + "description": "Execute SSIS package activity.", + "x-ms-discriminator-value": "ExecuteSSISPackage", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute SSIS package activity properties.", + "$ref": "#/definitions/ExecuteSSISPackageActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecuteSSISPackageActivityTypeProperties": { + "description": "Execute SSIS package activity properties.", + "properties": { + "packageLocation": { + "description": "SSIS package location.", + "$ref": "#/definitions/SSISPackageLocation" + }, + "runtime": { + "description": "Specifies the runtime to execute SSIS package. The value should be \"x86\" or \"x64\". Type: string (or Expression with resultType string).", + "type": "object" + }, + "loggingLevel": { + "description": "The logging level of SSIS package execution. Type: string (or Expression with resultType string).", + "type": "object" + }, + "environmentPath": { + "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string).", + "type": "object" + }, + "executionCredential": { + "description": "The package execution credential.", + "$ref": "#/definitions/SSISExecutionCredential" + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + }, + "projectParameters": { + "description": "The project level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "packageParameters": { + "description": "The package level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "projectConnectionManagers": { + "description": "The project level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "packageConnectionManagers": { + "description": "The package level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "propertyOverrides": { + "description": "The property overrides to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISPropertyOverride" + } + }, + "logLocation": { + "description": "SSIS package execution log location.", + "$ref": "#/definitions/SSISLogLocation" + } + }, + "required": [ + "packageLocation", + "connectVia" + ] + }, + "SSISPackageLocation": { + "description": "SSIS package location.", + "type": "object", + "properties": { + "packagePath": { + "description": "The SSIS package path. Type: string (or Expression with resultType string).", + "type": "object" + }, + "type": { + "description": "The type of SSIS package location.", + "type": "string", + "enum": [ + "SSISDB", + "File", + "InlinePackage", + "PackageStore" + ], + "x-ms-enum": { + "name": "SsisPackageLocationType", + "modelAsString": true + } + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SSIS package location properties.", + "$ref": "#/definitions/SSISPackageLocationTypeProperties" + } + } + }, + "SSISPackageLocationTypeProperties": { + "description": "SSIS package location properties.", + "type": "object", + "properties": { + "packagePassword": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "Password of the package." + }, + "accessCredential": { + "description": "The package access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "configurationPath": { + "description": "The configuration file of the package execution. Type: string (or Expression with resultType string).", + "type": "object" + }, + "configurationAccessCredential": { + "description": "The configuration file access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "packageName": { + "description": "The package name.", + "type": "string" + }, + "packageContent": { + "description": "The embedded package content. Type: string (or Expression with resultType string).", + "type": "object" + }, + "packageLastModifiedDate": { + "description": "The embedded package last modified date.", + "type": "string" + }, + "childPackages": { + "description": "The embedded child package list.", + "type": "array", + "items": { + "$ref": "#/definitions/SSISChildPackage" + } + } + } + }, + "SSISConnectionManager": { + "description": "SSIS Connection Manager.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "SSISExecutionParameter": { + "description": "SSIS execution parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package execution parameter value. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "value" + ] + }, + "SSISPropertyOverride": { + "description": "SSIS property override.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package property override value. Type: string (or Expression with resultType string)." + }, + "isSensitive": { + "type": "boolean", + "description": "Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true" + } + }, + "required": [ + "value" + ] + }, + "SSISExecutionCredential": { + "description": "SSIS package execution credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../datafactory.json#/definitions/SecureString", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, + "SSISAccessCredential": { + "description": "SSIS access credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, + "SSISChildPackage": { + "description": "SSIS embedded child package.", + "type": "object", + "properties": { + "packagePath": { + "type": "object", + "description": "Path for embedded child package. Type: string (or Expression with resultType string)." + }, + "packageName": { + "type": "string", + "description": "Name for embedded child package." + }, + "packageContent": { + "type": "object", + "description": "Content for embedded child package. Type: string (or Expression with resultType string)." + }, + "packageLastModifiedDate": { + "type": "string", + "description": "Last modified date for embedded child package." + } + }, + "required": [ + "packagePath", + "packageContent" + ] + }, + "SSISLogLocation": { + "description": "SSIS package execution log location", + "type": "object", + "properties": { + "logPath": { + "description": "The SSIS package execution log path. Type: string (or Expression with resultType string).", + "type": "object" + }, + "type": { + "description": "The type of SSIS log location.", + "type": "string", + "enum": [ + "File" + ], + "x-ms-enum": { + "name": "SsisLogLocationType", + "modelAsString": true + } + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SSIS package execution log location properties.", + "$ref": "#/definitions/SSISLogLocationTypeProperties" + } + }, + "required": [ + "logPath", + "type", + "typeProperties" + ] + }, + "SSISLogLocationTypeProperties": { + "description": "SSIS package execution log location properties.", + "type": "object", + "properties": { + "accessCredential": { + "description": "The package execution log access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "logRefreshInterval": { + "type": "object", + "description": "Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "CustomActivity": { + "description": "Custom activity type.", + "x-ms-discriminator-value": "Custom", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Custom activity properties.", + "$ref": "#/definitions/CustomActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CustomActivityTypeProperties": { + "description": "Custom activity properties.", + "properties": { + "command": { + "type": "object", + "description": "Command for custom activity Type: string (or Expression with resultType string)." + }, + "resourceLinkedService": { + "description": "Resource linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "folderPath": { + "type": "object", + "description": "Folder path for resource files Type: string (or Expression with resultType string)." + }, + "referenceObjects": { + "description": "Reference objects", + "$ref": "#/definitions/CustomActivityReferenceObject" + }, + "extendedProperties": { + "description": "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.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "retentionTimeInDays": { + "type": "object", + "description": "The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double)." + } + }, + "required": [ + "command" + ] + }, + "CustomActivityReferenceObject": { + "description": "Reference objects for custom activity", + "properties": { + "linkedServices": { + "description": "Linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "datasets": { + "description": "Dataset references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + } + } + }, + "SqlServerStoredProcedureActivity": { + "description": "SQL stored procedure activity type.", + "x-ms-discriminator-value": "SqlServerStoredProcedure", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SQL stored procedure activity properties.", + "$ref": "#/definitions/SqlServerStoredProcedureActivityTypeProperties" + } + }, + "required": [ + "typeProperties", + "linkedServiceName" + ] + }, + "SqlServerStoredProcedureActivityTypeProperties": { + "description": "SQL stored procedure activity properties.", + "properties": { + "storedProcedureName": { + "type": "object", + "description": "Stored procedure name. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + }, + "required": [ + "storedProcedureName" + ] + }, + "ExecutePipelineActivity": { + "x-ms-discriminator-value": "ExecutePipeline", + "description": "Execute pipeline activity.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Execute pipeline activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExecutePipelineActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecutePipelineActivityTypeProperties": { + "description": "Execute pipeline activity properties.", + "properties": { + "pipeline": { + "description": "Pipeline reference.", + "$ref": "../datafactory.json#/definitions/PipelineReference" + }, + "parameters": { + "description": "Pipeline parameters.", + "$ref": "../datafactory.json#/definitions/ParameterValueSpecification" + }, + "waitOnCompletion": { + "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.", + "type": "boolean" + } + }, + "required": [ + "pipeline" + ] + }, + "DeleteActivity": { + "x-ms-discriminator-value": "Delete", + "description": "Delete activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Delete activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeleteActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DeleteActivityTypeProperties": { + "description": "Delete activity properties.", + "properties": { + "recursive": { + "type": "object", + "description": "If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "maxConcurrentConnections": { + "type": "integer", + "minimum": 1, + "description": "The max concurrent connections to connect data source at the same time." + }, + "enableLogging": { + "type": "object", + "description": "Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "logStorageSettings": { + "description": "Log storage settings customer need to provide when enableLogging is true.", + "$ref": "#/definitions/LogStorageSettings" + }, + "dataset": { + "description": "Delete activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "required": [ + "dataset" + ] + }, + "AzureDataExplorerCommandActivity": { + "x-ms-discriminator-value": "AzureDataExplorerCommand", + "description": "Azure Data Explorer command activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Explorer command activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataExplorerCommandActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataExplorerCommandActivityTypeProperties": { + "description": "Azure Data Explorer command activity properties.", + "properties": { + "command": { + "type": "object", + "description": "A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string)." + }, + "commandTimeout": { + "type": "object", + "description": "Control command timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))..)" + } + }, + "required": [ + "command" + ] + }, + "LookupActivity": { + "x-ms-discriminator-value": "Lookup", + "description": "Lookup activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Lookup activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LookupActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "LookupActivityTypeProperties": { + "description": "Lookup activity properties.", + "properties": { + "source": { + "description": "Dataset-specific source properties, same as copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "dataset": { + "description": "Lookup activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + }, + "firstRowOnly": { + "type": "object", + "description": "Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "source", + "dataset" + ] + }, + "WebActivityMethod": { + "description": "The list of HTTP methods supported by a WebActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE" + ], + "x-ms-enum": { + "name": "WebActivityMethod", + "modelAsString": true + } + }, + "WebActivity": { + "x-ms-discriminator-value": "WebActivity", + "description": "Web activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Web activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebActivityAuthentication": { + "description": "Web activity authentication properties.", + "properties": { + "type": { + "description": "Web activity authentication (Basic/ClientCertificate/MSI)", + "type": "string" + }, + "pfx": { + "description": "Base64-encoded contents of a PFX file.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "username": { + "description": "Web activity authentication user name for basic authentication.", + "type": "string" + }, + "password": { + "description": "Password for the PFX file or basic authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "resource": { + "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "WebActivityTypeProperties": { + "description": "Web activity type properties.", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebActivityMethod" + }, + "url": { + "type": "object", + "description": "Web activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "headers": { + "type": "object", + "description": "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": { + "type": "object", + "description": "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": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebActivityAuthentication" + }, + "datasets": { + "type": "array", + "description": "List of datasets passed to web endpoint.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "linkedServices": { + "type": "array", + "description": "List of linked services passed to web endpoint.", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + } + }, + "required": [ + "method", + "url" + ] + }, + "GetMetadataActivity": { + "x-ms-discriminator-value": "GetMetadata", + "description": "Activity to get metadata of dataset", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "GetMetadata activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GetMetadataActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GetMetadataActivityTypeProperties": { + "description": "GetMetadata activity properties.", + "properties": { + "dataset": { + "description": "GetMetadata activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + }, + "fieldList": { + "description": "Fields of metadata to get from dataset.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "dataset" + ] + }, + "IfConditionActivity": { + "x-ms-discriminator-value": "IfCondition", + "description": "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.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "IfCondition activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/IfConditionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "IfConditionActivityTypeProperties": { + "description": "IfCondition activity properties.", + "properties": { + "expression": { + "description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "ifTrueActivities": { + "type": "array", + "description": "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.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "ifFalseActivities": { + "type": "array", + "description": "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.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression" + ] + }, + "SwitchActivity": { + "x-ms-discriminator-value": "Switch", + "description": "This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Switch activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SwitchActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SwitchActivityTypeProperties": { + "description": "Switch activity properties.", + "properties": { + "on": { + "description": "An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "cases": { + "type": "array", + "description": "List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.", + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SwitchCase" + } + }, + "defaultActivities": { + "type": "array", + "description": "List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "on" + ] + }, + "SwitchCase": { + "description": "Switch cases with have a value and corresponding activities.", + "properties": { + "value": { + "description": "Expected value that satisfies the expression result of the 'on' property.", + "type": "string" + }, + "activities": { + "type": "array", + "description": "List of activities to execute for satisfied case condition.", + "items": { + "$ref": "#/definitions/Activity" + } + } + } + }, + "ForEachActivity": { + "x-ms-discriminator-value": "ForEach", + "description": "This activity is used for iterating over a collection and execute given activities.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "ForEach activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ForEachActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ForEachActivityTypeProperties": { + "description": "ForEach activity properties.", + "properties": { + "isSequential": { + "description": "Should the loop be executed in sequence or in parallel (max 50)", + "type": "boolean" + }, + "batchCount": { + "description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).", + "type": "integer", + "maximum": 50 + }, + "items": { + "description": "Collection to iterate.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "activities": { + "type": "array", + "description": "List of activities to execute .", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "items", + "activities" + ] + }, + "AzureMLBatchExecutionActivity": { + "description": "Azure ML Batch Execution activity.", + "x-ms-discriminator-value": "AzureMLBatchExecution", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Batch Execution activity properties.", + "$ref": "#/definitions/AzureMLBatchExecutionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLBatchExecutionActivityTypeProperties": { + "description": "Azure ML Batch Execution activity properties.", + "properties": { + "globalParameters": { + "description": "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.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "webServiceOutputs": { + "description": "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.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + }, + "webServiceInputs": { + "description": "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.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + } + } + }, + "AzureMLWebServiceFile": { + "description": "Azure ML WebService Input/Output file", + "type": "object", + "properties": { + "filePath": { + "type": "object", + "description": "The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "required": [ + "linkedServiceName", + "filePath" + ] + }, + "AzureMLUpdateResourceActivity": { + "description": "Azure ML Update Resource management activity.", + "x-ms-discriminator-value": "AzureMLUpdateResource", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Update Resource management activity properties.", + "$ref": "#/definitions/AzureMLUpdateResourceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLUpdateResourceActivityTypeProperties": { + "description": "Azure ML Update Resource activity properties.", + "properties": { + "trainedModelName": { + "type": "object", + "description": "Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string)." + }, + "trainedModelLinkedServiceName": { + "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "trainedModelFilePath": { + "type": "object", + "description": "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)." + } + }, + "required": [ + "trainedModelName", + "trainedModelLinkedServiceName", + "trainedModelFilePath" + ] + }, + "AzureMLExecutePipelineActivity": { + "description": "Azure ML Execute Pipeline activity.", + "x-ms-discriminator-value": "AzureMLExecutePipeline", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Execute Pipeline activity properties.", + "$ref": "#/definitions/AzureMLExecutePipelineActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLExecutePipelineActivityTypeProperties": { + "description": "Azure ML Execute Pipeline activity properties.", + "properties": { + "mlPipelineId": { + "description": "ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).", + "type": "object" + }, + "experimentName": { + "description": "Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).", + "type": "object" + }, + "mlPipelineParameters": { + "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).", + "type": "object" + }, + "mlParentRunId": { + "description": "The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).", + "type": "object" + }, + "continueOnStepFailure": { + "description": "Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + }, + "required": [ + "mlPipelineId" + ] + }, + "AzureMLPipelineParameters": { + "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "DataLakeAnalyticsUSQLActivity": { + "description": "Data Lake Analytics U-SQL activity.", + "x-ms-discriminator-value": "DataLakeAnalyticsU-SQL", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Data Lake Analytics U-SQL activity properties.", + "$ref": "#/definitions/DataLakeAnalyticsUSQLActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DataLakeAnalyticsUSQLActivityTypeProperties": { + "description": "DataLakeAnalyticsU-SQL activity properties.", + "properties": { + "scriptPath": { + "type": "object", + "description": "Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "degreeOfParallelism": { + "type": "object", + "description": "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": { + "type": "object", + "description": "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": { + "description": "Parameters for U-SQL job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "runtimeVersion": { + "type": "object", + "description": "Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string)." + }, + "compilationMode": { + "type": "object", + "description": "Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "scriptPath", + "scriptLinkedService" + ] + }, + "WaitActivity": { + "x-ms-discriminator-value": "Wait", + "description": "This activity suspends pipeline execution for the specified interval.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Wait activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WaitActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WaitActivityTypeProperties": { + "description": "Wait activity properties.", + "properties": { + "waitTimeInSeconds": { + "description": "Duration in seconds.", + "type": "integer" + } + }, + "required": [ + "waitTimeInSeconds" + ] + }, + "UntilActivity": { + "x-ms-discriminator-value": "Until", + "description": "This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Until activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UntilActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "UntilActivityTypeProperties": { + "description": "Until activity properties.", + "properties": { + "expression": { + "description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "timeout": { + "type": "object", + "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "activities": { + "type": "array", + "description": "List of activities to execute.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression", + "activities" + ] + }, + "ValidationActivity": { + "x-ms-discriminator-value": "Validation", + "description": "This activity verifies that an external resource exists.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Validation activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ValidationActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ValidationActivityTypeProperties": { + "description": "Validation activity properties.", + "properties": { + "timeout": { + "type": "object", + "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "sleep": { + "type": "object", + "description": "A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer)." + }, + "minimumSize": { + "type": "object", + "description": "Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer)." + }, + "childItems": { + "type": "object", + "description": "Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean)." + }, + "dataset": { + "description": "Validation activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "required": [ + "dataset" + ] + }, + "FilterActivity": { + "x-ms-discriminator-value": "Filter", + "description": "Filter and return results from input array based on the conditions.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Filter activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FilterActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FilterActivityTypeProperties": { + "description": "Filter activity properties.", + "properties": { + "items": { + "description": "Input array on which filter should be applied.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "condition": { + "description": "Condition to be used for filtering the input.", + "$ref": "../datafactory.json#/definitions/Expression" + } + }, + "required": [ + "condition", + "items" + ] + }, + "DatabricksNotebookActivity": { + "description": "DatabricksNotebook activity.", + "x-ms-discriminator-value": "DatabricksNotebook", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks Notebook activity properties.", + "$ref": "#/definitions/DatabricksNotebookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksNotebookActivityTypeProperties": { + "description": "Databricks Notebook activity properties.", + "properties": { + "notebookPath": { + "type": "object", + "description": "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)." + }, + "baseParameters": { + "description": "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.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "TabularTranslator": { - "description": "A copy activity tabular translator.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopyTranslator" - } - ], - "properties": { - "columnMappings": { - "type": "object", - "description": "Column mappings. Example: \"UserId: MyUserId, Group: MyGroup, Name: MyName\" Type: string (or Expression with resultType string). This property will be retired. Please use mappings property." - }, - "schemaMapping": { - "type": "object", - "description": "The schema mapping to map between tabular data and hierarchical data. Example: {\"Column1\": \"$.Column1\", \"Column2\": \"$.Column2.Property1\", \"Column3\": \"$.Column2.Property2\"}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property." - }, - "collectionReference": { - "type": "object", - "description": "The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object)." - }, - "mapComplexValuesToString": { - "type": "object", - "description": "Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean)." - }, - "mappings": { - "type": "object", - "description": "Column mappings with logical types. Tabular->tabular example: [{\"source\":{\"name\":\"CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"name\":\"CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Hierarchical->tabular example: [{\"source\":{\"path\":\"$.CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"path\":\"$.CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Type: object (or Expression with resultType object)." - } - } - }, - "HDInsightHiveActivity": { - "description": "HDInsight Hive activity type.", - "x-ms-discriminator-value": "HDInsightHive", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight Hive activity properties.", - "$ref": "#/definitions/HDInsightHiveActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightHiveActivityTypeProperties": { - "description": "HDInsight Hive activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "description": "User specified arguments to HDInsightActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "scriptPath": { - "type": "object", - "description": "Script path. Type: string (or Expression with resultType string)." - }, - "scriptLinkedService": { - "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "defines": { - "description": "Allows user to specify defines for Hive job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "variables": { - "description": "User specified arguments under hivevar namespace.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "queryTimeout": { - "type": "integer", - "description": "Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)" - } - } - }, - "HDInsightActivityDebugInfoOption": { - "description": "The HDInsightActivityDebugInfoOption settings to use.", - "type": "string", - "enum": [ - "None", - "Always", - "Failure" - ], - "x-ms-enum": { - "name": "HDInsightActivityDebugInfoOption", - "modelAsString": true - } - }, - "HDInsightPigActivity": { - "description": "HDInsight Pig activity type.", - "x-ms-discriminator-value": "HDInsightPig", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight Pig activity properties.", - "$ref": "#/definitions/HDInsightPigActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightPigActivityTypeProperties": { - "description": "HDInsight Pig activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "type": "object", - "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "scriptPath": { - "type": "object", - "description": "Script path. Type: string (or Expression with resultType string)." - }, - "scriptLinkedService": { - "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "defines": { - "description": "Allows user to specify defines for Pig job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - } - }, - "HDInsightMapReduceActivity": { - "description": "HDInsight MapReduce activity type.", - "x-ms-discriminator-value": "HDInsightMapReduce", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight MapReduce activity properties.", - "$ref": "#/definitions/HDInsightMapReduceActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightMapReduceActivityTypeProperties": { - "description": "HDInsight MapReduce activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "description": "User specified arguments to HDInsightActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "className": { - "type": "object", - "description": "Class name. Type: string (or Expression with resultType string)." - }, - "jarFilePath": { - "type": "object", - "description": "Jar path. Type: string (or Expression with resultType string)." - }, - "jarLinkedService": { - "description": "Jar linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "jarLibs": { - "description": "Jar libs.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "defines": { - "description": "Allows user to specify defines for the MapReduce job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "className", - "jarFilePath" - ] - }, - "HDInsightStreamingActivity": { - "description": "HDInsight streaming activity type.", - "x-ms-discriminator-value": "HDInsightStreaming", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight streaming activity properties.", - "$ref": "#/definitions/HDInsightStreamingActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightStreamingActivityTypeProperties": { - "description": "HDInsight streaming activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "description": "User specified arguments to HDInsightActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "mapper": { - "type": "object", - "description": "Mapper executable name. Type: string (or Expression with resultType string)." - }, - "reducer": { - "type": "object", - "description": "Reducer executable name. Type: string (or Expression with resultType string)." - }, - "input": { - "type": "object", - "description": "Input blob path. Type: string (or Expression with resultType string)." - }, - "output": { - "type": "object", - "description": "Output blob path. Type: string (or Expression with resultType string)." - }, - "filePaths": { - "description": "Paths to streaming job files. Can be directories.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "fileLinkedService": { - "description": "Linked service reference where the files are located.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "combiner": { - "type": "object", - "description": "Combiner executable name. Type: string (or Expression with resultType string)." - }, - "commandEnvironment": { - "description": "Command line environment values.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "defines": { - "description": "Allows user to specify defines for streaming job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "mapper", - "reducer", - "input", - "output", - "filePaths" - ] - }, - "HDInsightSparkActivity": { - "description": "HDInsight Spark activity.", - "x-ms-discriminator-value": "HDInsightSpark", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight spark activity properties.", - "$ref": "#/definitions/HDInsightSparkActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightSparkActivityTypeProperties": { - "description": "HDInsight spark activity properties.", - "properties": { - "rootPath": { - "type": "object", - "description": "The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string)." - }, - "entryFilePath": { - "type": "object", - "description": "The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string)." - }, - "arguments": { - "description": "The user-specified arguments to HDInsightSparkActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "sparkJobLinkedService": { - "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "className": { - "description": "The application's Java/Spark main class.", - "type": "string" - }, - "proxyUser": { - "type": "object", - "description": "The user to impersonate that will execute the job. Type: string (or Expression with resultType string)." - }, - "sparkConfig": { - "description": "Spark configuration property.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "rootPath", - "entryFilePath" - ] - }, - "ExecuteSSISPackageActivity": { - "description": "Execute SSIS package activity.", - "x-ms-discriminator-value": "ExecuteSSISPackage", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Execute SSIS package activity properties.", - "$ref": "#/definitions/ExecuteSSISPackageActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ExecuteSSISPackageActivityTypeProperties": { - "description": "Execute SSIS package activity properties.", - "properties": { - "packageLocation": { - "description": "SSIS package location.", - "$ref": "#/definitions/SSISPackageLocation" - }, - "runtime": { - "description": "Specifies the runtime to execute SSIS package. The value should be \"x86\" or \"x64\". Type: string (or Expression with resultType string).", - "type": "object" - }, - "loggingLevel": { - "description": "The logging level of SSIS package execution. Type: string (or Expression with resultType string).", - "type": "object" - }, - "environmentPath": { - "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string).", - "type": "object" - }, - "executionCredential": { - "description": "The package execution credential.", - "$ref": "#/definitions/SSISExecutionCredential" - }, - "connectVia": { - "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" - }, - "projectParameters": { - "description": "The project level parameters to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISExecutionParameter" - } - }, - "packageParameters": { - "description": "The package level parameters to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISExecutionParameter" - } - }, - "projectConnectionManagers": { - "description": "The project level connection managers to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISConnectionManager" - } - }, - "packageConnectionManagers": { - "description": "The package level connection managers to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISConnectionManager" - } - }, - "propertyOverrides": { - "description": "The property overrides to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISPropertyOverride" - } - }, - "logLocation": { - "description": "SSIS package execution log location.", - "$ref": "#/definitions/SSISLogLocation" - } - }, - "required": [ - "packageLocation", - "connectVia" - ] - }, - "SSISPackageLocation": { - "description": "SSIS package location.", - "type": "object", - "properties": { - "packagePath": { - "description": "The SSIS package path. Type: string (or Expression with resultType string).", - "type": "object" - }, - "type": { - "description": "The type of SSIS package location.", - "type": "string", - "enum": [ - "SSISDB", - "File", - "InlinePackage", - "PackageStore" - ], - "x-ms-enum": { - "name": "SsisPackageLocationType", - "modelAsString": true - } - }, - "typeProperties": { - "x-ms-client-flatten": true, - "description": "SSIS package location properties.", - "$ref": "#/definitions/SSISPackageLocationTypeProperties" - } - } - }, - "SSISPackageLocationTypeProperties": { - "description": "SSIS package location properties.", - "type": "object", - "properties": { - "packagePassword": { - "$ref": "../datafactory.json#/definitions/SecretBase", - "description": "Password of the package." - }, - "accessCredential": { - "description": "The package access credential.", - "$ref": "#/definitions/SSISAccessCredential" - }, - "configurationPath": { - "description": "The configuration file of the package execution. Type: string (or Expression with resultType string).", - "type": "object" - }, - "configurationAccessCredential": { - "description": "The configuration file access credential.", - "$ref": "#/definitions/SSISAccessCredential" - }, - "packageName": { - "description": "The package name.", - "type": "string" - }, - "packageContent": { - "description": "The embedded package content. Type: string (or Expression with resultType string).", - "type": "object" - }, - "packageLastModifiedDate": { - "description": "The embedded package last modified date.", - "type": "string" - }, - "childPackages": { - "description": "The embedded child package list.", - "type": "array", - "items": { - "$ref": "#/definitions/SSISChildPackage" - } - } + "type": "object" } - }, - "SSISConnectionManager": { - "description": "SSIS Connection Manager.", - "type": "object", + } + } + }, + "required": [ + "notebookPath" + ] + }, + "DatabricksSparkJarActivity": { + "description": "DatabricksSparkJar activity.", + "x-ms-discriminator-value": "DatabricksSparkJar", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks SparkJar activity properties.", + "$ref": "#/definitions/DatabricksSparkJarActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksSparkJarActivityTypeProperties": { + "description": "Databricks SparkJar activity properties.", + "properties": { + "mainClassName": { + "type": "object", + "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string)." + }, + "parameters": { + "description": "Parameters that will be passed to the main method.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", "additionalProperties": { - "$ref": "#/definitions/SSISExecutionParameter" - } - }, - "SSISExecutionParameter": { - "description": "SSIS execution parameter.", - "type": "object", - "properties": { - "value": { - "type": "object", - "description": "SSIS package execution parameter value. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "value" - ] - }, - "SSISPropertyOverride": { - "description": "SSIS property override.", - "type": "object", - "properties": { - "value": { - "type": "object", - "description": "SSIS package property override value. Type: string (or Expression with resultType string)." - }, - "isSensitive": { - "type": "boolean", - "description": "Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true" - } - }, - "required": [ - "value" - ] - }, - "SSISExecutionCredential": { - "description": "SSIS package execution credential.", - "type": "object", - "properties": { - "domain": { - "type": "object", - "description": "Domain for windows authentication." - }, - "userName": { - "type": "object", - "description": "UseName for windows authentication." - }, - "password": { - "$ref": "../datafactory.json#/definitions/SecureString", - "description": "Password for windows authentication." - } - }, - "required": [ - "domain", - "userName", - "password" - ] - }, - "SSISAccessCredential": { - "description": "SSIS access credential.", - "type": "object", - "properties": { - "domain": { - "type": "object", - "description": "Domain for windows authentication." - }, - "userName": { - "type": "object", - "description": "UseName for windows authentication." - }, - "password": { - "$ref": "../datafactory.json#/definitions/SecretBase", - "description": "Password for windows authentication." - } - }, - "required": [ - "domain", - "userName", - "password" - ] - }, - "SSISChildPackage": { - "description": "SSIS embedded child package.", - "type": "object", - "properties": { - "packagePath": { - "type": "object", - "description": "Path for embedded child package. Type: string (or Expression with resultType string)." - }, - "packageName": { - "type": "string", - "description": "Name for embedded child package." - }, - "packageContent": { - "type": "object", - "description": "Content for embedded child package. Type: string (or Expression with resultType string)." - }, - "packageLastModifiedDate": { - "type": "string", - "description": "Last modified date for embedded child package." - } - }, - "required": [ - "packagePath", - "packageContent" - ] - }, - "SSISLogLocation": { - "description": "SSIS package execution log location", - "type": "object", - "properties": { - "logPath": { - "description": "The SSIS package execution log path. Type: string (or Expression with resultType string).", - "type": "object" - }, - "type": { - "description": "The type of SSIS log location.", - "type": "string", - "enum": [ - "File" - ], - "x-ms-enum": { - "name": "SsisLogLocationType", - "modelAsString": true - } - }, - "typeProperties": { - "x-ms-client-flatten": true, - "description": "SSIS package execution log location properties.", - "$ref": "#/definitions/SSISLogLocationTypeProperties" - } - }, - "required": [ - "logPath", - "type", - "typeProperties" - ] - }, - "SSISLogLocationTypeProperties": { - "description": "SSIS package execution log location properties.", - "type": "object", - "properties": { - "accessCredential": { - "description": "The package execution log access credential.", - "$ref": "#/definitions/SSISAccessCredential" - }, - "logRefreshInterval": { - "type": "object", - "description": "Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "CustomActivity": { - "description": "Custom activity type.", - "x-ms-discriminator-value": "Custom", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Custom activity properties.", - "$ref": "#/definitions/CustomActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "CustomActivityTypeProperties": { - "description": "Custom activity properties.", - "properties": { - "command": { - "type": "object", - "description": "Command for custom activity Type: string (or Expression with resultType string)." - }, - "resourceLinkedService": { - "description": "Resource linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "folderPath": { - "type": "object", - "description": "Folder path for resource files Type: string (or Expression with resultType string)." - }, - "referenceObjects": { - "description": "Reference objects", - "$ref": "#/definitions/CustomActivityReferenceObject" - }, - "extendedProperties": { - "description": "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.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "retentionTimeInDays": { - "type": "object", - "description": "The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double)." - } - }, - "required": [ - "command" - ] - }, - "CustomActivityReferenceObject": { - "description": "Reference objects for custom activity", - "properties": { - "linkedServices": { - "description": "Linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "datasets": { - "description": "Dataset references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - } - } - }, - "SqlServerStoredProcedureActivity": { - "description": "SQL stored procedure activity type.", - "x-ms-discriminator-value": "SqlServerStoredProcedure", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "SQL stored procedure activity properties.", - "$ref": "#/definitions/SqlServerStoredProcedureActivityTypeProperties" - } - }, - "required": [ - "typeProperties", - "linkedServiceName" - ] - }, - "SqlServerStoredProcedureActivityTypeProperties": { - "description": "SQL stored procedure activity properties.", - "properties": { - "storedProcedureName": { - "type": "object", - "description": "Stored procedure name. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - } - }, - "required": [ - "storedProcedureName" - ] - }, - "ExecutePipelineActivity": { - "x-ms-discriminator-value": "ExecutePipeline", - "description": "Execute pipeline activity.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Execute pipeline activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExecutePipelineActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ExecutePipelineActivityTypeProperties": { - "description": "Execute pipeline activity properties.", - "properties": { - "pipeline": { - "description": "Pipeline reference.", - "$ref": "../datafactory.json#/definitions/PipelineReference" - }, - "parameters": { - "description": "Pipeline parameters.", - "$ref": "../datafactory.json#/definitions/ParameterValueSpecification" - }, - "waitOnCompletion": { - "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.", - "type": "boolean" - } - }, - "required": [ - "pipeline" - ] - }, - "DeleteActivity": { - "x-ms-discriminator-value": "Delete", - "description": "Delete activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Delete activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DeleteActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DeleteActivityTypeProperties": { - "description": "Delete activity properties.", - "properties": { - "recursive": { - "type": "object", - "description": "If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean)." - }, - "maxConcurrentConnections": { - "type": "integer", - "minimum": 1, - "description": "The max concurrent connections to connect data source at the same time." - }, - "enableLogging": { - "type": "object", - "description": "Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean)." - }, - "logStorageSettings": { - "description": "Log storage settings customer need to provide when enableLogging is true.", - "$ref": "#/definitions/LogStorageSettings" - }, - "dataset": { - "description": "Delete activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - }, - "required": [ - "dataset" - ] - }, - "AzureDataExplorerCommandActivity": { - "x-ms-discriminator-value": "AzureDataExplorerCommand", - "description": "Azure Data Explorer command activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Azure Data Explorer command activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureDataExplorerCommandActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureDataExplorerCommandActivityTypeProperties": { - "description": "Azure Data Explorer command activity properties.", - "properties": { - "command": { - "type": "object", - "description": "A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string)." - }, - "commandTimeout": { - "type": "object", - "description": "Control command timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))..)" - } - }, - "required": [ - "command" - ] - }, - "LookupActivity": { - "x-ms-discriminator-value": "Lookup", - "description": "Lookup activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Lookup activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/LookupActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "LookupActivityTypeProperties": { - "description": "Lookup activity properties.", - "properties": { - "source": { - "description": "Dataset-specific source properties, same as copy activity source.", - "$ref": "#/definitions/CopySource" - }, - "dataset": { - "description": "Lookup activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" - }, - "firstRowOnly": { - "type": "object", - "description": "Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean)." - } - }, - "required": [ - "source", - "dataset" - ] - }, - "WebActivityMethod": { - "description": "The list of HTTP methods supported by a WebActivity.", - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ], - "x-ms-enum": { - "name": "WebActivityMethod", - "modelAsString": true - } - }, - "WebActivity": { - "x-ms-discriminator-value": "WebActivity", - "description": "Web activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Web activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WebActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "WebActivityAuthentication": { - "description": "Web activity authentication properties.", - "properties": { - "type": { - "description": "Web activity authentication (Basic/ClientCertificate/MSI)", - "type": "string" - }, - "pfx": { - "description": "Base64-encoded contents of a PFX file.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "username": { - "description": "Web activity authentication user name for basic authentication.", - "type": "string" - }, - "password": { - "description": "Password for the PFX file or basic authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "resource": { - "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", - "type": "string" - } - }, - "required": [ - "type" - ] - }, - "WebActivityTypeProperties": { - "description": "Web activity type properties.", - "properties": { - "method": { - "description": "Rest API method for target endpoint.", - "$ref": "#/definitions/WebActivityMethod" - }, - "url": { - "type": "object", - "description": "Web activity target endpoint and path. Type: string (or Expression with resultType string)." - }, - "headers": { - "type": "object", - "description": "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": { - "type": "object", - "description": "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": { - "description": "Authentication method used for calling the endpoint.", - "$ref": "#/definitions/WebActivityAuthentication" - }, - "datasets": { - "type": "array", - "description": "List of datasets passed to web endpoint.", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - }, - "linkedServices": { - "type": "array", - "description": "List of linked services passed to web endpoint.", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "connectVia": { - "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" - } - }, - "required": [ - "method", - "url" - ] - }, - "GetMetadataActivity": { - "x-ms-discriminator-value": "GetMetadata", - "description": "Activity to get metadata of dataset", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "GetMetadata activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/GetMetadataActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "GetMetadataActivityTypeProperties": { - "description": "GetMetadata activity properties.", - "properties": { - "dataset": { - "description": "GetMetadata activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" - }, - "fieldList": { - "description": "Fields of metadata to get from dataset.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "dataset" - ] - }, - "IfConditionActivity": { - "x-ms-discriminator-value": "IfCondition", - "description": "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.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "IfCondition activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/IfConditionActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "IfConditionActivityTypeProperties": { - "description": "IfCondition activity properties.", - "properties": { - "expression": { - "description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "ifTrueActivities": { - "type": "array", - "description": "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.", - "items": { - "$ref": "#/definitions/Activity" - } - }, - "ifFalseActivities": { - "type": "array", - "description": "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.", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "expression" - ] - }, - "SwitchActivity": { - "x-ms-discriminator-value": "Switch", - "description": "This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Switch activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SwitchActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "SwitchActivityTypeProperties": { - "description": "Switch activity properties.", - "properties": { - "on": { - "description": "An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "cases": { - "type": "array", - "description": "List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.", - "items": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SwitchCase" - } - }, - "defaultActivities": { - "type": "array", - "description": "List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "on" - ] - }, - "SwitchCase": { - "description": "Switch cases with have a value and corresponding activities.", - "properties": { - "value": { - "description": "Expected value that satisfies the expression result of the 'on' property.", - "type": "string" - }, - "activities": { - "type": "array", - "description": "List of activities to execute for satisfied case condition.", - "items": { - "$ref": "#/definitions/Activity" - } - } - } - }, - "ForEachActivity": { - "x-ms-discriminator-value": "ForEach", - "description": "This activity is used for iterating over a collection and execute given activities.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "ForEach activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ForEachActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ForEachActivityTypeProperties": { - "description": "ForEach activity properties.", - "properties": { - "isSequential": { - "description": "Should the loop be executed in sequence or in parallel (max 50)", - "type": "boolean" - }, - "batchCount": { - "description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).", - "type": "integer", - "maximum": 50 - }, - "items": { - "description": "Collection to iterate.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "activities": { - "type": "array", - "description": "List of activities to execute .", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "items", - "activities" - ] - }, - "AzureMLBatchExecutionActivity": { - "description": "Azure ML Batch Execution activity.", - "x-ms-discriminator-value": "AzureMLBatchExecution", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Azure ML Batch Execution activity properties.", - "$ref": "#/definitions/AzureMLBatchExecutionActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureMLBatchExecutionActivityTypeProperties": { - "description": "Azure ML Batch Execution activity properties.", - "properties": { - "globalParameters": { - "description": "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.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "webServiceOutputs": { - "description": "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.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AzureMLWebServiceFile" - } - }, - "webServiceInputs": { - "description": "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.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AzureMLWebServiceFile" - } - } + "type": "object" } - }, - "AzureMLWebServiceFile": { - "description": "Azure ML WebService Input/Output file", - "type": "object", - "properties": { - "filePath": { - "type": "object", - "description": "The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string)." - }, - "linkedServiceName": { - "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "required": [ - "linkedServiceName", - "filePath" - ] - }, - "AzureMLUpdateResourceActivity": { - "description": "Azure ML Update Resource management activity.", - "x-ms-discriminator-value": "AzureMLUpdateResource", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Azure ML Update Resource management activity properties.", - "$ref": "#/definitions/AzureMLUpdateResourceActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureMLUpdateResourceActivityTypeProperties": { - "description": "Azure ML Update Resource activity properties.", - "properties": { - "trainedModelName": { - "type": "object", - "description": "Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string)." - }, - "trainedModelLinkedServiceName": { - "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "trainedModelFilePath": { - "type": "object", - "description": "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)." - } - }, - "required": [ - "trainedModelName", - "trainedModelLinkedServiceName", - "trainedModelFilePath" - ] - }, - "AzureMLExecutePipelineActivity": { - "description": "Azure ML Execute Pipeline activity.", - "x-ms-discriminator-value": "AzureMLExecutePipeline", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Azure ML Execute Pipeline activity properties.", - "$ref": "#/definitions/AzureMLExecutePipelineActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureMLExecutePipelineActivityTypeProperties": { - "description": "Azure ML Execute Pipeline activity properties.", - "properties": { - "mlPipelineId": { - "description": "ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).", - "type": "object" - }, - "experimentName": { - "description": "Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).", - "type": "object" - }, - "mlPipelineParameters": { - "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).", - "type": "object" - }, - "mlParentRunId": { - "description": "The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).", - "type": "object" - }, - "continueOnStepFailure": { - "description": "Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).", - "type": "object" - } - }, - "required": [ - "mlPipelineId" - ] - }, - "AzureMLPipelineParameters": { - "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request.", - "type": "object", + } + } + }, + "required": [ + "mainClassName" + ] + }, + "DatabricksSparkPythonActivity": { + "description": "DatabricksSparkPython activity.", + "x-ms-discriminator-value": "DatabricksSparkPython", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks SparkPython activity properties.", + "$ref": "#/definitions/DatabricksSparkPythonActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksSparkPythonActivityTypeProperties": { + "description": "Databricks SparkPython activity properties.", + "properties": { + "pythonFile": { + "type": "object", + "description": "The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string)." + }, + "parameters": { + "description": "Command line parameters that will be passed to the Python file.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "DataLakeAnalyticsUSQLActivity": { - "description": "Data Lake Analytics U-SQL activity.", - "x-ms-discriminator-value": "DataLakeAnalyticsU-SQL", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Data Lake Analytics U-SQL activity properties.", - "$ref": "#/definitions/DataLakeAnalyticsUSQLActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DataLakeAnalyticsUSQLActivityTypeProperties": { - "description": "DataLakeAnalyticsU-SQL activity properties.", - "properties": { - "scriptPath": { - "type": "object", - "description": "Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string)." - }, - "scriptLinkedService": { - "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "degreeOfParallelism": { - "type": "object", - "description": "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": { - "type": "object", - "description": "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": { - "description": "Parameters for U-SQL job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "runtimeVersion": { - "type": "object", - "description": "Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string)." - }, - "compilationMode": { - "type": "object", - "description": "Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "scriptPath", - "scriptLinkedService" - ] - }, - "WaitActivity": { - "x-ms-discriminator-value": "Wait", - "description": "This activity suspends pipeline execution for the specified interval.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Wait activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WaitActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "WaitActivityTypeProperties": { - "description": "Wait activity properties.", - "properties": { - "waitTimeInSeconds": { - "description": "Duration in seconds.", - "type": "integer" - } - }, - "required": [ - "waitTimeInSeconds" - ] - }, - "UntilActivity": { - "x-ms-discriminator-value": "Until", - "description": "This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Until activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/UntilActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "UntilActivityTypeProperties": { - "description": "Until activity properties.", - "properties": { - "expression": { - "description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "timeout": { - "type": "object", - "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "activities": { - "type": "array", - "description": "List of activities to execute.", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "expression", - "activities" - ] - }, - "ValidationActivity": { - "x-ms-discriminator-value": "Validation", - "description": "This activity verifies that an external resource exists.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Validation activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ValidationActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ValidationActivityTypeProperties": { - "description": "Validation activity properties.", - "properties": { - "timeout": { - "type": "object", - "description": "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+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "sleep": { - "type": "object", - "description": "A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer)." - }, - "minimumSize": { - "type": "object", - "description": "Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer)." - }, - "childItems": { - "type": "object", - "description": "Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean)." - }, - "dataset": { - "description": "Validation activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - }, - "required": [ - "dataset" - ] - }, - "FilterActivity": { - "x-ms-discriminator-value": "Filter", - "description": "Filter and return results from input array based on the conditions.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Filter activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/FilterActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "FilterActivityTypeProperties": { - "description": "Filter activity properties.", - "properties": { - "items": { - "description": "Input array on which filter should be applied.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "condition": { - "description": "Condition to be used for filtering the input.", - "$ref": "../datafactory.json#/definitions/Expression" - } - }, - "required": [ - "condition", - "items" - ] - }, - "DatabricksNotebookActivity": { - "description": "DatabricksNotebook activity.", - "x-ms-discriminator-value": "DatabricksNotebook", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Databricks Notebook activity properties.", - "$ref": "#/definitions/DatabricksNotebookActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DatabricksNotebookActivityTypeProperties": { - "description": "Databricks Notebook activity properties.", - "properties": { - "notebookPath": { - "type": "object", - "description": "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)." - }, - "baseParameters": { - "description": "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.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "libraries": { - "description": "A list of libraries to be installed on the cluster that will execute the job.", - "type": "array", - "items": { - "type": "object", - "description": "Databricks library definition.", - "additionalProperties": { - "type": "object" - } - } - } - }, - "required": [ - "notebookPath" - ] - }, - "DatabricksSparkJarActivity": { - "description": "DatabricksSparkJar activity.", - "x-ms-discriminator-value": "DatabricksSparkJar", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Databricks SparkJar activity properties.", - "$ref": "#/definitions/DatabricksSparkJarActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DatabricksSparkJarActivityTypeProperties": { - "description": "Databricks SparkJar activity properties.", - "properties": { - "mainClassName": { - "type": "object", - "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string)." - }, - "parameters": { - "description": "Parameters that will be passed to the main method.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "libraries": { - "description": "A list of libraries to be installed on the cluster that will execute the job.", - "type": "array", - "items": { - "type": "object", - "description": "Databricks library definition.", - "additionalProperties": { - "type": "object" - } - } - } - }, - "required": [ - "mainClassName" - ] - }, - "DatabricksSparkPythonActivity": { - "description": "DatabricksSparkPython activity.", - "x-ms-discriminator-value": "DatabricksSparkPython", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Databricks SparkPython activity properties.", - "$ref": "#/definitions/DatabricksSparkPythonActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DatabricksSparkPythonActivityTypeProperties": { - "description": "Databricks SparkPython activity properties.", - "properties": { - "pythonFile": { - "type": "object", - "description": "The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string)." - }, - "parameters": { - "description": "Command line parameters that will be passed to the Python file.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "libraries": { - "description": "A list of libraries to be installed on the cluster that will execute the job.", - "type": "array", - "items": { - "type": "object", - "description": "Databricks library definition.", - "additionalProperties": { - "type": "object" - } - } - } - }, - "required": [ - "pythonFile" - ] - }, - "SetVariableActivity": { - "x-ms-discriminator-value": "SetVariable", - "description": "Set value for a Variable.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Set Variable activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SetVariableActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "SetVariableActivityTypeProperties": { - "description": "SetVariable activity properties.", - "properties": { - "variableName": { - "description": "Name of the variable whose value needs to be set.", - "type": "string" - }, - "value": { - "description": "Value to be set. Could be a static value or Expression", - "type": "object" - } - } - }, - "AppendVariableActivity": { - "x-ms-discriminator-value": "AppendVariable", - "description": "Append value for a Variable of type Array.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Append Variable activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AppendVariableActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AppendVariableActivityTypeProperties": { - "description": "AppendVariable activity properties.", - "properties": { - "variableName": { - "description": "Name of the variable whose value needs to be appended to.", - "type": "string" - }, - "value": { - "description": "Value to be appended. Could be a static value or Expression", - "type": "object" - } + "type": "object" } - }, - "AzureFunctionActivityMethod": { - "description": "The list of HTTP methods supported by a AzureFunctionActivity.", - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE", - "OPTIONS", - "HEAD", - "TRACE" - ], - "x-ms-enum": { - "name": "AzureFunctionActivityMethod", - "modelAsString": true - } - }, - "AzureFunctionActivity": { - "x-ms-discriminator-value": "AzureFunctionActivity", - "description": "Azure Function activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Azure Function activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureFunctionActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureFunctionActivityTypeProperties": { - "description": "Azure Function activity type properties.", - "properties": { - "method": { - "description": "Rest API method for target endpoint.", - "$ref": "#/definitions/AzureFunctionActivityMethod" - }, - "functionName": { - "type": "object", - "description": "Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string)" - }, - "headers": { - "type": "object", - "description": "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": { - "type": "object", - "description": "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)." - } - }, - "required": [ - "method", - "functionName" - ] - }, - "WebHookActivity": { - "x-ms-discriminator-value": "WebHook", - "description": "WebHook activity.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "WebHook activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WebHookActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "WebHookActivityMethod": { - "description": "The list of HTTP methods supported by a WebHook activity.", - "type": "string", - "enum": [ - "POST" - ], - "x-ms-enum": { - "name": "WebHookActivityMethod", + } + } + }, + "required": [ + "pythonFile" + ] + }, + "SetVariableActivity": { + "x-ms-discriminator-value": "SetVariable", + "description": "Set value for a Variable.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Set Variable activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SetVariableActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SetVariableActivityTypeProperties": { + "description": "SetVariable activity properties.", + "properties": { + "variableName": { + "description": "Name of the variable whose value needs to be set.", + "type": "string" + }, + "value": { + "description": "Value to be set. Could be a static value or Expression", + "type": "object" + } + } + }, + "AppendVariableActivity": { + "x-ms-discriminator-value": "AppendVariable", + "description": "Append value for a Variable of type Array.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Append Variable activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AppendVariableActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AppendVariableActivityTypeProperties": { + "description": "AppendVariable activity properties.", + "properties": { + "variableName": { + "description": "Name of the variable whose value needs to be appended to.", + "type": "string" + }, + "value": { + "description": "Value to be appended. Could be a static value or Expression", + "type": "object" + } + } + }, + "AzureFunctionActivityMethod": { + "description": "The list of HTTP methods supported by a AzureFunctionActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE", + "OPTIONS", + "HEAD", + "TRACE" + ], + "x-ms-enum": { + "name": "AzureFunctionActivityMethod", + "modelAsString": true + } + }, + "AzureFunctionActivity": { + "x-ms-discriminator-value": "AzureFunctionActivity", + "description": "Azure Function activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Function activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFunctionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureFunctionActivityTypeProperties": { + "description": "Azure Function activity type properties.", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/AzureFunctionActivityMethod" + }, + "functionName": { + "type": "object", + "description": "Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string)" + }, + "headers": { + "type": "object", + "description": "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": { + "type": "object", + "description": "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)." + } + }, + "required": [ + "method", + "functionName" + ] + }, + "WebHookActivity": { + "x-ms-discriminator-value": "WebHook", + "description": "WebHook activity.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "WebHook activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebHookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebHookActivityMethod": { + "description": "The list of HTTP methods supported by a WebHook activity.", + "type": "string", + "enum": [ + "POST" + ], + "x-ms-enum": { + "name": "WebHookActivityMethod", + "modelAsString": true + } + }, + "WebHookActivityTypeProperties": { + "description": "WebHook activity type properties.", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebHookActivityMethod" + }, + "url": { + "type": "object", + "description": "WebHook activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "timeout": { + "type": "string", + "description": "The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "headers": { + "type": "object", + "description": "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": { + "type": "object", + "description": "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": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebActivityAuthentication" + }, + "reportStatusOnCallBack": { + "type": "object", + "description": "When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "method", + "url" + ] + }, + "ExecuteDataFlowActivity": { + "description": "Execute data flow activity.", + "x-ms-discriminator-value": "ExecuteDataFlow", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute data flow activity properties.", + "$ref": "#/definitions/ExecuteDataFlowActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecuteDataFlowActivityTypeProperties": { + "description": "Execute data flow activity properties.", + "properties": { + "dataFlow": { + "description": "Data flow reference.", + "$ref": "../datafactory.json#/definitions/DataFlowReference" + }, + "staging": { + "description": "Staging info for execute data flow activity.", + "$ref": "../datafactory.json#/definitions/DataFlowStagingInfo" + }, + "integrationRuntime": { + "description": "The integration runtime reference.", + "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + }, + "compute": { + "description": "Compute properties for data flow activity.", + "type": "object", + "properties": { + "computeType": { + "description": "Compute type of the cluster which will execute data flow job.", + "type": "string", + "enum": [ + "General", + "MemoryOptimized", + "ComputeOptimized" + ], + "x-ms-enum": { + "name": "DataFlowComputeType", "modelAsString": true - } - }, - "WebHookActivityTypeProperties": { - "description": "WebHook activity type properties.", - "properties": { - "method": { - "description": "Rest API method for target endpoint.", - "$ref": "#/definitions/WebHookActivityMethod" - }, - "url": { - "type": "object", - "description": "WebHook activity target endpoint and path. Type: string (or Expression with resultType string)." - }, - "timeout": { - "type": "string", - "description": "The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "headers": { - "type": "object", - "description": "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": { - "type": "object", - "description": "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": { - "description": "Authentication method used for calling the endpoint.", - "$ref": "#/definitions/WebActivityAuthentication" - }, - "reportStatusOnCallBack": { - "type": "object", - "description": "When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean)." - } - }, - "required": [ - "method", - "url" - ] - }, - "ExecuteDataFlowActivity": { - "description": "Execute data flow activity.", - "x-ms-discriminator-value": "ExecuteDataFlow", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Execute data flow activity properties.", - "$ref": "#/definitions/ExecuteDataFlowActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ExecuteDataFlowActivityTypeProperties": { - "description": "Execute data flow activity properties.", - "properties": { - "dataFlow": { - "description": "Data flow reference.", - "$ref": "../datafactory.json#/definitions/DataFlowReference" - }, - "staging": { - "description": "Staging info for execute data flow activity.", - "$ref": "../datafactory.json#/definitions/DataFlowStagingInfo" - }, - "integrationRuntime": { - "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" - }, - "compute": { - "description": "Compute properties for data flow activity.", - "type": "object", - "properties": { - "computeType": { - "description": "Compute type of the cluster which will execute data flow job.", - "type": "string", - "enum": [ - "General", - "MemoryOptimized", - "ComputeOptimized" - ], - "x-ms-enum": { - "name": "DataFlowComputeType", - "modelAsString": true - } - }, - "coreCount": { - "description": "Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.", - "type": "integer" - } - } - } + } }, - "required": [ - "dataFlow" - ] - }, - "SharePointOnlineListSource": { - "description": "A copy activity source for sharePoint online list source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "The OData query to filter the data in SharePoint Online list. For example, \"$top=1\". Type: string (or Expression with resultType string)." - }, - "httpRequestTimeout": { - "type": "object", - "description": "The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } + "coreCount": { + "description": "Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.", + "type": "integer" } + } + } + }, + "required": [ + "dataFlow" + ] + }, + "SharePointOnlineListSource": { + "description": "A copy activity source for sharePoint online list source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "The OData query to filter the data in SharePoint Online list. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." } + } } + } } \ No newline at end of file From a19c6f333e39ec0897941ede7c4098aa7858bba8 Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Fri, 31 Jul 2020 13:18:52 -0700 Subject: [PATCH 08/11] Add new EC API --- .../stable/2018-06-01/datafactory.json | 85 ++++++++++++++++++- ...reControl_QueryFeatureValuesByFactory.json | 36 ++++++++ 2 files changed, 120 insertions(+), 1 deletion(-) create mode 100644 specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_QueryFeatureValuesByFactory.json diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index 8ac8e38601ed..fd9082f0f206 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -255,6 +255,57 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryFeaturesValue": { + "post": { + "tags": [ + "exposureControl" + ], + "operationId": "ExposureControl_QueryFeatureValuesByFactory", + "x-ms-examples": { + "ExposureControl_QueryFeatureValuesByFactory": { + "$ref": "./examples/ExposureControl_QueryFeatureValuesByFactory.json" + } + }, + "description": "Get list of exposure control features for specific factory.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "exposureControlBatchRequest", + "description": "The exposure control request for list of features.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExposureControlBatchRequest" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ExposureControlBatchResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories": { "get": { "tags": [ @@ -3105,7 +3156,7 @@ ], "operationId": "TriggerRuns_Cancel", "x-ms-examples": { - "Triggers_Rerun": { + "Triggers_Cancel": { "$ref": "./examples/TriggerRuns_Cancel.json" } }, @@ -5459,6 +5510,22 @@ } } }, + "ExposureControlBatchRequest": { + "description": "A list of exposure control features.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of exposure control features.", + "items": { + "$ref": "#/definitions/ExposureControlRequest" + } + } + } + }, "ExposureControlRequest": { "type": "object", "description": "The exposure control request.", @@ -5473,6 +5540,22 @@ } } }, + "ExposureControlBatchResponse": { + "description": "A list of exposure control feature values.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of exposure control feature values.", + "items": { + "$ref": "#/definitions/ExposureControlResponse" + } + } + } + }, "ExposureControlResponse": { "type": "object", "description": "The exposure control response.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_QueryFeatureValuesByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_QueryFeatureValuesByFactory.json new file mode 100644 index 000000000000..1c61574924d6 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_QueryFeatureValuesByFactory.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "exposureControlBatchRequest": [ + { + "featureName": "ADFIntegrationRuntimeSharingRbac", + "featureType": "Feature" + }, + { + "featureName": "ADFSampleFeature", + "featureType": "Feature" + } + ], + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 22 Dec 2018 09:46:07 GMT", + "X-Content-Type-Options": "nosniff" + }, + "body": [ + { + "featureName": "ADFIntegrationRuntimeSharingRbac", + "value": "False" + }, + { + "featureName": "ADFSampleFeature", + "value": "True" + } + ] + } + } +} From 7dc70e2d15d2bfccc73030e607a60667c5b01223 Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Fri, 31 Jul 2020 13:25:38 -0700 Subject: [PATCH 09/11] lint --- .../stable/2018-06-01/entityTypes/Pipeline.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 6476fc903e7c..e7963bb5c123 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -6676,4 +6676,4 @@ } } } -} \ No newline at end of file +} From 04695a9421c2411ecbcaa8121a5c90692da12fb3 Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Fri, 31 Jul 2020 14:54:09 -0700 Subject: [PATCH 10/11] fix validation --- .../Microsoft.DataFactory/stable/2018-06-01/datafactory.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index fd9082f0f206..9e0ea5cfced3 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -5512,7 +5512,7 @@ }, "ExposureControlBatchRequest": { "description": "A list of exposure control features.", - "type": "object", + "type": "array", "required": [ "value" ], @@ -5542,7 +5542,7 @@ }, "ExposureControlBatchResponse": { "description": "A list of exposure control feature values.", - "type": "object", + "type": "array", "required": [ "value" ], From b630fbb8f3473ceced4556404f4d987f85661be5 Mon Sep 17 00:00:00 2001 From: Arulnithi Date: Fri, 31 Jul 2020 17:24:24 -0700 Subject: [PATCH 11/11] fix defn --- .../stable/2018-06-01/datafactory.json | 12 ++--- ...reControl_QueryFeatureValuesByFactory.json | 44 ++++++++++--------- 2 files changed, 30 insertions(+), 26 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index 9e0ea5cfced3..aa26d4faab45 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -5512,12 +5512,12 @@ }, "ExposureControlBatchRequest": { "description": "A list of exposure control features.", - "type": "array", + "type": "object", "required": [ - "value" + "exposureControlRequests" ], "properties": { - "value": { + "exposureControlRequests": { "type": "array", "description": "List of exposure control features.", "items": { @@ -5542,12 +5542,12 @@ }, "ExposureControlBatchResponse": { "description": "A list of exposure control feature values.", - "type": "array", + "type": "object", "required": [ - "value" + "exposureControlResponses" ], "properties": { - "value": { + "exposureControlResponses": { "type": "array", "description": "List of exposure control feature values.", "items": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_QueryFeatureValuesByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_QueryFeatureValuesByFactory.json index 1c61574924d6..a546ad232dc1 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_QueryFeatureValuesByFactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_QueryFeatureValuesByFactory.json @@ -3,16 +3,18 @@ "subscriptionId": "12345678-1234-1234-1234-12345678abc", "resourceGroupName": "exampleResourceGroup", "factoryName": "exampleFactoryName", - "exposureControlBatchRequest": [ - { - "featureName": "ADFIntegrationRuntimeSharingRbac", - "featureType": "Feature" - }, - { - "featureName": "ADFSampleFeature", - "featureType": "Feature" - } - ], + "exposureControlBatchRequest": { + "exposureControlRequests": [ + { + "featureName": "ADFIntegrationRuntimeSharingRbac", + "featureType": "Feature" + }, + { + "featureName": "ADFSampleFeature", + "featureType": "Feature" + } + ] + }, "api-version": "2018-06-01" }, "responses": { @@ -21,16 +23,18 @@ "Date": "Sat, 22 Dec 2018 09:46:07 GMT", "X-Content-Type-Options": "nosniff" }, - "body": [ - { - "featureName": "ADFIntegrationRuntimeSharingRbac", - "value": "False" - }, - { - "featureName": "ADFSampleFeature", - "value": "True" - } - ] + "body": { + "exposureControlResponses": [ + { + "featureName": "ADFIntegrationRuntimeSharingRbac", + "value": "False" + }, + { + "featureName": "ADFSampleFeature", + "value": "True" + } + ] + } } } }