{ "swagger": "2.0", "info": { "title": "DataFactoryManagementClient", "version": "2018-06-01", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "factories" }, { "name": "exposureControl" }, { "name": "pipelineruns" }, { "name": "activityruns" }, { "name": "triggers" }, { "name": "triggerruns" }, { "name": "dataFlowDebugSession" }, { "name": "privateLinkResources" }, { "name": "integrationRuntimes" }, { "name": "integrationRuntimeObjectMetadata" }, { "name": "integrationRuntimeNodes" }, { "name": "integrationRuntimeEnableInteractiveQuery" }, { "name": "integrationRuntimeDisableInteractiveQuery" }, { "name": "linkedServices" }, { "name": "datasets" }, { "name": "pipelines" }, { "name": "trigger" }, { "name": "dataFlows" }, { "name": "managedVirtualNetworks" }, { "name": "managedPrivateEndpoints" }, { "name": "credentials" }, { "name": "privateEndpointConnections" }, { "name": "privateEndPointConnections" }, { "name": "globalParameters" }, { "name": "changeDataCapture" } ], "paths": { "/providers/Microsoft.DataFactory/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "Lists the available Azure Data Factory API operations.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Operations_List": { "$ref": "./examples/Operations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories": { "get": { "operationId": "Factories_List", "tags": [ "factories" ], "description": "Lists factories under the specified subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FactoryListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Factories_List": { "$ref": "./examples/Factories_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo": { "post": { "operationId": "Factories_ConfigureFactoryRepo", "tags": [ "factories" ], "description": "Updates a factory's repo information.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "locationId", "in": "path", "description": "The location identifier.", "required": true, "type": "string" }, { "name": "factoryRepoUpdate", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/FactoryRepoUpdate" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Factory" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Factories_ConfigureFactoryRepo": { "$ref": "./examples/Factories_ConfigureFactoryRepo.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/getFeatureValue": { "post": { "operationId": "ExposureControl_GetFeatureValue", "tags": [ "exposureControl" ], "description": "Get exposure control feature for specific location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "locationId", "in": "path", "description": "The location identifier.", "required": true, "type": "string" }, { "name": "exposureControlRequest", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/ExposureControlRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExposureControlResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ExposureControl_GetFeatureValue": { "$ref": "./examples/ExposureControl_GetFeatureValue.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories": { "get": { "operationId": "Factories_ListByResourceGroup", "tags": [ "factories" ], "description": "Lists factories.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FactoryListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Factories_ListByResourceGroup": { "$ref": "./examples/Factories_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}": { "get": { "operationId": "Factories_Get", "tags": [ "factories" ], "description": "Gets a factory.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the factory entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Factory" } }, "304": { "description": "The client has made a conditional request and the resource has not been modified." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Factories_Get": { "$ref": "./examples/Factories_Get.json" } } }, "put": { "operationId": "Factories_CreateOrUpdate", "tags": [ "factories" ], "description": "Creates or updates a factory.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "if-match", "in": "header", "description": "ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "factory", "in": "body", "description": "Factory resource definition.", "required": true, "schema": { "$ref": "#/definitions/Factory" } } ], "responses": { "200": { "description": "Resource 'Factory' update operation succeeded", "schema": { "$ref": "#/definitions/Factory" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Factories_CreateOrUpdate": { "$ref": "./examples/Factories_CreateOrUpdate.json" } } }, "patch": { "operationId": "Factories_Update", "tags": [ "factories" ], "description": "Updates a factory.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "factoryUpdateParameters", "in": "body", "description": "The parameters for updating a factory.", "required": true, "schema": { "$ref": "#/definitions/FactoryUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Factory" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Factories_Update": { "$ref": "./examples/Factories_Update.json" } } }, "delete": { "operationId": "Factories_Delete", "tags": [ "factories" ], "description": "Deletes a factory.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Factories_Delete": { "$ref": "./examples/Factories_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/addDataFlowToDebugSession": { "post": { "operationId": "DataFlowDebugSession_AddDataFlow", "tags": [ "dataFlowDebugSession" ], "description": "Add a data flow into debug session.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "request", "in": "body", "description": "Data flow debug session definition with debug content.", "required": true, "schema": { "$ref": "#/definitions/DataFlowDebugPackage" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AddDataFlowToDebugSessionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "DataFlowDebugSession_AddDataFlow": { "$ref": "./examples/DataFlowDebugSession_AddDataFlow.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs": { "get": { "operationId": "ChangeDataCapture_ListByFactory", "tags": [ "changeDataCapture" ], "description": "Lists all resources of type change data capture.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ChangeDataCaptureListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ChangeDataCapture_ListByFactory": { "$ref": "./examples/ChangeDataCapture_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}": { "get": { "operationId": "ChangeDataCapture_Get", "tags": [ "changeDataCapture" ], "description": "Gets a change data capture.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "changeDataCaptureName", "in": "path", "description": "The change data capture name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the change data capture entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ChangeDataCaptureResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ChangeDataCapture_Get": { "$ref": "./examples/ChangeDataCapture_Get.json" } } }, "put": { "operationId": "ChangeDataCapture_CreateOrUpdate", "tags": [ "changeDataCapture" ], "description": "Creates or updates a change data capture resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "changeDataCaptureName", "in": "path", "description": "The change data capture name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-match", "in": "header", "description": "ETag of the change data capture entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "changeDataCapture", "in": "body", "description": "Change data capture resource definition.", "required": true, "schema": { "$ref": "#/definitions/ChangeDataCaptureResource" } } ], "responses": { "200": { "description": "Resource 'ChangeDataCaptureResource' update operation succeeded", "schema": { "$ref": "#/definitions/ChangeDataCaptureResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ChangeDataCapture_Create": { "$ref": "./examples/ChangeDataCapture_Create.json" }, "ChangeDataCapture_Update": { "$ref": "./examples/ChangeDataCapture_Update.json" } } }, "delete": { "operationId": "ChangeDataCapture_Delete", "tags": [ "changeDataCapture" ], "description": "Deletes a change data capture.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "changeDataCaptureName", "in": "path", "description": "The change data capture name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ChangeDataCapture_Delete": { "$ref": "./examples/ChangeDataCapture_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/start": { "post": { "operationId": "ChangeDataCapture_Start", "tags": [ "changeDataCapture" ], "description": "Starts a change data capture.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "changeDataCaptureName", "in": "path", "description": "The change data capture name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ChangeDataCapture_Start": { "$ref": "./examples/ChangeDataCapture_Start.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/status": { "get": { "operationId": "ChangeDataCapture_Status", "tags": [ "changeDataCapture" ], "description": "Gets the current status for the change data capture resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "changeDataCaptureName", "in": "path", "description": "The change data capture name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ChangeDataCaptureStatusResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ChangeDataCapture_Start": { "$ref": "./examples/ChangeDataCapture_Status.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/stop": { "post": { "operationId": "ChangeDataCapture_Stop", "tags": [ "changeDataCapture" ], "description": "Stops a change data capture.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "changeDataCaptureName", "in": "path", "description": "The change data capture name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ChangeDataCapture_Stop": { "$ref": "./examples/ChangeDataCapture_Stop.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/createDataFlowDebugSession": { "post": { "operationId": "DataFlowDebugSession_Create", "tags": [ "dataFlowDebugSession" ], "description": "Creates a data flow debug session.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "request", "in": "body", "description": "Data flow debug session definition", "required": true, "schema": { "$ref": "#/definitions/CreateDataFlowDebugSessionRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CreateDataFlowDebugSessionResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "DataFlowDebugSession_Create": { "$ref": "./examples/DataFlowDebugSession_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/CreateDataFlowDebugSessionResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials": { "get": { "operationId": "CredentialOperations_ListByFactory", "tags": [ "credentials" ], "description": "List credentials.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CredentialListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Credentials_ListByFactory": { "$ref": "./examples/Credentials_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}": { "get": { "operationId": "CredentialOperations_Get", "tags": [ "credentials" ], "description": "Gets a credential.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "credentialName", "in": "path", "description": "Credential name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the credential entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CredentialResource" } }, "304": { "description": "The client has made a conditional request and the resource has not been modified." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Credentials_Get": { "$ref": "./examples/Credentials_Get.json" } } }, "put": { "operationId": "CredentialOperations_CreateOrUpdate", "tags": [ "credentials" ], "description": "Creates or updates a credential.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "credentialName", "in": "path", "description": "Credential name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" }, { "name": "if-match", "in": "header", "description": "ETag of the credential entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "credential", "in": "body", "description": "Credential resource definition.", "required": true, "schema": { "$ref": "#/definitions/CredentialResource" } } ], "responses": { "200": { "description": "Resource 'CredentialResource' update operation succeeded", "schema": { "$ref": "#/definitions/CredentialResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Credentials_Create": { "$ref": "./examples/Credentials_Create.json" } } }, "delete": { "operationId": "CredentialOperations_Delete", "tags": [ "credentials" ], "description": "Deletes a credential.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "credentialName", "in": "path", "description": "Credential name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Credentials_Delete": { "$ref": "./examples/Credentials_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows": { "get": { "operationId": "DataFlows_ListByFactory", "tags": [ "dataFlows" ], "description": "Lists data flows.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataFlowListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "DataFlows_ListByFactory": { "$ref": "./examples/DataFlows_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}": { "get": { "operationId": "DataFlows_Get", "tags": [ "dataFlows" ], "description": "Gets a data flow.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "dataFlowName", "in": "path", "description": "The data flow name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the data flow entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataFlowResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "DataFlows_Get": { "$ref": "./examples/DataFlows_Get.json" } } }, "put": { "operationId": "DataFlows_CreateOrUpdate", "tags": [ "dataFlows" ], "description": "Creates or updates a data flow.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "dataFlowName", "in": "path", "description": "The data flow name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-match", "in": "header", "description": "ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "dataFlow", "in": "body", "description": "Data flow resource definition.", "required": true, "schema": { "$ref": "#/definitions/DataFlowResource" } } ], "responses": { "200": { "description": "Resource 'DataFlowResource' update operation succeeded", "schema": { "$ref": "#/definitions/DataFlowResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "DataFlows_Create": { "$ref": "./examples/DataFlows_Create.json" }, "DataFlows_Update": { "$ref": "./examples/DataFlows_Update.json" } } }, "delete": { "operationId": "DataFlows_Delete", "tags": [ "dataFlows" ], "description": "Deletes a data flow.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "dataFlowName", "in": "path", "description": "The data flow name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "DataFlows_Delete": { "$ref": "./examples/DataFlows_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets": { "get": { "operationId": "Datasets_ListByFactory", "tags": [ "datasets" ], "description": "Lists datasets.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatasetListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Datasets_ListByFactory": { "$ref": "./examples/Datasets_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}": { "get": { "operationId": "Datasets_Get", "tags": [ "datasets" ], "description": "Gets a dataset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "datasetName", "in": "path", "description": "The dataset name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatasetResource" } }, "304": { "description": "The client has made a conditional request and the resource has not been modified." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Datasets_Get": { "$ref": "./examples/Datasets_Get.json" } } }, "put": { "operationId": "Datasets_CreateOrUpdate", "tags": [ "datasets" ], "description": "Creates or updates a dataset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "datasetName", "in": "path", "description": "The dataset name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-match", "in": "header", "description": "ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "dataset", "in": "body", "description": "Dataset resource definition.", "required": true, "schema": { "$ref": "#/definitions/DatasetResource" } } ], "responses": { "200": { "description": "Resource 'DatasetResource' update operation succeeded", "schema": { "$ref": "#/definitions/DatasetResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Datasets_Create": { "$ref": "./examples/Datasets_Create.json" }, "Datasets_Update": { "$ref": "./examples/Datasets_Update.json" } } }, "delete": { "operationId": "Datasets_Delete", "tags": [ "datasets" ], "description": "Deletes a dataset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "datasetName", "in": "path", "description": "The dataset name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Datasets_Delete": { "$ref": "./examples/Datasets_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/deleteDataFlowDebugSession": { "post": { "operationId": "DataFlowDebugSession_Delete", "tags": [ "dataFlowDebugSession" ], "description": "Deletes a data flow debug session.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "request", "in": "body", "description": "Data flow debug session definition for deletion", "required": true, "schema": { "$ref": "#/definitions/DeleteDataFlowDebugSessionRequest" } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "DataFlowDebugSession_Delete": { "$ref": "./examples/DataFlowDebugSession_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/executeDataFlowDebugCommand": { "post": { "operationId": "DataFlowDebugSession_ExecuteCommand", "tags": [ "dataFlowDebugSession" ], "description": "Execute a data flow debug command.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "request", "in": "body", "description": "Data flow debug command definition.", "required": true, "schema": { "$ref": "#/definitions/DataFlowDebugCommandRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataFlowDebugCommandResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "DataFlowDebugSession_ExecuteCommand": { "$ref": "./examples/DataFlowDebugSession_ExecuteCommand.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DataFlowDebugCommandResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess": { "post": { "operationId": "Factories_GetDataPlaneAccess", "tags": [ "factories" ], "description": "Get Data Plane access.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "policy", "in": "body", "description": "Data Plane user access policy definition.", "required": true, "schema": { "$ref": "#/definitions/UserAccessPolicy" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessPolicyResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Factories_GetDataPlaneAccess": { "$ref": "./examples/Factories_GetDataPlaneAccess.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getFeatureValue": { "post": { "operationId": "ExposureControl_GetFeatureValueByFactory", "tags": [ "exposureControl" ], "description": "Get exposure control feature for specific factory.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "exposureControlRequest", "in": "body", "description": "The exposure control request.", "required": true, "schema": { "$ref": "#/definitions/ExposureControlRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExposureControlResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ExposureControl_GetFeatureValueByFactory": { "$ref": "./examples/ExposureControl_GetFeatureValueByFactory.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getGitHubAccessToken": { "post": { "operationId": "Factories_GetGitHubAccessToken", "tags": [ "factories" ], "description": "Get GitHub Access Token.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "gitHubAccessTokenRequest", "in": "body", "description": "Get GitHub access token request definition.", "required": true, "schema": { "$ref": "#/definitions/GitHubAccessTokenRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GitHubAccessTokenResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Factories_GetGitHubAccessToken": { "$ref": "./examples/Factories_GetGitHubAccessToken.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters": { "get": { "operationId": "GlobalParameters_ListByFactory", "tags": [ "globalParameters" ], "description": "Lists Global parameters", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GlobalParameterListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "GlobalParameters_ListByFactory": { "$ref": "./examples/GlobalParameters_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}": { "get": { "operationId": "GlobalParameters_Get", "tags": [ "globalParameters" ], "description": "Gets a Global parameter", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "globalParameterName", "in": "path", "description": "The global parameter name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GlobalParameterResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "GlobalParameters_Get": { "$ref": "./examples/GlobalParameters_Get.json" } } }, "put": { "operationId": "GlobalParameters_CreateOrUpdate", "tags": [ "globalParameters" ], "description": "Creates or updates a Global parameter", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "globalParameterName", "in": "path", "description": "The global parameter name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "default", "in": "body", "description": "Global parameter resource definition.", "required": true, "schema": { "$ref": "#/definitions/GlobalParameterResource" } } ], "responses": { "200": { "description": "Resource 'GlobalParameterResource' update operation succeeded", "schema": { "$ref": "#/definitions/GlobalParameterResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "GlobalParameters_Create": { "$ref": "./examples/GlobalParameters_Create.json" }, "GlobalParameters_Update": { "$ref": "./examples/GlobalParameters_Update.json" } } }, "delete": { "operationId": "GlobalParameters_Delete", "tags": [ "globalParameters" ], "description": "Deletes a Global parameter", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "globalParameterName", "in": "path", "description": "The global parameter name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "GlobalParameters_Delete": { "$ref": "./examples/GlobalParameters_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes": { "get": { "operationId": "IntegrationRuntimes_ListByFactory", "tags": [ "integrationRuntimes" ], "description": "Lists integration runtimes.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_ListByFactory": { "$ref": "./examples/IntegrationRuntimes_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}": { "get": { "operationId": "IntegrationRuntimes_Get", "tags": [ "integrationRuntimes" ], "description": "Gets an integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeResource" } }, "304": { "description": "The client has made a conditional request and the resource has not been modified." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_Get": { "$ref": "./examples/IntegrationRuntimes_Get.json" } } }, "put": { "operationId": "IntegrationRuntimes_CreateOrUpdate", "tags": [ "integrationRuntimes" ], "description": "Creates or updates an integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "if-match", "in": "header", "description": "ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "integrationRuntime", "in": "body", "description": "Integration runtime resource definition.", "required": true, "schema": { "$ref": "#/definitions/IntegrationRuntimeResource" } } ], "responses": { "200": { "description": "Resource 'IntegrationRuntimeResource' update operation succeeded", "schema": { "$ref": "#/definitions/IntegrationRuntimeResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_Create": { "$ref": "./examples/IntegrationRuntimes_Create.json" } } }, "patch": { "operationId": "IntegrationRuntimes_Update", "tags": [ "integrationRuntimes" ], "description": "Updates an integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "updateIntegrationRuntimeRequest", "in": "body", "description": "The parameters for updating an integration runtime.", "required": true, "schema": { "$ref": "#/definitions/UpdateIntegrationRuntimeRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_Update": { "$ref": "./examples/IntegrationRuntimes_Update.json" } } }, "delete": { "operationId": "IntegrationRuntimes_Delete", "tags": [ "integrationRuntimes" ], "description": "Deletes an integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_Delete": { "$ref": "./examples/IntegrationRuntimes_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/disableInteractiveQuery": { "post": { "operationId": "IntegrationRuntime_DisableInteractiveQuery", "tags": [ "integrationRuntimeDisableInteractiveQuery" ], "description": "Disable interactive authoring of Managed Virtual Network integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeResource" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "IntegrationRuntime_DisableInteractiveQuery": { "$ref": "./examples/IntegrationRuntimes_DisableInteractiveQuery.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/IntegrationRuntimeResource" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/enableInteractiveQuery": { "post": { "operationId": "IntegrationRuntime_EnableInteractiveQuery", "tags": [ "integrationRuntimeEnableInteractiveQuery" ], "description": "Enable interactive authoring of Managed Virtual Network integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "enableInteractiveQueryRequest", "in": "body", "description": "The enable interactive authoring integration runtime properties.", "required": true, "schema": { "$ref": "#/definitions/EnableInteractiveQueryRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeResource" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "IntegrationRuntime_EnableInteractiveQuery": { "$ref": "./examples/IntegrationRuntimes_EnableInteractiveQuery.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/IntegrationRuntimeResource" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo": { "post": { "operationId": "IntegrationRuntimes_GetConnectionInfo", "tags": [ "integrationRuntimes" ], "description": "Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeConnectionInfo" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_GetConnectionInfo": { "$ref": "./examples/IntegrationRuntimes_GetConnectionInfo.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata": { "post": { "operationId": "IntegrationRuntimeObjectMetadata_Get", "tags": [ "integrationRuntimeObjectMetadata" ], "description": "Get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "getMetadataRequest", "in": "body", "description": "The parameters for getting a SSIS object metadata.", "required": false, "schema": { "$ref": "#/definitions/GetSsisObjectMetadataRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SsisObjectMetadataListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimeObjectMetadata_Get": { "$ref": "./examples/IntegrationRuntimeObjectMetadata_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus": { "post": { "operationId": "IntegrationRuntimes_GetStatus", "tags": [ "integrationRuntimes" ], "description": "Gets detailed status information for an integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeStatusResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_GetStatus": { "$ref": "./examples/IntegrationRuntimes_GetStatus.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/linkedIntegrationRuntime": { "post": { "operationId": "IntegrationRuntimes_CreateLinkedIntegrationRuntime", "tags": [ "integrationRuntimes" ], "description": "Create a linked integration runtime entry in a shared integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "createLinkedIntegrationRuntimeRequest", "in": "body", "description": "The linked integration runtime properties.", "required": true, "schema": { "$ref": "#/definitions/CreateLinkedIntegrationRuntimeRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeStatusResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_CreateLinkedIntegrationRuntime": { "$ref": "./examples/IntegrationRuntimes_CreateLinkedIntegrationRuntime.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys": { "post": { "operationId": "IntegrationRuntimes_ListAuthKeys", "tags": [ "integrationRuntimes" ], "description": "Retrieves the authentication keys for an integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeAuthKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_ListAuthKeys": { "$ref": "./examples/IntegrationRuntimes_ListAuthKeys.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData": { "post": { "operationId": "IntegrationRuntimes_GetMonitoringData", "tags": [ "integrationRuntimes" ], "description": "Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeMonitoringData" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_GetMonitoringData": { "$ref": "./examples/IntegrationRuntimes_GetMonitoringData.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}": { "get": { "operationId": "IntegrationRuntimeNodes_Get", "tags": [ "integrationRuntimeNodes" ], "description": "Gets a self-hosted integration runtime node.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "nodeName", "in": "path", "description": "The integration runtime node name.", "required": true, "type": "string", "minLength": 1, "maxLength": 150, "pattern": "^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SelfHostedIntegrationRuntimeNode" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimeNodes_Get": { "$ref": "./examples/IntegrationRuntimeNodes_Get.json" } } }, "patch": { "operationId": "IntegrationRuntimeNodes_Update", "tags": [ "integrationRuntimeNodes" ], "description": "Updates a self-hosted integration runtime node.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "nodeName", "in": "path", "description": "The integration runtime node name.", "required": true, "type": "string", "minLength": 1, "maxLength": 150, "pattern": "^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$" }, { "name": "updateIntegrationRuntimeNodeRequest", "in": "body", "description": "The parameters for updating an integration runtime node.", "required": true, "schema": { "$ref": "#/definitions/UpdateIntegrationRuntimeNodeRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SelfHostedIntegrationRuntimeNode" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimeNodes_Update": { "$ref": "./examples/IntegrationRuntimeNodes_Update.json" } } }, "delete": { "operationId": "IntegrationRuntimeNodes_Delete", "tags": [ "integrationRuntimeNodes" ], "description": "Deletes a self-hosted integration runtime node.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "nodeName", "in": "path", "description": "The integration runtime node name.", "required": true, "type": "string", "minLength": 1, "maxLength": 150, "pattern": "^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$" } ], "responses": { "200": { "description": "The request has succeeded." }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimesNodes_Delete": { "$ref": "./examples/IntegrationRuntimeNodes_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress": { "post": { "operationId": "IntegrationRuntimeNodes_GetIpAddress", "tags": [ "integrationRuntimeNodes" ], "description": "Get the IP address of self-hosted integration runtime node.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "nodeName", "in": "path", "description": "The integration runtime node name.", "required": true, "type": "string", "minLength": 1, "maxLength": 150, "pattern": "^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeNodeIpAddress" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimeNodes_GetIpAddress": { "$ref": "./examples/IntegrationRuntimeNodes_GetIpAddress.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints": { "get": { "operationId": "IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints", "tags": [ "integrationRuntimes" ], "description": "Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_OutboundNetworkDependenciesEndpoints": { "$ref": "./examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata": { "post": { "operationId": "IntegrationRuntimeObjectMetadata_Refresh", "tags": [ "integrationRuntimeObjectMetadata" ], "description": "Refresh a SSIS integration runtime object metadata.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SsisObjectMetadataStatusResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimeObjectMetadata_Refresh": { "$ref": "./examples/IntegrationRuntimeObjectMetadata_Refresh.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/SsisObjectMetadataStatusResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey": { "post": { "operationId": "IntegrationRuntimes_RegenerateAuthKey", "tags": [ "integrationRuntimes" ], "description": "Regenerates the authentication key for an integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "regenerateKeyParameters", "in": "body", "description": "The parameters for regenerating integration runtime authentication key.", "required": true, "schema": { "$ref": "#/definitions/IntegrationRuntimeRegenerateKeyParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeAuthKeys" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_RegenerateAuthKey": { "$ref": "./examples/IntegrationRuntimes_RegenerateAuthKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeLinks": { "post": { "operationId": "IntegrationRuntimes_RemoveLinks", "tags": [ "integrationRuntimes" ], "description": "Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "linkedIntegrationRuntimeRequest", "in": "body", "description": "The data factory name for the linked integration runtime.", "required": true, "schema": { "$ref": "#/definitions/LinkedIntegrationRuntimeRequest" } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_Upgrade": { "$ref": "./examples/IntegrationRuntimes_RemoveLinks.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start": { "post": { "operationId": "IntegrationRuntimes_Start", "tags": [ "integrationRuntimes" ], "description": "Starts a ManagedReserved type integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IntegrationRuntimeStatusResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_Start": { "$ref": "./examples/IntegrationRuntimes_Start.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/IntegrationRuntimeStatusResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop": { "post": { "operationId": "IntegrationRuntimes_Stop", "tags": [ "integrationRuntimes" ], "description": "Stops a ManagedReserved type integration runtime.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_Stop": { "$ref": "./examples/IntegrationRuntimes_Stop.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials": { "post": { "operationId": "IntegrationRuntimes_SyncCredentials", "tags": [ "integrationRuntimes" ], "description": "Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_SyncCredentials": { "$ref": "./examples/IntegrationRuntimes_SyncCredentials.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade": { "post": { "operationId": "IntegrationRuntimes_Upgrade", "tags": [ "integrationRuntimes" ], "description": "Upgrade self-hosted integration runtime to latest version if availability.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "integrationRuntimeName", "in": "path", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "IntegrationRuntimes_Upgrade": { "$ref": "./examples/IntegrationRuntimes_Upgrade.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices": { "get": { "operationId": "LinkedServices_ListByFactory", "tags": [ "linkedServices" ], "description": "Lists linked services.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LinkedServiceListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "LinkedServices_ListByFactory": { "$ref": "./examples/LinkedServices_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}": { "get": { "operationId": "LinkedServices_Get", "tags": [ "linkedServices" ], "description": "Gets a linked service.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "linkedServiceName", "in": "path", "description": "The linked service name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LinkedServiceResource" } }, "304": { "description": "The client has made a conditional request and the resource has not been modified." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "LinkedServices_Get": { "$ref": "./examples/LinkedServices_Get.json" } } }, "put": { "operationId": "LinkedServices_CreateOrUpdate", "tags": [ "linkedServices" ], "description": "Creates or updates a linked service.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "linkedServiceName", "in": "path", "description": "The linked service name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-match", "in": "header", "description": "ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "linkedService", "in": "body", "description": "Linked service resource definition.", "required": true, "schema": { "$ref": "#/definitions/LinkedServiceResource" } } ], "responses": { "200": { "description": "Resource 'LinkedServiceResource' update operation succeeded", "schema": { "$ref": "#/definitions/LinkedServiceResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "LinkedServices_Create": { "$ref": "./examples/LinkedServices_Create.json" }, "LinkedServices_Update": { "$ref": "./examples/LinkedServices_Update.json" } } }, "delete": { "operationId": "LinkedServices_Delete", "tags": [ "linkedServices" ], "description": "Deletes a linked service.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "linkedServiceName", "in": "path", "description": "The linked service name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "LinkedServices_Delete": { "$ref": "./examples/LinkedServices_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks": { "get": { "operationId": "ManagedVirtualNetworks_ListByFactory", "tags": [ "managedVirtualNetworks" ], "description": "Lists managed Virtual Networks.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedVirtualNetworkListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ManagedVirtualNetworks_ListByFactory": { "$ref": "./examples/ManagedVirtualNetworks_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}": { "get": { "operationId": "ManagedVirtualNetworks_Get", "tags": [ "managedVirtualNetworks" ], "description": "Gets a managed Virtual Network.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "managedVirtualNetworkName", "in": "path", "description": "Managed virtual network name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the managed Virtual Network entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedVirtualNetworkResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ManagedVirtualNetworks_Get": { "$ref": "./examples/ManagedVirtualNetworks_Get.json" } } }, "put": { "operationId": "ManagedVirtualNetworks_CreateOrUpdate", "tags": [ "managedVirtualNetworks" ], "description": "Creates or updates a managed Virtual Network.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "managedVirtualNetworkName", "in": "path", "description": "Managed virtual network name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" }, { "name": "if-match", "in": "header", "description": "ETag of the managed Virtual Network entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "managedVirtualNetwork", "in": "body", "description": "Managed Virtual Network resource definition.", "required": true, "schema": { "$ref": "#/definitions/ManagedVirtualNetworkResource" } } ], "responses": { "200": { "description": "Resource 'ManagedVirtualNetworkResource' update operation succeeded", "schema": { "$ref": "#/definitions/ManagedVirtualNetworkResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ManagedVirtualNetworks_Create": { "$ref": "./examples/ManagedVirtualNetworks_Create.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints": { "get": { "operationId": "ManagedPrivateEndpoints_ListByFactory", "tags": [ "managedPrivateEndpoints" ], "description": "Lists managed private endpoints.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "managedVirtualNetworkName", "in": "path", "description": "Managed virtual network name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/managedPrivateEndpointListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ManagedPrivateEndpoints_ListByFactory": { "$ref": "./examples/ManagedPrivateEndpoints_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}": { "get": { "operationId": "ManagedPrivateEndpoints_Get", "tags": [ "managedPrivateEndpoints" ], "description": "Gets a managed private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "managedVirtualNetworkName", "in": "path", "description": "Managed virtual network name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" }, { "name": "managedPrivateEndpointName", "in": "path", "description": "Managed private endpoint name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the managed private endpoint entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedPrivateEndpointResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ManagedPrivateEndpoints_Get": { "$ref": "./examples/ManagedPrivateEndpoints_Get.json" } } }, "put": { "operationId": "ManagedPrivateEndpoints_CreateOrUpdate", "tags": [ "managedPrivateEndpoints" ], "description": "Creates or updates a managed private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "managedVirtualNetworkName", "in": "path", "description": "Managed virtual network name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" }, { "name": "managedPrivateEndpointName", "in": "path", "description": "Managed private endpoint name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" }, { "name": "if-match", "in": "header", "description": "ETag of the managed private endpoint entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "managedPrivateEndpoint", "in": "body", "description": "Managed private endpoint resource definition.", "required": true, "schema": { "$ref": "#/definitions/ManagedPrivateEndpointResource" } } ], "responses": { "200": { "description": "Resource 'ManagedPrivateEndpointResource' update operation succeeded", "schema": { "$ref": "#/definitions/ManagedPrivateEndpointResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ManagedVirtualNetworks_Create": { "$ref": "./examples/ManagedPrivateEndpoints_Create.json" } } }, "delete": { "operationId": "ManagedPrivateEndpoints_Delete", "tags": [ "managedPrivateEndpoints" ], "description": "Deletes a managed private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "managedVirtualNetworkName", "in": "path", "description": "Managed virtual network name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" }, { "name": "managedPrivateEndpointName", "in": "path", "description": "Managed private endpoint name", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ManagedVirtualNetworks_Delete": { "$ref": "./examples/ManagedPrivateEndpoints_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}": { "get": { "operationId": "PipelineRuns_Get", "tags": [ "pipelineruns" ], "description": "Get a pipeline run by its run ID.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "runId", "in": "path", "description": "The pipeline run identifier.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PipelineRun" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "PipelineRuns_Get": { "$ref": "./examples/PipelineRuns_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel": { "post": { "operationId": "PipelineRuns_Cancel", "tags": [ "pipelineruns" ], "description": "Cancel a pipeline run by its run ID.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "runId", "in": "path", "description": "The pipeline run identifier.", "required": true, "type": "string" }, { "name": "isRecursive", "in": "query", "description": "If true, cancel all the Child pipelines that are triggered by the current pipeline.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "PipelineRuns_Cancel": { "$ref": "./examples/PipelineRuns_Cancel.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns": { "post": { "operationId": "ActivityRuns_QueryByPipelineRun", "tags": [ "activityruns" ], "description": "Query activity runs based on input filter conditions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "runId", "in": "path", "description": "The pipeline run identifier.", "required": true, "type": "string" }, { "name": "filterParameters", "in": "body", "description": "Parameters to filter the activity runs.", "required": true, "schema": { "$ref": "#/definitions/RunFilterParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ActivityRunsQueryResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ActivityRuns_QueryByPipelineRun": { "$ref": "./examples/ActivityRuns_QueryByPipelineRun.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines": { "get": { "operationId": "Pipelines_ListByFactory", "tags": [ "pipelines" ], "description": "Lists pipelines.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PipelineListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Pipelines_ListByFactory": { "$ref": "./examples/Pipelines_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}": { "get": { "operationId": "Pipelines_Get", "tags": [ "pipelines" ], "description": "Gets a pipeline.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "pipelineName", "in": "path", "description": "The pipeline name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PipelineResource" } }, "304": { "description": "The client has made a conditional request and the resource has not been modified." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Pipelines_Get": { "$ref": "./examples/Pipelines_Get.json" } } }, "put": { "operationId": "Pipelines_CreateOrUpdate", "tags": [ "pipelines" ], "description": "Creates or updates a pipeline.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "pipelineName", "in": "path", "description": "The pipeline name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-match", "in": "header", "description": "ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "pipeline", "in": "body", "description": "Pipeline resource definition.", "required": true, "schema": { "$ref": "#/definitions/PipelineResource" } } ], "responses": { "200": { "description": "Resource 'PipelineResource' update operation succeeded", "schema": { "$ref": "#/definitions/PipelineResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Pipelines_Create": { "$ref": "./examples/Pipelines_Create.json" }, "Pipelines_Update": { "$ref": "./examples/Pipelines_Update.json" } } }, "delete": { "operationId": "Pipelines_Delete", "tags": [ "pipelines" ], "description": "Deletes a pipeline.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "pipelineName", "in": "path", "description": "The pipeline name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Pipelines_Delete": { "$ref": "./examples/Pipelines_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun": { "post": { "operationId": "Pipelines_CreateRun", "tags": [ "pipelines" ], "description": "Creates a run of a pipeline.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "pipelineName", "in": "path", "description": "The pipeline name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "referencePipelineRunId", "in": "query", "description": "The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.", "required": false, "type": "string" }, { "name": "isRecovery", "in": "query", "description": "Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.", "required": false, "type": "boolean" }, { "name": "startActivityName", "in": "query", "description": "In recovery mode, the rerun will start from this activity. If not specified, all activities will run.", "required": false, "type": "string" }, { "name": "startFromFailure", "in": "query", "description": "In recovery mode, if set to true, the rerun will start from failed activities. The property will be used only if startActivityName is not specified.", "required": false, "type": "boolean" }, { "name": "parameters", "in": "body", "description": "Parameters of the pipeline run. These parameters will be used only if the runId is not specified.", "required": false, "schema": { "type": "object", "additionalProperties": {} } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CreateRunResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Pipelines_CreateRun": { "$ref": "./examples/Pipelines_CreateRun.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections": { "get": { "operationId": "privateEndPointConnections_ListByFactory", "tags": [ "privateEndPointConnections" ], "description": "Lists Private endpoint connections", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "privateEndPointConnections_ListByFactory": { "$ref": "./examples/PrivateEndPointConnections_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "PrivateEndpointConnection_Get", "tags": [ "privateEndpointConnections" ], "description": "Gets a private endpoint connection", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The private endpoint connection name.", "required": true, "type": "string" }, { "name": "if-none-match", "in": "header", "description": "ETag of the private endpoint connection entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Get a private endpoint connection for a datafactory.": { "$ref": "./examples/GetPrivateEndpointConnection.json" } } }, "put": { "operationId": "PrivateEndpointConnection_CreateOrUpdate", "tags": [ "privateEndpointConnections" ], "description": "Approves or rejects a private endpoint connection", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The private endpoint connection name.", "required": true, "type": "string" }, { "name": "if-match", "in": "header", "description": "ETag of the private endpoint connection entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "privateEndpointWrapper", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/PrivateLinkConnectionApprovalRequestResource" } } ], "responses": { "200": { "description": "Resource 'PrivateEndpointConnectionResource' update operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Approves or rejects a private endpoint connection for a factory.": { "$ref": "./examples/ApproveRejectPrivateEndpointConnection.json" } } }, "delete": { "operationId": "PrivateEndpointConnection_Delete", "tags": [ "privateEndpointConnections" ], "description": "Deletes a private endpoint connection", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The private endpoint connection name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Delete a private endpoint connection for a datafactory.": { "$ref": "./examples/DeletePrivateEndpointConnection.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateLinkResources": { "get": { "operationId": "privateLinkResources_Get", "tags": [ "privateLinkResources" ], "description": "Gets the private link resources", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResourcesWrapper" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Get private link resources of a site": { "$ref": "./examples/GetPrivateLinkResources.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryDataFlowDebugSessions": { "post": { "operationId": "DataFlowDebugSession_QueryByFactory", "tags": [ "dataFlowDebugSession" ], "description": "Query all active data flow debug sessions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/QueryDataFlowDebugSessionsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "DataFlowDebugSession_QueryByFactory": { "$ref": "./examples/DataFlowDebugSession_QueryByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryFeaturesValue": { "post": { "operationId": "ExposureControl_QueryFeatureValuesByFactory", "tags": [ "exposureControl" ], "description": "Get list of exposure control features for specific factory.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "exposureControlBatchRequest", "in": "body", "description": "The exposure control request for list of features.", "required": true, "schema": { "$ref": "#/definitions/ExposureControlBatchRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExposureControlBatchResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "ExposureControl_QueryFeatureValuesByFactory": { "$ref": "./examples/ExposureControl_QueryFeatureValuesByFactory.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns": { "post": { "operationId": "PipelineRuns_QueryByFactory", "tags": [ "pipelineruns" ], "description": "Query pipeline runs in the factory based on input filter conditions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "filterParameters", "in": "body", "description": "Parameters to filter the pipeline run.", "required": true, "schema": { "$ref": "#/definitions/RunFilterParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PipelineRunsQueryResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "PipelineRuns_QueryByFactory": { "$ref": "./examples/PipelineRuns_QueryByFactory.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns": { "post": { "operationId": "TriggerRuns_QueryByFactory", "tags": [ "triggerruns" ], "description": "Query trigger runs.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "filterParameters", "in": "body", "description": "Parameters to filter the pipeline run.", "required": true, "schema": { "$ref": "#/definitions/RunFilterParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TriggerRunsQueryResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "TriggerRuns_QueryByFactory": { "$ref": "./examples/TriggerRuns_QueryByFactory.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/querytriggers": { "post": { "operationId": "Triggers_QueryByFactory", "tags": [ "triggers" ], "description": "Query triggers.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "filterParameters", "in": "body", "description": "Parameters to filter the triggers.", "required": true, "schema": { "$ref": "#/definitions/TriggerFilterParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TriggerQueryResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_QueryByFactory": { "$ref": "./examples/Triggers_QueryByFactory.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers": { "get": { "operationId": "Triggers_ListByFactory", "tags": [ "triggers" ], "description": "Lists triggers.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TriggerListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_ListByFactory": { "$ref": "./examples/Triggers_ListByFactory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}": { "get": { "operationId": "Triggers_Get", "tags": [ "trigger" ], "description": "Gets a trigger.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "triggerName", "in": "path", "description": "The trigger name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-none-match", "in": "header", "description": "ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.", "required": false, "type": "string", "x-ms-client-name": "If-None-Match" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TriggerResource" } }, "304": { "description": "The client has made a conditional request and the resource has not been modified." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_Get": { "$ref": "./examples/Triggers_Get.json" } } }, "put": { "operationId": "Triggers_CreateOrUpdate", "tags": [ "triggers" ], "description": "Creates or updates a trigger.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "triggerName", "in": "path", "description": "The trigger name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "if-match", "in": "header", "description": "ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.", "required": false, "type": "string", "x-ms-client-name": "If-Match" }, { "name": "trigger", "in": "body", "description": "Trigger resource definition.", "required": true, "schema": { "$ref": "#/definitions/TriggerResource" } } ], "responses": { "200": { "description": "Resource 'TriggerResource' update operation succeeded", "schema": { "$ref": "#/definitions/TriggerResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_Create": { "$ref": "./examples/Triggers_Create.json" }, "Triggers_Update": { "$ref": "./examples/Triggers_Update.json" } } }, "delete": { "operationId": "Triggers_Delete", "tags": [ "triggers" ], "description": "Deletes a trigger.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "triggerName", "in": "path", "description": "The trigger name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_Delete": { "$ref": "./examples/Triggers_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/getEventSubscriptionStatus": { "post": { "operationId": "Triggers_GetEventSubscriptionStatus", "tags": [ "triggers" ], "description": "Get a trigger's event subscription status.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "triggerName", "in": "path", "description": "The trigger name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TriggerSubscriptionOperationStatus" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_GetEventSubscriptionStatus": { "$ref": "./examples/Triggers_GetEventSubscriptionStatus.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/start": { "post": { "operationId": "Triggers_Start", "tags": [ "triggers" ], "description": "Starts a trigger.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "triggerName", "in": "path", "description": "The trigger name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "The request has succeeded.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_Start": { "$ref": "./examples/Triggers_Start.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/stop": { "post": { "operationId": "Triggers_Stop", "tags": [ "triggers" ], "description": "Stops a trigger.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "triggerName", "in": "path", "description": "The trigger name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "The request has succeeded.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_Stop": { "$ref": "./examples/Triggers_Stop.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/subscribeToEvents": { "post": { "operationId": "Triggers_SubscribeToEvents", "tags": [ "triggers" ], "description": "Subscribe event trigger to events.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "triggerName", "in": "path", "description": "The trigger name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TriggerSubscriptionOperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_SubscribeToEvents": { "$ref": "./examples/Triggers_SubscribeToEvents.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/TriggerSubscriptionOperationStatus" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerRuns/{runId}/cancel": { "post": { "operationId": "TriggerRuns_Cancel", "tags": [ "triggerruns" ], "description": "Cancel a single trigger instance by runId.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "triggerName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "runId", "in": "path", "description": "The pipeline run identifier.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_Cancel": { "$ref": "./examples/TriggerRuns_Cancel.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerRuns/{runId}/rerun": { "post": { "operationId": "TriggerRuns_Rerun", "tags": [ "triggerruns" ], "description": "Rerun single trigger instance by runId.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "triggerName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" }, { "name": "runId", "in": "path", "description": "The pipeline run identifier.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_Rerun": { "$ref": "./examples/TriggerRuns_Rerun.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/unsubscribeFromEvents": { "post": { "operationId": "Triggers_UnsubscribeFromEvents", "tags": [ "triggers" ], "description": "Unsubscribe event trigger from events.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "factoryName", "in": "path", "description": "The factory name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "triggerName", "in": "path", "description": "The trigger name.", "required": true, "type": "string", "minLength": 1, "maxLength": 260, "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TriggerSubscriptionOperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Triggers_UnsubscribeFromEvents": { "$ref": "./examples/Triggers_UnsubscribeFromEvents.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/TriggerSubscriptionOperationStatus" }, "x-ms-long-running-operation": true } } }, "definitions": { "AccessPolicyResponse": { "type": "object", "description": "Get Data Plane read only token response definition.", "properties": { "policy": { "$ref": "#/definitions/UserAccessPolicy", "description": "The user access policy." }, "accessToken": { "type": "string", "description": "Data Plane read only access token." }, "dataPlaneUrl": { "type": "string", "description": "Data Plane service base URL." } } }, "Activity": { "type": "object", "description": "A pipeline activity.", "properties": { "name": { "type": "string", "description": "Activity name." }, "type": { "type": "string", "description": "Type of activity." }, "description": { "type": "string", "description": "Activity description." }, "state": { "$ref": "#/definitions/ActivityState", "description": "Activity state. This is an optional property and if not provided, the state will be Active by default." }, "onInactiveMarkAs": { "$ref": "#/definitions/ActivityOnInactiveMarkAs", "description": "Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default." }, "dependsOn": { "type": "array", "description": "Activity depends on condition.", "items": { "$ref": "#/definitions/ActivityDependency" }, "x-ms-identifiers": [] }, "userProperties": { "type": "array", "description": "Activity user properties.", "items": { "$ref": "#/definitions/UserProperty" }, "x-ms-identifiers": [ "name" ] } }, "discriminator": "type", "required": [ "name", "type" ], "additionalProperties": {} }, "ActivityDependency": { "type": "object", "description": "Activity dependency information.", "properties": { "activity": { "type": "string", "description": "Activity name." }, "dependencyConditions": { "type": "array", "description": "Match-Condition for the dependency.", "items": { "$ref": "#/definitions/DependencyCondition" } } }, "required": [ "activity", "dependencyConditions" ], "additionalProperties": {} }, "ActivityOnInactiveMarkAs": { "type": "string", "description": "Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.", "enum": [ "Succeeded", "Failed", "Skipped" ], "x-ms-enum": { "name": "ActivityOnInactiveMarkAs", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Skipped", "value": "Skipped", "description": "Skipped" } ] } }, "ActivityPolicy": { "type": "object", "description": "Execution policy for an activity.", "properties": { "timeout": { "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": { "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." }, "retryIntervalInSeconds": { "type": "integer", "format": "int32", "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": {} }, "ActivityRun": { "type": "object", "description": "Information about an activity run in a pipeline.", "properties": { "pipelineName": { "type": "string", "description": "The name of the pipeline.", "readOnly": true }, "pipelineRunId": { "type": "string", "description": "The id of the pipeline run.", "readOnly": true }, "activityName": { "type": "string", "description": "The name of the activity.", "readOnly": true }, "activityType": { "type": "string", "description": "The type of the activity.", "readOnly": true }, "activityRunId": { "type": "string", "description": "The id of the activity run.", "readOnly": true }, "linkedServiceName": { "type": "string", "description": "The name of the compute linked service.", "readOnly": true }, "status": { "type": "string", "description": "The status of the activity run.", "readOnly": true }, "activityRunStart": { "type": "string", "format": "date-time", "description": "The start time of the activity run in 'ISO 8601' format.", "readOnly": true }, "activityRunEnd": { "type": "string", "format": "date-time", "description": "The end time of the activity run in 'ISO 8601' format.", "readOnly": true }, "durationInMs": { "type": "integer", "format": "int32", "description": "The duration of the activity run.", "readOnly": true }, "input": { "description": "The input for the activity.", "readOnly": true }, "output": { "description": "The output for the activity.", "readOnly": true }, "error": { "description": "The error if any from the activity run.", "readOnly": true } }, "additionalProperties": {} }, "ActivityRunsQueryResponse": { "type": "object", "description": "A list activity runs.", "properties": { "value": { "type": "array", "description": "List of activity runs.", "items": { "$ref": "#/definitions/ActivityRun" }, "x-ms-identifiers": [ "pipelineRunId" ] }, "continuationToken": { "type": "string", "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise." } }, "required": [ "value" ] }, "ActivityState": { "type": "string", "description": "Activity state. This is an optional property and if not provided, the state will be Active by default.", "enum": [ "Active", "Inactive" ], "x-ms-enum": { "name": "ActivityState", "modelAsString": true, "values": [ { "name": "Active", "value": "Active", "description": "Active" }, { "name": "Inactive", "value": "Inactive", "description": "Inactive" } ] } }, "AddDataFlowToDebugSessionResponse": { "type": "object", "description": "Response body structure for starting data flow debug session.", "properties": { "jobVersion": { "type": "string", "description": "The ID of data flow debug job version." } } }, "AdditionalColumns": { "type": "object", "description": "Specify the column name and value of additional columns.", "properties": { "name": { "description": "Additional column name. Type: string (or Expression with resultType string)." }, "value": { "description": "Additional column value. Type: string (or Expression with resultType string)." } } }, "AmazonMWSLinkedService": { "type": "object", "description": "Amazon Marketplace Web Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AmazonMWSLinkedServiceTypeProperties", "description": "Amazon Marketplace Web Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AmazonMWS" }, "AmazonMWSLinkedServiceTypeProperties": { "type": "object", "description": "Amazon Marketplace Web Service linked service properties.", "properties": { "endpoint": { "description": "The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)" }, "marketplaceID": { "description": "The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)" }, "sellerID": { "description": "The Amazon seller ID." }, "mwsAuthToken": { "$ref": "#/definitions/SecretBase", "description": "The Amazon MWS authentication token." }, "accessKeyId": { "description": "The access key id used to access data." }, "secretKey": { "$ref": "#/definitions/SecretBase", "description": "The secret key used to access data." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "endpoint", "marketplaceID", "sellerID", "accessKeyId" ] }, "AmazonMWSObjectDataset": { "type": "object", "description": "Amazon Marketplace Web Service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AmazonMWSObject" }, "AmazonMWSSource": { "type": "object", "description": "A copy activity Amazon Marketplace Web Service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "AmazonMWSSource" }, "AmazonRdsForLinkedServiceTypeProperties": { "type": "object", "description": "AmazonRdsForOracle database linked service properties.", "properties": { "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0." }, "server": { "description": "The location of AmazonRdsForOracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0." }, "authenticationType": { "$ref": "#/definitions/AmazonRdsForOracleAuthenticationType", "description": "Authentication type for connecting to the AmazonRdsForOracle database. Only used for Version 2.0." }, "username": { "description": "The AmazonRdsForOracle database username. Type: string. Only used for Version 2.0." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The Azure key vault secret reference of password in connection string." }, "encryptionClient": { "description": "Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0." }, "encryptionTypesClient": { "description": "Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0." }, "cryptoChecksumClient": { "description": "Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0." }, "cryptoChecksumTypesClient": { "description": "Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0." }, "initialLobFetchSize": { "description": "Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0." }, "fetchSize": { "description": "Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0." }, "statementCacheSize": { "description": "Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0." }, "initializationString": { "description": "Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0." }, "enableBulkLoad": { "description": "Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0." }, "supportV1DataTypes": { "description": "Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0." }, "fetchTswtzAsTimestamp": { "description": "Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "AmazonRdsForOracleAuthenticationType": { "type": "string", "description": "Authentication type for connecting to the AmazonRdsForOracle database. Only used for Version 2.0.", "enum": [ "Basic" ], "x-ms-enum": { "name": "AmazonRdsForOracleAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" } ] } }, "AmazonRdsForOracleLinkedService": { "type": "object", "description": "AmazonRdsForOracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.", "properties": { "typeProperties": { "$ref": "#/definitions/AmazonRdsForLinkedServiceTypeProperties", "description": "AmazonRdsForOracle database linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AmazonRdsForOracle" }, "AmazonRdsForOraclePartitionOption": { "type": "string", "enum": [ "None", "PhysicalPartitionsOfTable", "DynamicRange" ], "x-ms-enum": { "name": "AmazonRdsForOraclePartitionOption", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "PhysicalPartitionsOfTable", "value": "PhysicalPartitionsOfTable", "description": "PhysicalPartitionsOfTable" }, { "name": "DynamicRange", "value": "DynamicRange", "description": "DynamicRange" } ] } }, "AmazonRdsForOraclePartitionSettings": { "type": "object", "description": "The settings that will be leveraged for AmazonRdsForOracle source partitioning.", "properties": { "partitionNames": { "description": "Names of the physical partitions of AmazonRdsForOracle table." }, "partitionColumnName": { "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": { "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": { "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." } } }, "AmazonRdsForOracleSource": { "type": "object", "description": "A copy activity AmazonRdsForOracle source.", "properties": { "oracleReaderQuery": { "description": "AmazonRdsForOracle reader query. Type: string (or Expression with resultType string)." }, "queryTimeout": { "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 AmazonRdsForOracle read in parallel. Type: string (or Expression with resultType string)." }, "partitionSettings": { "$ref": "#/definitions/AmazonRdsForOraclePartitionSettings", "description": "The settings that will be leveraged for AmazonRdsForOracle source partitioning." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." }, "numberPrecision": { "description": "The decimal precision used to represent Oracle NUMBER type without precision and scale. The range is 1 to 256 and default value is 256 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0." }, "numberScale": { "description": "The decimal scale used to represent Oracle NUMBER type without precision and scale. The range is 0 to 130 and default value is 130 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "AmazonRdsForOracleSource" }, "AmazonRdsForOracleTableDataset": { "type": "object", "description": "The AmazonRdsForOracle database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AmazonRdsForOracleTableDatasetTypeProperties", "description": "AmazonRdsForOracle dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AmazonRdsForOracleTable" }, "AmazonRdsForOracleTableDatasetTypeProperties": { "type": "object", "description": "AmazonRdsForOracle dataset properties.", "properties": { "schema": { "description": "The schema name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string)." } } }, "AmazonRdsForSqlAuthenticationType": { "type": "string", "description": "The type used for authentication. Type: string.", "enum": [ "SQL", "Windows" ], "x-ms-enum": { "name": "AmazonRdsForSqlAuthenticationType", "modelAsString": true, "values": [ { "name": "SQL", "value": "SQL", "description": "SQL" }, { "name": "Windows", "value": "Windows", "description": "Windows" } ] } }, "AmazonRdsForSqlServerLinkedService": { "type": "object", "description": "Amazon RDS for SQL Server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AmazonRdsForSqlServerLinkedServiceTypeProperties", "description": "Amazon RDS for SQL Server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AmazonRdsForSqlServer" }, "AmazonRdsForSqlServerLinkedServiceTypeProperties": { "type": "object", "description": "Amazon Rds for SQL Server linked service properties.", "properties": { "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "authenticationType": { "$ref": "#/definitions/AmazonRdsForSqlAuthenticationType", "description": "The type used for authentication. Type: string." }, "userName": { "description": "The on-premises Windows authentication user name. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The on-premises Windows authentication password." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "alwaysEncryptedSettings": { "$ref": "#/definitions/SqlAlwaysEncryptedProperties", "description": "Sql always encrypted properties." } }, "allOf": [ { "$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties" } ] }, "AmazonRdsForSqlServerSource": { "type": "object", "description": "A copy activity Amazon RDS for SQL Server source.", "properties": { "sqlReaderQuery": { "description": "SQL reader query. Type: string (or Expression with resultType string)." }, "sqlReaderStoredProcedureName": { "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\"}}\"." }, "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)." }, "produceAdditionalTypes": { "description": "Which additional types to produce." }, "partitionOption": { "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\"." }, "partitionSettings": { "$ref": "#/definitions/SqlPartitionSettings", "description": "The settings that will be leveraged for Sql source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "AmazonRdsForSqlServerSource" }, "AmazonRdsForSqlServerTableDataset": { "type": "object", "description": "The Amazon RDS for SQL Server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AmazonRdsForSqlServerTableDatasetTypeProperties", "description": "The Amazon RDS for SQL Server dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AmazonRdsForSqlServerTable" }, "AmazonRdsForSqlServerTableDatasetTypeProperties": { "type": "object", "description": "The Amazon RDS for SQL Server dataset properties.", "properties": { "schema": { "description": "The schema name of the SQL Server dataset. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the SQL Server dataset. Type: string (or Expression with resultType string)." } } }, "AmazonRedshiftLinkedService": { "type": "object", "description": "Linked service for Amazon Redshift.", "properties": { "typeProperties": { "$ref": "#/definitions/AmazonRedshiftLinkedServiceTypeProperties", "description": "Amazon Redshift linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AmazonRedshift" }, "AmazonRedshiftLinkedServiceTypeProperties": { "type": "object", "description": "Amazon Redshift linked service properties.", "properties": { "server": { "description": "The name of the Amazon Redshift server. Type: string (or Expression with resultType string)." }, "username": { "description": "The username of the Amazon Redshift source. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password of the Amazon Redshift source." }, "database": { "description": "The database name of the Amazon Redshift source. Type: string (or Expression with resultType string)." }, "port": { "description": "The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "server", "database" ] }, "AmazonRedshiftSource": { "type": "object", "description": "A copy activity source for Amazon Redshift Source.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." }, "redshiftUnloadSettings": { "$ref": "#/definitions/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." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "AmazonRedshiftSource" }, "AmazonRedshiftTableDataset": { "type": "object", "description": "The Amazon Redshift table dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AmazonRedshiftTableDatasetTypeProperties", "description": "Amazon Redshift table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AmazonRedshiftTable" }, "AmazonRedshiftTableDatasetTypeProperties": { "type": "object", "description": "Amazon Redshift table dataset properties.", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The Amazon Redshift table name. Type: string (or Expression with resultType string)." }, "schema": { "description": "The Amazon Redshift schema name. Type: string (or Expression with resultType string)." } } }, "AmazonS3CompatibleLinkedService": { "type": "object", "description": "Linked service for Amazon S3 Compatible.", "properties": { "typeProperties": { "$ref": "#/definitions/AmazonS3CompatibleLinkedServiceTypeProperties", "description": "Amazon S3 Compatible linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AmazonS3Compatible" }, "AmazonS3CompatibleLinkedServiceTypeProperties": { "type": "object", "description": "Amazon S3 Compatible linked service properties.", "properties": { "accessKeyId": { "description": "The access key identifier of the Amazon S3 Compatible Identity and Access Management (IAM) user. Type: string (or Expression with resultType string)." }, "secretAccessKey": { "$ref": "#/definitions/SecretBase", "description": "The secret access key of the Amazon S3 Compatible Identity and Access Management (IAM) user." }, "serviceUrl": { "description": "This value specifies the endpoint to access with the Amazon S3 Compatible Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string)." }, "forcePathStyle": { "description": "If true, use S3 path-style access instead of virtual hosted-style access. Default value is false. Type: boolean (or Expression with resultType boolean)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "AmazonS3CompatibleLocation": { "type": "object", "description": "The location of Amazon S3 Compatible dataset.", "properties": { "bucketName": { "description": "Specify the bucketName of Amazon S3 Compatible. Type: string (or Expression with resultType string)" }, "version": { "description": "Specify the version of Amazon S3 Compatible. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "AmazonS3CompatibleLocation" }, "AmazonS3CompatibleReadSettings": { "type": "object", "description": "Amazon S3 Compatible read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "Amazon S3 Compatible wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "Amazon S3 Compatible wildcardFileName. Type: string (or Expression with resultType string)." }, "prefix": { "description": "The prefix filter for the S3 Compatible object name. Type: string (or Expression with resultType string)." }, "fileListPath": { "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": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "AmazonS3CompatibleReadSettings" }, "AmazonS3Dataset": { "type": "object", "description": "A single Amazon Simple Storage Service (S3) object or a set of S3 objects.", "properties": { "typeProperties": { "$ref": "#/definitions/AmazonS3DatasetTypeProperties", "description": "Amazon S3 dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AmazonS3Object" }, "AmazonS3DatasetTypeProperties": { "type": "object", "description": "Amazon S3 dataset properties.", "properties": { "bucketName": { "description": "The name of the Amazon S3 bucket. Type: string (or Expression with resultType string)." }, "key": { "description": "The key of the Amazon S3 object. Type: string (or Expression with resultType string)." }, "prefix": { "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." }, "version": { "description": "The version for the S3 object. Type: string (or Expression with resultType string)." }, "modifiedDatetimeStart": { "description": "The start of S3 object's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of S3 object's modified datetime. Type: string (or Expression with resultType string)." }, "format": { "$ref": "#/definitions/DatasetStorageFormat", "description": "The format of files." }, "compression": { "$ref": "#/definitions/DatasetCompression", "description": "The data compression method used for the Amazon S3 object." } }, "required": [ "bucketName" ] }, "AmazonS3LinkedService": { "type": "object", "description": "Linked service for Amazon S3.", "properties": { "typeProperties": { "$ref": "#/definitions/AmazonS3LinkedServiceTypeProperties", "description": "Amazon S3 linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AmazonS3" }, "AmazonS3LinkedServiceTypeProperties": { "type": "object", "description": "Amazon S3 linked service properties.", "properties": { "authenticationType": { "description": "The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string)." }, "accessKeyId": { "description": "The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string)." }, "secretAccessKey": { "$ref": "#/definitions/SecretBase", "description": "The secret access key of the Amazon S3 Identity and Access Management (IAM) user." }, "serviceUrl": { "description": "This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string)." }, "sessionToken": { "$ref": "#/definitions/SecretBase", "description": "The session token for the S3 temporary security credential." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "AmazonS3Location": { "type": "object", "description": "The location of amazon S3 dataset.", "properties": { "bucketName": { "description": "Specify the bucketName of amazon S3. Type: string (or Expression with resultType string)" }, "version": { "description": "Specify the version of amazon S3. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "AmazonS3Location" }, "AmazonS3ReadSettings": { "type": "object", "description": "Amazon S3 read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "AmazonS3 wildcardFileName. Type: string (or Expression with resultType string)." }, "prefix": { "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." }, "fileListPath": { "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": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "AmazonS3ReadSettings" }, "AppFiguresLinkedService": { "type": "object", "description": "Linked service for AppFigures.", "properties": { "typeProperties": { "$ref": "#/definitions/AppFiguresLinkedServiceTypeProperties", "description": "AppFigures linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AppFigures" }, "AppFiguresLinkedServiceTypeProperties": { "type": "object", "description": "AppFigures linked service type properties.", "properties": { "userName": { "description": "The username of the Appfigures source. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password of the AppFigures source." }, "clientKey": { "$ref": "#/definitions/SecretBase", "description": "The client key for the AppFigures source." } }, "required": [ "userName", "password", "clientKey" ] }, "AppendVariableActivity": { "type": "object", "description": "Append value for a Variable of type Array.", "properties": { "typeProperties": { "$ref": "#/definitions/AppendVariableActivityTypeProperties", "description": "Append Variable activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "AppendVariable" }, "AppendVariableActivityTypeProperties": { "type": "object", "description": "AppendVariable activity properties.", "properties": { "variableName": { "type": "string", "description": "Name of the variable whose value needs to be appended to." }, "value": { "description": "Value to be appended. Type: could be a static value matching type of the variable item or Expression with resultType matching type of the variable item" } } }, "ArmIdWrapper": { "type": "object", "description": "A wrapper for an ARM resource id", "properties": { "id": { "type": "string", "readOnly": true } } }, "AsanaLinkedService": { "type": "object", "description": "Linked service for Asana.", "properties": { "typeProperties": { "$ref": "#/definitions/AsanaLinkedServiceTypeProperties", "description": "Asana linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Asana" }, "AsanaLinkedServiceTypeProperties": { "type": "object", "description": "Asana linked service type properties.", "properties": { "apiToken": { "$ref": "#/definitions/SecretBase", "description": "The api token for the Asana source." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "apiToken" ] }, "AvroCompressionCodec": { "type": "string", "enum": [ "none", "deflate", "snappy", "xz", "bzip2" ], "x-ms-enum": { "name": "AvroCompressionCodec", "modelAsString": true, "values": [ { "name": "none", "value": "none", "description": "none" }, { "name": "deflate", "value": "deflate", "description": "deflate" }, { "name": "snappy", "value": "snappy", "description": "snappy" }, { "name": "xz", "value": "xz", "description": "xz" }, { "name": "bzip2", "value": "bzip2", "description": "bzip2" } ] } }, "AvroDataset": { "type": "object", "description": "Avro dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AvroDatasetTypeProperties", "description": "Avro dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "Avro" }, "AvroDatasetTypeProperties": { "type": "object", "description": "Avro dataset properties.", "properties": { "location": { "$ref": "#/definitions/DatasetLocation", "description": "The location of the avro storage." }, "avroCompressionCodec": { "description": "The data avroCompressionCodec. Type: string (or Expression with resultType string)." }, "avroCompressionLevel": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 9 } }, "required": [ "location" ] }, "AvroFormat": { "type": "object", "description": "The data stored in Avro format.", "allOf": [ { "$ref": "#/definitions/DatasetStorageFormat" } ], "x-ms-discriminator-value": "AvroFormat" }, "AvroSink": { "type": "object", "description": "A copy activity Avro sink.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreWriteSettings", "description": "Avro store settings." }, "formatSettings": { "$ref": "#/definitions/AvroWriteSettings", "description": "Avro format settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AvroSink" }, "AvroSource": { "type": "object", "description": "A copy activity Avro source.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreReadSettings", "description": "Avro store settings." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "AvroSource" }, "AvroWriteSettings": { "type": "object", "description": "Avro write settings.", "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." }, "maxRowsPerFile": { "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." }, "fileNamePrefix": { "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/FormatWriteSettings" } ], "x-ms-discriminator-value": "AvroWriteSettings" }, "AzPowerShellSetup": { "type": "object", "description": "The express custom setup of installing Azure PowerShell.", "properties": { "typeProperties": { "$ref": "#/definitions/AzPowerShellSetupTypeProperties", "description": "Install Azure PowerShell type properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/CustomSetupBase" } ], "x-ms-discriminator-value": "AzPowerShellSetup" }, "AzPowerShellSetupTypeProperties": { "type": "object", "description": "Installation of Azure PowerShell type properties.", "properties": { "version": { "type": "string", "description": "The required version of Azure PowerShell to install." } }, "required": [ "version" ] }, "Azure.Core.uuid": { "type": "string", "format": "uuid", "description": "Universally Unique Identifier" }, "AzureBatchLinkedService": { "type": "object", "description": "Azure Batch linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureBatchLinkedServiceTypeProperties", "description": "Azure Batch linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureBatch" }, "AzureBatchLinkedServiceTypeProperties": { "type": "object", "description": "Azure Batch linked service properties.", "properties": { "accountName": { "description": "The Azure Batch account name. Type: string (or Expression with resultType string)." }, "accessKey": { "$ref": "#/definitions/SecretBase", "description": "The Azure Batch account access key." }, "batchUri": { "description": "The Azure Batch URI. Type: string (or Expression with resultType string)." }, "poolName": { "description": "The Azure Batch pool name. Type: string (or Expression with resultType string)." }, "linkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "The Azure Storage linked service reference." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "required": [ "accountName", "batchUri", "poolName", "linkedServiceName" ] }, "AzureBlobDataset": { "type": "object", "description": "The Azure Blob storage.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureBlobDatasetTypeProperties", "description": "Azure Blob dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureBlob" }, "AzureBlobDatasetTypeProperties": { "type": "object", "description": "Azure Blob dataset properties.", "properties": { "folderPath": { "description": "The path of the Azure Blob storage. Type: string (or Expression with resultType string)." }, "tableRootLocation": { "description": "The root of blob path. Type: string (or Expression with resultType string)." }, "fileName": { "description": "The name of the Azure Blob. Type: string (or Expression with resultType string)." }, "modifiedDatetimeStart": { "description": "The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string)." }, "format": { "$ref": "#/definitions/DatasetStorageFormat", "description": "The format of the Azure Blob storage." }, "compression": { "$ref": "#/definitions/DatasetCompression", "description": "The data compression method used for the blob storage." } } }, "AzureBlobFSDataset": { "type": "object", "description": "The Azure Data Lake Storage Gen2 storage.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureBlobFSDatasetTypeProperties", "description": "Azure Data Lake Storage Gen2 dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureBlobFSFile" }, "AzureBlobFSDatasetTypeProperties": { "type": "object", "description": "Azure Data Lake Storage Gen2 dataset properties.", "properties": { "folderPath": { "description": "The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string)." }, "fileName": { "description": "The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string)." }, "format": { "$ref": "#/definitions/DatasetStorageFormat", "description": "The format of the Azure Data Lake Storage Gen2 storage." }, "compression": { "$ref": "#/definitions/DatasetCompression", "description": "The data compression method used for the blob storage." } } }, "AzureBlobFSLinkedService": { "type": "object", "description": "Azure Data Lake Storage Gen2 linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureBlobFSLinkedServiceTypeProperties", "description": "Azure Data Lake Storage Gen2 linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureBlobFS" }, "AzureBlobFSLinkedServiceTypeProperties": { "type": "object", "description": "Azure Data Lake Storage Gen2 linked service properties.", "properties": { "url": { "description": "Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string)." }, "accountKey": { "description": "Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string)." }, "servicePrincipalId": { "description": "The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "azureCloudType": { "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { "$ref": "#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "sasUri": { "description": "SAS URI of the Azure Data Lake Storage Gen2 service. Type: string, SecureString or AzureKeyVaultSecretReference." }, "sasToken": { "$ref": "#/definitions/SecretBase", "description": "The Azure key vault secret reference of sasToken in sas uri." } } }, "AzureBlobFSLocation": { "type": "object", "description": "The location of azure blobFS dataset.", "properties": { "fileSystem": { "description": "Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "AzureBlobFSLocation" }, "AzureBlobFSReadSettings": { "type": "object", "description": "Azure blobFS read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "Azure blobFS wildcardFileName. Type: string (or Expression with resultType string)." }, "fileListPath": { "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": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "AzureBlobFSReadSettings" }, "AzureBlobFSSink": { "type": "object", "description": "A copy activity Azure Data Lake Storage Gen2 sink.", "properties": { "copyBehavior": { "description": "The type of copy behavior for copy sink. Type: string (or Expression with resultType string)." }, "metadata": { "type": "array", "description": "Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).", "items": { "$ref": "#/definitions/MetadataItem" }, "x-ms-identifiers": [ "name" ] } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AzureBlobFSSink" }, "AzureBlobFSSource": { "type": "object", "description": "A copy activity Azure BlobFS source.", "properties": { "treatEmptyAsNull": { "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." }, "skipHeaderLineCount": { "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." }, "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "AzureBlobFSSource" }, "AzureBlobFSWriteSettings": { "type": "object", "description": "Azure blobFS write settings.", "properties": { "blockSizeInMB": { "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer)." } }, "allOf": [ { "$ref": "#/definitions/StoreWriteSettings" } ], "x-ms-discriminator-value": "AzureBlobFSWriteSettings" }, "AzureBlobStorageLinkedService": { "type": "object", "description": "The azure blob storage linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureBlobStorageLinkedServiceTypeProperties", "description": "Azure Blob Storage linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureBlobStorage" }, "AzureBlobStorageLinkedServiceTypeProperties": { "type": "object", "description": "Azure Blob Storage linked service properties.", "properties": { "connectionString": { "description": "The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference." }, "accountKey": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of accountKey in connection string." }, "sasUri": { "description": "SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference." }, "sasToken": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of sasToken in sas uri." }, "serviceEndpoint": { "description": "Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property." }, "servicePrincipalId": { "description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "azureCloudType": { "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." }, "accountKind": { "description": "Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." }, "authenticationType": { "$ref": "#/definitions/AzureStorageAuthenticationType", "description": "The type used for authentication. Type: string." }, "containerUri": { "description": "Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string)." } } }, "AzureBlobStorageLocation": { "type": "object", "description": "The location of azure blob dataset.", "properties": { "container": { "description": "Specify the container of azure blob. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "AzureBlobStorageLocation" }, "AzureBlobStorageReadSettings": { "type": "object", "description": "Azure blob read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "Azure blob wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "Azure blob wildcardFileName. Type: string (or Expression with resultType string)." }, "prefix": { "description": "The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string)." }, "fileListPath": { "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": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "AzureBlobStorageReadSettings" }, "AzureBlobStorageWriteSettings": { "type": "object", "description": "Azure blob write settings.", "properties": { "blockSizeInMB": { "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer)." } }, "allOf": [ { "$ref": "#/definitions/StoreWriteSettings" } ], "x-ms-discriminator-value": "AzureBlobStorageWriteSettings" }, "AzureDataExplorerCommandActivity": { "type": "object", "description": "Azure Data Explorer command activity.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureDataExplorerCommandActivityTypeProperties", "description": "Azure Data Explorer command activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "AzureDataExplorerCommand" }, "AzureDataExplorerCommandActivityTypeProperties": { "type": "object", "description": "Azure Data Explorer command activity properties.", "properties": { "command": { "description": "A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string)." }, "commandTimeout": { "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" ] }, "AzureDataExplorerDatasetTypeProperties": { "type": "object", "description": "Azure Data Explorer (Kusto) dataset properties.", "properties": { "table": { "description": "The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string)." } } }, "AzureDataExplorerLinkedService": { "type": "object", "description": "Azure Data Explorer (Kusto) linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureDataExplorerLinkedServiceTypeProperties", "description": "Azure Data Explorer (Kusto) linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureDataExplorer" }, "AzureDataExplorerLinkedServiceTypeProperties": { "type": "object", "description": "Azure Data Explorer (Kusto) linked service properties.", "properties": { "endpoint": { "description": "The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://..kusto.windows.net. Type: string (or Expression with resultType string)" }, "servicePrincipalId": { "description": "The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Kusto." }, "database": { "description": "Database name for connection. Type: string (or Expression with resultType string)." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "required": [ "endpoint", "database" ] }, "AzureDataExplorerSink": { "type": "object", "description": "A copy activity Azure Data Explorer sink.", "properties": { "ingestionMappingName": { "description": "A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string." }, "ingestionMappingAsJson": { "description": "An explicit column mapping description provided in a json format. Type: string." }, "flushImmediately": { "description": "If set to true, any aggregation will be skipped. Default is false. Type: boolean." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AzureDataExplorerSink" }, "AzureDataExplorerSource": { "type": "object", "description": "A copy activity Azure Data Explorer (Kusto) source.", "properties": { "query": { "description": "Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string)." }, "noTruncation": { "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": { "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": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "required": [ "query" ], "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "AzureDataExplorerSource" }, "AzureDataExplorerTableDataset": { "type": "object", "description": "The Azure Data Explorer (Kusto) dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureDataExplorerDatasetTypeProperties", "description": "Azure Data Explorer (Kusto) dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureDataExplorerTable" }, "AzureDataLakeAnalyticsLinkedService": { "type": "object", "description": "Azure Data Lake Analytics linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureDataLakeAnalyticsLinkedServiceTypeProperties", "description": "Azure Data Lake Analytics linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureDataLakeAnalytics" }, "AzureDataLakeAnalyticsLinkedServiceTypeProperties": { "type": "object", "description": "Azure Data Lake Analytics linked service properties.", "properties": { "accountName": { "description": "The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string)." }, "servicePrincipalId": { "description": "The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The Key of the application used to authenticate against the Azure Data Lake Analytics account." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "subscriptionId": { "description": "Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string)." }, "resourceGroupName": { "description": "Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string)." }, "dataLakeAnalyticsUri": { "description": "Azure Data Lake Analytics URI Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "accountName", "tenant" ] }, "AzureDataLakeStoreDataset": { "type": "object", "description": "Azure Data Lake Store dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureDataLakeStoreDatasetTypeProperties", "description": "Azure Data Lake Store dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureDataLakeStoreFile" }, "AzureDataLakeStoreDatasetTypeProperties": { "type": "object", "description": "Azure Data Lake Store dataset properties.", "properties": { "folderPath": { "description": "Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string)." }, "fileName": { "description": "The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string)." }, "format": { "$ref": "#/definitions/DatasetStorageFormat", "description": "The format of the Data Lake Store." }, "compression": { "$ref": "#/definitions/DatasetCompression", "description": "The data compression method used for the item(s) in the Azure Data Lake Store." } } }, "AzureDataLakeStoreLinkedService": { "type": "object", "description": "Azure Data Lake Store linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureDataLakeStoreLinkedServiceTypeProperties", "description": "Azure Data Lake Store linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureDataLakeStore" }, "AzureDataLakeStoreLinkedServiceTypeProperties": { "type": "object", "description": "Azure Data Lake Store linked service properties.", "properties": { "dataLakeStoreUri": { "description": "Data Lake Store service URI. Type: string (or Expression with resultType string)." }, "servicePrincipalId": { "description": "The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The Key of the application used to authenticate against the Azure Data Lake Store account." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "azureCloudType": { "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." }, "accountName": { "description": "Data Lake Store account name. Type: string (or Expression with resultType string)." }, "subscriptionId": { "description": "Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string)." }, "resourceGroupName": { "description": "Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "required": [ "dataLakeStoreUri" ] }, "AzureDataLakeStoreLocation": { "type": "object", "description": "The location of azure data lake store dataset.", "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "AzureDataLakeStoreLocation" }, "AzureDataLakeStoreReadSettings": { "type": "object", "description": "Azure data lake store read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "ADLS wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "ADLS wildcardFileName. Type: string (or Expression with resultType string)." }, "fileListPath": { "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)." }, "listAfter": { "description": "Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string)." }, "listBefore": { "description": "Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string)." }, "enablePartitionDiscovery": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "AzureDataLakeStoreReadSettings" }, "AzureDataLakeStoreSink": { "type": "object", "description": "A copy activity Azure Data Lake Store sink.", "properties": { "copyBehavior": { "description": "The type of copy behavior for copy sink. Type: string (or Expression with resultType string)." }, "enableAdlsSingleFileParallel": { "description": "Single File Parallel." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AzureDataLakeStoreSink" }, "AzureDataLakeStoreSource": { "type": "object", "description": "A copy activity Azure Data Lake source.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "AzureDataLakeStoreSource" }, "AzureDataLakeStoreWriteSettings": { "type": "object", "description": "Azure data lake store write settings.", "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: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/StoreWriteSettings" } ], "x-ms-discriminator-value": "AzureDataLakeStoreWriteSettings" }, "AzureDatabricksDeltaLakeDataset": { "type": "object", "description": "Azure Databricks Delta Lake dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureDatabricksDeltaLakeDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureDatabricksDeltaLakeDataset" }, "AzureDatabricksDeltaLakeDatasetTypeProperties": { "type": "object", "description": "Azure Databricks Delta Lake Dataset Properties", "properties": { "table": { "description": "The name of delta table. Type: string (or Expression with resultType string)." }, "database": { "description": "The database name of delta table. Type: string (or Expression with resultType string)." } } }, "AzureDatabricksDeltaLakeExportCommand": { "type": "object", "description": "Azure Databricks Delta Lake export command settings.", "properties": { "dateFormat": { "description": "Specify the date format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." }, "timestampFormat": { "description": "Specify the timestamp format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/ExportSettings" } ], "x-ms-discriminator-value": "AzureDatabricksDeltaLakeExportCommand" }, "AzureDatabricksDeltaLakeImportCommand": { "type": "object", "description": "Azure Databricks Delta Lake import command settings.", "properties": { "dateFormat": { "description": "Specify the date format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." }, "timestampFormat": { "description": "Specify the timestamp format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/ImportSettings" } ], "x-ms-discriminator-value": "AzureDatabricksDeltaLakeImportCommand" }, "AzureDatabricksDeltaLakeLinkedService": { "type": "object", "description": "Azure Databricks Delta Lake linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureDatabricksDetltaLakeLinkedServiceTypeProperties", "description": "Azure Databricks Delta Lake linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureDatabricksDeltaLake" }, "AzureDatabricksDeltaLakeSink": { "type": "object", "description": "A copy activity Azure Databricks Delta Lake sink.", "properties": { "preCopyScript": { "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." }, "importSettings": { "$ref": "#/definitions/AzureDatabricksDeltaLakeImportCommand", "description": "Azure Databricks Delta Lake import settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AzureDatabricksDeltaLakeSink" }, "AzureDatabricksDeltaLakeSource": { "type": "object", "description": "A copy activity Azure Databricks Delta Lake source.", "properties": { "query": { "description": "Azure Databricks Delta Lake Sql query. Type: string (or Expression with resultType string)." }, "exportSettings": { "$ref": "#/definitions/AzureDatabricksDeltaLakeExportCommand", "description": "Azure Databricks Delta Lake export settings." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "AzureDatabricksDeltaLakeSource" }, "AzureDatabricksDetltaLakeLinkedServiceTypeProperties": { "type": "object", "description": "Azure Databricks Delta Lake linked service properties.", "properties": { "domain": { "description": ".azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string)." }, "accessToken": { "$ref": "#/definitions/SecretBase", "description": "Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference." }, "clusterId": { "description": "The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." }, "workspaceResourceId": { "description": "Workspace resource id for databricks REST API. Type: string (or Expression with resultType string)." } }, "required": [ "domain" ] }, "AzureDatabricksLinkedService": { "type": "object", "description": "Azure Databricks linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureDatabricksLinkedServiceTypeProperties", "description": "Azure Databricks linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureDatabricks" }, "AzureDatabricksLinkedServiceTypeProperties": { "type": "object", "description": "Azure Databricks linked service properties.", "properties": { "domain": { "description": ".azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string)." }, "accessToken": { "$ref": "#/definitions/SecretBase", "description": "Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string)." }, "authentication": { "description": "Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string)." }, "workspaceResourceId": { "description": "Workspace resource id for databricks REST API. Type: string (or Expression with resultType string)." }, "existingClusterId": { "description": "The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string)." }, "instancePoolId": { "description": "The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string)." }, "newClusterVersion": { "description": "If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string)." }, "newClusterNumOfWorker": { "description": "If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as '2'. Required if newClusterVersion is specified. Type: string (or Expression with resultType string)." }, "newClusterNodeType": { "description": "The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string)." }, "newClusterSparkConf": { "type": "object", "description": "A set of optional, user-specified Spark configuration key-value pairs.", "additionalProperties": {} }, "newClusterSparkEnvVars": { "type": "object", "description": "A set of optional, user-specified Spark environment variables key-value pairs.", "additionalProperties": {} }, "newClusterCustomTags": { "type": "object", "description": "Additional tags for cluster resources. This property is ignored in instance pool configurations.", "additionalProperties": {} }, "newClusterLogDestination": { "description": "Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string)." }, "newClusterDriverNodeType": { "description": "The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string)." }, "newClusterInitScripts": { "description": "User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings)." }, "newClusterEnableElasticDisk": { "description": "Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "policyId": { "description": "The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string)." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." }, "dataSecurityMode": { "description": "The data security mode for the Databricks Cluster. Type: string (or Expression with resultType string)." } }, "required": [ "domain" ] }, "AzureFileStorageLinkedService": { "type": "object", "description": "Azure File Storage linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureFileStorageLinkedServiceTypeProperties", "description": "Azure File Storage linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureFileStorage" }, "AzureFileStorageLinkedServiceTypeProperties": { "type": "object", "description": "Azure File Storage linked service properties.", "properties": { "host": { "description": "Host name of the server. Type: string (or Expression with resultType string)." }, "userId": { "description": "User ID to logon the server. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to logon the server." }, "connectionString": { "description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference." }, "accountKey": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of accountKey in connection string." }, "sasUri": { "description": "SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference." }, "sasToken": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of sasToken in sas uri." }, "fileShare": { "description": "The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string)." }, "snapshot": { "description": "The azure file share snapshot version. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "serviceEndpoint": { "description": "File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } } }, "AzureFileStorageLocation": { "type": "object", "description": "The location of file server dataset.", "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "AzureFileStorageLocation" }, "AzureFileStorageReadSettings": { "type": "object", "description": "Azure File Storage read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "Azure File Storage wildcardFileName. Type: string (or Expression with resultType string)." }, "prefix": { "description": "The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string)." }, "fileListPath": { "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": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "AzureFileStorageReadSettings" }, "AzureFileStorageWriteSettings": { "type": "object", "description": "Azure File Storage write settings.", "allOf": [ { "$ref": "#/definitions/StoreWriteSettings" } ], "x-ms-discriminator-value": "AzureFileStorageWriteSettings" }, "AzureFunctionActivity": { "type": "object", "description": "Azure Function activity.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureFunctionActivityTypeProperties", "description": "Azure Function activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "AzureFunctionActivity" }, "AzureFunctionActivityMethod": { "type": "string", "description": "The list of HTTP methods supported by a AzureFunctionActivity.", "enum": [ "GET", "POST", "PUT", "DELETE", "OPTIONS", "HEAD", "TRACE" ], "x-ms-enum": { "name": "AzureFunctionActivityMethod", "modelAsString": true, "values": [ { "name": "GET", "value": "GET", "description": "GET" }, { "name": "POST", "value": "POST", "description": "POST" }, { "name": "PUT", "value": "PUT", "description": "PUT" }, { "name": "DELETE", "value": "DELETE", "description": "DELETE" }, { "name": "OPTIONS", "value": "OPTIONS", "description": "OPTIONS" }, { "name": "HEAD", "value": "HEAD", "description": "HEAD" }, { "name": "TRACE", "value": "TRACE", "description": "TRACE" } ] } }, "AzureFunctionActivityTypeProperties": { "type": "object", "description": "Azure Function activity type properties.", "properties": { "method": { "$ref": "#/definitions/AzureFunctionActivityMethod", "description": "Rest API method for target endpoint." }, "functionName": { "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).", "additionalProperties": {} }, "body": { "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" ] }, "AzureFunctionLinkedService": { "type": "object", "description": "Azure Function linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureFunctionLinkedServiceTypeProperties", "description": "Azure Function linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureFunction" }, "AzureFunctionLinkedServiceTypeProperties": { "type": "object", "description": "Azure Function linked service properties.", "properties": { "functionAppUrl": { "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net. Type: string (or Expression with resultType string)." }, "functionKey": { "$ref": "#/definitions/SecretBase", "description": "Function or Host key for Azure Function App." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." }, "resourceId": { "description": "Allowed token audiences for azure function. Type: string (or Expression with resultType string)." }, "authentication": { "description": "Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string)." } }, "required": [ "functionAppUrl" ] }, "AzureKeyVaultLinkedService": { "type": "object", "description": "Azure Key Vault linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureKeyVaultLinkedServiceTypeProperties", "description": "Azure Key Vault linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureKeyVault" }, "AzureKeyVaultLinkedServiceTypeProperties": { "type": "object", "description": "Azure Key Vault linked service properties.", "properties": { "baseUrl": { "description": "The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string)." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "required": [ "baseUrl" ] }, "AzureKeyVaultSecretReference": { "type": "object", "description": "Azure Key Vault secret reference.", "properties": { "store": { "$ref": "#/definitions/LinkedServiceReference", "description": "The Azure Key Vault linked service reference." }, "secretName": { "description": "The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string)." }, "secretVersion": { "description": "The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string)." } }, "required": [ "store", "secretName" ], "allOf": [ { "$ref": "#/definitions/SecretBase" } ], "x-ms-discriminator-value": "AzureKeyVaultSecret" }, "AzureMLBatchExecutionActivity": { "type": "object", "description": "Azure ML Batch Execution activity.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureMLBatchExecutionActivityTypeProperties", "description": "Azure ML Batch Execution activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "AzureMLBatchExecution" }, "AzureMLBatchExecutionActivityTypeProperties": { "type": "object", "description": "Azure ML Batch Execution activity properties.", "properties": { "globalParameters": { "type": "object", "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.", "additionalProperties": {} }, "webServiceOutputs": { "type": "object", "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.", "additionalProperties": { "$ref": "#/definitions/AzureMLWebServiceFile" } }, "webServiceInputs": { "type": "object", "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.", "additionalProperties": { "$ref": "#/definitions/AzureMLWebServiceFile" } } } }, "AzureMLExecutePipelineActivity": { "type": "object", "description": "Azure ML Execute Pipeline activity.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureMLExecutePipelineActivityTypeProperties", "description": "Azure ML Execute Pipeline activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "AzureMLExecutePipeline" }, "AzureMLExecutePipelineActivityTypeProperties": { "type": "object", "description": "Azure ML Execute Pipeline activity properties.", "properties": { "mlPipelineId": { "description": "ID of the published Azure ML pipeline. Type: string (or Expression with resultType string)." }, "mlPipelineEndpointId": { "description": "ID of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string)." }, "version": { "description": "Version of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string)." }, "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)." }, "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)." }, "dataPathAssignments": { "description": "Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object (or Expression with resultType 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)." }, "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)." } } }, "AzureMLLinkedService": { "type": "object", "description": "Azure ML Studio Web Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureMLLinkedServiceTypeProperties", "description": "Azure ML Studio Web Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureML" }, "AzureMLLinkedServiceTypeProperties": { "type": "object", "description": "Azure ML Studio Web Service linked service properties.", "properties": { "mlEndpoint": { "description": "The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string)." }, "apiKey": { "$ref": "#/definitions/SecretBase", "description": "The API key for accessing the Azure ML model endpoint." }, "updateResourceEndpoint": { "description": "The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string)." }, "servicePrincipalId": { "description": "The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "authentication": { "description": "Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string)." } }, "required": [ "mlEndpoint", "apiKey" ] }, "AzureMLServiceLinkedService": { "type": "object", "description": "Azure ML Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureMLServiceLinkedServiceTypeProperties", "description": "Azure ML Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureMLService" }, "AzureMLServiceLinkedServiceTypeProperties": { "type": "object", "description": "Azure ML Service linked service properties.", "properties": { "subscriptionId": { "description": "Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string)." }, "resourceGroupName": { "description": "Azure ML Service workspace resource group name. Type: string (or Expression with resultType string)." }, "mlWorkspaceName": { "description": "Azure ML Service workspace name. Type: string (or Expression with resultType string)." }, "authentication": { "description": "Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string)." }, "servicePrincipalId": { "description": "The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "subscriptionId", "resourceGroupName", "mlWorkspaceName" ] }, "AzureMLUpdateResourceActivity": { "type": "object", "description": "Azure ML Update Resource management activity.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureMLUpdateResourceActivityTypeProperties", "description": "Azure ML Update Resource management activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "AzureMLUpdateResource" }, "AzureMLUpdateResourceActivityTypeProperties": { "type": "object", "description": "Azure ML Update Resource activity properties.", "properties": { "trainedModelName": { "description": "Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string)." }, "trainedModelLinkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation." }, "trainedModelFilePath": { "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" ] }, "AzureMLWebServiceFile": { "type": "object", "description": "Azure ML WebService Input/Output file", "properties": { "filePath": { "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": { "$ref": "#/definitions/LinkedServiceReference", "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located." } }, "required": [ "filePath", "linkedServiceName" ] }, "AzureMariaDBLinkedService": { "type": "object", "description": "Azure Database for MariaDB linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureMariaDBLinkedServiceTypeProperties", "description": "Azure Database for MariaDB linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureMariaDB" }, "AzureMariaDBLinkedServiceTypeProperties": { "type": "object", "description": "Azure Database for MariaDB linked service properties.", "properties": { "connectionString": { "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "pwd": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "AzureMariaDBSource": { "type": "object", "description": "A copy activity Azure MariaDB source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "AzureMariaDBSource" }, "AzureMariaDBTableDataset": { "type": "object", "description": "Azure Database for MariaDB dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureMariaDBTable" }, "AzureMySqlLinkedService": { "type": "object", "description": "Azure MySQL database linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureMySqlLinkedServiceTypeProperties", "description": "Azure MySQL database linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureMySql" }, "AzureMySqlLinkedServiceTypeProperties": { "type": "object", "description": "Azure MySQL database linked service properties.", "properties": { "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "connectionString" ] }, "AzureMySqlSink": { "type": "object", "description": "A copy activity Azure MySql sink.", "properties": { "preCopyScript": { "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AzureMySqlSink" }, "AzureMySqlSource": { "type": "object", "description": "A copy activity Azure MySQL source.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "AzureMySqlSource" }, "AzureMySqlTableDataset": { "type": "object", "description": "The Azure MySQL database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureMySqlTableDatasetTypeProperties", "description": "Azure MySQL database dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureMySqlTable" }, "AzureMySqlTableDatasetTypeProperties": { "type": "object", "description": "Azure MySQL database dataset properties.", "properties": { "tableName": { "description": "The Azure MySQL database table name. Type: string (or Expression with resultType string)." }, "table": { "description": "The name of Azure MySQL database table. Type: string (or Expression with resultType string)." } } }, "AzurePostgreSqlLinkedService": { "type": "object", "description": "Azure PostgreSQL linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzurePostgreSqlLinkedServiceTypeProperties", "description": "Azure PostgreSQL linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzurePostgreSql" }, "AzurePostgreSqlLinkedServiceTypeProperties": { "type": "object", "description": "Azure PostgreSQL linked service properties.", "properties": { "connectionString": { "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "server": { "description": "Server name for connection. Type: string." }, "port": { "description": "The port for the connection. Type: integer." }, "username": { "description": "Username for authentication. Type: string." }, "database": { "description": "Database name for connection. Type: string." }, "sslMode": { "description": "SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer." }, "timeout": { "description": "The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer." }, "commandTimeout": { "description": "The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer." }, "trustServerCertificate": { "description": "Whether to trust the server certificate without validating it. Type: boolean." }, "readBufferSize": { "description": "Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer." }, "timezone": { "description": "Gets or sets the session timezone. Type: string." }, "encoding": { "description": "Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string" }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "servicePrincipalId": { "description": "The ID of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalEmbeddedCert": { "$ref": "#/definitions/SecretBase", "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." }, "servicePrincipalEmbeddedCertPassword": { "$ref": "#/definitions/SecretBase", "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string)." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "azureCloudType": { "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } } }, "AzurePostgreSqlSink": { "type": "object", "description": "A copy activity Azure Database for PostgreSQL sink.", "properties": { "preCopyScript": { "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." }, "writeMethod": { "$ref": "#/definitions/AzurePostgreSqlWriteMethodEnum", "description": "The write behavior for the operation. Default is Bulk Insert." }, "upsertSettings": { "$ref": "#/definitions/AzurePostgreSqlSinkUpsertSettings", "description": "Azure Database for PostgreSQL upsert option settings" } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AzurePostgreSqlSink" }, "AzurePostgreSqlSinkUpsertSettings": { "type": "object", "description": "Azure Database for PostgreSQL upsert option settings", "properties": { "keys": { "description": "Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings)." } } }, "AzurePostgreSqlSource": { "type": "object", "description": "A copy activity Azure Database for PostgreSQL source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "AzurePostgreSqlSource" }, "AzurePostgreSqlTableDataset": { "type": "object", "description": "Azure PostgreSQL dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AzurePostgreSqlTableDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzurePostgreSqlTable" }, "AzurePostgreSqlTableDatasetTypeProperties": { "type": "object", "description": "Azure PostgreSQL dataset properties.", "properties": { "tableName": { "description": "The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string)." }, "schema": { "description": "The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string)." } } }, "AzurePostgreSqlWriteMethodEnum": { "type": "string", "description": "The write behavior for the operation. Default is Bulk Insert.", "enum": [ "BulkInsert", "CopyCommand", "Upsert" ], "x-ms-enum": { "name": "AzurePostgreSqlWriteMethodEnum", "modelAsString": true, "values": [ { "name": "BulkInsert", "value": "BulkInsert", "description": "BulkInsert" }, { "name": "CopyCommand", "value": "CopyCommand", "description": "CopyCommand" }, { "name": "Upsert", "value": "Upsert", "description": "Upsert" } ] } }, "AzureQueueSink": { "type": "object", "description": "A copy activity Azure Queue sink.", "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AzureQueueSink" }, "AzureSearchIndexDataset": { "type": "object", "description": "The Azure Search Index.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureSearchIndexDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureSearchIndex" }, "AzureSearchIndexDatasetTypeProperties": { "type": "object", "description": "Properties specific to this dataset type.", "properties": { "indexName": { "description": "The name of the Azure Search Index. Type: string (or Expression with resultType string)." } }, "required": [ "indexName" ] }, "AzureSearchIndexSink": { "type": "object", "description": "A copy activity Azure Search Index sink.", "properties": { "writeBehavior": { "$ref": "#/definitions/AzureSearchIndexWriteBehaviorType", "description": "Specify the write behavior when upserting documents into Azure Search Index." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AzureSearchIndexSink" }, "AzureSearchIndexWriteBehaviorType": { "type": "string", "description": "Specify the write behavior when upserting documents into Azure Search Index.", "enum": [ "Merge", "Upload" ], "x-ms-enum": { "name": "AzureSearchIndexWriteBehaviorType", "modelAsString": true, "values": [ { "name": "Merge", "value": "Merge", "description": "Merge" }, { "name": "Upload", "value": "Upload", "description": "Upload" } ] } }, "AzureSearchLinkedService": { "type": "object", "description": "Linked service for Windows Azure Search Service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureSearchLinkedServiceTypeProperties", "description": "Windows Azure Search Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureSearch" }, "AzureSearchLinkedServiceTypeProperties": { "type": "object", "description": "Windows Azure Search Service linked service properties.", "properties": { "url": { "description": "URL for Azure Search service. Type: string (or Expression with resultType string)." }, "key": { "$ref": "#/definitions/SecretBase", "description": "Admin Key for Azure Search service" }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "url" ] }, "AzureSqlDWAuthenticationType": { "type": "string", "description": "The type used for authentication. Type: string.", "enum": [ "SQL", "ServicePrincipal", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], "x-ms-enum": { "name": "AzureSqlDWAuthenticationType", "modelAsString": true, "values": [ { "name": "SQL", "value": "SQL", "description": "SQL" }, { "name": "ServicePrincipal", "value": "ServicePrincipal", "description": "ServicePrincipal" }, { "name": "SystemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", "description": "SystemAssignedManagedIdentity" }, { "name": "UserAssignedManagedIdentity", "value": "UserAssignedManagedIdentity", "description": "UserAssignedManagedIdentity" } ] } }, "AzureSqlDWLinkedService": { "type": "object", "description": "Azure SQL Data Warehouse linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureSqlDWLinkedServiceTypeProperties", "description": "Azure SQL Data Warehouse linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureSqlDW" }, "AzureSqlDWLinkedServiceTypeProperties": { "type": "object", "description": "Azure SQL Data Warehouse linked service properties.", "properties": { "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference." }, "authenticationType": { "$ref": "#/definitions/AzureSqlDWAuthenticationType", "description": "The type used for authentication. Type: string." }, "userName": { "description": "The user name to be used when connecting to server. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "servicePrincipalId": { "description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { "$ref": "#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "azureCloudType": { "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "allOf": [ { "$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties" } ] }, "AzureSqlDWTableDataset": { "type": "object", "description": "The Azure SQL Data Warehouse dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureSqlDWTableDatasetTypeProperties", "description": "Azure SQL Data Warehouse dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureSqlDWTable" }, "AzureSqlDWTableDatasetTypeProperties": { "type": "object", "description": "Azure SQL Data Warehouse dataset properties.", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "schema": { "description": "The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." } } }, "AzureSqlDatabaseAuthenticationType": { "type": "string", "description": "The type used for authentication. Type: string.", "enum": [ "SQL", "ServicePrincipal", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], "x-ms-enum": { "name": "AzureSqlDatabaseAuthenticationType", "modelAsString": true, "values": [ { "name": "SQL", "value": "SQL", "description": "SQL" }, { "name": "ServicePrincipal", "value": "ServicePrincipal", "description": "ServicePrincipal" }, { "name": "SystemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", "description": "SystemAssignedManagedIdentity" }, { "name": "UserAssignedManagedIdentity", "value": "UserAssignedManagedIdentity", "description": "UserAssignedManagedIdentity" } ] } }, "AzureSqlDatabaseLinkedService": { "type": "object", "description": "Microsoft Azure SQL Database linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureSqlDatabaseLinkedServiceTypeProperties", "description": "Azure SQL Database linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureSqlDatabase" }, "AzureSqlDatabaseLinkedServiceTypeProperties": { "type": "object", "description": "Azure SQL Database linked service properties.", "properties": { "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "authenticationType": { "$ref": "#/definitions/AzureSqlDatabaseAuthenticationType", "description": "The type used for authentication. Type: string." }, "userName": { "description": "The user name to be used when connecting to server. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "servicePrincipalId": { "description": "The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Database." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { "$ref": "#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "azureCloudType": { "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "alwaysEncryptedSettings": { "$ref": "#/definitions/SqlAlwaysEncryptedProperties", "description": "Sql always encrypted properties." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "allOf": [ { "$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties" } ] }, "AzureSqlMIAuthenticationType": { "type": "string", "description": "The type used for authentication. Type: string.", "enum": [ "SQL", "ServicePrincipal", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], "x-ms-enum": { "name": "AzureSqlMIAuthenticationType", "modelAsString": true, "values": [ { "name": "SQL", "value": "SQL", "description": "SQL" }, { "name": "ServicePrincipal", "value": "ServicePrincipal", "description": "ServicePrincipal" }, { "name": "SystemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", "description": "SystemAssignedManagedIdentity" }, { "name": "UserAssignedManagedIdentity", "value": "UserAssignedManagedIdentity", "description": "UserAssignedManagedIdentity" } ] } }, "AzureSqlMILinkedService": { "type": "object", "description": "Azure SQL Managed Instance linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureSqlMILinkedServiceTypeProperties", "description": "Azure SQL Managed Instance linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureSqlMI" }, "AzureSqlMILinkedServiceTypeProperties": { "type": "object", "description": "Azure SQL Managed Instance linked service properties.", "properties": { "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "authenticationType": { "$ref": "#/definitions/AzureSqlMIAuthenticationType", "description": "The type used for authentication. Type: string." }, "userName": { "description": "The user name to be used when connecting to server. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "servicePrincipalId": { "description": "The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Managed Instance." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { "$ref": "#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "azureCloudType": { "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "alwaysEncryptedSettings": { "$ref": "#/definitions/SqlAlwaysEncryptedProperties", "description": "Sql always encrypted properties." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "allOf": [ { "$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties" } ] }, "AzureSqlMITableDataset": { "type": "object", "description": "The Azure SQL Managed Instance dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureSqlMITableDatasetTypeProperties", "description": "Azure SQL Managed Instance dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureSqlMITable" }, "AzureSqlMITableDatasetTypeProperties": { "type": "object", "description": "Azure SQL Managed Instance dataset properties.", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "schema": { "description": "The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string)." } } }, "AzureSqlSink": { "type": "object", "description": "A copy activity Azure SQL sink.", "properties": { "sqlWriterStoredProcedureName": { "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." }, "sqlWriterTableType": { "description": "SQL writer table type. Type: string (or Expression with resultType string)." }, "preCopyScript": { "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." }, "storedProcedureParameters": { "description": "SQL stored procedure parameters." }, "storedProcedureTableTypeParameterName": { "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." }, "tableOption": { "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." }, "sqlWriterUseTableLock": { "description": "Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean)." }, "writeBehavior": { "description": "Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" }, "upsertSettings": { "$ref": "#/definitions/SqlUpsertSettings", "description": "SQL upsert settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AzureSqlSink" }, "AzureSqlSource": { "type": "object", "description": "A copy activity Azure SQL source.", "properties": { "sqlReaderQuery": { "description": "SQL reader query. Type: string (or Expression with resultType string)." }, "sqlReaderStoredProcedureName": { "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\"}}\"." }, "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)." }, "produceAdditionalTypes": { "description": "Which additional types to produce." }, "partitionOption": { "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string)." }, "partitionSettings": { "$ref": "#/definitions/SqlPartitionSettings", "description": "The settings that will be leveraged for Sql source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "AzureSqlSource" }, "AzureSqlTableDataset": { "type": "object", "description": "The Azure SQL Server database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureSqlTableDatasetTypeProperties", "description": "Azure SQL dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureSqlTable" }, "AzureSqlTableDatasetTypeProperties": { "type": "object", "description": "Azure SQL dataset properties.", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "schema": { "description": "The schema name of the Azure SQL database. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the Azure SQL database. Type: string (or Expression with resultType string)." } } }, "AzureStorageAuthenticationType": { "type": "string", "description": "The type used for authentication. Type: string.", "enum": [ "Anonymous", "AccountKey", "SasUri", "ServicePrincipal", "Msi" ], "x-ms-enum": { "name": "AzureStorageAuthenticationType", "modelAsString": true, "values": [ { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "AccountKey", "value": "AccountKey", "description": "AccountKey" }, { "name": "SasUri", "value": "SasUri", "description": "SasUri" }, { "name": "ServicePrincipal", "value": "ServicePrincipal", "description": "ServicePrincipal" }, { "name": "Msi", "value": "Msi", "description": "Msi" } ] } }, "AzureStorageLinkedService": { "type": "object", "description": "The storage account linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties", "description": "Azure Storage linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureStorage" }, "AzureStorageLinkedServiceTypeProperties": { "type": "object", "description": "Azure Storage linked service properties.", "properties": { "connectionString": { "description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference." }, "accountKey": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of accountKey in connection string." }, "sasUri": { "description": "SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference." }, "sasToken": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of sasToken in sas uri." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "AzureSynapseArtifactsLinkedService": { "type": "object", "description": "Azure Synapse Analytics (Artifacts) linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureSynapseArtifactsLinkedServiceTypeProperties", "description": "Azure Synapse Analytics (Artifacts) linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureSynapseArtifacts" }, "AzureSynapseArtifactsLinkedServiceTypeProperties": { "type": "object", "description": "Azure Synapse Analytics (Artifacts) linked service properties.", "properties": { "endpoint": { "description": "https://.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string)." }, "authentication": { "description": "Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string)." }, "workspaceResourceId": { "description": "The resource ID of the Synapse workspace. The format should be: /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/providers/Microsoft.Synapse/workspaces/{workspaceName}. Type: string (or Expression with resultType string)." } }, "required": [ "endpoint" ] }, "AzureTableDataset": { "type": "object", "description": "The Azure Table storage dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureTableDatasetTypeProperties", "description": "Azure Table dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "AzureTable" }, "AzureTableDatasetTypeProperties": { "type": "object", "description": "Azure Table dataset properties.", "properties": { "tableName": { "description": "The table name of the Azure Table storage. Type: string (or Expression with resultType string)." } }, "required": [ "tableName" ] }, "AzureTableSink": { "type": "object", "description": "A copy activity Azure Table sink.", "properties": { "azureTableDefaultPartitionKeyValue": { "description": "Azure Table default partition key value. Type: string (or Expression with resultType string)." }, "azureTablePartitionKeyName": { "description": "Azure Table partition key name. Type: string (or Expression with resultType string)." }, "azureTableRowKeyName": { "description": "Azure Table row key name. Type: string (or Expression with resultType string)." }, "azureTableInsertType": { "description": "Azure Table insert type. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "AzureTableSink" }, "AzureTableSource": { "type": "object", "description": "A copy activity Azure Table source.", "properties": { "azureTableSourceQuery": { "description": "Azure Table source query. Type: string (or Expression with resultType string)." }, "azureTableSourceIgnoreTableNotFound": { "description": "Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "AzureTableSource" }, "AzureTableStorageLinkedService": { "type": "object", "description": "The azure table storage linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/AzureTableStorageLinkedServiceTypeProperties", "description": "Azure Table Storage linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "AzureTableStorage" }, "AzureTableStorageLinkedServiceTypeProperties": { "type": "object", "description": "Azure Table Storage linked service properties.", "properties": { "serviceEndpoint": { "description": "Table service endpoint of the Azure Table Storage resource. It is mutually exclusive with connectionString, sasUri property." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "allOf": [ { "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties" } ] }, "BigDataPoolParametrizationReference": { "type": "object", "description": "Big data pool reference type.", "properties": { "type": { "$ref": "#/definitions/BigDataPoolReferenceType", "description": "Big data pool reference type." }, "referenceName": { "description": "Reference big data pool name. Type: string (or Expression with resultType string)." } }, "required": [ "type", "referenceName" ] }, "BigDataPoolReferenceType": { "type": "string", "description": "Big data pool reference type.", "enum": [ "BigDataPoolReference" ], "x-ms-enum": { "name": "BigDataPoolReferenceType", "modelAsString": true, "values": [ { "name": "BigDataPoolReference", "value": "BigDataPoolReference", "description": "BigDataPoolReference" } ] } }, "BinaryDataset": { "type": "object", "description": "Binary dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/BinaryDatasetTypeProperties", "description": "Binary dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "Binary" }, "BinaryDatasetTypeProperties": { "type": "object", "description": "Binary dataset properties.", "properties": { "location": { "$ref": "#/definitions/DatasetLocation", "description": "The location of the Binary storage." }, "compression": { "$ref": "#/definitions/DatasetCompression", "description": "The data compression method used for the binary dataset." } }, "required": [ "location" ] }, "BinaryReadSettings": { "type": "object", "description": "Binary read settings.", "properties": { "compressionProperties": { "$ref": "#/definitions/CompressionReadSettings", "description": "Compression settings." } }, "allOf": [ { "$ref": "#/definitions/FormatReadSettings" } ], "x-ms-discriminator-value": "BinaryReadSettings" }, "BinarySink": { "type": "object", "description": "A copy activity Binary sink.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreWriteSettings", "description": "Binary store settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "BinarySink" }, "BinarySource": { "type": "object", "description": "A copy activity Binary source.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreReadSettings", "description": "Binary store settings." }, "formatSettings": { "$ref": "#/definitions/BinaryReadSettings", "description": "Binary format settings." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "BinarySource" }, "BlobEventTypes": { "type": "string", "enum": [ "Microsoft.Storage.BlobCreated", "Microsoft.Storage.BlobDeleted" ], "x-ms-enum": { "name": "BlobEventTypes", "modelAsString": true, "values": [ { "name": "Microsoft.Storage.BlobCreated", "value": "Microsoft.Storage.BlobCreated", "description": "Microsoft.Storage.BlobCreated" }, { "name": "Microsoft.Storage.BlobDeleted", "value": "Microsoft.Storage.BlobDeleted", "description": "Microsoft.Storage.BlobDeleted" } ] } }, "BlobEventsTrigger": { "type": "object", "description": "Trigger that runs every time a Blob event occurs.", "properties": { "typeProperties": { "$ref": "#/definitions/BlobEventsTriggerTypeProperties", "description": "Blob Events Trigger properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/MultiplePipelineTrigger" } ], "x-ms-discriminator-value": "BlobEventsTrigger" }, "BlobEventsTriggerTypeProperties": { "type": "object", "description": "Blob Events Trigger properties.", "properties": { "blobPathBeginsWith": { "type": "string", "description": "The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith." }, "blobPathEndsWith": { "type": "string", "description": "The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith." }, "ignoreEmptyBlobs": { "type": "boolean", "description": "If set to true, blobs with zero bytes will be ignored." }, "events": { "type": "array", "description": "The type of events that cause this trigger to fire.", "items": { "$ref": "#/definitions/BlobEventTypes" } }, "scope": { "type": "string", "description": "The ARM resource ID of the Storage Account." } }, "required": [ "events", "scope" ] }, "BlobSink": { "type": "object", "description": "A copy activity Azure Blob sink.", "properties": { "blobWriterOverwriteFiles": { "description": "Blob writer overwrite files. Type: boolean (or Expression with resultType boolean)." }, "blobWriterDateTimeFormat": { "description": "Blob writer date time format. Type: string (or Expression with resultType string)." }, "blobWriterAddHeader": { "description": "Blob writer add header. Type: boolean (or Expression with resultType boolean)." }, "copyBehavior": { "description": "The type of copy behavior for copy sink." }, "metadata": { "type": "array", "description": "Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).", "items": { "$ref": "#/definitions/MetadataItem" }, "x-ms-identifiers": [ "name" ] } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "BlobSink" }, "BlobSource": { "type": "object", "description": "A copy activity Azure Blob source.", "properties": { "treatEmptyAsNull": { "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." }, "skipHeaderLineCount": { "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." }, "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "BlobSource" }, "BlobTrigger": { "type": "object", "description": "Trigger that runs every time the selected Blob container changes.", "properties": { "typeProperties": { "$ref": "#/definitions/BlobTriggerTypeProperties", "description": "Blob Trigger properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/MultiplePipelineTrigger" } ], "x-ms-discriminator-value": "BlobTrigger" }, "BlobTriggerTypeProperties": { "type": "object", "description": "Blob Trigger properties.", "properties": { "folderPath": { "type": "string", "description": "The path of the container/folder that will trigger the pipeline." }, "maxConcurrency": { "type": "integer", "format": "int32", "description": "The max number of parallel files to handle when it is triggered." }, "linkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "The Azure Storage linked service reference." } }, "required": [ "folderPath", "maxConcurrency", "linkedService" ] }, "CMKIdentityDefinition": { "type": "object", "description": "Managed Identity used for CMK.", "properties": { "userAssignedIdentity": { "type": "string", "description": "The resource id of the user assigned identity to authenticate to customer's key vault." } } }, "CassandraLinkedService": { "type": "object", "description": "Linked service for Cassandra data source.", "properties": { "typeProperties": { "$ref": "#/definitions/CassandraLinkedServiceTypeProperties", "description": "Cassandra linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Cassandra" }, "CassandraLinkedServiceTypeProperties": { "type": "object", "description": "Cassandra linked service properties.", "properties": { "host": { "description": "Host name for connection. Type: string (or Expression with resultType string)." }, "authenticationType": { "description": "AuthenticationType to be used for connection. Type: string (or Expression with resultType string)." }, "port": { "description": "The port for the connection. Type: integer (or Expression with resultType integer)." }, "username": { "description": "Username for authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for authentication." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host" ] }, "CassandraSource": { "type": "object", "description": "A copy activity source for a Cassandra database.", "properties": { "query": { "description": "Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string)." }, "consistencyLevel": { "$ref": "#/definitions/CassandraSourceReadConsistencyLevels", "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." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "CassandraSource" }, "CassandraSourceReadConsistencyLevels": { "type": "string", "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.", "enum": [ "ALL", "EACH_QUORUM", "QUORUM", "LOCAL_QUORUM", "ONE", "TWO", "THREE", "LOCAL_ONE", "SERIAL", "LOCAL_SERIAL" ], "x-ms-enum": { "name": "CassandraSourceReadConsistencyLevels", "modelAsString": true, "values": [ { "name": "ALL", "value": "ALL", "description": "ALL" }, { "name": "EACH_QUORUM", "value": "EACH_QUORUM", "description": "EACH_QUORUM" }, { "name": "QUORUM", "value": "QUORUM", "description": "QUORUM" }, { "name": "LOCAL_QUORUM", "value": "LOCAL_QUORUM", "description": "LOCAL_QUORUM" }, { "name": "ONE", "value": "ONE", "description": "ONE" }, { "name": "TWO", "value": "TWO", "description": "TWO" }, { "name": "THREE", "value": "THREE", "description": "THREE" }, { "name": "LOCAL_ONE", "value": "LOCAL_ONE", "description": "LOCAL_ONE" }, { "name": "SERIAL", "value": "SERIAL", "description": "SERIAL" }, { "name": "LOCAL_SERIAL", "value": "LOCAL_SERIAL", "description": "LOCAL_SERIAL" } ] } }, "CassandraTableDataset": { "type": "object", "description": "The Cassandra database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/CassandraTableDatasetTypeProperties", "description": "Cassandra dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "CassandraTable" }, "CassandraTableDatasetTypeProperties": { "type": "object", "description": "Cassandra dataset properties.", "properties": { "tableName": { "description": "The table name of the Cassandra database. Type: string (or Expression with resultType string)." }, "keyspace": { "description": "The keyspace of the Cassandra database. Type: string (or Expression with resultType string)." } } }, "ChainingTrigger": { "type": "object", "description": "Trigger that allows the referenced pipeline to depend on other pipeline runs based on runDimension Name/Value pairs. Upstream pipelines should declare the same runDimension Name and their runs should have the values for those runDimensions. The referenced pipeline run would be triggered if the values for the runDimension match for all upstream pipeline runs.", "properties": { "pipeline": { "$ref": "#/definitions/TriggerPipelineReference", "description": "Pipeline for which runs are created when all upstream pipelines complete successfully." }, "typeProperties": { "$ref": "#/definitions/ChainingTriggerTypeProperties", "description": "Chaining Trigger properties.", "x-ms-client-flatten": true } }, "required": [ "pipeline", "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Trigger" } ], "x-ms-discriminator-value": "ChainingTrigger" }, "ChainingTriggerTypeProperties": { "type": "object", "description": "Chaining Trigger properties.", "properties": { "dependsOn": { "type": "array", "description": "Upstream Pipelines.", "items": { "$ref": "#/definitions/PipelineReference" }, "x-ms-identifiers": [ "referenceName" ] }, "runDimension": { "type": "string", "description": "Run Dimension property that needs to be emitted by upstream pipelines." } }, "required": [ "dependsOn", "runDimension" ] }, "ChangeDataCapture": { "type": "object", "description": "A Azure Data Factory object which automatically detects data changes at the source and then sends the updated data to the destination.", "properties": { "folder": { "$ref": "#/definitions/ChangeDataCaptureFolder", "description": "The folder that this CDC is in. If not specified, CDC will appear at the root level." }, "description": { "type": "string", "description": "The description of the change data capture." }, "sourceConnectionsInfo": { "type": "array", "description": "List of sources connections that can be used as sources in the CDC.", "items": { "$ref": "#/definitions/MapperSourceConnectionsInfo" }, "x-ms-identifiers": [] }, "targetConnectionsInfo": { "type": "array", "description": "List of target connections that can be used as sources in the CDC.", "items": { "$ref": "#/definitions/MapperTargetConnectionsInfo" }, "x-ms-identifiers": [] }, "policy": { "$ref": "#/definitions/MapperPolicy", "description": "CDC policy" }, "allowVNetOverride": { "type": "boolean", "description": "A boolean to determine if the vnet configuration needs to be overwritten." }, "status": { "type": "string", "description": "Status of the CDC as to if it is running or stopped." } }, "required": [ "sourceConnectionsInfo", "targetConnectionsInfo", "policy" ] }, "ChangeDataCaptureFolder": { "type": "object", "description": "The folder that this CDC is in. If not specified, CDC will appear at the root level.", "properties": { "name": { "type": "string", "description": "The name of the folder that this CDC is in." } } }, "ChangeDataCaptureListResponse": { "type": "object", "description": "A list of change data capture resources.", "properties": { "value": { "type": "array", "description": "The ChangeDataCaptureResource items on this page", "items": { "$ref": "#/definitions/ChangeDataCaptureResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ChangeDataCaptureResource": { "type": "object", "description": "Change data capture resource type.", "properties": { "properties": { "$ref": "#/definitions/ChangeDataCapture", "description": "Properties of the change data capture.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "additionalProperties": {}, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ChangeDataCaptureStatusResponse": { "type": "string", "description": "Current status of the change data capture resource." }, "CloudError": { "type": "object", "description": "The object that defines the structure of an Azure Data Factory error response.", "properties": { "error": { "$ref": "#/definitions/CloudErrorBody", "description": "Error data", "x-ms-client-flatten": true } }, "required": [ "error" ], "x-ms-external": true }, "CloudErrorBody": { "type": "object", "description": "The object that defines the structure of an Azure Data Factory error.", "properties": { "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." }, "target": { "type": "string", "description": "Property name/path in request associated with error." }, "details": { "type": "array", "description": "Array with additional error details.", "items": { "$ref": "#/definitions/CloudError" }, "x-ms-identifiers": [] } }, "required": [ "code", "message" ], "x-ms-external": true }, "CmdkeySetup": { "type": "object", "description": "The custom setup of running cmdkey commands.", "properties": { "typeProperties": { "$ref": "#/definitions/CmdkeySetupTypeProperties", "description": "Cmdkey command custom setup type properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/CustomSetupBase" } ], "x-ms-discriminator-value": "CmdkeySetup" }, "CmdkeySetupTypeProperties": { "type": "object", "description": "Cmdkey command custom setup type properties.", "properties": { "targetName": { "description": "The server name of data source access. Type: string." }, "userName": { "description": "The user name of data source access. Type: string." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password of data source access." } }, "required": [ "targetName", "userName", "password" ] }, "CommonDataServiceForAppsEntityDataset": { "type": "object", "description": "The Common Data Service for Apps entity dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/CommonDataServiceForAppsEntityDatasetTypeProperties", "description": "Common Data Service for Apps entity dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "CommonDataServiceForAppsEntity" }, "CommonDataServiceForAppsEntityDatasetTypeProperties": { "type": "object", "description": "Common Data Service for Apps entity dataset properties.", "properties": { "entityName": { "description": "The logical name of the entity. Type: string (or Expression with resultType string)." } } }, "CommonDataServiceForAppsLinkedService": { "type": "object", "description": "Common Data Service for Apps linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/CommonDataServiceForAppsLinkedServiceTypeProperties", "description": "Common Data Service for Apps linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "CommonDataServiceForApps" }, "CommonDataServiceForAppsLinkedServiceTypeProperties": { "type": "object", "description": "Common Data Service for Apps linked service properties.", "properties": { "deploymentType": { "description": "The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string)." }, "hostName": { "description": "The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string)." }, "port": { "description": "The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." }, "serviceUri": { "description": "The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." }, "organizationName": { "description": "The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string)." }, "authenticationType": { "description": "The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string)." }, "domain": { "description": "The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string)." }, "username": { "description": "User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to access the Common Data Service for Apps instance." }, "servicePrincipalId": { "description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { "$ref": "#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "deploymentType", "authenticationType" ] }, "CommonDataServiceForAppsSink": { "type": "object", "description": "A copy activity Common Data Service for Apps sink.", "properties": { "writeBehavior": { "$ref": "#/definitions/DynamicsSinkWriteBehavior", "description": "The write behavior for the operation." }, "ignoreNullValues": { "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": { "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." }, "bypassBusinessLogicExecution": { "description": "Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." }, "bypassPowerAutomateFlows": { "description": "Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean)." } }, "required": [ "writeBehavior" ], "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "CommonDataServiceForAppsSink" }, "CommonDataServiceForAppsSource": { "type": "object", "description": "A copy activity Common Data Service for Apps source.", "properties": { "query": { "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": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "CommonDataServiceForAppsSource" }, "ComponentSetup": { "type": "object", "description": "The custom setup of installing 3rd party components.", "properties": { "typeProperties": { "$ref": "#/definitions/LicensedComponentSetupTypeProperties", "description": "Install 3rd party component type properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/CustomSetupBase" } ], "x-ms-discriminator-value": "ComponentSetup" }, "CompressionCodec": { "type": "string", "description": "All available compressionCodec values.", "enum": [ "none", "lzo", "bzip2", "gzip", "deflate", "zipDeflate", "snappy", "lz4", "tar", "tarGZip" ], "x-ms-enum": { "name": "CompressionCodec", "modelAsString": true, "values": [ { "name": "none", "value": "none", "description": "none" }, { "name": "lzo", "value": "lzo", "description": "lzo" }, { "name": "bzip2", "value": "bzip2", "description": "bzip2" }, { "name": "gzip", "value": "gzip", "description": "gzip" }, { "name": "deflate", "value": "deflate", "description": "deflate" }, { "name": "zipDeflate", "value": "zipDeflate", "description": "zipDeflate" }, { "name": "snappy", "value": "snappy", "description": "snappy" }, { "name": "lz4", "value": "lz4", "description": "lz4" }, { "name": "tar", "value": "tar", "description": "tar" }, { "name": "tarGZip", "value": "tarGZip", "description": "tarGZip" } ] } }, "CompressionReadSettings": { "type": "object", "description": "Compression read settings.", "properties": { "type": { "type": "string", "description": "The Compression setting type." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "ConcurLinkedService": { "type": "object", "description": "Concur Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/ConcurLinkedServiceTypeProperties", "description": "Concur Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Concur" }, "ConcurLinkedServiceTypeProperties": { "type": "object", "description": "Concur Service linked service properties.", "properties": { "connectionProperties": { "description": "Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object." }, "clientId": { "description": "Application client_id supplied by Concur App Management." }, "username": { "description": "The user name that you use to access Concur Service." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name that you provided in the username field." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "clientId", "username" ] }, "ConcurObjectDataset": { "type": "object", "description": "Concur Service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "ConcurObject" }, "ConcurSource": { "type": "object", "description": "A copy activity Concur Service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "ConcurSource" }, "ConfigurationType": { "type": "string", "description": "The type of the spark config.", "enum": [ "Default", "Customized", "Artifact" ], "x-ms-enum": { "name": "ConfigurationType", "modelAsString": true, "values": [ { "name": "Default", "value": "Default", "description": "Default" }, { "name": "Customized", "value": "Customized", "description": "Customized" }, { "name": "Artifact", "value": "Artifact", "description": "Artifact" } ] } }, "ConnectionStateProperties": { "type": "object", "description": "The connection state of a managed private endpoint", "properties": { "actionsRequired": { "type": "string", "description": "The actions required on the managed private endpoint", "readOnly": true }, "description": { "type": "string", "description": "The managed private endpoint description", "readOnly": true }, "status": { "type": "string", "description": "The approval status", "readOnly": true } } }, "ConnectionType": { "type": "string", "description": "Type of connection via linked service or dataset.", "enum": [ "linkedservicetype" ], "x-ms-enum": { "name": "ConnectionType", "modelAsString": true, "values": [ { "name": "linkedservicetype", "value": "linkedservicetype", "description": "linkedservicetype" } ] } }, "ContinuationSettingsReference": { "type": "object", "description": "Continuation settings for execute data flow activity.", "properties": { "continuationTtlInMinutes": { "description": "Continuation TTL in minutes." }, "idleCondition": { "description": "Idle condition." }, "customizedCheckpointKey": { "description": "Customized checkpoint key." } } }, "ControlActivity": { "type": "object", "description": "Base class for all control activities like IfCondition, ForEach , Until.", "allOf": [ { "$ref": "#/definitions/Activity" } ], "x-ms-discriminator-value": "Container" }, "CopyActivity": { "type": "object", "description": "Copy activity.", "properties": { "typeProperties": { "$ref": "#/definitions/CopyActivityTypeProperties", "description": "Copy activity properties.", "x-ms-client-flatten": true }, "inputs": { "type": "array", "description": "List of inputs for the activity.", "items": { "$ref": "#/definitions/DatasetReference" }, "x-ms-identifiers": [ "referenceName" ] }, "outputs": { "type": "array", "description": "List of outputs for the activity.", "items": { "$ref": "#/definitions/DatasetReference" }, "x-ms-identifiers": [ "referenceName" ] } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "Copy" }, "CopyActivityLogSettings": { "type": "object", "description": "Settings for copy activity log.", "properties": { "logLevel": { "description": "Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string)." }, "enableReliableLogging": { "description": "Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean)." } } }, "CopyActivityTypeProperties": { "type": "object", "description": "Copy activity properties.", "properties": { "source": { "$ref": "#/definitions/CopySource", "description": "Copy activity source." }, "sink": { "$ref": "#/definitions/CopySink", "description": "Copy activity sink." }, "translator": { "description": "Copy activity translator. If not specified, tabular translator is used." }, "enableStaging": { "description": "Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." }, "stagingSettings": { "$ref": "#/definitions/StagingSettings", "description": "Specifies interim staging settings when EnableStaging is true." }, "parallelCopies": { "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": { "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": { "description": "Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean)." }, "redirectIncompatibleRowSettings": { "$ref": "#/definitions/RedirectIncompatibleRowSettings", "description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true." }, "logStorageSettings": { "$ref": "#/definitions/LogStorageSettings", "description": "(Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log." }, "logSettings": { "$ref": "#/definitions/LogSettings", "description": "Log settings customer needs provide when enabling log." }, "preserveRules": { "type": "array", "description": "Preserve Rules.", "items": {} }, "preserve": { "type": "array", "description": "Preserve rules.", "items": {} }, "validateDataConsistency": { "description": "Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean)." }, "skipErrorFile": { "$ref": "#/definitions/SkipErrorFile", "description": "Specify the fault tolerance for data consistency." } }, "required": [ "source", "sink" ] }, "CopyBehaviorType": { "type": "string", "description": "All available types of copy behavior.", "enum": [ "PreserveHierarchy", "FlattenHierarchy", "MergeFiles" ], "x-ms-enum": { "name": "CopyBehaviorType", "modelAsString": true, "values": [ { "name": "PreserveHierarchy", "value": "PreserveHierarchy", "description": "PreserveHierarchy" }, { "name": "FlattenHierarchy", "value": "FlattenHierarchy", "description": "FlattenHierarchy" }, { "name": "MergeFiles", "value": "MergeFiles", "description": "MergeFiles" } ] } }, "CopyComputeScaleProperties": { "type": "object", "description": "CopyComputeScale properties for managed integration runtime.", "properties": { "dataIntegrationUnit": { "type": "integer", "format": "int32", "description": "DIU number setting reserved for copy activity execution. Supported values are multiples of 4 in range 4-256.", "minimum": 4 }, "timeToLive": { "type": "integer", "format": "int32", "description": "Time to live (in minutes) setting of integration runtime which will execute copy activity.", "minimum": 5 } }, "additionalProperties": {} }, "CopySink": { "type": "object", "description": "A copy activity sink.", "properties": { "type": { "type": "string", "description": "Copy sink type." }, "writeBatchSize": { "description": "Write batch size. Type: integer (or Expression with resultType integer), minimum: 0." }, "writeBatchTimeout": { "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": { "description": "Sink retry count. Type: integer (or Expression with resultType integer)." }, "sinkRetryWait": { "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": { "description": "The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer)." }, "disableMetricsCollection": { "description": "If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean)." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "CopySource": { "type": "object", "description": "A copy activity source.", "properties": { "type": { "type": "string", "description": "Copy source type." }, "sourceRetryCount": { "description": "Source retry count. Type: integer (or Expression with resultType integer)." }, "sourceRetryWait": { "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": { "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." }, "disableMetricsCollection": { "description": "If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean)." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "CopyTranslator": { "type": "object", "description": "A copy activity translator.", "properties": { "type": { "type": "string", "description": "Copy translator type." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "CosmosDbConnectionMode": { "type": "string", "description": "The connection mode used to access CosmosDB account. Type: string.", "enum": [ "Gateway", "Direct" ], "x-ms-enum": { "name": "CosmosDbConnectionMode", "modelAsString": true, "values": [ { "name": "Gateway", "value": "Gateway", "description": "Gateway" }, { "name": "Direct", "value": "Direct", "description": "Direct" } ] } }, "CosmosDbLinkedService": { "type": "object", "description": "Microsoft Azure Cosmos Database (CosmosDB) linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/CosmosDbLinkedServiceTypeProperties", "description": "CosmosDB linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "CosmosDb" }, "CosmosDbLinkedServiceTypeProperties": { "type": "object", "description": "CosmosDB linked service properties.", "properties": { "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "accountEndpoint": { "description": "The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string)" }, "database": { "description": "The name of the database. Type: string (or Expression with resultType string)" }, "accountKey": { "$ref": "#/definitions/SecretBase", "description": "The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference." }, "servicePrincipalId": { "description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string." }, "servicePrincipalCredential": { "$ref": "#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "azureCloudType": { "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." }, "connectionMode": { "$ref": "#/definitions/CosmosDbConnectionMode", "description": "The connection mode used to access CosmosDB account. Type: string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } } }, "CosmosDbMongoDbApiCollectionDataset": { "type": "object", "description": "The CosmosDB (MongoDB API) database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/CosmosDbMongoDbApiCollectionDatasetTypeProperties", "description": "CosmosDB (MongoDB API) database dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "CosmosDbMongoDbApiCollection" }, "CosmosDbMongoDbApiCollectionDatasetTypeProperties": { "type": "object", "description": "CosmosDB (MongoDB API) database dataset properties.", "properties": { "collection": { "description": "The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string)." } }, "required": [ "collection" ] }, "CosmosDbMongoDbApiLinkedService": { "type": "object", "description": "Linked service for CosmosDB (MongoDB API) data source.", "properties": { "typeProperties": { "$ref": "#/definitions/CosmosDbMongoDbApiLinkedServiceTypeProperties", "description": "CosmosDB (MongoDB API) linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "CosmosDbMongoDbApi" }, "CosmosDbMongoDbApiLinkedServiceTypeProperties": { "type": "object", "description": "CosmosDB (MongoDB API) linked service properties.", "properties": { "isServerVersionAbove32": { "description": "Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean)." }, "connectionString": { "description": "The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference." }, "database": { "description": "The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string)." } }, "required": [ "connectionString", "database" ] }, "CosmosDbMongoDbApiSink": { "type": "object", "description": "A copy activity sink for a CosmosDB (MongoDB API) database.", "properties": { "writeBehavior": { "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)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "CosmosDbMongoDbApiSink" }, "CosmosDbMongoDbApiSource": { "type": "object", "description": "A copy activity source for a CosmosDB (MongoDB API) database.", "properties": { "filter": { "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": { "$ref": "#/definitions/MongoDbCursorMethodsProperties", "description": "Cursor methods for Mongodb query." }, "batchSize": { "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": { "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": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "CosmosDbMongoDbApiSource" }, "CosmosDbSqlApiCollectionDataset": { "type": "object", "description": "Microsoft Azure CosmosDB (SQL API) Collection dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/CosmosDbSqlApiCollectionDatasetTypeProperties", "description": "CosmosDB (SQL API) Collection dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "CosmosDbSqlApiCollection" }, "CosmosDbSqlApiCollectionDatasetTypeProperties": { "type": "object", "description": "CosmosDB (SQL API) Collection dataset properties.", "properties": { "collectionName": { "description": "CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string)." } }, "required": [ "collectionName" ] }, "CosmosDbSqlApiSink": { "type": "object", "description": "A copy activity Azure CosmosDB (SQL API) Collection sink.", "properties": { "writeBehavior": { "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "CosmosDbSqlApiSink" }, "CosmosDbSqlApiSource": { "type": "object", "description": "A copy activity Azure CosmosDB (SQL API) Collection source.", "properties": { "query": { "description": "SQL API query. Type: string (or Expression with resultType string)." }, "pageSize": { "description": "Page size of the result. Type: integer (or Expression with resultType integer)." }, "preferredRegions": { "description": "Preferred regions. Type: array of strings (or Expression with resultType array of strings)." }, "detectDatetime": { "description": "Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean)." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "CosmosDbSqlApiSource" }, "CouchbaseLinkedService": { "type": "object", "description": "Couchbase server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/CouchbaseLinkedServiceTypeProperties", "description": "Couchbase server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Couchbase" }, "CouchbaseLinkedServiceTypeProperties": { "type": "object", "description": "Couchbase server linked service properties.", "properties": { "connectionString": { "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "credString": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of credString in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "CouchbaseSource": { "type": "object", "description": "A copy activity Couchbase server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "CouchbaseSource" }, "CouchbaseTableDataset": { "type": "object", "description": "Couchbase server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "CouchbaseTable" }, "CreateDataFlowDebugSessionRequest": { "type": "object", "description": "Request body structure for creating data flow debug session.", "properties": { "computeType": { "type": "string", "description": "Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided." }, "coreCount": { "type": "integer", "format": "int32", "description": "Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided." }, "timeToLive": { "type": "integer", "format": "int32", "description": "Time to live setting of the cluster in minutes." }, "integrationRuntime": { "$ref": "#/definitions/IntegrationRuntimeDebugResource", "description": "Set to use integration runtime setting for data flow debug session." } } }, "CreateDataFlowDebugSessionResponse": { "type": "object", "description": "Response body structure for creating data flow debug session.", "properties": { "status": { "type": "string", "description": "The state of the debug session." }, "sessionId": { "type": "string", "description": "The ID of data flow debug session." } } }, "CreateLinkedIntegrationRuntimeRequest": { "type": "object", "description": "The linked integration runtime information.", "properties": { "name": { "type": "string", "description": "The name of the linked integration runtime." }, "subscriptionId": { "type": "string", "description": "The ID of the subscription that the linked integration runtime belongs to." }, "dataFactoryName": { "type": "string", "description": "The name of the data factory that the linked integration runtime belongs to." }, "dataFactoryLocation": { "type": "string", "description": "The location of the data factory that the linked integration runtime belongs to." } } }, "CreateRunResponse": { "type": "object", "description": "Response body with a run identifier.", "properties": { "runId": { "type": "string", "description": "Identifier of a run." } }, "required": [ "runId" ] }, "Credential": { "type": "object", "description": "The Azure Data Factory nested object which contains the information and credential which can be used to connect with related store or compute resource.", "properties": { "type": { "type": "string", "description": "Type of credential." }, "description": { "type": "string", "description": "Credential description." }, "annotations": { "type": "array", "description": "List of tags that can be used for describing the Credential.", "items": {} } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "CredentialListResponse": { "type": "object", "description": "A list of credential resources.", "properties": { "value": { "type": "array", "description": "The CredentialResource items on this page", "items": { "$ref": "#/definitions/CredentialResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CredentialReference": { "type": "object", "description": "Credential reference type.", "properties": { "type": { "$ref": "#/definitions/CredentialReferenceType", "description": "Credential reference type." }, "referenceName": { "type": "string", "description": "Reference credential name." } }, "required": [ "type", "referenceName" ], "additionalProperties": {} }, "CredentialReferenceType": { "type": "string", "description": "Credential reference type.", "enum": [ "CredentialReference" ], "x-ms-enum": { "name": "CredentialReferenceType", "modelAsString": true, "values": [ { "name": "CredentialReference", "value": "CredentialReference", "description": "CredentialReference" } ] } }, "CredentialResource": { "type": "object", "description": "Credential resource type.", "properties": { "properties": { "$ref": "#/definitions/Credential", "description": "Properties of credentials." }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "CustomActivity": { "type": "object", "description": "Custom activity type.", "properties": { "typeProperties": { "$ref": "#/definitions/CustomActivityTypeProperties", "description": "Custom activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "Custom" }, "CustomActivityReferenceObject": { "type": "object", "description": "Reference objects for custom activity", "properties": { "linkedServices": { "type": "array", "description": "Linked service references.", "items": { "$ref": "#/definitions/LinkedServiceReference" }, "x-ms-identifiers": [ "referenceName" ] }, "datasets": { "type": "array", "description": "Dataset references.", "items": { "$ref": "#/definitions/DatasetReference" }, "x-ms-identifiers": [ "referenceName" ] } } }, "CustomActivityTypeProperties": { "type": "object", "description": "Custom activity properties.", "properties": { "command": { "description": "Command for custom activity Type: string (or Expression with resultType string)." }, "resourceLinkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Resource linked service reference." }, "folderPath": { "description": "Folder path for resource files Type: string (or Expression with resultType string)." }, "referenceObjects": { "$ref": "#/definitions/CustomActivityReferenceObject", "description": "Reference objects" }, "extendedProperties": { "type": "object", "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.", "additionalProperties": {} }, "retentionTimeInDays": { "description": "The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double)." }, "autoUserSpecification": { "description": "Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double)." } }, "required": [ "command" ] }, "CustomDataSourceLinkedService": { "type": "object", "description": "Custom linked service.", "properties": { "typeProperties": { "description": "Custom linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "CustomDataSource" }, "CustomDataset": { "type": "object", "description": "The custom dataset.", "properties": { "typeProperties": { "description": "Custom dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "CustomDataset" }, "CustomEventsTrigger": { "type": "object", "description": "Trigger that runs every time a custom event is received.", "properties": { "typeProperties": { "$ref": "#/definitions/CustomEventsTriggerTypeProperties", "description": "Custom Events Trigger properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/MultiplePipelineTrigger" } ], "x-ms-discriminator-value": "CustomEventsTrigger" }, "CustomEventsTriggerTypeProperties": { "type": "object", "description": "Custom Events Trigger properties.", "properties": { "subjectBeginsWith": { "type": "string", "description": "The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith." }, "subjectEndsWith": { "type": "string", "description": "The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith." }, "events": { "type": "array", "description": "The list of event types that cause this trigger to fire.", "items": {} }, "scope": { "type": "string", "description": "The ARM resource ID of the Azure Event Grid Topic." } }, "required": [ "events", "scope" ] }, "CustomSetupBase": { "type": "object", "description": "The base definition of the custom setup.", "properties": { "type": { "type": "string", "description": "The type of custom setup." } }, "discriminator": "type", "required": [ "type" ] }, "DWCopyCommandDefaultValue": { "type": "object", "description": "Default value.", "properties": { "columnName": { "description": "Column name. Type: object (or Expression with resultType string)." }, "defaultValue": { "description": "The default value of the column. Type: object (or Expression with resultType string)." } } }, "DWCopyCommandSettings": { "type": "object", "description": "DW Copy Command settings.", "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" }, "x-ms-identifiers": [ "columnName" ] }, "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" } } } }, "DataFactoryElement": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "Expression" ], "x-ms-enum": { "modelAsString": false } }, "value": { "type": "string" } }, "required": [ "kind", "value" ] }, "DataFlow": { "type": "object", "description": "Azure Data Factory nested object which contains a flow with data movements and transformations.", "properties": { "type": { "type": "string", "description": "Type of data flow." }, "description": { "type": "string", "description": "The description of the data flow." }, "annotations": { "type": "array", "description": "List of tags that can be used for describing the data flow.", "items": {} }, "folder": { "$ref": "#/definitions/DataFlowFolder", "description": "The folder that this data flow is in. If not specified, Data flow will appear at the root level." } }, "discriminator": "type", "required": [ "type" ] }, "DataFlowComputeType": { "type": "string", "description": "Compute type of the cluster which will execute data flow job.", "enum": [ "General", "MemoryOptimized", "ComputeOptimized" ], "x-ms-enum": { "name": "DataFlowComputeType", "modelAsString": true, "values": [ { "name": "General", "value": "General", "description": "General" }, { "name": "MemoryOptimized", "value": "MemoryOptimized", "description": "MemoryOptimized" }, { "name": "ComputeOptimized", "value": "ComputeOptimized", "description": "ComputeOptimized" } ] } }, "DataFlowDebugCommandPayload": { "type": "object", "description": "Structure of command payload.", "properties": { "streamName": { "type": "string", "description": "The stream name which is used for preview." }, "rowLimits": { "type": "integer", "format": "int32", "description": "Row limits for preview response." }, "columns": { "type": "array", "description": "Array of column names.", "items": { "type": "string" } }, "expression": { "type": "string", "description": "The expression which is used for preview." } }, "required": [ "streamName" ] }, "DataFlowDebugCommandRequest": { "type": "object", "description": "Request body structure for data flow debug command.", "properties": { "sessionId": { "type": "string", "description": "The ID of data flow debug session." }, "command": { "$ref": "#/definitions/DataFlowDebugCommandType", "description": "The command type." }, "commandPayload": { "$ref": "#/definitions/DataFlowDebugCommandPayload", "description": "The command payload object." } } }, "DataFlowDebugCommandResponse": { "type": "object", "description": "Response body structure of data flow result for data preview, statistics or expression preview.", "properties": { "status": { "type": "string", "description": "The run status of data preview, statistics or expression preview." }, "data": { "type": "string", "description": "The result data of data preview, statistics or expression preview." } } }, "DataFlowDebugCommandType": { "type": "string", "description": "The command type.", "enum": [ "executePreviewQuery", "executeStatisticsQuery", "executeExpressionQuery" ], "x-ms-enum": { "name": "DataFlowDebugCommandType", "modelAsString": true, "values": [ { "name": "executePreviewQuery", "value": "executePreviewQuery", "description": "executePreviewQuery" }, { "name": "executeStatisticsQuery", "value": "executeStatisticsQuery", "description": "executeStatisticsQuery" }, { "name": "executeExpressionQuery", "value": "executeExpressionQuery", "description": "executeExpressionQuery" } ] } }, "DataFlowDebugPackage": { "type": "object", "description": "Request body structure for starting data flow debug session.", "properties": { "sessionId": { "type": "string", "description": "The ID of data flow debug session." }, "dataFlow": { "$ref": "#/definitions/DataFlowDebugResource", "description": "Data flow instance." }, "dataFlows": { "type": "array", "description": "List of Data flows", "items": { "$ref": "#/definitions/DataFlowDebugResource" }, "x-ms-identifiers": [ "name" ] }, "datasets": { "type": "array", "description": "List of datasets.", "items": { "$ref": "#/definitions/DatasetDebugResource" }, "x-ms-identifiers": [ "name" ] }, "linkedServices": { "type": "array", "description": "List of linked services.", "items": { "$ref": "#/definitions/LinkedServiceDebugResource" }, "x-ms-identifiers": [ "name" ] }, "staging": { "$ref": "#/definitions/DataFlowStagingInfo", "description": "Staging info for debug session." }, "debugSettings": { "$ref": "#/definitions/DataFlowDebugPackageDebugSettings", "description": "Data flow debug settings." } }, "additionalProperties": {} }, "DataFlowDebugPackageDebugSettings": { "type": "object", "description": "Data flow debug settings.", "properties": { "sourceSettings": { "type": "array", "description": "Source setting for data flow debug.", "items": { "$ref": "#/definitions/DataFlowSourceSetting" }, "x-ms-identifiers": [ "sourceName" ] }, "parameters": { "type": "object", "description": "Data flow parameters.", "additionalProperties": {} }, "datasetParameters": { "description": "Parameters for dataset." } } }, "DataFlowDebugResource": { "type": "object", "description": "Data flow debug resource.", "properties": { "properties": { "$ref": "#/definitions/DataFlow", "description": "Data flow properties." } }, "required": [ "properties" ], "allOf": [ { "$ref": "#/definitions/SubResourceDebugResource" } ] }, "DataFlowDebugSessionInfo": { "type": "object", "description": "Data flow debug session info.", "properties": { "dataFlowName": { "type": "string", "description": "The name of the data flow." }, "computeType": { "type": "string", "description": "Compute type of the cluster." }, "coreCount": { "type": "integer", "format": "int32", "description": "Core count of the cluster." }, "nodeCount": { "type": "integer", "format": "int32", "description": "Node count of the cluster. (deprecated property)" }, "integrationRuntimeName": { "type": "string", "description": "Attached integration runtime name of data flow debug session." }, "sessionId": { "type": "string", "description": "The ID of data flow debug session." }, "startTime": { "type": "string", "description": "Start time of data flow debug session." }, "timeToLiveInMinutes": { "type": "integer", "format": "int32", "description": "Compute type of the cluster." }, "lastActivityTime": { "type": "string", "description": "Last activity time of data flow debug session." } }, "additionalProperties": {} }, "DataFlowFolder": { "type": "object", "description": "The folder that this data flow is in. If not specified, Data flow will appear at the root level.", "properties": { "name": { "type": "string", "description": "The name of the folder that this data flow is in." } } }, "DataFlowListResponse": { "type": "object", "description": "A list of data flow resources.", "properties": { "value": { "type": "array", "description": "The DataFlowResource items on this page", "items": { "$ref": "#/definitions/DataFlowResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DataFlowReference": { "type": "object", "description": "Data flow reference type.", "properties": { "type": { "$ref": "#/definitions/DataFlowReferenceType", "description": "Data flow reference type." }, "referenceName": { "type": "string", "description": "Reference data flow name." }, "datasetParameters": { "description": "Reference data flow parameters from dataset." }, "parameters": { "type": "object", "description": "Data flow parameters", "additionalProperties": {} } }, "required": [ "type", "referenceName" ], "additionalProperties": {} }, "DataFlowReferenceType": { "type": "string", "description": "Data flow reference type.", "enum": [ "DataFlowReference" ], "x-ms-enum": { "name": "DataFlowReferenceType", "modelAsString": true, "values": [ { "name": "DataFlowReference", "value": "DataFlowReference", "description": "DataFlowReference" } ] } }, "DataFlowResource": { "type": "object", "description": "Data flow resource type.", "properties": { "properties": { "$ref": "#/definitions/DataFlow", "description": "Data flow properties." }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "DataFlowSink": { "type": "object", "description": "Transformation for data flow sink.", "properties": { "schemaLinkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Schema linked service reference." }, "rejectedDataLinkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Rejected data linked service reference." } }, "allOf": [ { "$ref": "#/definitions/Transformation" } ] }, "DataFlowSource": { "type": "object", "description": "Transformation for data flow source.", "properties": { "schemaLinkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Schema linked service reference." } }, "allOf": [ { "$ref": "#/definitions/Transformation" } ] }, "DataFlowSourceSetting": { "type": "object", "description": "Definition of data flow source setting for debug.", "properties": { "sourceName": { "type": "string", "description": "The data flow source name." }, "rowLimit": { "type": "integer", "format": "int32", "description": "Defines the row limit of data flow source in debug." } }, "additionalProperties": {} }, "DataFlowStagingInfo": { "type": "object", "description": "Staging info for execute data flow activity.", "properties": { "linkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Staging linked service reference." }, "folderPath": { "description": "Folder path for staging blob. Type: string (or Expression with resultType string)" } } }, "DataLakeAnalyticsUSQLActivity": { "type": "object", "description": "Data Lake Analytics U-SQL activity.", "properties": { "typeProperties": { "$ref": "#/definitions/DataLakeAnalyticsUSQLActivityTypeProperties", "description": "Data Lake Analytics U-SQL activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "DataLakeAnalyticsU-SQL" }, "DataLakeAnalyticsUSQLActivityTypeProperties": { "type": "object", "description": "DataLakeAnalyticsU-SQL activity properties.", "properties": { "scriptPath": { "description": "Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string)." }, "scriptLinkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Script linked service reference." }, "degreeOfParallelism": { "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": { "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": { "type": "object", "description": "Parameters for U-SQL job request.", "additionalProperties": {} }, "runtimeVersion": { "description": "Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string)." }, "compilationMode": { "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" ] }, "DataMapperMapping": { "type": "object", "description": "Source and target table mapping details.", "properties": { "targetEntityName": { "type": "string", "description": "Name of the target table" }, "sourceEntityName": { "type": "string", "description": "Name of the source table" }, "sourceConnectionReference": { "$ref": "#/definitions/MapperConnectionReference", "description": "The connection reference for the source connection." }, "attributeMappingInfo": { "$ref": "#/definitions/MapperAttributeMappings", "description": "This holds the user provided attribute mapping information." }, "sourceDenormalizeInfo": { "description": "This holds the source denormalization information used while joining multiple sources." } } }, "DatabricksJobActivity": { "type": "object", "description": "Databricks Job activity.", "properties": { "typeProperties": { "$ref": "#/definitions/DatabricksJobActivityTypeProperties", "description": "Databricks Job activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "DatabricksJob" }, "DatabricksJobActivityTypeProperties": { "type": "object", "description": "Databricks Job activity properties.", "properties": { "jobId": { "description": "The Id of the Databricks Job to be executed. Type: string (or Expression with resultType string)." }, "jobParameters": { "type": "object", "description": "Job parameters to be used for each run of this job. If the job takes a parameter that is not specified, the default value from the job will be used.", "additionalProperties": {} } }, "required": [ "jobId" ] }, "DatabricksNotebookActivity": { "type": "object", "description": "DatabricksNotebook activity.", "properties": { "typeProperties": { "$ref": "#/definitions/DatabricksNotebookActivityTypeProperties", "description": "Databricks Notebook activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "DatabricksNotebook" }, "DatabricksNotebookActivityTypeProperties": { "type": "object", "description": "Databricks Notebook activity properties.", "properties": { "notebookPath": { "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": { "type": "object", "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.", "additionalProperties": {} }, "libraries": { "type": "array", "description": "A list of libraries to be installed on the cluster that will execute the job.", "items": { "type": "object", "additionalProperties": {} }, "x-ms-identifiers": [] } }, "required": [ "notebookPath" ] }, "DatabricksSparkJarActivity": { "type": "object", "description": "DatabricksSparkJar activity.", "properties": { "typeProperties": { "$ref": "#/definitions/DatabricksSparkJarActivityTypeProperties", "description": "Databricks SparkJar activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "DatabricksSparkJar" }, "DatabricksSparkJarActivityTypeProperties": { "type": "object", "description": "Databricks SparkJar activity properties.", "properties": { "mainClassName": { "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": { "type": "array", "description": "Parameters that will be passed to the main method.", "items": {} }, "libraries": { "type": "array", "description": "A list of libraries to be installed on the cluster that will execute the job.", "items": { "type": "object", "additionalProperties": {} }, "x-ms-identifiers": [] } }, "required": [ "mainClassName" ] }, "DatabricksSparkPythonActivity": { "type": "object", "description": "DatabricksSparkPython activity.", "properties": { "typeProperties": { "$ref": "#/definitions/DatabricksSparkPythonActivityTypeProperties", "description": "Databricks SparkPython activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "DatabricksSparkPython" }, "DatabricksSparkPythonActivityTypeProperties": { "type": "object", "description": "Databricks SparkPython activity properties.", "properties": { "pythonFile": { "description": "The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string)." }, "parameters": { "type": "array", "description": "Command line parameters that will be passed to the Python file.", "items": {} }, "libraries": { "type": "array", "description": "A list of libraries to be installed on the cluster that will execute the job.", "items": { "type": "object", "additionalProperties": {} }, "x-ms-identifiers": [] } }, "required": [ "pythonFile" ] }, "Dataset": { "type": "object", "description": "The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.", "properties": { "type": { "type": "string", "description": "Type of dataset." }, "description": { "type": "string", "description": "Dataset description." }, "structure": { "description": "Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement." }, "schema": { "description": "Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement." }, "linkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "Linked service reference." }, "parameters": { "type": "object", "description": "Parameters for dataset.", "additionalProperties": { "$ref": "#/definitions/ParameterSpecification" } }, "annotations": { "type": "array", "description": "List of tags that can be used for describing the Dataset.", "items": {} }, "folder": { "$ref": "#/definitions/DatasetFolder", "description": "The folder that this Dataset is in. If not specified, Dataset will appear at the root level." } }, "discriminator": "type", "required": [ "type", "linkedServiceName" ], "additionalProperties": {} }, "DatasetCompression": { "type": "object", "description": "The compression method used on a dataset.", "properties": { "type": { "description": "Type of dataset compression. Type: string (or Expression with resultType string)." }, "level": { "description": "The dataset compression level. Type: string (or Expression with resultType string)." } }, "required": [ "type" ], "additionalProperties": {} }, "DatasetCompressionLevel": { "type": "string", "description": "All available compression levels.", "enum": [ "Optimal", "Fastest" ], "x-ms-enum": { "name": "DatasetCompressionLevel", "modelAsString": true, "values": [ { "name": "Optimal", "value": "Optimal", "description": "Optimal" }, { "name": "Fastest", "value": "Fastest", "description": "Fastest" } ] } }, "DatasetDataElement": { "type": "object", "description": "Columns that define the structure of the dataset.", "properties": { "name": { "description": "Name of the column. Type: string (or Expression with resultType string)." }, "type": { "description": "Type of the column. Type: string (or Expression with resultType string)." } } }, "DatasetDebugResource": { "type": "object", "description": "Dataset debug resource.", "properties": { "properties": { "$ref": "#/definitions/Dataset", "description": "Dataset properties." } }, "required": [ "properties" ], "allOf": [ { "$ref": "#/definitions/SubResourceDebugResource" } ] }, "DatasetFolder": { "type": "object", "description": "The folder that this Dataset is in. If not specified, Dataset will appear at the root level.", "properties": { "name": { "type": "string", "description": "The name of the folder that this Dataset is in." } } }, "DatasetListResponse": { "type": "object", "description": "A list of dataset resources.", "properties": { "value": { "type": "array", "description": "The DatasetResource items on this page", "items": { "$ref": "#/definitions/DatasetResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DatasetLocation": { "type": "object", "description": "Dataset location.", "properties": { "type": { "type": "string", "description": "Type of dataset storage location." }, "folderPath": { "description": "Specify the folder path of dataset. Type: string (or Expression with resultType string)" }, "fileName": { "description": "Specify the file name of dataset. Type: string (or Expression with resultType string)." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "DatasetReference": { "type": "object", "description": "Dataset reference type.", "properties": { "type": { "$ref": "#/definitions/DatasetReferenceType", "description": "Dataset reference type." }, "referenceName": { "type": "string", "description": "Reference dataset name." }, "parameters": { "type": "object", "description": "Arguments for dataset.", "additionalProperties": {} } }, "required": [ "type", "referenceName" ] }, "DatasetReferenceType": { "type": "string", "description": "Dataset reference type.", "enum": [ "DatasetReference" ], "x-ms-enum": { "name": "DatasetReferenceType", "modelAsString": true, "values": [ { "name": "DatasetReference", "value": "DatasetReference", "description": "DatasetReference" } ] } }, "DatasetResource": { "type": "object", "description": "Dataset resource type.", "properties": { "properties": { "$ref": "#/definitions/Dataset", "description": "Dataset properties." }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "DatasetSchemaDataElement": { "type": "object", "description": "Columns that define the physical type schema of the dataset.", "properties": { "name": { "description": "Name of the schema column. Type: string (or Expression with resultType string)." }, "type": { "description": "Type of the schema column. Type: string (or Expression with resultType string)." } }, "additionalProperties": {} }, "DatasetStorageFormat": { "type": "object", "description": "The format definition of a storage.", "properties": { "type": { "type": "string", "description": "Type of dataset storage format." }, "serializer": { "description": "Serializer. Type: string (or Expression with resultType string)." }, "deserializer": { "description": "Deserializer. Type: string (or Expression with resultType string)." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "DataworldLinkedService": { "type": "object", "description": "Linked service for Dataworld.", "properties": { "typeProperties": { "$ref": "#/definitions/DataworldLinkedServiceTypeProperties", "description": "Dataworld linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Dataworld" }, "DataworldLinkedServiceTypeProperties": { "type": "object", "description": "Dataworld linked service type properties.", "properties": { "apiToken": { "$ref": "#/definitions/SecretBase", "description": "The api token for the Dataworld source." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "apiToken" ] }, "DayOfWeek": { "type": "string", "description": "The days of the week.", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "x-ms-enum": { "name": "DayOfWeek", "modelAsString": false, "values": [ { "name": "Sunday", "value": "Sunday", "description": "Sunday" }, { "name": "Monday", "value": "Monday", "description": "Monday" }, { "name": "Tuesday", "value": "Tuesday", "description": "Tuesday" }, { "name": "Wednesday", "value": "Wednesday", "description": "Wednesday" }, { "name": "Thursday", "value": "Thursday", "description": "Thursday" }, { "name": "Friday", "value": "Friday", "description": "Friday" }, { "name": "Saturday", "value": "Saturday", "description": "Saturday" } ] } }, "DaysOfWeek": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "x-ms-enum": { "name": "DaysOfWeek", "modelAsString": false, "values": [ { "name": "Sunday", "value": "Sunday", "description": "Sunday" }, { "name": "Monday", "value": "Monday", "description": "Monday" }, { "name": "Tuesday", "value": "Tuesday", "description": "Tuesday" }, { "name": "Wednesday", "value": "Wednesday", "description": "Wednesday" }, { "name": "Thursday", "value": "Thursday", "description": "Thursday" }, { "name": "Friday", "value": "Friday", "description": "Friday" }, { "name": "Saturday", "value": "Saturday", "description": "Saturday" } ] } }, "Db2AuthenticationType": { "type": "string", "description": "AuthenticationType to be used for connection. It is mutually exclusive with connectionString property.", "enum": [ "Basic" ], "x-ms-enum": { "name": "Db2AuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" } ] } }, "Db2LinkedService": { "type": "object", "description": "Linked service for DB2 data source.", "properties": { "typeProperties": { "$ref": "#/definitions/Db2LinkedServiceTypeProperties", "description": "DB2 linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Db2" }, "Db2LinkedServiceTypeProperties": { "type": "object", "description": "DB2 linked service properties.", "properties": { "connectionString": { "description": "The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference." }, "server": { "description": "Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." }, "database": { "description": "Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/Db2AuthenticationType", "description": "AuthenticationType to be used for connection. It is mutually exclusive with connectionString property." }, "username": { "description": "Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for authentication." }, "packageCollection": { "description": "Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." }, "certificateCommonName": { "description": "Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string." } } }, "Db2Source": { "type": "object", "description": "A copy activity source for Db2 databases.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "Db2Source" }, "Db2TableDataset": { "type": "object", "description": "The Db2 table dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/Db2TableDatasetTypeProperties", "description": "Db2 table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "Db2Table" }, "Db2TableDatasetTypeProperties": { "type": "object", "description": "Db2 table dataset properties.", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "schema": { "description": "The Db2 schema name. Type: string (or Expression with resultType string)." }, "table": { "description": "The Db2 table name. Type: string (or Expression with resultType string)." } } }, "DeleteActivity": { "type": "object", "description": "Delete activity.", "properties": { "typeProperties": { "$ref": "#/definitions/DeleteActivityTypeProperties", "description": "Delete activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "Delete" }, "DeleteActivityTypeProperties": { "type": "object", "description": "Delete activity properties.", "properties": { "recursive": { "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", "format": "int32", "description": "The max concurrent connections to connect data source at the same time.", "minimum": 1 }, "enableLogging": { "description": "Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean)." }, "logStorageSettings": { "$ref": "#/definitions/LogStorageSettings", "description": "Log storage settings customer need to provide when enableLogging is true." }, "dataset": { "$ref": "#/definitions/DatasetReference", "description": "Delete activity dataset reference." }, "storeSettings": { "$ref": "#/definitions/StoreReadSettings", "description": "Delete activity store settings." } }, "required": [ "dataset" ] }, "DeleteDataFlowDebugSessionRequest": { "type": "object", "description": "Request body structure for deleting data flow debug session.", "properties": { "sessionId": { "type": "string", "description": "The ID of data flow debug session." } } }, "DelimitedTextDataset": { "type": "object", "description": "Delimited text dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/DelimitedTextDatasetTypeProperties", "description": "Delimited text dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "DelimitedText" }, "DelimitedTextDatasetTypeProperties": { "type": "object", "description": "DelimitedText dataset properties.", "properties": { "location": { "$ref": "#/definitions/DatasetLocation", "description": "The location of the delimited text storage." }, "columnDelimiter": { "description": "The column delimiter. Type: string (or Expression with resultType string)." }, "rowDelimiter": { "description": "The row delimiter. Type: string (or Expression with resultType string)." }, "encodingName": { "description": "The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." }, "compressionCodec": { "description": "The data compressionCodec. Type: string (or Expression with resultType string)." }, "compressionLevel": { "description": "The data compression method used for DelimitedText." }, "quoteChar": { "description": "The quote character. Type: string (or Expression with resultType string)." }, "escapeChar": { "description": "The escape character. Type: string (or Expression with resultType string)." }, "firstRowAsHeader": { "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." }, "nullValue": { "description": "The null value string. Type: string (or Expression with resultType string)." } }, "required": [ "location" ] }, "DelimitedTextReadSettings": { "type": "object", "description": "Delimited text read settings.", "properties": { "skipLineCount": { "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." } }, "allOf": [ { "$ref": "#/definitions/FormatReadSettings" } ], "x-ms-discriminator-value": "DelimitedTextReadSettings" }, "DelimitedTextSink": { "type": "object", "description": "A copy activity DelimitedText sink.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreWriteSettings", "description": "DelimitedText store settings." }, "formatSettings": { "$ref": "#/definitions/DelimitedTextWriteSettings", "description": "DelimitedText format settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "DelimitedTextSink" }, "DelimitedTextSource": { "type": "object", "description": "A copy activity DelimitedText source.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreReadSettings", "description": "DelimitedText store settings." }, "formatSettings": { "$ref": "#/definitions/DelimitedTextReadSettings", "description": "DelimitedText format settings." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "DelimitedTextSource" }, "DelimitedTextWriteSettings": { "type": "object", "description": "Delimited text write settings.", "properties": { "quoteAllText": { "description": "Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean)." }, "fileExtension": { "description": "The file extension used to create the files. Type: string (or Expression with resultType string)." }, "maxRowsPerFile": { "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." }, "fileNamePrefix": { "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." } }, "required": [ "fileExtension" ], "allOf": [ { "$ref": "#/definitions/FormatWriteSettings" } ], "x-ms-discriminator-value": "DelimitedTextWriteSettings" }, "DependencyCondition": { "type": "string", "enum": [ "Succeeded", "Failed", "Skipped", "Completed" ], "x-ms-enum": { "name": "DependencyCondition", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Skipped", "value": "Skipped", "description": "Skipped" }, { "name": "Completed", "value": "Completed", "description": "Completed" } ] } }, "DependencyReference": { "type": "object", "description": "Referenced dependency.", "properties": { "type": { "type": "string", "description": "The type of dependency reference." } }, "discriminator": "type", "required": [ "type" ] }, "DistcpSettings": { "type": "object", "description": "Distcp settings.", "properties": { "resourceManagerEndpoint": { "description": "Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string)." }, "tempScriptPath": { "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": { "description": "Specifies the Distcp options. Type: string (or Expression with resultType string)." } }, "required": [ "resourceManagerEndpoint", "tempScriptPath" ] }, "DocumentDbCollectionDataset": { "type": "object", "description": "Microsoft Azure Document Database Collection dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/DocumentDbCollectionDatasetTypeProperties", "description": "DocumentDB Collection dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "DocumentDbCollection" }, "DocumentDbCollectionDatasetTypeProperties": { "type": "object", "description": "DocumentDB Collection dataset properties.", "properties": { "collectionName": { "description": "Document Database collection name. Type: string (or Expression with resultType string)." } }, "required": [ "collectionName" ] }, "DocumentDbCollectionSink": { "type": "object", "description": "A copy activity Document Database Collection sink.", "properties": { "nestingSeparator": { "description": "Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string)." }, "writeBehavior": { "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "DocumentDbCollectionSink" }, "DocumentDbCollectionSource": { "type": "object", "description": "A copy activity Document Database Collection source.", "properties": { "query": { "description": "Documents query. Type: string (or Expression with resultType string)." }, "nestingSeparator": { "description": "Nested properties separator. Type: string (or Expression with resultType string)." }, "queryTimeout": { "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": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "DocumentDbCollectionSource" }, "DrillDatasetTypeProperties": { "type": "object", "description": "Drill Dataset Properties", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The table name of the Drill. Type: string (or Expression with resultType string)." }, "schema": { "description": "The schema name of the Drill. Type: string (or Expression with resultType string)." } } }, "DrillLinkedService": { "type": "object", "description": "Drill server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/DrillLinkedServiceTypeProperties", "description": "Drill server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Drill" }, "DrillLinkedServiceTypeProperties": { "type": "object", "description": "Drill server linked service properties.", "properties": { "connectionString": { "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "pwd": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "DrillSource": { "type": "object", "description": "A copy activity Drill server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "DrillSource" }, "DrillTableDataset": { "type": "object", "description": "Drill server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/DrillDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "DrillTable" }, "DynamicsAXLinkedService": { "type": "object", "description": "Dynamics AX linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/DynamicsAXLinkedServiceTypeProperties", "description": "Dynamics AX linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "DynamicsAX" }, "DynamicsAXLinkedServiceTypeProperties": { "type": "object", "description": "Dynamics AX linked service properties.", "properties": { "url": { "description": "The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint." }, "servicePrincipalId": { "description": "Specify the application's client ID. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "Specify the application's key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string)." }, "tenant": { "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string)." }, "aadResourceId": { "description": "Specify the resource you are requesting authorization. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "url", "servicePrincipalId", "servicePrincipalKey", "tenant", "aadResourceId" ] }, "DynamicsAXResourceDataset": { "type": "object", "description": "The path of the Dynamics AX OData entity.", "properties": { "typeProperties": { "$ref": "#/definitions/DynamicsAXResourceDatasetTypeProperties", "description": "Dynamics AX OData resource dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "DynamicsAXResource" }, "DynamicsAXResourceDatasetTypeProperties": { "type": "object", "description": "Dynamics AX OData resource dataset properties.", "properties": { "path": { "description": "The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string)." } }, "required": [ "path" ] }, "DynamicsAXSource": { "type": "object", "description": "A copy activity Dynamics AX source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." }, "httpRequestTimeout": { "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]))." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "DynamicsAXSource" }, "DynamicsAuthenticationType": { "type": "string", "description": "All available dynamicsAuthenticationType values.", "enum": [ "Office365", "Ifd", "AADServicePrincipal", "Active Directory" ], "x-ms-enum": { "name": "DynamicsAuthenticationType", "modelAsString": true, "values": [ { "name": "Office365", "value": "Office365", "description": "Office365" }, { "name": "Ifd", "value": "Ifd", "description": "Ifd" }, { "name": "AADServicePrincipal", "value": "AADServicePrincipal", "description": "AADServicePrincipal" }, { "name": "Active Directory", "value": "Active Directory", "description": "Active Directory" } ] } }, "DynamicsCrmEntityDataset": { "type": "object", "description": "The Dynamics CRM entity dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/DynamicsCrmEntityDatasetTypeProperties", "description": "Dynamics CRM entity dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "DynamicsCrmEntity" }, "DynamicsCrmEntityDatasetTypeProperties": { "type": "object", "description": "Dynamics CRM entity dataset properties.", "properties": { "entityName": { "description": "The logical name of the entity. Type: string (or Expression with resultType string)." } } }, "DynamicsCrmLinkedService": { "type": "object", "description": "Dynamics CRM linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/DynamicsCrmLinkedServiceTypeProperties", "description": "Dynamics CRM linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "DynamicsCrm" }, "DynamicsCrmLinkedServiceTypeProperties": { "type": "object", "description": "Dynamics CRM linked service properties.", "properties": { "deploymentType": { "description": "The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string)." }, "hostName": { "description": "The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string)." }, "port": { "description": "The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." }, "serviceUri": { "description": "The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." }, "organizationName": { "description": "The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string)." }, "authenticationType": { "description": "The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string)." }, "domain": { "description": "The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string)." }, "username": { "description": "User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to access the Dynamics CRM instance." }, "servicePrincipalId": { "description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { "$ref": "#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "deploymentType", "authenticationType" ] }, "DynamicsCrmSink": { "type": "object", "description": "A copy activity Dynamics CRM sink.", "properties": { "writeBehavior": { "$ref": "#/definitions/DynamicsSinkWriteBehavior", "description": "The write behavior for the operation." }, "ignoreNullValues": { "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": { "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." }, "bypassBusinessLogicExecution": { "description": "Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." }, "bypassPowerAutomateFlows": { "description": "Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean)." } }, "required": [ "writeBehavior" ], "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "DynamicsCrmSink" }, "DynamicsCrmSource": { "type": "object", "description": "A copy activity Dynamics CRM source.", "properties": { "query": { "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": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "DynamicsCrmSource" }, "DynamicsDeploymentType": { "type": "string", "description": "All available dynamicsDeploymentType values.", "enum": [ "Online", "OnPremisesWithIfd" ], "x-ms-enum": { "name": "DynamicsDeploymentType", "modelAsString": true, "values": [ { "name": "Online", "value": "Online", "description": "Online" }, { "name": "OnPremisesWithIfd", "value": "OnPremisesWithIfd", "description": "OnPremisesWithIfd" } ] } }, "DynamicsEntityDataset": { "type": "object", "description": "The Dynamics entity dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/DynamicsEntityDatasetTypeProperties", "description": "Dynamics entity dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "DynamicsEntity" }, "DynamicsEntityDatasetTypeProperties": { "type": "object", "description": "Dynamics entity dataset properties.", "properties": { "entityName": { "description": "The logical name of the entity. Type: string (or Expression with resultType string)." } } }, "DynamicsLinkedService": { "type": "object", "description": "Dynamics linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/DynamicsLinkedServiceTypeProperties", "description": "Dynamics linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Dynamics" }, "DynamicsLinkedServiceTypeProperties": { "type": "object", "description": "Dynamics linked service properties.", "properties": { "deploymentType": { "description": "The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string)." }, "hostName": { "description": "The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string)." }, "port": { "description": "The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." }, "serviceUri": { "description": "The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." }, "organizationName": { "description": "The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string)." }, "authenticationType": { "description": "The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string)." }, "domain": { "description": "The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string)." }, "username": { "description": "User name to access the Dynamics instance. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to access the Dynamics instance." }, "servicePrincipalId": { "description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { "$ref": "#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "required": [ "deploymentType", "authenticationType" ] }, "DynamicsSink": { "type": "object", "description": "A copy activity Dynamics sink.", "properties": { "writeBehavior": { "$ref": "#/definitions/DynamicsSinkWriteBehavior", "description": "The write behavior for the operation." }, "ignoreNullValues": { "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": { "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." }, "bypassBusinessLogicExecution": { "description": "Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." }, "bypassPowerAutomateFlows": { "description": "Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean)." } }, "required": [ "writeBehavior" ], "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "DynamicsSink" }, "DynamicsSinkWriteBehavior": { "type": "string", "description": "Defines values for DynamicsSinkWriteBehavior.", "enum": [ "Upsert" ], "x-ms-enum": { "name": "DynamicsSinkWriteBehavior", "modelAsString": true, "values": [ { "name": "Upsert", "value": "Upsert", "description": "Upsert" } ] } }, "DynamicsSource": { "type": "object", "description": "A copy activity Dynamics source.", "properties": { "query": { "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "DynamicsSource" }, "EloquaLinkedService": { "type": "object", "description": "Eloqua server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/EloquaLinkedServiceTypeProperties", "description": "Eloqua server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Eloqua" }, "EloquaLinkedServiceTypeProperties": { "type": "object", "description": "Eloqua server linked service properties.", "properties": { "endpoint": { "description": "The endpoint of the Eloqua server. (i.e. eloqua.example.com)" }, "username": { "description": "The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)" }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "endpoint", "username" ] }, "EloquaObjectDataset": { "type": "object", "description": "Eloqua server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "EloquaObject" }, "EloquaSource": { "type": "object", "description": "A copy activity Eloqua server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "EloquaSource" }, "EnableInteractiveQueryRequest": { "type": "object", "description": "The enable the interactive authoring information.", "properties": { "autoTerminationMinutes": { "type": "integer", "format": "int32", "description": "The allowed idle time for interactive authoring." } } }, "EncryptionConfiguration": { "type": "object", "description": "Definition of CMK for the factory.", "properties": { "keyName": { "type": "string", "description": "The name of the key in Azure Key Vault to use as Customer Managed Key." }, "vaultBaseUrl": { "type": "string", "description": "The url of the Azure Key Vault used for CMK." }, "keyVersion": { "type": "string", "description": "The version of the key used for CMK. If not provided, latest version will be used." }, "identity": { "$ref": "#/definitions/CMKIdentityDefinition", "description": "User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used." } }, "required": [ "keyName", "vaultBaseUrl" ] }, "EntityReference": { "type": "object", "description": "The entity reference.", "properties": { "type": { "$ref": "#/definitions/IntegrationRuntimeEntityReferenceType", "description": "The type of this referenced entity." }, "referenceName": { "type": "string", "description": "The name of this referenced entity." } } }, "EnvironmentVariableSetup": { "type": "object", "description": "The custom setup of setting environment variable.", "properties": { "typeProperties": { "$ref": "#/definitions/EnvironmentVariableSetupTypeProperties", "description": "Add environment variable type properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/CustomSetupBase" } ], "x-ms-discriminator-value": "EnvironmentVariableSetup" }, "EnvironmentVariableSetupTypeProperties": { "type": "object", "description": "Environment variable custom setup type properties.", "properties": { "variableName": { "type": "string", "description": "The name of the environment variable." }, "variableValue": { "type": "string", "description": "The value of the environment variable." } }, "required": [ "variableName", "variableValue" ] }, "EventSubscriptionStatus": { "type": "string", "description": "Event Subscription Status.", "enum": [ "Enabled", "Provisioning", "Deprovisioning", "Disabled", "Unknown" ], "x-ms-enum": { "name": "EventSubscriptionStatus", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enabled" }, { "name": "Provisioning", "value": "Provisioning", "description": "Provisioning" }, { "name": "Deprovisioning", "value": "Deprovisioning", "description": "Deprovisioning" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Unknown", "value": "Unknown", "description": "Unknown" } ] } }, "ExcelDataset": { "type": "object", "description": "Excel dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/ExcelDatasetTypeProperties", "description": "Excel dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "Excel" }, "ExcelDatasetTypeProperties": { "type": "object", "description": "Excel dataset properties.", "properties": { "location": { "$ref": "#/definitions/DatasetLocation", "description": "The location of the excel storage." }, "sheetName": { "description": "The sheet name of excel file. Type: string (or Expression with resultType string)." }, "sheetIndex": { "description": "The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer)" }, "range": { "description": "The partial data of one sheet. Type: string (or Expression with resultType string)." }, "firstRowAsHeader": { "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." }, "compression": { "$ref": "#/definitions/DatasetCompression", "description": "The data compression method used for the json dataset." }, "nullValue": { "description": "The null value string. Type: string (or Expression with resultType string)." } }, "required": [ "location" ] }, "ExcelSource": { "type": "object", "description": "A copy activity excel source.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreReadSettings", "description": "Excel store settings." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "ExcelSource" }, "ExecuteDataFlowActivity": { "type": "object", "description": "Execute data flow activity.", "properties": { "typeProperties": { "$ref": "#/definitions/ExecuteDataFlowActivityTypeProperties", "description": "Execute data flow activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "ExecuteDataFlow" }, "ExecuteDataFlowActivityTypeProperties": { "type": "object", "description": "Execute data flow activity properties.", "properties": { "dataFlow": { "$ref": "#/definitions/DataFlowReference", "description": "Data flow reference." }, "staging": { "$ref": "#/definitions/DataFlowStagingInfo", "description": "Staging info for execute data flow activity." }, "integrationRuntime": { "$ref": "#/definitions/IntegrationRuntimeReference", "description": "The integration runtime reference." }, "continuationSettings": { "$ref": "#/definitions/ContinuationSettingsReference", "description": "Continuation settings for execute data flow activity." }, "compute": { "$ref": "#/definitions/ExecuteDataFlowActivityTypePropertiesCompute", "description": "Compute properties for data flow activity." }, "traceLevel": { "description": "Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string)" }, "continueOnError": { "description": "Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean)" }, "runConcurrently": { "description": "Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean)" }, "sourceStagingConcurrency": { "description": "Specify number of parallel staging for sources applicable to the sink. Type: integer (or Expression with resultType integer)" } }, "required": [ "dataFlow" ] }, "ExecuteDataFlowActivityTypePropertiesCompute": { "type": "object", "description": "Compute properties for data flow activity.", "properties": { "computeType": { "description": "Compute type of the cluster which will execute data flow job. Possible values include: 'General', 'MemoryOptimized', 'ComputeOptimized'. Type: string (or Expression with resultType string)" }, "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 (or Expression with resultType integer)" } } }, "ExecutePipelineActivity": { "type": "object", "description": "Execute pipeline activity.", "properties": { "policy": { "$ref": "#/definitions/ExecutePipelineActivityPolicy", "description": "Execute pipeline activity policy." }, "typeProperties": { "$ref": "#/definitions/ExecutePipelineActivityTypeProperties", "description": "Execute pipeline activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "ExecutePipeline" }, "ExecutePipelineActivityPolicy": { "type": "object", "description": "Execution policy for an execute pipeline activity.", "properties": { "secureInput": { "type": "boolean", "description": "When set to true, Input from activity is considered as secure and will not be logged to monitoring." } }, "additionalProperties": {} }, "ExecutePipelineActivityTypeProperties": { "type": "object", "description": "Execute pipeline activity properties.", "properties": { "pipeline": { "$ref": "#/definitions/PipelineReference", "description": "Pipeline reference." }, "parameters": { "type": "object", "description": "Pipeline parameters.", "additionalProperties": {} }, "waitOnCompletion": { "type": "boolean", "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false." } }, "required": [ "pipeline" ] }, "ExecutePowerQueryActivityTypeProperties": { "type": "object", "description": "Execute power query data flow activity properties.", "properties": { "sinks": { "type": "object", "description": "(Deprecated. Please use Queries). List of Power Query activity sinks mapped to a queryName.", "additionalProperties": { "$ref": "#/definitions/PowerQuerySink" } }, "queries": { "type": "array", "description": "List of mapping for Power Query mashup query to sink dataset(s).", "items": { "$ref": "#/definitions/PowerQuerySinkMapping" }, "x-ms-identifiers": [ "queryName" ] } }, "allOf": [ { "$ref": "#/definitions/ExecuteDataFlowActivityTypeProperties" } ] }, "ExecuteSSISPackageActivity": { "type": "object", "description": "Execute SSIS package activity.", "properties": { "typeProperties": { "$ref": "#/definitions/ExecuteSSISPackageActivityTypeProperties", "description": "Execute SSIS package activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "ExecuteSSISPackage" }, "ExecuteSSISPackageActivityTypeProperties": { "type": "object", "description": "Execute SSIS package activity properties.", "properties": { "packageLocation": { "$ref": "#/definitions/SSISPackageLocation", "description": "SSIS package location." }, "runtime": { "description": "Specifies the runtime to execute SSIS package. The value should be \"x86\" or \"x64\". Type: string (or Expression with resultType string)." }, "loggingLevel": { "description": "The logging level of SSIS package execution. Type: string (or Expression with resultType string)." }, "environmentPath": { "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string)." }, "executionCredential": { "$ref": "#/definitions/SSISExecutionCredential", "description": "The package execution credential." }, "connectVia": { "$ref": "#/definitions/IntegrationRuntimeReference", "description": "The integration runtime reference." }, "projectParameters": { "type": "object", "description": "The project level parameters to execute the SSIS package.", "additionalProperties": { "$ref": "#/definitions/SSISExecutionParameter" } }, "packageParameters": { "type": "object", "description": "The package level parameters to execute the SSIS package.", "additionalProperties": { "$ref": "#/definitions/SSISExecutionParameter" } }, "projectConnectionManagers": { "type": "object", "description": "The project level connection managers to execute the SSIS package.", "additionalProperties": { "additionalProperties": { "$ref": "#/definitions/SSISExecutionParameter" }, "type": "object" } }, "packageConnectionManagers": { "type": "object", "description": "The package level connection managers to execute the SSIS package.", "additionalProperties": { "additionalProperties": { "$ref": "#/definitions/SSISExecutionParameter" }, "type": "object" } }, "propertyOverrides": { "type": "object", "description": "The property overrides to execute the SSIS package.", "additionalProperties": { "$ref": "#/definitions/SSISPropertyOverride" } }, "logLocation": { "$ref": "#/definitions/SSISLogLocation", "description": "SSIS package execution log location." } }, "required": [ "packageLocation", "connectVia" ] }, "ExecuteWranglingDataflowActivity": { "type": "object", "description": "Execute power query activity.", "properties": { "typeProperties": { "$ref": "#/definitions/ExecutePowerQueryActivityTypeProperties", "description": "Execute power query activity properties.", "x-ms-client-flatten": true }, "policy": { "$ref": "#/definitions/ActivityPolicy", "description": "Activity policy." } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Activity" } ], "x-ms-discriminator-value": "ExecuteWranglingDataflow" }, "ExecutionActivity": { "type": "object", "description": "Base class for all execution activities.", "properties": { "linkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "Linked service reference." }, "policy": { "$ref": "#/definitions/ActivityPolicy", "description": "Activity policy." } }, "allOf": [ { "$ref": "#/definitions/Activity" } ], "x-ms-discriminator-value": "Execution" }, "ExportSettings": { "type": "object", "description": "Export command settings.", "properties": { "type": { "type": "string", "description": "The export setting type." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "ExposureControlBatchRequest": { "type": "object", "description": "A list of exposure control features.", "properties": { "exposureControlRequests": { "type": "array", "description": "List of exposure control features.", "items": { "$ref": "#/definitions/ExposureControlRequest" }, "x-ms-identifiers": [ "featureName" ] } }, "required": [ "exposureControlRequests" ] }, "ExposureControlBatchResponse": { "type": "object", "description": "A list of exposure control feature values.", "properties": { "exposureControlResponses": { "type": "array", "description": "List of exposure control feature values.", "items": { "$ref": "#/definitions/ExposureControlResponse" }, "x-ms-identifiers": [ "featureName" ] } }, "required": [ "exposureControlResponses" ] }, "ExposureControlRequest": { "type": "object", "description": "The exposure control request.", "properties": { "featureName": { "type": "string", "description": "The feature name." }, "featureType": { "type": "string", "description": "The feature type." } } }, "ExposureControlResponse": { "type": "object", "description": "The exposure control response.", "properties": { "featureName": { "type": "string", "description": "The feature name.", "readOnly": true }, "value": { "type": "string", "description": "The feature value.", "readOnly": true } } }, "Expression": { "type": "object", "description": "Azure Data Factory expression definition.", "properties": { "type": { "$ref": "#/definitions/ExpressionType", "description": "Expression type." }, "value": { "type": "string", "description": "Expression value." } }, "required": [ "type", "value" ] }, "ExpressionType": { "type": "string", "description": "Expression type.", "enum": [ "Expression" ], "x-ms-enum": { "name": "ExpressionType", "modelAsString": true, "values": [ { "name": "Expression", "value": "Expression", "description": "Expression" } ] } }, "ExpressionV2": { "type": "object", "description": "Nested representation of a complex expression.", "properties": { "type": { "$ref": "#/definitions/ExpressionV2Type", "description": "Type of expressions supported by the system. Type: string." }, "value": { "description": "Value for Constant/Field Type: object." }, "operators": { "type": "array", "description": "Expression operator value Type: list of strings.", "items": { "type": "string" } }, "operands": { "type": "array", "description": "List of nested expressions.", "items": { "$ref": "#/definitions/ExpressionV2" }, "x-ms-identifiers": [] } } }, "ExpressionV2Type": { "type": "string", "description": "Type of expressions supported by the system. Type: string.", "enum": [ "Constant", "Field", "Unary", "Binary", "NAry" ], "x-ms-enum": { "name": "ExpressionV2Type", "modelAsString": true, "values": [ { "name": "Constant", "value": "Constant", "description": "Constant" }, { "name": "Field", "value": "Field", "description": "Field" }, { "name": "Unary", "value": "Unary", "description": "Unary" }, { "name": "Binary", "value": "Binary", "description": "Binary" }, { "name": "NAry", "value": "NAry", "description": "NAry" } ] } }, "Factory": { "type": "object", "description": "Factory resource type.", "properties": { "properties": { "$ref": "#/definitions/FactoryProperties", "description": "Properties of the factory.", "x-ms-client-flatten": true }, "identity": { "$ref": "#/definitions/FactoryIdentity", "description": "Managed service identity of the factory." }, "location": { "type": "string", "description": "The resource location.", "x-ms-mutability": [ "read", "create" ] }, "tags": { "type": "object", "description": "The resource tags.", "additionalProperties": { "type": "string" } }, "eTag": { "type": "string", "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", "readOnly": true } }, "additionalProperties": {}, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "FactoryGitHubConfiguration": { "type": "object", "description": "Factory's GitHub repo information.", "properties": { "hostName": { "type": "string", "description": "GitHub Enterprise host name. For example: `https://github.mydomain.com`" }, "clientId": { "type": "string", "description": "GitHub bring your own app client id." }, "clientSecret": { "$ref": "#/definitions/GitHubClientSecret", "description": "GitHub bring your own app client secret information." } }, "allOf": [ { "$ref": "#/definitions/FactoryRepoConfiguration" } ], "x-ms-discriminator-value": "FactoryGitHubConfiguration" }, "FactoryIdentity": { "type": "object", "description": "Identity properties of the factory resource.", "properties": { "type": { "$ref": "#/definitions/FactoryIdentityType", "description": "The identity type." }, "principalId": { "$ref": "#/definitions/Azure.Core.uuid", "description": "The principal id of the identity.", "readOnly": true }, "tenantId": { "$ref": "#/definitions/Azure.Core.uuid", "description": "The client tenant id of the identity.", "readOnly": true }, "userAssignedIdentities": { "type": "object", "description": "List of user assigned identities for the factory.", "additionalProperties": {} } }, "required": [ "type" ] }, "FactoryIdentityType": { "type": "string", "description": "The identity type.", "enum": [ "SystemAssigned", "UserAssigned", "SystemAssigned,UserAssigned" ], "x-ms-enum": { "name": "FactoryIdentityType", "modelAsString": true, "values": [ { "name": "SystemAssigned", "value": "SystemAssigned", "description": "SystemAssigned" }, { "name": "UserAssigned", "value": "UserAssigned", "description": "UserAssigned" }, { "name": "SystemAssigned,UserAssigned", "value": "SystemAssigned,UserAssigned", "description": "SystemAssigned,UserAssigned" } ] } }, "FactoryListResponse": { "type": "object", "description": "A list of factory resources.", "properties": { "value": { "type": "array", "description": "The Factory items on this page", "items": { "$ref": "#/definitions/Factory" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "FactoryProperties": { "type": "object", "description": "Factory resource properties.", "properties": { "provisioningState": { "type": "string", "description": "Factory provisioning state, example Succeeded.", "readOnly": true }, "createTime": { "type": "string", "format": "date-time", "description": "Time the factory was created in ISO8601 format.", "readOnly": true }, "version": { "type": "string", "description": "Version of the factory.", "readOnly": true }, "purviewConfiguration": { "$ref": "#/definitions/PurviewConfiguration", "description": "Purview information of the factory." }, "repoConfiguration": { "$ref": "#/definitions/FactoryRepoConfiguration", "description": "Git repo information of the factory." }, "globalParameters": { "type": "object", "description": "List of parameters for factory.", "additionalProperties": { "$ref": "#/definitions/GlobalParameterSpecification" } }, "encryption": { "$ref": "#/definitions/EncryptionConfiguration", "description": "Properties to enable Customer Managed Key for the factory." }, "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccess", "description": "Whether or not public network access is allowed for the data factory." } } }, "FactoryRepoConfiguration": { "type": "object", "description": "Factory's git repo information.", "properties": { "type": { "type": "string", "description": "Type of repo configuration." }, "accountName": { "type": "string", "description": "Account name." }, "repositoryName": { "type": "string", "description": "Repository name." }, "collaborationBranch": { "type": "string", "description": "Collaboration branch." }, "rootFolder": { "type": "string", "description": "Root folder." }, "lastCommitId": { "type": "string", "description": "Last commit id." }, "disablePublish": { "type": "boolean", "description": "Disable manual publish operation in ADF studio to favor automated publish." } }, "discriminator": "type", "required": [ "type", "accountName", "repositoryName", "collaborationBranch", "rootFolder" ] }, "FactoryRepoUpdate": { "type": "object", "description": "Factory's git repo information.", "properties": { "factoryResourceId": { "type": "string", "description": "The factory resource id." }, "repoConfiguration": { "$ref": "#/definitions/FactoryRepoConfiguration", "description": "Git repo information of the factory." } } }, "FactoryUpdateParameters": { "type": "object", "description": "Parameters for updating a factory resource.", "properties": { "tags": { "type": "object", "description": "The resource tags.", "additionalProperties": { "type": "string" } }, "identity": { "$ref": "#/definitions/FactoryIdentity", "description": "Managed service identity of the factory." }, "properties": { "$ref": "#/definitions/FactoryUpdateProperties", "description": "Properties of update the factory.", "x-ms-client-flatten": true } } }, "FactoryUpdateProperties": { "type": "object", "description": "Factory update resource properties.", "properties": { "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccess", "description": "Whether or not public network access is allowed for the data factory." } } }, "FactoryVSTSConfiguration": { "type": "object", "description": "Factory's VSTS repo information.", "properties": { "projectName": { "type": "string", "description": "VSTS project name." }, "tenantId": { "type": "string", "description": "VSTS tenant id." } }, "required": [ "projectName" ], "allOf": [ { "$ref": "#/definitions/FactoryRepoConfiguration" } ], "x-ms-discriminator-value": "FactoryVSTSConfiguration" }, "FailActivity": { "type": "object", "description": "This activity will fail within its own scope and output a custom error message and error code. The error message and code can provided either as a string literal or as an expression that can be evaluated to a string at runtime. The activity scope can be the whole pipeline or a control activity (e.g. foreach, switch, until), if the fail activity is contained in it.", "properties": { "typeProperties": { "$ref": "#/definitions/FailActivityTypeProperties", "description": "Fail activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "Fail" }, "FailActivityTypeProperties": { "type": "object", "description": "Fail activity properties.", "properties": { "message": { "description": "The error message that surfaced in the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string)." }, "errorCode": { "description": "The error code that categorizes the error type of the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string)." } }, "required": [ "message", "errorCode" ] }, "FileServerLinkedService": { "type": "object", "description": "File system linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/FileServerLinkedServiceTypeProperties", "description": "File system linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "FileServer" }, "FileServerLinkedServiceTypeProperties": { "type": "object", "description": "File system linked service properties.", "properties": { "host": { "description": "Host name of the server. Type: string (or Expression with resultType string)." }, "userId": { "description": "User ID to logon the server. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to logon the server." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host" ] }, "FileServerLocation": { "type": "object", "description": "The location of file server dataset.", "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "FileServerLocation" }, "FileServerReadSettings": { "type": "object", "description": "File server read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "FileServer wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "FileServer wildcardFileName. Type: string (or Expression with resultType string)." }, "fileListPath": { "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": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." }, "fileFilter": { "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)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "FileServerReadSettings" }, "FileServerWriteSettings": { "type": "object", "description": "File server write settings.", "allOf": [ { "$ref": "#/definitions/StoreWriteSettings" } ], "x-ms-discriminator-value": "FileServerWriteSettings" }, "FileShareDataset": { "type": "object", "description": "An on-premises file system dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/FileShareDatasetTypeProperties", "description": "On-premises file system dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "FileShare" }, "FileShareDatasetTypeProperties": { "type": "object", "description": "On-premises file system dataset properties.", "properties": { "folderPath": { "description": "The path of the on-premises file system. Type: string (or Expression with resultType string)." }, "fileName": { "description": "The name of the on-premises file system. Type: string (or Expression with resultType string)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." }, "format": { "$ref": "#/definitions/DatasetStorageFormat", "description": "The format of the files." }, "fileFilter": { "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)." }, "compression": { "$ref": "#/definitions/DatasetCompression", "description": "The data compression method used for the file system." } } }, "FileSystemSink": { "type": "object", "description": "A copy activity file system sink.", "properties": { "copyBehavior": { "description": "The type of copy behavior for copy sink." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "FileSystemSink" }, "FileSystemSource": { "type": "object", "description": "A copy activity file system source.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "FileSystemSource" }, "FilterActivity": { "type": "object", "description": "Filter and return results from input array based on the conditions.", "properties": { "typeProperties": { "$ref": "#/definitions/FilterActivityTypeProperties", "description": "Filter activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "Filter" }, "FilterActivityTypeProperties": { "type": "object", "description": "Filter activity properties.", "properties": { "items": { "$ref": "#/definitions/Expression", "description": "Input array on which filter should be applied." }, "condition": { "$ref": "#/definitions/Expression", "description": "Condition to be used for filtering the input." } }, "required": [ "items", "condition" ] }, "Flowlet": { "type": "object", "description": "Data flow flowlet", "properties": { "typeProperties": { "$ref": "#/definitions/FlowletTypeProperties", "description": "Flowlet type properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/DataFlow" } ], "x-ms-discriminator-value": "Flowlet" }, "FlowletTypeProperties": { "type": "object", "description": "Flowlet type properties.", "properties": { "sources": { "type": "array", "description": "List of sources in Flowlet.", "items": { "$ref": "#/definitions/DataFlowSource" }, "x-ms-identifiers": [ "name" ] }, "sinks": { "type": "array", "description": "List of sinks in Flowlet.", "items": { "$ref": "#/definitions/DataFlowSink" }, "x-ms-identifiers": [ "name" ] }, "transformations": { "type": "array", "description": "List of transformations in Flowlet.", "items": { "$ref": "#/definitions/Transformation" }, "x-ms-identifiers": [ "name" ] }, "script": { "type": "string", "description": "Flowlet script." }, "scriptLines": { "type": "array", "description": "Flowlet script lines.", "items": { "type": "string" } } } }, "ForEachActivity": { "type": "object", "description": "This activity is used for iterating over a collection and execute given activities.", "properties": { "typeProperties": { "$ref": "#/definitions/ForEachActivityTypeProperties", "description": "ForEach activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "ForEach" }, "ForEachActivityTypeProperties": { "type": "object", "description": "ForEach activity properties.", "properties": { "isSequential": { "type": "boolean", "description": "Should the loop be executed in sequence or in parallel (max 50)" }, "batchCount": { "type": "integer", "format": "int32", "description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).", "maximum": 50 }, "items": { "$ref": "#/definitions/Expression", "description": "Collection to iterate." }, "activities": { "type": "array", "description": "List of activities to execute .", "items": { "$ref": "#/definitions/Activity" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "items", "activities" ] }, "FormatReadSettings": { "type": "object", "description": "Format read settings.", "properties": { "type": { "type": "string", "description": "The read setting type." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "FormatWriteSettings": { "type": "object", "description": "Format write settings.", "properties": { "type": { "type": "string", "description": "The write setting type." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "FrequencyType": { "type": "string", "description": "Frequency of period in terms of 'Hour', 'Minute' or 'Second'.", "enum": [ "Hour", "Minute", "Second" ], "x-ms-enum": { "name": "FrequencyType", "modelAsString": true, "values": [ { "name": "Hour", "value": "Hour", "description": "Hour" }, { "name": "Minute", "value": "Minute", "description": "Minute" }, { "name": "Second", "value": "Second", "description": "Second" } ] } }, "FtpAuthenticationType": { "type": "string", "description": "The authentication type to be used to connect to the FTP server.", "enum": [ "Basic", "Anonymous" ], "x-ms-enum": { "name": "FtpAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" } ] } }, "FtpReadSettings": { "type": "object", "description": "Ftp read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "Ftp wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "Ftp wildcardFileName. Type: string (or Expression with resultType string)." }, "enablePartitionDiscovery": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "fileListPath": { "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": { "description": "Specify whether to use binary transfer mode for FTP stores. Type: boolean (or Expression with resultType boolean)." }, "disableChunking": { "description": "If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "FtpReadSettings" }, "FtpServerLinkedService": { "type": "object", "description": "A FTP server Linked Service.", "properties": { "typeProperties": { "$ref": "#/definitions/FtpServerLinkedServiceTypeProperties", "description": "Properties specific to this linked service type.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "FtpServer" }, "FtpServerLinkedServiceTypeProperties": { "type": "object", "description": "Properties specific to this linked service type.", "properties": { "host": { "description": "Host name of the FTP server. Type: string (or Expression with resultType string)." }, "port": { "description": "The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0." }, "authenticationType": { "$ref": "#/definitions/FtpAuthenticationType", "description": "The authentication type to be used to connect to the FTP server." }, "userName": { "description": "Username to logon the FTP server. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to logon the FTP server." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "enableSsl": { "description": "If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean)." }, "enableServerCertificateValidation": { "description": "If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean)." } }, "required": [ "host" ] }, "FtpServerLocation": { "type": "object", "description": "The location of ftp server dataset.", "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "FtpServerLocation" }, "GenericDatasetTypeProperties": { "type": "object", "description": "Properties specific to this dataset type.", "properties": { "tableName": { "description": "The table name. Type: string (or Expression with resultType string)." } } }, "GetDataFactoryOperationStatusResponse": { "type": "object", "description": "Response body structure for get data factory operation status.", "properties": { "status": { "type": "string", "description": "Status of the operation." } }, "additionalProperties": {} }, "GetMetadataActivity": { "type": "object", "description": "Activity to get metadata of dataset", "properties": { "typeProperties": { "$ref": "#/definitions/GetMetadataActivityTypeProperties", "description": "GetMetadata activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "GetMetadata" }, "GetMetadataActivityTypeProperties": { "type": "object", "description": "GetMetadata activity properties.", "properties": { "dataset": { "$ref": "#/definitions/DatasetReference", "description": "GetMetadata activity dataset reference." }, "fieldList": { "type": "array", "description": "Fields of metadata to get from dataset.", "items": {} }, "storeSettings": { "$ref": "#/definitions/StoreReadSettings", "description": "GetMetadata activity store settings." }, "formatSettings": { "$ref": "#/definitions/FormatReadSettings", "description": "GetMetadata activity format settings." } }, "required": [ "dataset" ] }, "GetSsisObjectMetadataRequest": { "type": "object", "description": "The request payload of get SSIS object metadata.", "properties": { "metadataPath": { "type": "string", "description": "Metadata path." } } }, "GitHubAccessTokenRequest": { "type": "object", "description": "Get GitHub access token request definition.", "properties": { "gitHubAccessCode": { "type": "string", "description": "GitHub access code." }, "gitHubClientId": { "type": "string", "description": "GitHub application client ID." }, "gitHubClientSecret": { "$ref": "#/definitions/GitHubClientSecret", "description": "GitHub bring your own app client secret information." }, "gitHubAccessTokenBaseUrl": { "type": "string", "description": "GitHub access token base URL." } }, "required": [ "gitHubAccessCode", "gitHubAccessTokenBaseUrl" ] }, "GitHubAccessTokenResponse": { "type": "object", "description": "Get GitHub access token response definition.", "properties": { "gitHubAccessToken": { "type": "string", "description": "GitHub access token." } } }, "GitHubClientSecret": { "type": "object", "description": "Client secret information for factory's bring your own app repository configuration.", "properties": { "byoaSecretAkvUrl": { "type": "string", "description": "Bring your own app client secret AKV URL." }, "byoaSecretName": { "type": "string", "description": "Bring your own app client secret name in AKV." } } }, "GlobalParameterListResponse": { "type": "object", "description": "A list of Global parameters.", "properties": { "value": { "type": "array", "description": "The GlobalParameterResource items on this page", "items": { "$ref": "#/definitions/GlobalParameterResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "GlobalParameterResource": { "type": "object", "description": "Global parameters resource type.", "properties": { "properties": { "type": "object", "description": "Properties of the global parameter.", "additionalProperties": { "$ref": "#/definitions/GlobalParameterSpecification" } }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "GlobalParameterSpecification": { "type": "object", "description": "Definition of a single parameter for an entity.", "properties": { "type": { "$ref": "#/definitions/GlobalParameterType", "description": "Global Parameter type." }, "value": { "description": "Value of parameter." } }, "required": [ "type", "value" ] }, "GlobalParameterType": { "type": "string", "description": "Global Parameter type.", "enum": [ "Object", "String", "Int", "Float", "Bool", "Array" ], "x-ms-enum": { "name": "GlobalParameterType", "modelAsString": true, "values": [ { "name": "Object", "value": "Object", "description": "Object" }, { "name": "String", "value": "String", "description": "String" }, { "name": "Int", "value": "Int", "description": "Int" }, { "name": "Float", "value": "Float", "description": "Float" }, { "name": "Bool", "value": "Bool", "description": "Bool" }, { "name": "Array", "value": "Array", "description": "Array" } ] } }, "GoogleAdWordsAuthenticationType": { "type": "string", "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", "enum": [ "ServiceAuthentication", "UserAuthentication" ], "x-ms-enum": { "name": "GoogleAdWordsAuthenticationType", "modelAsString": true, "values": [ { "name": "ServiceAuthentication", "value": "ServiceAuthentication", "description": "ServiceAuthentication" }, { "name": "UserAuthentication", "value": "UserAuthentication", "description": "UserAuthentication" } ] } }, "GoogleAdWordsLinkedService": { "type": "object", "description": "Google AdWords service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/GoogleAdWordsLinkedServiceTypeProperties", "description": "Google AdWords service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "GoogleAdWords" }, "GoogleAdWordsLinkedServiceTypeProperties": { "type": "object", "description": "Google AdWords service linked service properties.", "properties": { "connectionProperties": { "description": "(Deprecated) Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object." }, "clientCustomerID": { "description": "The Client customer ID of the AdWords account that you want to fetch report data for. Type: string (or Expression with resultType string)." }, "developerToken": { "$ref": "#/definitions/SecretBase", "description": "The developer token associated with the manager account that you use to grant access to the AdWords API." }, "authenticationType": { "$ref": "#/definitions/GoogleAdWordsAuthenticationType", "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR." }, "refreshToken": { "$ref": "#/definitions/SecretBase", "description": "The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication." }, "clientId": { "description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string)." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret of the google application used to acquire the refresh token." }, "email": { "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR. Type: string (or Expression with resultType string)." }, "keyFilePath": { "description": "(Deprecated) The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string)." }, "trustedCertPath": { "description": "(Deprecated) The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string)." }, "useSystemTrustStore": { "description": "(Deprecated) Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. Type: boolean (or Expression with resultType boolean)." }, "privateKey": { "$ref": "#/definitions/SecretBase", "description": "The private key that is used to authenticate the service account email address and can only be used on self-hosted IR." }, "loginCustomerID": { "description": "The customer ID of the Google Ads Manager account through which you want to fetch report data of specific Customer. Type: string (or Expression with resultType string)." }, "googleAdsApiVersion": { "description": "The Google Ads API major version such as v14. The supported major versions could be found on https://developers.google.com/google-ads/api/docs/release-notes. Type: string (or Expression with resultType string)." }, "supportLegacyDataTypes": { "description": "Specifies whether to use the legacy data type mappings, which maps float, int32 and int64 from Google to string. Do not set this to true unless you want to keep backward compatibility with legacy driver's data type mappings. Type: boolean (or Expression with resultType boolean)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "GoogleAdWordsObjectDataset": { "type": "object", "description": "Google AdWords service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "GoogleAdWordsObject" }, "GoogleAdWordsSource": { "type": "object", "description": "A copy activity Google AdWords service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "GoogleAdWordsSource" }, "GoogleBigQueryAuthenticationType": { "type": "string", "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", "enum": [ "ServiceAuthentication", "UserAuthentication" ], "x-ms-enum": { "name": "GoogleBigQueryAuthenticationType", "modelAsString": true, "values": [ { "name": "ServiceAuthentication", "value": "ServiceAuthentication", "description": "ServiceAuthentication" }, { "name": "UserAuthentication", "value": "UserAuthentication", "description": "UserAuthentication" } ] } }, "GoogleBigQueryDatasetTypeProperties": { "type": "object", "description": "Google BigQuery Dataset Properties", "properties": { "tableName": { "description": "This property will be retired. Please consider using database + table properties instead." }, "table": { "description": "The table name of the Google BigQuery. Type: string (or Expression with resultType string)." }, "dataset": { "description": "The database name of the Google BigQuery. Type: string (or Expression with resultType string)." } } }, "GoogleBigQueryLinkedService": { "type": "object", "description": "Google BigQuery service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/GoogleBigQueryLinkedServiceTypeProperties", "description": "Google BigQuery service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "GoogleBigQuery" }, "GoogleBigQueryLinkedServiceTypeProperties": { "type": "object", "description": "Google BigQuery service linked service properties.", "properties": { "project": { "description": "The default BigQuery project to query against. Type: string (or Expression with resultType string)." }, "additionalProjects": { "description": "A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string)." }, "requestGoogleDriveScope": { "description": "Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/GoogleBigQueryAuthenticationType", "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR." }, "refreshToken": { "$ref": "#/definitions/SecretBase", "description": "The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication." }, "clientId": { "description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string)." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret of the google application used to acquire the refresh token." }, "email": { "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR. Type: string (or Expression with resultType string)." }, "keyFilePath": { "description": "The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string)." }, "trustedCertPath": { "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string)." }, "useSystemTrustStore": { "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.Type: boolean (or Expression with resultType boolean)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "project", "authenticationType" ] }, "GoogleBigQueryObjectDataset": { "type": "object", "description": "Google BigQuery service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GoogleBigQueryDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "GoogleBigQueryObject" }, "GoogleBigQuerySource": { "type": "object", "description": "A copy activity Google BigQuery service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "GoogleBigQuerySource" }, "GoogleBigQueryV2AuthenticationType": { "type": "string", "description": "The OAuth 2.0 authentication mechanism used for authentication.", "enum": [ "ServiceAuthentication", "UserAuthentication" ], "x-ms-enum": { "name": "GoogleBigQueryV2AuthenticationType", "modelAsString": true, "values": [ { "name": "ServiceAuthentication", "value": "ServiceAuthentication", "description": "ServiceAuthentication" }, { "name": "UserAuthentication", "value": "UserAuthentication", "description": "UserAuthentication" } ] } }, "GoogleBigQueryV2DatasetTypeProperties": { "type": "object", "description": "Google BigQuery Dataset Properties", "properties": { "table": { "description": "The table name of the Google BigQuery. Type: string (or Expression with resultType string)." }, "dataset": { "description": "The database name of the Google BigQuery. Type: string (or Expression with resultType string)." } } }, "GoogleBigQueryV2LinkedService": { "type": "object", "description": "Google BigQuery service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/GoogleBigQueryV2LinkedServiceTypeProperties", "description": "Google BigQuery service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "GoogleBigQueryV2" }, "GoogleBigQueryV2LinkedServiceTypeProperties": { "type": "object", "description": "Google BigQuery service linked service properties.", "properties": { "projectId": { "description": "The default BigQuery project id to query against. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/GoogleBigQueryV2AuthenticationType", "description": "The OAuth 2.0 authentication mechanism used for authentication." }, "clientId": { "description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string)." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret of the google application used to acquire the refresh token." }, "refreshToken": { "$ref": "#/definitions/SecretBase", "description": "The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication." }, "keyFileContent": { "$ref": "#/definitions/SecretBase", "description": "The content of the .json key file that is used to authenticate the service account. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "projectId", "authenticationType" ] }, "GoogleBigQueryV2ObjectDataset": { "type": "object", "description": "Google BigQuery service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GoogleBigQueryV2DatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "GoogleBigQueryV2Object" }, "GoogleBigQueryV2Source": { "type": "object", "description": "A copy activity Google BigQuery service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "GoogleBigQueryV2Source" }, "GoogleCloudStorageLinkedService": { "type": "object", "description": "Linked service for Google Cloud Storage.", "properties": { "typeProperties": { "$ref": "#/definitions/GoogleCloudStorageLinkedServiceTypeProperties", "description": "Google Cloud Storage linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "GoogleCloudStorage" }, "GoogleCloudStorageLinkedServiceTypeProperties": { "type": "object", "description": "Google Cloud Storage linked service properties.", "properties": { "accessKeyId": { "description": "The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string)." }, "secretAccessKey": { "$ref": "#/definitions/SecretBase", "description": "The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user." }, "serviceUrl": { "description": "This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "GoogleCloudStorageLocation": { "type": "object", "description": "The location of Google Cloud Storage dataset.", "properties": { "bucketName": { "description": "Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string)" }, "version": { "description": "Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "GoogleCloudStorageLocation" }, "GoogleCloudStorageReadSettings": { "type": "object", "description": "Google Cloud Storage read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string)." }, "prefix": { "description": "The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string)." }, "fileListPath": { "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": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "GoogleCloudStorageReadSettings" }, "GoogleSheetsLinkedService": { "type": "object", "description": "Linked service for GoogleSheets.", "properties": { "typeProperties": { "$ref": "#/definitions/GoogleSheetsLinkedServiceTypeProperties", "description": "GoogleSheets linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "GoogleSheets" }, "GoogleSheetsLinkedServiceTypeProperties": { "type": "object", "description": "GoogleSheets linked service type properties.", "properties": { "apiToken": { "$ref": "#/definitions/SecretBase", "description": "The api token for the GoogleSheets source." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "apiToken" ] }, "GreenplumAuthenticationType": { "type": "string", "description": "The authentication type to use. Type: string. Only used for V2.", "enum": [ "Basic" ], "x-ms-enum": { "name": "GreenplumAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" } ] } }, "GreenplumDatasetTypeProperties": { "type": "object", "description": "Greenplum Dataset Properties", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The table name of Greenplum. Type: string (or Expression with resultType string)." }, "schema": { "description": "The schema name of Greenplum. Type: string (or Expression with resultType string)." } } }, "GreenplumLinkedService": { "type": "object", "description": "Greenplum Database linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/GreenplumLinkedServiceTypeProperties", "description": "Greenplum Database linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Greenplum" }, "GreenplumLinkedServiceTypeProperties": { "type": "object", "description": "Greenplum Database linked service properties.", "properties": { "connectionString": { "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "pwd": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "authenticationType": { "$ref": "#/definitions/GreenplumAuthenticationType", "description": "The authentication type to use. Type: string. Only used for V2." }, "host": { "description": "Host name for connection. Type: string. Only used for V2." }, "port": { "description": "The port for the connection. Type: integer. Only used for V2." }, "username": { "description": "Username for authentication. Type: string. Only used for V2." }, "database": { "description": "Database name for connection. Type: string. Only used for V2." }, "sslMode": { "description": "SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. Only used for V2." }, "connectionTimeout": { "description": "The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. Only used for V2." }, "commandTimeout": { "description": "The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer. Only used for V2." } } }, "GreenplumSource": { "type": "object", "description": "A copy activity Greenplum Database source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "GreenplumSource" }, "GreenplumTableDataset": { "type": "object", "description": "Greenplum Database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GreenplumDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "GreenplumTable" }, "HBaseAuthenticationType": { "type": "string", "description": "The authentication mechanism to use to connect to the HBase server.", "enum": [ "Anonymous", "Basic" ], "x-ms-enum": { "name": "HBaseAuthenticationType", "modelAsString": true, "values": [ { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "Basic", "value": "Basic", "description": "Basic" } ] } }, "HBaseLinkedService": { "type": "object", "description": "HBase server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/HBaseLinkedServiceTypeProperties", "description": "HBase server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "HBase" }, "HBaseLinkedServiceTypeProperties": { "type": "object", "description": "HBase server linked service properties.", "properties": { "host": { "description": "The IP address or host name of the HBase server. (i.e. 192.168.222.160)" }, "port": { "description": "The TCP port that the HBase instance uses to listen for client connections. The default value is 9090." }, "httpPath": { "description": "The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)" }, "authenticationType": { "$ref": "#/definitions/HBaseAuthenticationType", "description": "The authentication mechanism to use to connect to the HBase server." }, "username": { "description": "The user name used to connect to the HBase instance." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name." }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false." }, "trustedCertPath": { "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR." }, "allowHostNameCNMismatch": { "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false." }, "allowSelfSignedServerCert": { "description": "Specifies whether to allow self-signed certificates from the server. The default value is false." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host", "authenticationType" ] }, "HBaseObjectDataset": { "type": "object", "description": "HBase server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "HBaseObject" }, "HBaseSource": { "type": "object", "description": "A copy activity HBase server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "HBaseSource" }, "HDInsightActivityDebugInfoOption": { "type": "string", "description": "The HDInsightActivityDebugInfoOption settings to use.", "enum": [ "None", "Always", "Failure" ], "x-ms-enum": { "name": "HDInsightActivityDebugInfoOption", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Always", "value": "Always", "description": "Always" }, { "name": "Failure", "value": "Failure", "description": "Failure" } ] } }, "HDInsightClusterAuthenticationType": { "type": "string", "description": "HDInsight cluster authentication type.", "enum": [ "BasicAuth", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], "x-ms-enum": { "name": "HDInsightClusterAuthenticationType", "modelAsString": true, "values": [ { "name": "BasicAuth", "value": "BasicAuth", "description": "BasicAuth" }, { "name": "SystemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", "description": "SystemAssignedManagedIdentity" }, { "name": "UserAssignedManagedIdentity", "value": "UserAssignedManagedIdentity", "description": "UserAssignedManagedIdentity" } ] } }, "HDInsightHiveActivity": { "type": "object", "description": "HDInsight Hive activity type.", "properties": { "typeProperties": { "$ref": "#/definitions/HDInsightHiveActivityTypeProperties", "description": "HDInsight Hive activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "HDInsightHive" }, "HDInsightHiveActivityTypeProperties": { "type": "object", "description": "HDInsight Hive activity properties.", "properties": { "storageLinkedServices": { "type": "array", "description": "Storage linked service references.", "items": { "$ref": "#/definitions/LinkedServiceReference" }, "x-ms-identifiers": [ "referenceName" ] }, "arguments": { "type": "array", "description": "User specified arguments to HDInsightActivity.", "items": {} }, "getDebugInfo": { "$ref": "#/definitions/HDInsightActivityDebugInfoOption", "description": "Debug info option." }, "scriptPath": { "description": "Script path. Type: string (or Expression with resultType string)." }, "scriptLinkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Script linked service reference." }, "defines": { "type": "object", "description": "Allows user to specify defines for Hive job request.", "additionalProperties": {} }, "variables": { "type": "object", "description": "User specified arguments under hivevar namespace.", "additionalProperties": {} }, "queryTimeout": { "type": "integer", "format": "int32", "description": "Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)" } } }, "HDInsightLinkedService": { "type": "object", "description": "HDInsight linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/HDInsightLinkedServiceTypeProperties", "description": "HDInsight linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "HDInsight" }, "HDInsightLinkedServiceTypeProperties": { "type": "object", "description": "HDInsight linked service properties.", "properties": { "clusterUri": { "description": "HDInsight cluster URI. Type: string (or Expression with resultType string)." }, "clusterAuthType": { "$ref": "#/definitions/HDInsightClusterAuthenticationType", "description": "HDInsight cluster authentication type." }, "userName": { "description": "HDInsight cluster user name. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "HDInsight cluster password." }, "linkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "The Azure Storage linked service reference." }, "hcatalogLinkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "A reference to the Azure SQL linked service that points to the HCatalog database." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "isEspEnabled": { "description": "Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean." }, "fileSystem": { "description": "Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string)." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing MI authentication information for the HDInsight cluster." } }, "required": [ "clusterUri" ] }, "HDInsightMapReduceActivity": { "type": "object", "description": "HDInsight MapReduce activity type.", "properties": { "typeProperties": { "$ref": "#/definitions/HDInsightMapReduceActivityTypeProperties", "description": "HDInsight MapReduce activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "HDInsightMapReduce" }, "HDInsightMapReduceActivityTypeProperties": { "type": "object", "description": "HDInsight MapReduce activity properties.", "properties": { "storageLinkedServices": { "type": "array", "description": "Storage linked service references.", "items": { "$ref": "#/definitions/LinkedServiceReference" }, "x-ms-identifiers": [ "referenceName" ] }, "arguments": { "type": "array", "description": "User specified arguments to HDInsightActivity.", "items": {} }, "getDebugInfo": { "$ref": "#/definitions/HDInsightActivityDebugInfoOption", "description": "Debug info option." }, "className": { "description": "Class name. Type: string (or Expression with resultType string)." }, "jarFilePath": { "description": "Jar path. Type: string (or Expression with resultType string)." }, "jarLinkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Jar linked service reference." }, "jarLibs": { "type": "array", "description": "Jar libs.", "items": {} }, "defines": { "type": "object", "description": "Allows user to specify defines for the MapReduce job request.", "additionalProperties": {} } }, "required": [ "className", "jarFilePath" ] }, "HDInsightOnDemandLinkedService": { "type": "object", "description": "HDInsight ondemand linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/HDInsightOnDemandLinkedServiceTypeProperties", "description": "HDInsight ondemand linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "HDInsightOnDemand" }, "HDInsightOnDemandLinkedServiceTypeProperties": { "type": "object", "description": "HDInsight ondemand linked service properties.", "properties": { "clusterSize": { "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int)." }, "timeToLive": { "description": "The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string)." }, "version": { "description": "Version of the HDInsight cluster.  Type: string (or Expression with resultType string)." }, "linkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "Azure Storage linked service to be used by the on-demand cluster for storing and processing data." }, "hostSubscriptionId": { "description": "The customer’s subscription to host the cluster. Type: string (or Expression with resultType string)." }, "servicePrincipalId": { "description": "The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The key for the service principal id." }, "tenant": { "description": "The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string)." }, "clusterResourceGroup": { "description": "The resource group where the cluster belongs. Type: string (or Expression with resultType string)." }, "clusterResourceGroupAuthType": { "$ref": "#/definitions/HDInsightOndemandClusterResourceGroupAuthenticationType", "description": "HDInsight On-demand cluster resource group authentication type." }, "clusterNamePrefix": { "description": "The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string)." }, "clusterUserName": { "description": "The username to access the cluster. Type: string (or Expression with resultType string)." }, "clusterPassword": { "$ref": "#/definitions/SecretBase", "description": "The password to access the cluster." }, "clusterSshUserName": { "description": "The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string)." }, "clusterSshPassword": { "$ref": "#/definitions/SecretBase", "description": "The password to SSH remotely connect cluster’s node (for Linux)." }, "additionalLinkedServiceNames": { "type": "array", "description": "Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.", "items": { "$ref": "#/definitions/LinkedServiceReference" }, "x-ms-identifiers": [ "referenceName" ] }, "hcatalogLinkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore." }, "clusterType": { "description": "The cluster type. Type: string (or Expression with resultType string)." }, "sparkVersion": { "description": "The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string)." }, "coreConfiguration": { "description": "Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created." }, "hBaseConfiguration": { "description": "Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster." }, "hdfsConfiguration": { "description": "Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster." }, "hiveConfiguration": { "description": "Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster." }, "mapReduceConfiguration": { "description": "Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster." }, "oozieConfiguration": { "description": "Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster." }, "stormConfiguration": { "description": "Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster." }, "yarnConfiguration": { "description": "Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "headNodeSize": { "description": "Specifies the size of the head node for the HDInsight cluster." }, "dataNodeSize": { "description": "Specifies the size of the data node for the HDInsight cluster." }, "zookeeperNodeSize": { "description": "Specifies the size of the Zoo Keeper node for the HDInsight cluster." }, "scriptActions": { "type": "array", "description": "Custom script actions to run on HDI ondemand cluster once it's up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.", "items": { "$ref": "#/definitions/ScriptAction" }, "x-ms-identifiers": [ "name" ] }, "virtualNetworkId": { "description": "The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string)." }, "subnetName": { "description": "The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string)." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "required": [ "clusterSize", "timeToLive", "version", "linkedServiceName", "hostSubscriptionId", "tenant", "clusterResourceGroup" ] }, "HDInsightOndemandClusterResourceGroupAuthenticationType": { "type": "string", "description": "HDInsight On-demand cluster resource group authentication type.", "enum": [ "ServicePrincipalKey", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], "x-ms-enum": { "name": "HDInsightOndemandClusterResourceGroupAuthenticationType", "modelAsString": true, "values": [ { "name": "ServicePrincipalKey", "value": "ServicePrincipalKey", "description": "ServicePrincipalKey" }, { "name": "SystemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", "description": "SystemAssignedManagedIdentity" }, { "name": "UserAssignedManagedIdentity", "value": "UserAssignedManagedIdentity", "description": "UserAssignedManagedIdentity" } ] } }, "HDInsightPigActivity": { "type": "object", "description": "HDInsight Pig activity type.", "properties": { "typeProperties": { "$ref": "#/definitions/HDInsightPigActivityTypeProperties", "description": "HDInsight Pig activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "HDInsightPig" }, "HDInsightPigActivityTypeProperties": { "type": "object", "description": "HDInsight Pig activity properties.", "properties": { "storageLinkedServices": { "type": "array", "description": "Storage linked service references.", "items": { "$ref": "#/definitions/LinkedServiceReference" }, "x-ms-identifiers": [ "referenceName" ] }, "arguments": { "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." }, "getDebugInfo": { "$ref": "#/definitions/HDInsightActivityDebugInfoOption", "description": "Debug info option." }, "scriptPath": { "description": "Script path. Type: string (or Expression with resultType string)." }, "scriptLinkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Script linked service reference." }, "defines": { "type": "object", "description": "Allows user to specify defines for Pig job request.", "additionalProperties": {} } } }, "HDInsightSparkActivity": { "type": "object", "description": "HDInsight Spark activity.", "properties": { "typeProperties": { "$ref": "#/definitions/HDInsightSparkActivityTypeProperties", "description": "HDInsight spark activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "HDInsightSpark" }, "HDInsightSparkActivityTypeProperties": { "type": "object", "description": "HDInsight spark activity properties.", "properties": { "rootPath": { "description": "The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string)." }, "entryFilePath": { "description": "The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string)." }, "arguments": { "type": "array", "description": "The user-specified arguments to HDInsightSparkActivity.", "items": {} }, "getDebugInfo": { "$ref": "#/definitions/HDInsightActivityDebugInfoOption", "description": "Debug info option." }, "sparkJobLinkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs." }, "className": { "type": "string", "description": "The application's Java/Spark main class." }, "proxyUser": { "description": "The user to impersonate that will execute the job. Type: string (or Expression with resultType string)." }, "sparkConfig": { "type": "object", "description": "Spark configuration property.", "additionalProperties": {} } }, "required": [ "rootPath", "entryFilePath" ] }, "HDInsightStreamingActivity": { "type": "object", "description": "HDInsight streaming activity type.", "properties": { "typeProperties": { "$ref": "#/definitions/HDInsightStreamingActivityTypeProperties", "description": "HDInsight streaming activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "HDInsightStreaming" }, "HDInsightStreamingActivityTypeProperties": { "type": "object", "description": "HDInsight streaming activity properties.", "properties": { "storageLinkedServices": { "type": "array", "description": "Storage linked service references.", "items": { "$ref": "#/definitions/LinkedServiceReference" }, "x-ms-identifiers": [ "referenceName" ] }, "arguments": { "type": "array", "description": "User specified arguments to HDInsightActivity.", "items": {} }, "getDebugInfo": { "$ref": "#/definitions/HDInsightActivityDebugInfoOption", "description": "Debug info option." }, "mapper": { "description": "Mapper executable name. Type: string (or Expression with resultType string)." }, "reducer": { "description": "Reducer executable name. Type: string (or Expression with resultType string)." }, "input": { "description": "Input blob path. Type: string (or Expression with resultType string)." }, "output": { "description": "Output blob path. Type: string (or Expression with resultType string)." }, "filePaths": { "type": "array", "description": "Paths to streaming job files. Can be directories.", "items": {} }, "fileLinkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Linked service reference where the files are located." }, "combiner": { "description": "Combiner executable name. Type: string (or Expression with resultType string)." }, "commandEnvironment": { "type": "array", "description": "Command line environment values.", "items": {} }, "defines": { "type": "object", "description": "Allows user to specify defines for streaming job request.", "additionalProperties": {} } }, "required": [ "mapper", "reducer", "input", "output", "filePaths" ] }, "HdfsLinkedService": { "type": "object", "description": "Hadoop Distributed File System (HDFS) linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/HdfsLinkedServiceTypeProperties", "description": "HDFS linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Hdfs" }, "HdfsLinkedServiceTypeProperties": { "type": "object", "description": "HDFS linked service properties.", "properties": { "url": { "description": "The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string)." }, "authenticationType": { "description": "Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "userName": { "description": "User name for Windows authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for Windows authentication." } }, "required": [ "url" ] }, "HdfsLocation": { "type": "object", "description": "The location of HDFS.", "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "HdfsLocation" }, "HdfsReadSettings": { "type": "object", "description": "HDFS read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "HDFS wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "HDFS wildcardFileName. Type: string (or Expression with resultType string)." }, "fileListPath": { "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": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." }, "distcpSettings": { "$ref": "#/definitions/DistcpSettings", "description": "Specifies Distcp-related settings." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "HdfsReadSettings" }, "HdfsSource": { "type": "object", "description": "A copy activity HDFS source.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "distcpSettings": { "$ref": "#/definitions/DistcpSettings", "description": "Specifies Distcp-related settings." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "HdfsSource" }, "HdiNodeTypes": { "type": "string", "description": "All available HdiNodeTypes values.", "enum": [ "Headnode", "Workernode", "Zookeeper" ], "x-ms-enum": { "name": "HdiNodeTypes", "modelAsString": true, "values": [ { "name": "Headnode", "value": "Headnode", "description": "Headnode" }, { "name": "Workernode", "value": "Workernode", "description": "Workernode" }, { "name": "Zookeeper", "value": "Zookeeper", "description": "Zookeeper" } ] } }, "HiveAuthenticationType": { "type": "string", "description": "The authentication method used to access the Hive server.", "enum": [ "Anonymous", "Username", "UsernameAndPassword", "WindowsAzureHDInsightService" ], "x-ms-enum": { "name": "HiveAuthenticationType", "modelAsString": true, "values": [ { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "Username", "value": "Username", "description": "Username" }, { "name": "UsernameAndPassword", "value": "UsernameAndPassword", "description": "UsernameAndPassword" }, { "name": "WindowsAzureHDInsightService", "value": "WindowsAzureHDInsightService", "description": "WindowsAzureHDInsightService" } ] } }, "HiveDatasetTypeProperties": { "type": "object", "description": "Hive Properties", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The table name of the Hive. Type: string (or Expression with resultType string)." }, "schema": { "description": "The schema name of the Hive. Type: string (or Expression with resultType string)." } } }, "HiveLinkedService": { "type": "object", "description": "Hive Server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/HiveLinkedServiceTypeProperties", "description": "Hive Server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Hive" }, "HiveLinkedServiceTypeProperties": { "type": "object", "description": "Hive Server linked service properties.", "properties": { "host": { "description": "IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable)." }, "port": { "description": "The TCP port that the Hive server uses to listen for client connections." }, "serverType": { "$ref": "#/definitions/HiveServerType", "description": "The type of Hive server." }, "thriftTransportProtocol": { "$ref": "#/definitions/HiveThriftTransportProtocol", "description": "The transport protocol to use in the Thrift layer." }, "authenticationType": { "$ref": "#/definitions/HiveAuthenticationType", "description": "The authentication method used to access the Hive server." }, "serviceDiscoveryMode": { "description": "true to indicate using the ZooKeeper service, false not." }, "zooKeeperNameSpace": { "description": "The namespace on ZooKeeper under which Hive Server 2 nodes are added." }, "useNativeQuery": { "description": "Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL." }, "username": { "description": "The user name that you use to access Hive Server." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name that you provided in the Username field" }, "httpPath": { "description": "The partial URL corresponding to the Hive server." }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false." }, "enableServerCertificateValidation": { "description": "Specifies whether the connections to the server will validate server certificate, the default value is True. Only used for Version 2.0" }, "trustedCertPath": { "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR." }, "useSystemTrustStore": { "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false." }, "allowHostNameCNMismatch": { "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false." }, "allowSelfSignedServerCert": { "description": "Specifies whether to allow self-signed certificates from the server. The default value is false." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host", "authenticationType" ] }, "HiveObjectDataset": { "type": "object", "description": "Hive Server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/HiveDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "HiveObject" }, "HiveServerType": { "type": "string", "description": "The type of Hive server.", "enum": [ "HiveServer1", "HiveServer2", "HiveThriftServer" ], "x-ms-enum": { "name": "HiveServerType", "modelAsString": true, "values": [ { "name": "HiveServer1", "value": "HiveServer1", "description": "HiveServer1" }, { "name": "HiveServer2", "value": "HiveServer2", "description": "HiveServer2" }, { "name": "HiveThriftServer", "value": "HiveThriftServer", "description": "HiveThriftServer" } ] } }, "HiveSource": { "type": "object", "description": "A copy activity Hive Server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "HiveSource" }, "HiveThriftTransportProtocol": { "type": "string", "description": "The transport protocol to use in the Thrift layer.", "enum": [ "Binary", "SASL", "HTTP " ], "x-ms-enum": { "name": "HiveThriftTransportProtocol", "modelAsString": true, "values": [ { "name": "Binary", "value": "Binary", "description": "Binary" }, { "name": "SASL", "value": "SASL", "description": "SASL" }, { "name": "HTTP ", "value": "HTTP ", "description": "HTTP" } ] } }, "HttpAuthenticationType": { "type": "string", "description": "The authentication type to be used to connect to the HTTP server.", "enum": [ "Basic", "Anonymous", "Digest", "Windows", "ClientCertificate" ], "x-ms-enum": { "name": "HttpAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "Digest", "value": "Digest", "description": "Digest" }, { "name": "Windows", "value": "Windows", "description": "Windows" }, { "name": "ClientCertificate", "value": "ClientCertificate", "description": "ClientCertificate" } ] } }, "HttpDataset": { "type": "object", "description": "A file in an HTTP web server.", "properties": { "typeProperties": { "$ref": "#/definitions/HttpDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "HttpFile" }, "HttpDatasetTypeProperties": { "type": "object", "description": "Properties specific to this dataset type.", "properties": { "relativeUrl": { "description": "The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string)." }, "requestMethod": { "description": "The HTTP method for the HTTP request. Type: string (or Expression with resultType string)." }, "requestBody": { "description": "The body for the HTTP request. Type: string (or Expression with resultType string)." }, "additionalHeaders": { "description": "The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1\n...\nrequest-header-name-n:request-header-value-n Type: string (or Expression with resultType string)." }, "format": { "$ref": "#/definitions/DatasetStorageFormat", "description": "The format of files." }, "compression": { "$ref": "#/definitions/DatasetCompression", "description": "The data compression method used on files." } } }, "HttpLinkedService": { "type": "object", "description": "Linked service for an HTTP source.", "properties": { "typeProperties": { "$ref": "#/definitions/HttpLinkedServiceTypeProperties", "description": "Properties specific to this linked service type.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "HttpServer" }, "HttpLinkedServiceTypeProperties": { "type": "object", "description": "Properties specific to this linked service type.", "properties": { "url": { "description": "The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/HttpAuthenticationType", "description": "The authentication type to be used to connect to the HTTP server." }, "userName": { "description": "User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication." }, "authHeaders": { "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type)." }, "embeddedCertData": { "description": "Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string)." }, "certThumbprint": { "description": "Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "enableServerCertificateValidation": { "description": "If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean)." } }, "required": [ "url" ] }, "HttpReadSettings": { "type": "object", "description": "Http read settings.", "properties": { "requestMethod": { "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." }, "requestBody": { "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." }, "additionalHeaders": { "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." }, "requestTimeout": { "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server. Type: string (or Expression with resultType string)." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "HttpReadSettings" }, "HttpServerLocation": { "type": "object", "description": "The location of http server.", "properties": { "relativeUrl": { "description": "Specify the relativeUrl of http server. Type: string (or Expression with resultType string)" } }, "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "HttpServerLocation" }, "HttpSource": { "type": "object", "description": "A copy activity source for an HTTP file.", "properties": { "httpRequestTimeout": { "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]))." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "HttpSource" }, "HubspotLinkedService": { "type": "object", "description": "Hubspot Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/HubspotLinkedServiceTypeProperties", "description": "Hubspot Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Hubspot" }, "HubspotLinkedServiceTypeProperties": { "type": "object", "description": "Hubspot Service linked service properties.", "properties": { "clientId": { "description": "The client ID associated with your Hubspot application." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret associated with your Hubspot application." }, "accessToken": { "$ref": "#/definitions/SecretBase", "description": "The access token obtained when initially authenticating your OAuth integration." }, "refreshToken": { "$ref": "#/definitions/SecretBase", "description": "The refresh token obtained when initially authenticating your OAuth integration." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "clientId" ] }, "HubspotObjectDataset": { "type": "object", "description": "Hubspot Service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "HubspotObject" }, "HubspotSource": { "type": "object", "description": "A copy activity Hubspot Service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "HubspotSource" }, "IcebergDataset": { "type": "object", "description": "Iceberg dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/IcebergDatasetTypeProperties", "description": "Iceberg dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "Iceberg" }, "IcebergDatasetTypeProperties": { "type": "object", "description": "Iceberg dataset properties.", "properties": { "location": { "$ref": "#/definitions/DatasetLocation", "description": "The location of the iceberg storage. Setting a file name is not allowed for iceberg format." } }, "required": [ "location" ] }, "IcebergSink": { "type": "object", "description": "A copy activity Iceberg sink.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreWriteSettings", "description": "Iceberg store settings." }, "formatSettings": { "$ref": "#/definitions/IcebergWriteSettings", "description": "Iceberg format settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "IcebergSink" }, "IcebergWriteSettings": { "type": "object", "description": "Iceberg write settings.", "allOf": [ { "$ref": "#/definitions/FormatWriteSettings" } ], "x-ms-discriminator-value": "IcebergWriteSettings" }, "IfConditionActivity": { "type": "object", "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.", "properties": { "typeProperties": { "$ref": "#/definitions/IfConditionActivityTypeProperties", "description": "IfCondition activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "IfCondition" }, "IfConditionActivityTypeProperties": { "type": "object", "description": "IfCondition activity properties.", "properties": { "expression": { "$ref": "#/definitions/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." }, "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" }, "x-ms-identifiers": [ "name" ] }, "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" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "expression" ] }, "ImpalaAuthenticationType": { "type": "string", "description": "The authentication type to use.", "enum": [ "Anonymous", "SASLUsername", "UsernameAndPassword" ], "x-ms-enum": { "name": "ImpalaAuthenticationType", "modelAsString": true, "values": [ { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "SASLUsername", "value": "SASLUsername", "description": "SASLUsername" }, { "name": "UsernameAndPassword", "value": "UsernameAndPassword", "description": "UsernameAndPassword" } ] } }, "ImpalaDatasetTypeProperties": { "type": "object", "description": "Impala Dataset Properties", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The table name of the Impala. Type: string (or Expression with resultType string)." }, "schema": { "description": "The schema name of the Impala. Type: string (or Expression with resultType string)." } } }, "ImpalaLinkedService": { "type": "object", "description": "Impala server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/ImpalaLinkedServiceTypeProperties", "description": "Impala server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Impala" }, "ImpalaLinkedServiceTypeProperties": { "type": "object", "description": "Impala server linked service properties.", "properties": { "host": { "description": "The IP address or host name of the Impala server. (i.e. 192.168.222.160)" }, "port": { "description": "The TCP port that the Impala server uses to listen for client connections. The default value is 21050." }, "authenticationType": { "$ref": "#/definitions/ImpalaAuthenticationType", "description": "The authentication type to use." }, "username": { "description": "The user name used to access the Impala server. The default value is anonymous when using SASLUsername." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name when using UsernameAndPassword." }, "thriftTransportProtocol": { "$ref": "#/definitions/ImpalaThriftTransportProtocol", "description": "The transport protocol to use in the Thrift layer (for V2 only). Default value is Binary." }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false." }, "enableServerCertificateValidation": { "description": "Specify whether to enable server SSL certificate validation when you connect.Always use System Trust Store (for V2 only). The default value is true." }, "trustedCertPath": { "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR." }, "useSystemTrustStore": { "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false." }, "allowHostNameCNMismatch": { "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false." }, "allowSelfSignedServerCert": { "description": "Specifies whether to allow self-signed certificates from the server. The default value is false." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host", "authenticationType" ] }, "ImpalaObjectDataset": { "type": "object", "description": "Impala server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/ImpalaDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "ImpalaObject" }, "ImpalaSource": { "type": "object", "description": "A copy activity Impala server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "ImpalaSource" }, "ImpalaThriftTransportProtocol": { "type": "string", "description": "The transport protocol to use in the Thrift layer (for V2 only). Default value is Binary.", "enum": [ "Binary", "HTTP" ], "x-ms-enum": { "name": "ImpalaThriftTransportProtocol", "modelAsString": false, "values": [ { "name": "Binary", "value": "Binary", "description": "Binary" }, { "name": "HTTP", "value": "HTTP", "description": "HTTP" } ] } }, "ImportSettings": { "type": "object", "description": "Import command settings.", "properties": { "type": { "type": "string", "description": "The import setting type." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "InformixLinkedService": { "type": "object", "description": "Informix linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/InformixLinkedServiceTypeProperties", "description": "Informix linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Informix" }, "InformixLinkedServiceTypeProperties": { "type": "object", "description": "Informix linked service properties.", "properties": { "connectionString": { "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string." }, "authenticationType": { "description": "Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string)." }, "credential": { "$ref": "#/definitions/SecretBase", "description": "The access credential portion of the connection string specified in driver-specific property-value format." }, "userName": { "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for Basic authentication." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "connectionString" ] }, "InformixSink": { "type": "object", "description": "A copy activity Informix sink.", "properties": { "preCopyScript": { "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "InformixSink" }, "InformixSource": { "type": "object", "description": "A copy activity source for Informix.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "InformixSource" }, "InformixTableDataset": { "type": "object", "description": "The Informix table dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/InformixTableDatasetTypeProperties", "description": "Informix table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "InformixTable" }, "InformixTableDatasetTypeProperties": { "type": "object", "description": "Informix table dataset properties.", "properties": { "tableName": { "description": "The Informix table name. Type: string (or Expression with resultType string)." } } }, "IntegrationRuntime": { "type": "object", "description": "Azure Data Factory nested object which serves as a compute resource for activities.", "properties": { "type": { "$ref": "#/definitions/IntegrationRuntimeType", "description": "Type of integration runtime." }, "description": { "type": "string", "description": "Integration runtime description." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "IntegrationRuntimeAuthKeyName": { "type": "string", "description": "The name of the authentication key to regenerate.", "enum": [ "authKey1", "authKey2" ], "x-ms-enum": { "name": "IntegrationRuntimeAuthKeyName", "modelAsString": true, "values": [ { "name": "authKey1", "value": "authKey1", "description": "authKey1" }, { "name": "authKey2", "value": "authKey2", "description": "authKey2" } ] } }, "IntegrationRuntimeAuthKeys": { "type": "object", "description": "The integration runtime authentication keys.", "properties": { "authKey1": { "type": "string", "description": "The primary integration runtime authentication key." }, "authKey2": { "type": "string", "description": "The secondary integration runtime authentication key." } } }, "IntegrationRuntimeAutoUpdate": { "type": "string", "description": "The state of integration runtime auto update.", "enum": [ "On", "Off" ], "x-ms-enum": { "name": "IntegrationRuntimeAutoUpdate", "modelAsString": true, "values": [ { "name": "On", "value": "On", "description": "On" }, { "name": "Off", "value": "Off", "description": "Off" } ] } }, "IntegrationRuntimeComputeProperties": { "type": "object", "description": "The compute resource properties for managed integration runtime.", "properties": { "location": { "type": "string", "description": "The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities" }, "nodeSize": { "type": "string", "description": "The node size requirement to managed integration runtime." }, "numberOfNodes": { "type": "integer", "format": "int32", "description": "The required number of nodes for managed integration runtime.", "minimum": 1 }, "maxParallelExecutionsPerNode": { "type": "integer", "format": "int32", "description": "Maximum parallel executions count per node for managed integration runtime.", "minimum": 1 }, "dataFlowProperties": { "$ref": "#/definitions/IntegrationRuntimeDataFlowProperties", "description": "Data flow properties for managed integration runtime." }, "vNetProperties": { "$ref": "#/definitions/IntegrationRuntimeVNetProperties", "description": "VNet properties for managed integration runtime." }, "copyComputeScaleProperties": { "$ref": "#/definitions/CopyComputeScaleProperties", "description": "CopyComputeScale properties for managed integration runtime." }, "pipelineExternalComputeScaleProperties": { "$ref": "#/definitions/PipelineExternalComputeScaleProperties", "description": "PipelineExternalComputeScale properties for managed integration runtime." } }, "additionalProperties": {} }, "IntegrationRuntimeConnectionInfo": { "type": "object", "description": "Connection information for encrypting the on-premises data source credentials.", "properties": { "serviceToken": { "type": "string", "description": "The token generated in service. Callers use this token to authenticate to integration runtime.", "readOnly": true }, "identityCertThumbprint": { "type": "string", "description": "The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation.", "readOnly": true }, "hostServiceUri": { "type": "string", "description": "The on-premises integration runtime host URL.", "readOnly": true }, "version": { "type": "string", "description": "The integration runtime version.", "readOnly": true }, "publicKey": { "type": "string", "description": "The public key for encrypting a credential when transferring the credential to the integration runtime.", "readOnly": true }, "isIdentityCertExprired": { "type": "boolean", "description": "Whether the identity certificate is expired.", "readOnly": true } }, "additionalProperties": {} }, "IntegrationRuntimeCustomSetupScriptProperties": { "type": "object", "description": "Custom setup script properties for a managed dedicated integration runtime.", "properties": { "blobContainerUri": { "type": "string", "description": "The URI of the Azure blob container that contains the custom setup script." }, "sasToken": { "$ref": "#/definitions/SecureString", "description": "The SAS token of the Azure blob container." } } }, "IntegrationRuntimeCustomerVirtualNetwork": { "type": "object", "description": "The definition and properties of virtual network to which Azure-SSIS integration runtime will join.", "properties": { "subnetId": { "type": "string", "description": "The ID of subnet to which Azure-SSIS integration runtime will join." } } }, "IntegrationRuntimeDataFlowProperties": { "type": "object", "description": "Data flow properties for managed integration runtime.", "properties": { "computeType": { "$ref": "#/definitions/DataFlowComputeType", "description": "Compute type of the cluster which will execute data flow job." }, "coreCount": { "type": "integer", "format": "int32", "description": "Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272." }, "timeToLive": { "type": "integer", "format": "int32", "description": "Time to live (in minutes) setting of the cluster which will execute data flow job.", "minimum": 0 }, "cleanup": { "type": "boolean", "description": "Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true." }, "customProperties": { "type": "array", "description": "Custom properties are used to tune the data flow runtime performance.", "items": { "$ref": "#/definitions/IntegrationRuntimeDataFlowPropertiesCustomPropertiesItem" }, "x-ms-identifiers": [] } }, "additionalProperties": {} }, "IntegrationRuntimeDataFlowPropertiesCustomPropertiesItem": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of custom property." }, "value": { "type": "string", "description": "Value of custom property." } } }, "IntegrationRuntimeDataProxyProperties": { "type": "object", "description": "Data proxy properties for a managed dedicated integration runtime.", "properties": { "connectVia": { "$ref": "#/definitions/EntityReference", "description": "The self-hosted integration runtime reference." }, "stagingLinkedService": { "$ref": "#/definitions/EntityReference", "description": "The staging linked service reference." }, "path": { "type": "string", "description": "The path to contain the staged data in the Blob storage." } } }, "IntegrationRuntimeDebugResource": { "type": "object", "description": "Integration runtime debug resource.", "properties": { "properties": { "$ref": "#/definitions/IntegrationRuntime", "description": "Integration runtime properties." } }, "required": [ "properties" ], "allOf": [ { "$ref": "#/definitions/SubResourceDebugResource" } ] }, "IntegrationRuntimeEdition": { "type": "string", "description": "The edition for the SSIS Integration Runtime", "enum": [ "Standard", "Enterprise" ], "x-ms-enum": { "name": "IntegrationRuntimeEdition", "modelAsString": true, "values": [ { "name": "Standard", "value": "Standard", "description": "Standard" }, { "name": "Enterprise", "value": "Enterprise", "description": "Enterprise" } ] } }, "IntegrationRuntimeEntityReferenceType": { "type": "string", "description": "The type of this referenced entity.", "enum": [ "IntegrationRuntimeReference", "LinkedServiceReference" ], "x-ms-enum": { "name": "IntegrationRuntimeEntityReferenceType", "modelAsString": true, "values": [ { "name": "IntegrationRuntimeReference", "value": "IntegrationRuntimeReference", "description": "IntegrationRuntimeReference" }, { "name": "LinkedServiceReference", "value": "LinkedServiceReference", "description": "LinkedServiceReference" } ] } }, "IntegrationRuntimeInternalChannelEncryptionMode": { "type": "string", "description": "It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).", "enum": [ "NotSet", "SslEncrypted", "NotEncrypted" ], "x-ms-enum": { "name": "IntegrationRuntimeInternalChannelEncryptionMode", "modelAsString": true, "values": [ { "name": "NotSet", "value": "NotSet", "description": "NotSet" }, { "name": "SslEncrypted", "value": "SslEncrypted", "description": "SslEncrypted" }, { "name": "NotEncrypted", "value": "NotEncrypted", "description": "NotEncrypted" } ] } }, "IntegrationRuntimeLicenseType": { "type": "string", "description": "License type for bringing your own license scenario.", "enum": [ "BasePrice", "LicenseIncluded" ], "x-ms-enum": { "name": "IntegrationRuntimeLicenseType", "modelAsString": true, "values": [ { "name": "BasePrice", "value": "BasePrice", "description": "BasePrice" }, { "name": "LicenseIncluded", "value": "LicenseIncluded", "description": "LicenseIncluded" } ] } }, "IntegrationRuntimeListResponse": { "type": "object", "description": "A list of integration runtime resources.", "properties": { "value": { "type": "array", "description": "The IntegrationRuntimeResource items on this page", "items": { "$ref": "#/definitions/IntegrationRuntimeResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "IntegrationRuntimeMonitoringData": { "type": "object", "description": "Get monitoring data response.", "properties": { "name": { "type": "string", "description": "Integration runtime name." }, "nodes": { "type": "array", "description": "Integration runtime node monitoring data.", "items": { "$ref": "#/definitions/IntegrationRuntimeNodeMonitoringData" }, "x-ms-identifiers": [ "nodeName" ] } } }, "IntegrationRuntimeNodeIpAddress": { "type": "object", "description": "The IP address of self-hosted integration runtime node.", "properties": { "ipAddress": { "type": "string", "description": "The IP address of self-hosted integration runtime node.", "readOnly": true } } }, "IntegrationRuntimeNodeMonitoringData": { "type": "object", "description": "Monitoring data for integration runtime node.", "properties": { "nodeName": { "type": "string", "description": "Name of the integration runtime node.", "readOnly": true }, "availableMemoryInMB": { "type": "integer", "format": "int32", "description": "Available memory (MB) on the integration runtime node.", "readOnly": true }, "cpuUtilization": { "type": "integer", "format": "int32", "description": "CPU percentage on the integration runtime node.", "readOnly": true }, "concurrentJobsLimit": { "type": "integer", "format": "int32", "description": "Maximum concurrent jobs on the integration runtime node.", "readOnly": true }, "concurrentJobsRunning": { "type": "integer", "format": "int32", "description": "The number of jobs currently running on the integration runtime node.", "readOnly": true }, "maxConcurrentJobs": { "type": "integer", "format": "int32", "description": "The maximum concurrent jobs in this integration runtime.", "readOnly": true }, "sentBytes": { "type": "number", "format": "float", "description": "Sent bytes on the integration runtime node.", "readOnly": true }, "receivedBytes": { "type": "number", "format": "float", "description": "Received bytes on the integration runtime node.", "readOnly": true } }, "additionalProperties": {} }, "IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint": { "type": "object", "description": "Azure-SSIS integration runtime outbound network dependency endpoints for one category.", "properties": { "category": { "type": "string", "description": "The category of outbound network dependency." }, "endpoints": { "type": "array", "description": "The endpoints for outbound network dependency.", "items": { "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpoint" }, "x-ms-identifiers": [ "domainName" ] } } }, "IntegrationRuntimeOutboundNetworkDependenciesEndpoint": { "type": "object", "description": "The endpoint for Azure-SSIS integration runtime outbound network dependency.", "properties": { "domainName": { "type": "string", "description": "The domain name of endpoint." }, "endpointDetails": { "type": "array", "description": "The details of endpoint.", "items": { "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails" }, "x-ms-identifiers": [ "port" ] } } }, "IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails": { "type": "object", "description": "The details of Azure-SSIS integration runtime outbound network dependency endpoint.", "properties": { "port": { "type": "integer", "format": "int32", "description": "The port of endpoint." } } }, "IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse": { "type": "object", "description": "Azure-SSIS integration runtime outbound network dependency endpoints.", "properties": { "value": { "type": "array", "description": "The list of outbound network dependency endpoints.", "items": { "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint" }, "x-ms-identifiers": [ "category" ] } } }, "IntegrationRuntimeReference": { "type": "object", "description": "Integration runtime reference type.", "properties": { "type": { "$ref": "#/definitions/IntegrationRuntimeReferenceType", "description": "Type of integration runtime." }, "referenceName": { "type": "string", "description": "Reference integration runtime name." }, "parameters": { "type": "object", "description": "Arguments for integration runtime.", "additionalProperties": {} } }, "required": [ "type", "referenceName" ] }, "IntegrationRuntimeReferenceType": { "type": "string", "description": "Type of integration runtime.", "enum": [ "IntegrationRuntimeReference" ], "x-ms-enum": { "name": "IntegrationRuntimeReferenceType", "modelAsString": true, "values": [ { "name": "IntegrationRuntimeReference", "value": "IntegrationRuntimeReference", "description": "IntegrationRuntimeReference" } ] } }, "IntegrationRuntimeRegenerateKeyParameters": { "type": "object", "description": "Parameters to regenerate the authentication key.", "properties": { "keyName": { "$ref": "#/definitions/IntegrationRuntimeAuthKeyName", "description": "The name of the authentication key to regenerate." } } }, "IntegrationRuntimeResource": { "type": "object", "description": "Integration runtime resource type.", "properties": { "properties": { "$ref": "#/definitions/IntegrationRuntime", "description": "Integration runtime properties." }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "IntegrationRuntimeSsisCatalogInfo": { "type": "object", "description": "Catalog information for managed dedicated integration runtime.", "properties": { "catalogServerEndpoint": { "type": "string", "description": "The catalog database server URL." }, "catalogAdminUserName": { "type": "string", "description": "The administrator user name of catalog database.", "minLength": 1, "maxLength": 128 }, "catalogAdminPassword": { "$ref": "#/definitions/SecureString", "description": "The password of the administrator user account of the catalog database." }, "catalogPricingTier": { "$ref": "#/definitions/IntegrationRuntimeSsisCatalogPricingTier", "description": "The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/" }, "dualStandbyPairName": { "type": "string", "description": "The dual standby pair name of Azure-SSIS Integration Runtimes to support SSISDB failover." } }, "additionalProperties": {} }, "IntegrationRuntimeSsisCatalogPricingTier": { "type": "string", "description": "The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/", "enum": [ "Basic", "Standard", "Premium", "PremiumRS" ], "x-ms-enum": { "name": "IntegrationRuntimeSsisCatalogPricingTier", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Standard", "value": "Standard", "description": "Standard" }, { "name": "Premium", "value": "Premium", "description": "Premium" }, { "name": "PremiumRS", "value": "PremiumRS", "description": "PremiumRS" } ] } }, "IntegrationRuntimeSsisProperties": { "type": "object", "description": "SSIS properties for managed integration runtime.", "properties": { "catalogInfo": { "$ref": "#/definitions/IntegrationRuntimeSsisCatalogInfo", "description": "Catalog information for managed dedicated integration runtime." }, "licenseType": { "$ref": "#/definitions/IntegrationRuntimeLicenseType", "description": "License type for bringing your own license scenario." }, "customSetupScriptProperties": { "$ref": "#/definitions/IntegrationRuntimeCustomSetupScriptProperties", "description": "Custom setup script properties for a managed dedicated integration runtime." }, "dataProxyProperties": { "$ref": "#/definitions/IntegrationRuntimeDataProxyProperties", "description": "Data proxy properties for a managed dedicated integration runtime." }, "edition": { "$ref": "#/definitions/IntegrationRuntimeEdition", "description": "The edition for the SSIS Integration Runtime" }, "expressCustomSetupProperties": { "type": "array", "description": "Custom setup without script properties for a SSIS integration runtime.", "items": { "$ref": "#/definitions/CustomSetupBase" }, "x-ms-identifiers": [] }, "packageStores": { "type": "array", "description": "Package stores for the SSIS Integration Runtime.", "items": { "$ref": "#/definitions/PackageStore" }, "x-ms-identifiers": [ "name" ] }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "additionalProperties": {} }, "IntegrationRuntimeState": { "type": "string", "description": "The state of integration runtime.", "enum": [ "Initial", "Stopped", "Started", "Starting", "Stopping", "NeedRegistration", "Online", "Limited", "Offline", "AccessDenied" ], "x-ms-enum": { "name": "IntegrationRuntimeState", "modelAsString": true, "values": [ { "name": "Initial", "value": "Initial", "description": "Initial" }, { "name": "Stopped", "value": "Stopped", "description": "Stopped" }, { "name": "Started", "value": "Started", "description": "Started" }, { "name": "Starting", "value": "Starting", "description": "Starting" }, { "name": "Stopping", "value": "Stopping", "description": "Stopping" }, { "name": "NeedRegistration", "value": "NeedRegistration", "description": "NeedRegistration" }, { "name": "Online", "value": "Online", "description": "Online" }, { "name": "Limited", "value": "Limited", "description": "Limited" }, { "name": "Offline", "value": "Offline", "description": "Offline" }, { "name": "AccessDenied", "value": "AccessDenied", "description": "AccessDenied" } ] } }, "IntegrationRuntimeStatus": { "type": "object", "description": "Integration runtime status.", "properties": { "type": { "$ref": "#/definitions/IntegrationRuntimeType", "description": "Type of integration runtime." }, "dataFactoryName": { "type": "string", "description": "The data factory name which the integration runtime belong to.", "readOnly": true }, "state": { "$ref": "#/definitions/IntegrationRuntimeState", "description": "The state of integration runtime.", "readOnly": true } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "IntegrationRuntimeStatusListResponse": { "type": "object", "description": "A list of integration runtime status.", "properties": { "value": { "type": "array", "description": "The IntegrationRuntimeStatusResponse items on this page", "items": { "$ref": "#/definitions/IntegrationRuntimeStatusResponse" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "IntegrationRuntimeStatusResponse": { "type": "object", "description": "Integration runtime status response.", "properties": { "name": { "type": "string", "description": "The integration runtime name.", "readOnly": true }, "properties": { "$ref": "#/definitions/IntegrationRuntimeStatus", "description": "Integration runtime properties." } }, "required": [ "properties" ] }, "IntegrationRuntimeType": { "type": "string", "description": "The type of integration runtime.", "enum": [ "Managed", "SelfHosted" ], "x-ms-enum": { "name": "IntegrationRuntimeType", "modelAsString": true, "values": [ { "name": "Managed", "value": "Managed", "description": "Managed" }, { "name": "SelfHosted", "value": "SelfHosted", "description": "SelfHosted" } ] } }, "IntegrationRuntimeUpdateResult": { "type": "string", "description": "The result of the last integration runtime node update.", "enum": [ "None", "Succeed", "Fail" ], "x-ms-enum": { "name": "IntegrationRuntimeUpdateResult", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Succeed", "value": "Succeed", "description": "Succeed" }, { "name": "Fail", "value": "Fail", "description": "Fail" } ] } }, "IntegrationRuntimeVNetProperties": { "type": "object", "description": "VNet properties for managed integration runtime.", "properties": { "vNetId": { "type": "string", "description": "The ID of the VNet that this integration runtime will join." }, "subnet": { "type": "string", "description": "The name of the subnet this integration runtime will join." }, "publicIPs": { "type": "array", "description": "Resource IDs of the public IP addresses that this integration runtime will use.", "items": { "type": "string" } }, "subnetId": { "type": "string", "description": "The ID of subnet, to which this Azure-SSIS integration runtime will be joined." } }, "additionalProperties": {} }, "InteractiveCapabilityStatus": { "type": "string", "description": "The interactive authoring capability status. Must be one of InteractiveCapabilityStatus. The default value is 'Enabling'.", "enum": [ "Enabling", "Enabled", "Disabling", "Disabled" ], "x-ms-enum": { "name": "InteractiveCapabilityStatus", "modelAsString": true, "values": [ { "name": "Enabling", "value": "Enabling", "description": "Enabling" }, { "name": "Enabled", "value": "Enabled", "description": "Enabled" }, { "name": "Disabling", "value": "Disabling", "description": "Disabling" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" } ] } }, "InteractiveQueryProperties": { "type": "object", "description": "Interactive authoring capability type properties.", "properties": { "status": { "$ref": "#/definitions/InteractiveCapabilityStatus", "description": "The interactive authoring capability status. Must be one of InteractiveCapabilityStatus. The default value is 'Enabling'.", "readOnly": true }, "autoTerminationMinutes": { "type": "integer", "format": "int32", "description": "The allowed idle time for interactive authoring.", "readOnly": true } } }, "JiraLinkedService": { "type": "object", "description": "Jira Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/JiraLinkedServiceTypeProperties", "description": "Jira Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Jira" }, "JiraLinkedServiceTypeProperties": { "type": "object", "description": "Jira Service linked service properties.", "properties": { "host": { "description": "The IP address or host name of the Jira service. (e.g. jira.example.com)" }, "port": { "description": "The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP." }, "username": { "description": "The user name that you use to access Jira Service." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name that you provided in the username field." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host", "username" ] }, "JiraObjectDataset": { "type": "object", "description": "Jira Service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/JiraTableDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "JiraObject" }, "JiraSource": { "type": "object", "description": "A copy activity Jira Service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "JiraSource" }, "JiraTableDatasetTypeProperties": { "type": "object", "description": "Jira dataset properties.", "properties": { "tableName": { "description": "This property is only supported in Jira V1 Dataset, please consider upgrading to V2 dataset." }, "schema": { "description": "The schema name of the Jira, applies only for Jira V2 dataset. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the Jira, applies only for Jira V2 dataset. Type: string (or Expression with resultType string)." } } }, "JsonDataset": { "type": "object", "description": "Json dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/JsonDatasetTypeProperties", "description": "Json dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "Json" }, "JsonDatasetTypeProperties": { "type": "object", "description": "Json dataset properties.", "properties": { "location": { "$ref": "#/definitions/DatasetLocation", "description": "The location of the json data storage." }, "encodingName": { "description": "The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." }, "compression": { "$ref": "#/definitions/DatasetCompression", "description": "The data compression method used for the json dataset." } }, "required": [ "location" ] }, "JsonFormat": { "type": "object", "description": "The data stored in JSON format.", "properties": { "filePattern": { "description": "File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive." }, "nestingSeparator": { "description": "The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string)." }, "encodingName": { "description": "The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string)." }, "jsonNodeReference": { "description": "The JSONPath of the JSON array element to be flattened. Example: \"$.ArrayPath\". Type: string (or Expression with resultType string)." }, "jsonPathDefinition": { "description": "The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with \"$\"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {\"Column1\": \"$.Column1Path\", \"Column2\": \"Column2PathInArray\"}. Type: object (or Expression with resultType object)." } }, "allOf": [ { "$ref": "#/definitions/DatasetStorageFormat" } ], "x-ms-discriminator-value": "JsonFormat" }, "JsonFormatFilePattern": { "type": "string", "description": "JSON format file pattern. A property of JsonFormat.", "enum": [ "setOfObjects", "arrayOfObjects" ], "x-ms-enum": { "name": "JsonFormatFilePattern", "modelAsString": true, "values": [ { "name": "setOfObjects", "value": "setOfObjects", "description": "setOfObjects" }, { "name": "arrayOfObjects", "value": "arrayOfObjects", "description": "arrayOfObjects" } ] } }, "JsonReadSettings": { "type": "object", "description": "Json read settings.", "properties": { "compressionProperties": { "$ref": "#/definitions/CompressionReadSettings", "description": "Compression settings." } }, "allOf": [ { "$ref": "#/definitions/FormatReadSettings" } ], "x-ms-discriminator-value": "JsonReadSettings" }, "JsonSink": { "type": "object", "description": "A copy activity Json sink.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreWriteSettings", "description": "Json store settings." }, "formatSettings": { "$ref": "#/definitions/JsonWriteSettings", "description": "Json format settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "JsonSink" }, "JsonSource": { "type": "object", "description": "A copy activity Json source.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreReadSettings", "description": "Json store settings." }, "formatSettings": { "$ref": "#/definitions/JsonReadSettings", "description": "Json format settings." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "JsonSource" }, "JsonWriteFilePattern": { "type": "string", "description": "All available filePatterns.", "enum": [ "setOfObjects", "arrayOfObjects" ], "x-ms-enum": { "name": "JsonWriteFilePattern", "modelAsString": true, "values": [ { "name": "setOfObjects", "value": "setOfObjects", "description": "setOfObjects" }, { "name": "arrayOfObjects", "value": "arrayOfObjects", "description": "arrayOfObjects" } ] } }, "JsonWriteSettings": { "type": "object", "description": "Json write settings.", "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." } }, "allOf": [ { "$ref": "#/definitions/FormatWriteSettings" } ], "x-ms-discriminator-value": "JsonWriteSettings" }, "LakeHouseLinkedService": { "type": "object", "description": "Microsoft Fabric Lakehouse linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/LakeHouseLinkedServiceTypeProperties", "description": "Microsoft Fabric Lakehouse linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Lakehouse" }, "LakeHouseLinkedServiceTypeProperties": { "type": "object", "description": "Microsoft Fabric Lakehouse linked service properties.", "properties": { "workspaceId": { "description": "The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string)." }, "artifactId": { "description": "The ID of Microsoft Fabric Lakehouse artifact. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/LakehouseAuthenticationType", "description": "The authentication type to use." }, "servicePrincipalId": { "description": "The ID of the application used to authenticate against Microsoft Fabric Lakehouse. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The Key of the application used to authenticate against Microsoft Fabric Lakehouse." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { "$ref": "#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } } }, "LakeHouseLocation": { "type": "object", "description": "The location of Microsoft Fabric Lakehouse Files dataset.", "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "LakeHouseLocation" }, "LakeHouseReadSettings": { "type": "object", "description": "Microsoft Fabric Lakehouse Files read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "Microsoft Fabric Lakehouse Files wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "Microsoft Fabric Lakehouse Files wildcardFileName. Type: string (or Expression with resultType string)." }, "fileListPath": { "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": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "LakeHouseReadSettings" }, "LakeHouseTableDataset": { "type": "object", "description": "Microsoft Fabric Lakehouse Table.", "properties": { "typeProperties": { "$ref": "#/definitions/LakeHouseTableDatasetTypeProperties", "description": "Microsoft Fabric Lakehouse Table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "LakehouseTable" }, "LakeHouseTableDatasetTypeProperties": { "type": "object", "description": "Microsoft Fabric Lakehouse Table dataset properties.", "properties": { "schema": { "description": "The schema name of Microsoft Fabric Lakehouse Table. Type: string (or Expression with resultType string)." }, "table": { "description": "The name of Microsoft Fabric Lakehouse Table. Type: string (or Expression with resultType string)." } } }, "LakeHouseTableSink": { "type": "object", "description": "A copy activity for Microsoft Fabric Lakehouse Table sink.", "properties": { "tableActionOption": { "description": "The type of table action for Lakehouse Table sink. Possible values include: \"None\", \"Append\", \"Overwrite\"." }, "partitionOption": { "description": "Create partitions in folder structure based on one or multiple columns. Each distinct column value (pair) will be a new partition. Possible values include: \"None\", \"PartitionByKey\"." }, "partitionNameList": { "description": "Specify the partition column names from sink columns. Type: array of objects (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "LakeHouseTableSink" }, "LakeHouseTableSource": { "type": "object", "description": "A copy activity source for Microsoft Fabric Lakehouse Table.", "properties": { "timestampAsOf": { "description": "Query an older snapshot by timestamp. Type: string (or Expression with resultType string)." }, "versionAsOf": { "description": "Query an older snapshot by version. Type: integer (or Expression with resultType integer)." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "LakeHouseTableSource" }, "LakeHouseWriteSettings": { "type": "object", "description": "Microsoft Fabric Lakehouse Files write settings.", "allOf": [ { "$ref": "#/definitions/StoreWriteSettings" } ], "x-ms-discriminator-value": "LakeHouseWriteSettings" }, "LakehouseAuthenticationType": { "type": "string", "description": "The authentication type to use.", "enum": [ "ServicePrincipal", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], "x-ms-enum": { "name": "LakehouseAuthenticationType", "modelAsString": true, "values": [ { "name": "ServicePrincipal", "value": "ServicePrincipal", "description": "ServicePrincipal" }, { "name": "SystemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", "description": "SystemAssignedManagedIdentity" }, { "name": "UserAssignedManagedIdentity", "value": "UserAssignedManagedIdentity", "description": "UserAssignedManagedIdentity" } ] } }, "LicensedComponentSetupTypeProperties": { "type": "object", "description": "Installation of licensed component setup type properties.", "properties": { "componentName": { "type": "string", "description": "The name of the 3rd party component." }, "licenseKey": { "$ref": "#/definitions/SecretBase", "description": "The license key to activate the component." } }, "required": [ "componentName" ] }, "LinkedIntegrationRuntime": { "type": "object", "description": "The linked integration runtime information.", "properties": { "name": { "type": "string", "description": "The name of the linked integration runtime.", "readOnly": true }, "subscriptionId": { "type": "string", "description": "The subscription ID for which the linked integration runtime belong to.", "readOnly": true }, "dataFactoryName": { "type": "string", "description": "The name of the data factory for which the linked integration runtime belong to.", "readOnly": true }, "dataFactoryLocation": { "type": "string", "description": "The location of the data factory for which the linked integration runtime belong to.", "readOnly": true }, "createTime": { "type": "string", "format": "date-time", "description": "The creating time of the linked integration runtime.", "readOnly": true } } }, "LinkedIntegrationRuntimeKeyAuthorization": { "type": "object", "description": "The key authorization type integration runtime.", "properties": { "key": { "$ref": "#/definitions/SecureString", "description": "The key used for authorization." } }, "required": [ "key" ], "allOf": [ { "$ref": "#/definitions/LinkedIntegrationRuntimeType" } ], "x-ms-discriminator-value": "Key" }, "LinkedIntegrationRuntimeRbacAuthorization": { "type": "object", "description": "The role based access control (RBAC) authorization type integration runtime.", "properties": { "resourceId": { "type": "string", "description": "The resource identifier of the integration runtime to be shared." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "required": [ "resourceId" ], "allOf": [ { "$ref": "#/definitions/LinkedIntegrationRuntimeType" } ], "x-ms-discriminator-value": "RBAC" }, "LinkedIntegrationRuntimeRequest": { "type": "object", "description": "Data factory name for linked integration runtime request.", "properties": { "factoryName": { "type": "string", "description": "The data factory name for linked integration runtime.", "x-ms-client-name": "linkedFactoryName" } }, "required": [ "factoryName" ] }, "LinkedIntegrationRuntimeType": { "type": "object", "description": "The base definition of a linked integration runtime.", "properties": { "authorizationType": { "type": "string", "description": "The authorization type for integration runtime sharing." } }, "discriminator": "authorizationType", "required": [ "authorizationType" ] }, "LinkedService": { "type": "object", "description": "The nested object which contains the information and credential which can be used to connect with related store or compute resource.", "properties": { "type": { "type": "string", "description": "Type of linked service." }, "version": { "type": "string", "description": "Version of the linked service." }, "connectVia": { "$ref": "#/definitions/IntegrationRuntimeReference", "description": "The integration runtime reference." }, "description": { "type": "string", "description": "Linked service description." }, "parameters": { "type": "object", "description": "Parameters for linked service.", "additionalProperties": { "$ref": "#/definitions/ParameterSpecification" } }, "annotations": { "type": "array", "description": "List of tags that can be used for describing the linked service.", "items": {} } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "LinkedServiceDebugResource": { "type": "object", "description": "Linked service debug resource.", "properties": { "properties": { "$ref": "#/definitions/LinkedService", "description": "Properties of linked service." } }, "required": [ "properties" ], "allOf": [ { "$ref": "#/definitions/SubResourceDebugResource" } ] }, "LinkedServiceListResponse": { "type": "object", "description": "A list of linked service resources.", "properties": { "value": { "type": "array", "description": "The LinkedServiceResource items on this page", "items": { "$ref": "#/definitions/LinkedServiceResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "LinkedServiceReference": { "type": "object", "description": "Linked service reference type.", "properties": { "type": { "$ref": "#/definitions/Type", "description": "Linked service reference type." }, "referenceName": { "type": "string", "description": "Reference LinkedService name." }, "parameters": { "type": "object", "description": "Arguments for LinkedService.", "additionalProperties": {} } }, "required": [ "type", "referenceName" ] }, "LinkedServiceResource": { "type": "object", "description": "Linked service resource type.", "properties": { "properties": { "$ref": "#/definitions/LinkedService", "description": "Properties of linked service." }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "LogLocationSettings": { "type": "object", "description": "Log location settings.", "properties": { "linkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "Log storage linked service reference." }, "path": { "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." } }, "required": [ "linkedServiceName" ] }, "LogSettings": { "type": "object", "description": "Log settings.", "properties": { "enableCopyActivityLog": { "description": "Specifies whether to enable copy activity log. Type: boolean (or Expression with resultType boolean)." }, "copyActivityLogSettings": { "$ref": "#/definitions/CopyActivityLogSettings", "description": "Specifies settings for copy activity log." }, "logLocationSettings": { "$ref": "#/definitions/LogLocationSettings", "description": "Log location settings customer needs to provide when enabling log." } }, "required": [ "logLocationSettings" ] }, "LogStorageSettings": { "type": "object", "description": "(Deprecated. Please use LogSettings) Log storage settings.", "properties": { "linkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "Log storage linked service reference." }, "path": { "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." }, "logLevel": { "description": "Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string)." }, "enableReliableLogging": { "description": "Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean)." } }, "required": [ "linkedServiceName" ], "additionalProperties": {} }, "LookupActivity": { "type": "object", "description": "Lookup activity.", "properties": { "typeProperties": { "$ref": "#/definitions/LookupActivityTypeProperties", "description": "Lookup activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "Lookup" }, "LookupActivityTypeProperties": { "type": "object", "description": "Lookup activity properties.", "properties": { "source": { "$ref": "#/definitions/CopySource", "description": "Dataset-specific source properties, same as copy activity source." }, "dataset": { "$ref": "#/definitions/DatasetReference", "description": "Lookup activity dataset reference." }, "firstRowOnly": { "description": "Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean)." }, "treatDecimalAsString": { "description": "Indicates whether to treat decimal values as strings to avoid value overflow issue. This option is enabled for SnowflakeV2 connector only. Type: boolean (or Expression with resultType boolean)." } }, "required": [ "source", "dataset" ] }, "MagentoLinkedService": { "type": "object", "description": "Magento server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/MagentoLinkedServiceTypeProperties", "description": "Magento server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Magento" }, "MagentoLinkedServiceTypeProperties": { "type": "object", "description": "Magento server linked service properties.", "properties": { "host": { "description": "The URL of the Magento instance. (i.e. 192.168.222.110/magento3)" }, "accessToken": { "$ref": "#/definitions/SecretBase", "description": "The access token from Magento." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host" ] }, "MagentoObjectDataset": { "type": "object", "description": "Magento server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "MagentoObject" }, "MagentoSource": { "type": "object", "description": "A copy activity Magento server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "MagentoSource" }, "ManagedIdentityCredential": { "type": "object", "description": "Managed identity credential.", "properties": { "typeProperties": { "$ref": "#/definitions/ManagedIdentityTypeProperties", "description": "Managed identity credential properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Credential" } ], "x-ms-discriminator-value": "ManagedIdentity" }, "ManagedIdentityTypeProperties": { "type": "object", "description": "Managed identity type properties.", "properties": { "resourceId": { "type": "string", "description": "The resource id of user assigned managed identity" } } }, "ManagedIntegrationRuntime": { "type": "object", "description": "Managed integration runtime, including managed elastic and managed dedicated integration runtimes.", "properties": { "state": { "$ref": "#/definitions/IntegrationRuntimeState", "description": "Integration runtime state, only valid for managed dedicated integration runtime.", "readOnly": true }, "typeProperties": { "$ref": "#/definitions/ManagedIntegrationRuntimeTypeProperties", "description": "Managed integration runtime properties.", "x-ms-client-flatten": true }, "managedVirtualNetwork": { "$ref": "#/definitions/ManagedVirtualNetworkReference", "description": "Managed Virtual Network reference." } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/IntegrationRuntime" } ], "x-ms-discriminator-value": "Managed" }, "ManagedIntegrationRuntimeError": { "type": "object", "description": "Error definition for managed integration runtime.", "properties": { "time": { "type": "string", "format": "date-time", "description": "The time when the error occurred.", "readOnly": true }, "code": { "type": "string", "description": "Error code.", "readOnly": true }, "parameters": { "type": "array", "description": "Managed integration runtime error parameters.", "items": { "type": "string" }, "readOnly": true }, "message": { "type": "string", "description": "Error message.", "readOnly": true } }, "additionalProperties": {} }, "ManagedIntegrationRuntimeNode": { "type": "object", "description": "Properties of integration runtime node.", "properties": { "nodeId": { "type": "string", "description": "The managed integration runtime node id.", "readOnly": true }, "status": { "$ref": "#/definitions/ManagedIntegrationRuntimeNodeStatus", "description": "The managed integration runtime node status.", "readOnly": true }, "errors": { "type": "array", "description": "The errors that occurred on this integration runtime node.", "items": { "$ref": "#/definitions/ManagedIntegrationRuntimeError" }, "x-ms-identifiers": [] } }, "additionalProperties": {} }, "ManagedIntegrationRuntimeNodeStatus": { "type": "string", "description": "The managed integration runtime node status.", "enum": [ "Starting", "Available", "Recycling", "Unavailable" ], "x-ms-enum": { "name": "ManagedIntegrationRuntimeNodeStatus", "modelAsString": true, "values": [ { "name": "Starting", "value": "Starting", "description": "Starting" }, { "name": "Available", "value": "Available", "description": "Available" }, { "name": "Recycling", "value": "Recycling", "description": "Recycling" }, { "name": "Unavailable", "value": "Unavailable", "description": "Unavailable" } ] } }, "ManagedIntegrationRuntimeOperationResult": { "type": "object", "description": "Properties of managed integration runtime operation result.", "properties": { "type": { "type": "string", "description": "The operation type. Could be start or stop.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the operation.", "readOnly": true }, "result": { "type": "string", "description": "The operation result.", "readOnly": true }, "errorCode": { "type": "string", "description": "The error code.", "readOnly": true }, "parameters": { "type": "array", "description": "Managed integration runtime error parameters.", "items": { "type": "string" }, "readOnly": true }, "activityId": { "type": "string", "description": "The activity id for the operation request.", "readOnly": true } }, "additionalProperties": {} }, "ManagedIntegrationRuntimeStatus": { "type": "object", "description": "Managed integration runtime status.", "properties": { "typeProperties": { "$ref": "#/definitions/ManagedIntegrationRuntimeStatusTypeProperties", "description": "Managed integration runtime status type properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/IntegrationRuntimeStatus" } ], "x-ms-discriminator-value": "Managed" }, "ManagedIntegrationRuntimeStatusTypeProperties": { "type": "object", "description": "Managed integration runtime status type properties.", "properties": { "createTime": { "type": "string", "format": "date-time", "description": "The time at which the integration runtime was created, in ISO8601 format.", "readOnly": true }, "nodes": { "type": "array", "description": "The list of nodes for managed integration runtime.", "items": { "$ref": "#/definitions/ManagedIntegrationRuntimeNode" }, "readOnly": true, "x-ms-identifiers": [ "nodeId" ] }, "otherErrors": { "type": "array", "description": "The errors that occurred on this integration runtime.", "items": { "$ref": "#/definitions/ManagedIntegrationRuntimeError" }, "readOnly": true, "x-ms-identifiers": [] }, "lastOperation": { "$ref": "#/definitions/ManagedIntegrationRuntimeOperationResult", "description": "The last operation result that occurred on this integration runtime.", "readOnly": true } } }, "ManagedIntegrationRuntimeTypeProperties": { "type": "object", "description": "Managed integration runtime type properties.", "properties": { "computeProperties": { "$ref": "#/definitions/IntegrationRuntimeComputeProperties", "description": "The compute resource for managed integration runtime." }, "ssisProperties": { "$ref": "#/definitions/IntegrationRuntimeSsisProperties", "description": "SSIS properties for managed integration runtime." }, "customerVirtualNetwork": { "$ref": "#/definitions/IntegrationRuntimeCustomerVirtualNetwork", "description": "The name of virtual network to which Azure-SSIS integration runtime will join" }, "interactiveQuery": { "$ref": "#/definitions/InteractiveQueryProperties", "description": "Interactive authoring capability reference." } } }, "ManagedPrivateEndpoint": { "type": "object", "description": "Properties of a managed private endpoint", "properties": { "connectionState": { "$ref": "#/definitions/ConnectionStateProperties", "description": "The managed private endpoint connection state" }, "fqdns": { "type": "array", "description": "Fully qualified domain names", "items": { "type": "string" } }, "groupId": { "type": "string", "description": "The groupId to which the managed private endpoint is created" }, "isReserved": { "type": "boolean", "description": "Denotes whether the managed private endpoint is reserved", "readOnly": true }, "privateLinkResourceId": { "type": "string", "description": "The ARM resource ID of the resource to which the managed private endpoint is created" }, "provisioningState": { "type": "string", "description": "The managed private endpoint provisioning state", "readOnly": true } }, "additionalProperties": {} }, "ManagedPrivateEndpointResource": { "type": "object", "description": "Managed private endpoint resource type.", "properties": { "properties": { "$ref": "#/definitions/ManagedPrivateEndpoint", "description": "Managed private endpoint properties." }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ManagedVirtualNetwork": { "type": "object", "description": "A managed Virtual Network associated with the Azure Data Factory", "properties": { "vNetId": { "type": "string", "description": "Managed Virtual Network ID.", "readOnly": true }, "alias": { "type": "string", "description": "Managed Virtual Network alias.", "readOnly": true } }, "additionalProperties": {} }, "ManagedVirtualNetworkListResponse": { "type": "object", "description": "A list of managed Virtual Network resources.", "properties": { "value": { "type": "array", "description": "The ManagedVirtualNetworkResource items on this page", "items": { "$ref": "#/definitions/ManagedVirtualNetworkResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ManagedVirtualNetworkReference": { "type": "object", "description": "Managed Virtual Network reference type.", "properties": { "type": { "$ref": "#/definitions/ManagedVirtualNetworkReferenceType", "description": "Managed Virtual Network reference type." }, "referenceName": { "type": "string", "description": "Reference ManagedVirtualNetwork name." } }, "required": [ "type", "referenceName" ] }, "ManagedVirtualNetworkReferenceType": { "type": "string", "description": "Managed Virtual Network reference type.", "enum": [ "ManagedVirtualNetworkReference" ], "x-ms-enum": { "name": "ManagedVirtualNetworkReferenceType", "modelAsString": true, "values": [ { "name": "ManagedVirtualNetworkReference", "value": "ManagedVirtualNetworkReference", "description": "ManagedVirtualNetworkReference" } ] } }, "ManagedVirtualNetworkResource": { "type": "object", "description": "Managed Virtual Network resource type.", "properties": { "properties": { "$ref": "#/definitions/ManagedVirtualNetwork", "description": "Managed Virtual Network properties." }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "MapperAttributeMapping": { "type": "object", "description": "Source and target column mapping details.", "properties": { "name": { "type": "string", "description": "Name of the target column." }, "type": { "$ref": "#/definitions/MappingType", "description": "Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'." }, "functionName": { "type": "string", "description": "Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping." }, "expression": { "type": "string", "description": "Expression used for 'Aggregate' and 'Derived' type mapping." }, "attributeReference": { "$ref": "#/definitions/MapperAttributeReference", "description": "Reference of the source column used in the mapping. It is used for 'Direct' mapping type only." }, "attributeReferences": { "type": "array", "description": "List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only.", "items": { "$ref": "#/definitions/MapperAttributeReference" }, "x-ms-identifiers": [ "name" ] } } }, "MapperAttributeMappings": { "type": "object", "description": "Attribute mapping details.", "properties": { "attributeMappings": { "type": "array", "description": "List of attribute mappings.", "items": { "$ref": "#/definitions/MapperAttributeMapping" }, "x-ms-identifiers": [ "name" ] } } }, "MapperAttributeReference": { "type": "object", "description": "Attribute reference details for the referred column.", "properties": { "name": { "type": "string", "description": "Name of the column." }, "entity": { "type": "string", "description": "Name of the table." }, "entityConnectionReference": { "$ref": "#/definitions/MapperConnectionReference", "description": "The connection reference for the connection." } } }, "MapperConnection": { "type": "object", "description": "Source connection details.", "properties": { "linkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Linked service reference." }, "linkedServiceType": { "type": "string", "description": "Type of the linked service e.g.: AzureBlobFS." }, "type": { "$ref": "#/definitions/ConnectionType", "description": "Type of connection via linked service or dataset." }, "isInlineDataset": { "type": "boolean", "description": "A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported." }, "commonDslConnectorProperties": { "type": "array", "description": "List of name/value pairs for connection properties.", "items": { "$ref": "#/definitions/MapperDslConnectorProperties" }, "x-ms-identifiers": [] } }, "required": [ "type" ] }, "MapperConnectionReference": { "type": "object", "description": "Source or target connection reference details.", "properties": { "connectionName": { "type": "string", "description": "Name of the connection" }, "type": { "$ref": "#/definitions/ConnectionType", "description": "Type of connection via linked service or dataset." } } }, "MapperDslConnectorProperties": { "type": "object", "description": "Connector properties of a CDC table in terms of name / value pairs.", "properties": { "name": { "type": "string", "description": "Name of the property." }, "value": { "description": "Value of the property." } } }, "MapperPolicy": { "type": "object", "description": "CDC Policy.", "properties": { "mode": { "type": "string", "description": "Mode of running the CDC: batch vs continuous." }, "recurrence": { "$ref": "#/definitions/MapperPolicyRecurrence", "description": "Defines the frequency and interval for running the CDC for batch mode." } } }, "MapperPolicyRecurrence": { "type": "object", "description": "CDC policy recurrence details.", "properties": { "frequency": { "$ref": "#/definitions/FrequencyType", "description": "Frequency of period in terms of 'Hour', 'Minute' or 'Second'." }, "interval": { "type": "integer", "format": "int32", "description": "Actual interval value as per chosen frequency." } } }, "MapperSourceConnectionsInfo": { "type": "object", "description": "A object which contains list of tables and connection details for a source connection.", "properties": { "sourceEntities": { "type": "array", "description": "List of source tables for a source connection.", "items": { "$ref": "#/definitions/MapperTable" }, "x-ms-identifiers": [ "name" ] }, "connection": { "$ref": "#/definitions/MapperConnection", "description": "Source connection details." } } }, "MapperTable": { "type": "object", "description": "CDC table details.", "properties": { "name": { "type": "string", "description": "Name of the table." }, "properties": { "$ref": "#/definitions/MapperTableProperties", "description": "Table properties.", "x-ms-client-flatten": true } } }, "MapperTableProperties": { "type": "object", "description": "Properties for a CDC table.", "properties": { "schema": { "type": "array", "description": "List of columns for the source table.", "items": { "$ref": "#/definitions/MapperTableSchema" }, "x-ms-identifiers": [ "name" ] }, "dslConnectorProperties": { "type": "array", "description": "List of name/value pairs for connection properties.", "items": { "$ref": "#/definitions/MapperDslConnectorProperties" }, "x-ms-identifiers": [] } } }, "MapperTableSchema": { "type": "object", "description": "Schema of a CDC table in terms of column names and their corresponding data types.", "properties": { "name": { "type": "string", "description": "Name of the column." }, "dataType": { "type": "string", "description": "Data type of the column." } } }, "MapperTargetConnectionsInfo": { "type": "object", "description": "A object which contains list of tables and connection details for a target connection.", "properties": { "targetEntities": { "type": "array", "description": "List of source tables for a target connection.", "items": { "$ref": "#/definitions/MapperTable" }, "x-ms-identifiers": [ "name" ] }, "connection": { "$ref": "#/definitions/MapperConnection", "description": "Source connection details." }, "dataMapperMappings": { "type": "array", "description": "List of table mappings.", "items": { "$ref": "#/definitions/DataMapperMapping" }, "x-ms-identifiers": [ "targetEntityName", "sourceEntityName" ] }, "relationships": { "type": "array", "description": "List of relationship info among the tables.", "items": {} } } }, "MappingDataFlow": { "type": "object", "description": "Mapping data flow.", "properties": { "typeProperties": { "$ref": "#/definitions/MappingDataFlowTypeProperties", "description": "Mapping data flow type properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/DataFlow" } ], "x-ms-discriminator-value": "MappingDataFlow" }, "MappingDataFlowTypeProperties": { "type": "object", "description": "Mapping data flow type properties.", "properties": { "sources": { "type": "array", "description": "List of sources in data flow.", "items": { "$ref": "#/definitions/DataFlowSource" }, "x-ms-identifiers": [ "name" ] }, "sinks": { "type": "array", "description": "List of sinks in data flow.", "items": { "$ref": "#/definitions/DataFlowSink" }, "x-ms-identifiers": [ "name" ] }, "transformations": { "type": "array", "description": "List of transformations in data flow.", "items": { "$ref": "#/definitions/Transformation" }, "x-ms-identifiers": [ "name" ] }, "script": { "type": "string", "description": "DataFlow script." }, "scriptLines": { "type": "array", "description": "Data flow script lines.", "items": { "type": "string" } } } }, "MappingType": { "type": "string", "description": "Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'.", "enum": [ "Direct", "Derived", "Aggregate" ], "x-ms-enum": { "name": "MappingType", "modelAsString": true, "values": [ { "name": "Direct", "value": "Direct", "description": "Direct" }, { "name": "Derived", "value": "Derived", "description": "Derived" }, { "name": "Aggregate", "value": "Aggregate", "description": "Aggregate" } ] } }, "MariaDBLinkedService": { "type": "object", "description": "MariaDB server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/MariaDBLinkedServiceTypeProperties", "description": "MariaDB server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "MariaDB" }, "MariaDBLinkedServiceTypeProperties": { "type": "object", "description": "MariaDB server linked service properties.", "properties": { "driverVersion": { "description": "The version of the MariaDB driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string. The legacy driver is scheduled for deprecation by October 2024." }, "connectionString": { "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "server": { "description": "Server name for connection. Type: string." }, "port": { "description": "The port for the connection. Type: integer." }, "username": { "description": "Username for authentication. Type: string." }, "database": { "description": "Database name for connection. Type: string." }, "sslMode": { "description": "This option specifies whether the driver uses TLS encryption and verification when connecting to MariaDB. E.g., SSLMode=<0/1/2/3/4>. Options: DISABLED (0) / PREFERRED (1) (Default) / REQUIRED (2) / VERIFY_CA (3) / VERIFY_IDENTITY (4), REQUIRED (2) is recommended to only allow connections encrypted with SSL/TLS." }, "useSystemTrustStore": { "description": "This option specifies whether to use a CA certificate from the system trust store, or from a specified PEM file. E.g. UseSystemTrustStore=<0/1>; Options: Enabled (1) / Disabled (0) (Default)" }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "MariaDBSource": { "type": "object", "description": "A copy activity MariaDB server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "MariaDBSource" }, "MariaDBTableDataset": { "type": "object", "description": "MariaDB server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "MariaDBTable" }, "MarketoLinkedService": { "type": "object", "description": "Marketo server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/MarketoLinkedServiceTypeProperties", "description": "Marketo server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Marketo" }, "MarketoLinkedServiceTypeProperties": { "type": "object", "description": "Marketo server linked service properties.", "properties": { "endpoint": { "description": "The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)" }, "clientId": { "description": "The client Id of your Marketo service." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret of your Marketo service." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "endpoint", "clientId" ] }, "MarketoObjectDataset": { "type": "object", "description": "Marketo server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "MarketoObject" }, "MarketoSource": { "type": "object", "description": "A copy activity Marketo server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "MarketoSource" }, "MetadataItem": { "type": "object", "description": "Specify the name and value of custom metadata item.", "properties": { "name": { "description": "Metadata item key name. Type: string (or Expression with resultType string)." }, "value": { "description": "Metadata item value. Type: string (or Expression with resultType string)." } } }, "MicrosoftAccessLinkedService": { "type": "object", "description": "Microsoft Access linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/MicrosoftAccessLinkedServiceTypeProperties", "description": "Microsoft Access linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "MicrosoftAccess" }, "MicrosoftAccessLinkedServiceTypeProperties": { "type": "object", "description": "Microsoft Access linked service properties.", "properties": { "connectionString": { "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string." }, "authenticationType": { "description": "Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string)." }, "credential": { "$ref": "#/definitions/SecretBase", "description": "The access credential portion of the connection string specified in driver-specific property-value format." }, "userName": { "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for Basic authentication." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "connectionString" ] }, "MicrosoftAccessSink": { "type": "object", "description": "A copy activity Microsoft Access sink.", "properties": { "preCopyScript": { "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "MicrosoftAccessSink" }, "MicrosoftAccessSource": { "type": "object", "description": "A copy activity source for Microsoft Access.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "MicrosoftAccessSource" }, "MicrosoftAccessTableDataset": { "type": "object", "description": "The Microsoft Access table dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/MicrosoftAccessTableDatasetTypeProperties", "description": "Microsoft Access table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "MicrosoftAccessTable" }, "MicrosoftAccessTableDatasetTypeProperties": { "type": "object", "description": "Microsoft Access table dataset properties.", "properties": { "tableName": { "description": "The Microsoft Access table name. Type: string (or Expression with resultType string)." } } }, "MongoDbAtlasCollectionDataset": { "type": "object", "description": "The MongoDB Atlas database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/MongoDbAtlasCollectionDatasetTypeProperties", "description": "MongoDB Atlas database dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "MongoDbAtlasCollection" }, "MongoDbAtlasCollectionDatasetTypeProperties": { "type": "object", "description": "MongoDB Atlas database dataset properties.", "properties": { "collection": { "description": "The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string)." } }, "required": [ "collection" ] }, "MongoDbAtlasLinkedService": { "type": "object", "description": "Linked service for MongoDB Atlas data source.", "properties": { "typeProperties": { "$ref": "#/definitions/MongoDbAtlasLinkedServiceTypeProperties", "description": "MongoDB Atlas linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "MongoDbAtlas" }, "MongoDbAtlasLinkedServiceTypeProperties": { "type": "object", "description": "MongoDB Atlas linked service properties.", "properties": { "connectionString": { "description": "The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference." }, "database": { "description": "The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string)." }, "driverVersion": { "description": "The driver version that you want to choose. Allowed value are v1 and v2. Type: string (or Expression with resultType string)." } }, "required": [ "connectionString", "database" ] }, "MongoDbAtlasSink": { "type": "object", "description": "A copy activity MongoDB Atlas sink.", "properties": { "writeBehavior": { "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)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "MongoDbAtlasSink" }, "MongoDbAtlasSource": { "type": "object", "description": "A copy activity source for a MongoDB Atlas database.", "properties": { "filter": { "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": { "$ref": "#/definitions/MongoDbCursorMethodsProperties", "description": "Cursor methods for Mongodb query" }, "batchSize": { "description": "Specifies the number of documents to return in each batch of the response from MongoDB Atlas instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." }, "queryTimeout": { "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": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "MongoDbAtlasSource" }, "MongoDbAuthenticationType": { "type": "string", "description": "The authentication type to be used to connect to the MongoDB database.", "enum": [ "Basic", "Anonymous" ], "x-ms-enum": { "name": "MongoDbAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" } ] } }, "MongoDbCollectionDataset": { "type": "object", "description": "The MongoDB database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/MongoDbCollectionDatasetTypeProperties", "description": "MongoDB database dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "MongoDbCollection" }, "MongoDbCollectionDatasetTypeProperties": { "type": "object", "description": "MongoDB database dataset properties.", "properties": { "collectionName": { "description": "The table name of the MongoDB database. Type: string (or Expression with resultType string)." } }, "required": [ "collectionName" ] }, "MongoDbCursorMethodsProperties": { "type": "object", "description": "Cursor methods for Mongodb query", "properties": { "project": { "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": { "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": { "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": { "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": {} }, "MongoDbLinkedService": { "type": "object", "description": "Linked service for MongoDb data source.", "properties": { "typeProperties": { "$ref": "#/definitions/MongoDbLinkedServiceTypeProperties", "description": "MongoDB linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "MongoDb" }, "MongoDbLinkedServiceTypeProperties": { "type": "object", "description": "MongoDB linked service properties.", "properties": { "server": { "description": "The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/MongoDbAuthenticationType", "description": "The authentication type to be used to connect to the MongoDB database." }, "databaseName": { "description": "The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string)." }, "username": { "description": "Username for authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for authentication." }, "authSource": { "description": "Database to verify the username and password. Type: string (or Expression with resultType string)." }, "port": { "description": "The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0." }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean)." }, "allowSelfSignedServerCert": { "description": "Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "server", "databaseName" ] }, "MongoDbSource": { "type": "object", "description": "A copy activity source for a MongoDB database.", "properties": { "query": { "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "MongoDbSource" }, "MongoDbV2CollectionDataset": { "type": "object", "description": "The MongoDB database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/MongoDbV2CollectionDatasetTypeProperties", "description": "MongoDB database dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "MongoDbV2Collection" }, "MongoDbV2CollectionDatasetTypeProperties": { "type": "object", "description": "MongoDB database dataset properties.", "properties": { "collection": { "description": "The collection name of the MongoDB database. Type: string (or Expression with resultType string)." } }, "required": [ "collection" ] }, "MongoDbV2LinkedService": { "type": "object", "description": "Linked service for MongoDB data source.", "properties": { "typeProperties": { "$ref": "#/definitions/MongoDbV2LinkedServiceTypeProperties", "description": "MongoDB linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "MongoDbV2" }, "MongoDbV2LinkedServiceTypeProperties": { "type": "object", "description": "MongoDB linked service properties.", "properties": { "connectionString": { "description": "The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference." }, "database": { "description": "The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string)." } }, "required": [ "connectionString", "database" ] }, "MongoDbV2Sink": { "type": "object", "description": "A copy activity MongoDB sink.", "properties": { "writeBehavior": { "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)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "MongoDbV2Sink" }, "MongoDbV2Source": { "type": "object", "description": "A copy activity source for a MongoDB database.", "properties": { "filter": { "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": { "$ref": "#/definitions/MongoDbCursorMethodsProperties", "description": "Cursor methods for Mongodb query" }, "batchSize": { "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": { "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": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "MongoDbV2Source" }, "MultiplePipelineTrigger": { "type": "object", "description": "Base class for all triggers that support one to many model for trigger to pipeline.", "properties": { "pipelines": { "type": "array", "description": "Pipelines that need to be started.", "items": { "$ref": "#/definitions/TriggerPipelineReference" }, "x-ms-identifiers": [ "/pipelineReference/referenceName" ] } }, "allOf": [ { "$ref": "#/definitions/Trigger" } ], "x-ms-discriminator-value": "MultiplePipelineTrigger" }, "MySqlLinkedService": { "type": "object", "description": "Linked service for MySQL data source.", "properties": { "typeProperties": { "$ref": "#/definitions/MySqlLinkedServiceTypeProperties", "description": "MySQL linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "MySql" }, "MySqlLinkedServiceTypeProperties": { "type": "object", "description": "MySQL linked service properties.", "properties": { "driverVersion": { "description": "The version of the MySQL driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string." }, "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "server": { "description": "Server name for connection. Type: string." }, "port": { "description": "The port for the connection. Type: integer." }, "username": { "description": "Username for authentication. Type: string." }, "database": { "description": "Database name for connection. Type: string." }, "sslMode": { "description": "SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full." }, "useSystemTrustStore": { "description": "Use system trust store for connection. Type: integer. 0: enable, 1: disable." }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "allowZeroDateTime": { "description": "This allows the special “zero” date value 0000-00-00 to be retrieved from the database. Type: boolean." }, "connectionTimeout": { "description": "The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Type: integer." }, "convertZeroDateTime": { "description": "True to return DateTime.MinValue for date or datetime columns that have disallowed values. Type: boolean." }, "guidFormat": { "description": "Determines which column type (if any) should be read as a GUID. Type: string. None: No column types are automatically read as a Guid; Char36: All CHAR(36) columns are read/written as a Guid using lowercase hex with hyphens, which matches UUID." }, "sslCert": { "description": "The path to the client’s SSL certificate file in PEM format. SslKey must also be specified. Type: string." }, "sslKey": { "description": "The path to the client’s SSL private key in PEM format. SslCert must also be specified. Type: string." }, "treatTinyAsBoolean": { "description": "When set to true, TINYINT(1) values are returned as booleans. Type: bool." } } }, "MySqlSource": { "type": "object", "description": "A copy activity source for MySQL databases.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "MySqlSource" }, "MySqlTableDataset": { "type": "object", "description": "The MySQL table dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/MySqlTableDatasetTypeProperties", "description": "MySQL table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "MySqlTable" }, "MySqlTableDatasetTypeProperties": { "type": "object", "description": "MySql table dataset properties.", "properties": { "tableName": { "description": "The MySQL table name. Type: string (or Expression with resultType string)." } } }, "NetezzaLinkedService": { "type": "object", "description": "Netezza linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/NetezzaLinkedServiceTypeProperties", "description": "Netezza linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Netezza" }, "NetezzaLinkedServiceTypeProperties": { "type": "object", "description": "Netezza linked service properties.", "properties": { "connectionString": { "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "server": { "description": "Server name for connection. Type: string." }, "port": { "description": "The port for the connection. Type: integer." }, "uid": { "description": "Username for authentication. Type: string." }, "database": { "description": "Database name for connection. Type: string." }, "securityLevel": { "$ref": "#/definitions/NetezzaSecurityLevelType", "description": "Specifies the security level for the driver connection to the data store. PreferredUnSecured : prefer unsecured, allow fallback to secured connection if required. OnlyUnSecured : strictly unsecured, no fallback." }, "pwd": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "NetezzaPartitionOption": { "type": "string", "description": "The partition mechanism that will be used for Netezza read in parallel.", "enum": [ "None", "DataSlice", "DynamicRange" ], "x-ms-enum": { "name": "NetezzaPartitionOption", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "DataSlice", "value": "DataSlice", "description": "DataSlice" }, { "name": "DynamicRange", "value": "DynamicRange", "description": "DynamicRange" } ] } }, "NetezzaPartitionSettings": { "type": "object", "description": "The settings that will be leveraged for Netezza source partitioning.", "properties": { "partitionColumnName": { "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": { "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": { "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." } } }, "NetezzaSecurityLevelType": { "type": "string", "description": "Specifies the security level for the driver connection to the data store. PreferredUnSecured : prefer unsecured, allow fallback to secured connection if required. OnlyUnSecured : strictly unsecured, no fallback.", "enum": [ "PreferredUnSecured", "OnlyUnSecured" ], "x-ms-enum": { "name": "NetezzaSecurityLevelType", "modelAsString": true, "values": [ { "name": "PreferredUnSecured", "value": "PreferredUnSecured", "description": "PreferredUnSecured" }, { "name": "OnlyUnSecured", "value": "OnlyUnSecured", "description": "OnlyUnSecured" } ] } }, "NetezzaSource": { "type": "object", "description": "A copy activity Netezza source.", "properties": { "query": { "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. Possible values include: \"None\", \"DataSlice\", \"DynamicRange\"." }, "partitionSettings": { "$ref": "#/definitions/NetezzaPartitionSettings", "description": "The settings that will be leveraged for Netezza source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "NetezzaSource" }, "NetezzaTableDataset": { "type": "object", "description": "Netezza dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/NetezzaTableDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "NetezzaTable" }, "NetezzaTableDatasetTypeProperties": { "type": "object", "description": "Netezza dataset properties.", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The table name of the Netezza. Type: string (or Expression with resultType string)." }, "schema": { "description": "The schema name of the Netezza. Type: string (or Expression with resultType string)." } } }, "NotebookParameter": { "type": "object", "description": "Notebook parameter.", "properties": { "value": { "description": "Notebook parameter value. Type: string (or Expression with resultType string)." }, "type": { "$ref": "#/definitions/NotebookParameterType", "description": "Notebook parameter type." } } }, "NotebookParameterType": { "type": "string", "description": "Notebook parameter type.", "enum": [ "string", "int", "float", "bool" ], "x-ms-enum": { "name": "NotebookParameterType", "modelAsString": true, "values": [ { "name": "string", "value": "string", "description": "string" }, { "name": "int", "value": "int", "description": "int" }, { "name": "float", "value": "float", "description": "float" }, { "name": "bool", "value": "bool", "description": "bool" } ] } }, "NotebookReferenceType": { "type": "string", "description": "Synapse notebook reference type.", "enum": [ "NotebookReference" ], "x-ms-enum": { "name": "NotebookReferenceType", "modelAsString": true, "values": [ { "name": "NotebookReference", "value": "NotebookReference", "description": "NotebookReference" } ] } }, "ODataAadServicePrincipalCredentialType": { "type": "string", "description": "Specify the credential type (key or cert) is used for service principal.", "enum": [ "ServicePrincipalKey", "ServicePrincipalCert" ], "x-ms-enum": { "name": "ODataAadServicePrincipalCredentialType", "modelAsString": true, "values": [ { "name": "ServicePrincipalKey", "value": "ServicePrincipalKey", "description": "ServicePrincipalKey" }, { "name": "ServicePrincipalCert", "value": "ServicePrincipalCert", "description": "ServicePrincipalCert" } ] } }, "ODataAuthenticationType": { "type": "string", "description": "Type of authentication used to connect to the OData service.", "enum": [ "Basic", "Anonymous", "Windows", "AadServicePrincipal", "ManagedServiceIdentity" ], "x-ms-enum": { "name": "ODataAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "Windows", "value": "Windows", "description": "Windows" }, { "name": "AadServicePrincipal", "value": "AadServicePrincipal", "description": "AadServicePrincipal" }, { "name": "ManagedServiceIdentity", "value": "ManagedServiceIdentity", "description": "ManagedServiceIdentity" } ] } }, "ODataLinkedService": { "type": "object", "description": "Open Data Protocol (OData) linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/ODataLinkedServiceTypeProperties", "description": "OData linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "OData" }, "ODataLinkedServiceTypeProperties": { "type": "object", "description": "OData linked service properties.", "properties": { "url": { "description": "The URL of the OData service endpoint. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/ODataAuthenticationType", "description": "Type of authentication used to connect to the OData service." }, "userName": { "description": "User name of the OData service. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password of the OData service." }, "authHeaders": { "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type)." }, "tenant": { "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string)." }, "servicePrincipalId": { "description": "Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." }, "azureCloudType": { "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." }, "aadResourceId": { "description": "Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string)." }, "aadServicePrincipalCredentialType": { "$ref": "#/definitions/ODataAadServicePrincipalCredentialType", "description": "Specify the credential type (key or cert) is used for service principal." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." }, "servicePrincipalEmbeddedCert": { "$ref": "#/definitions/SecretBase", "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." }, "servicePrincipalEmbeddedCertPassword": { "$ref": "#/definitions/SecretBase", "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "url" ] }, "ODataResourceDataset": { "type": "object", "description": "The Open Data Protocol (OData) resource dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/ODataResourceDatasetTypeProperties", "description": "OData dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "ODataResource" }, "ODataResourceDatasetTypeProperties": { "type": "object", "description": "OData dataset properties.", "properties": { "path": { "description": "The OData resource path. Type: string (or Expression with resultType string)." } } }, "ODataSource": { "type": "object", "description": "A copy activity source for OData source.", "properties": { "query": { "description": "OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." }, "httpRequestTimeout": { "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": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "ODataSource" }, "OdbcLinkedService": { "type": "object", "description": "Open Database Connectivity (ODBC) linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/OdbcLinkedServiceTypeProperties", "description": "ODBC linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Odbc" }, "OdbcLinkedServiceTypeProperties": { "type": "object", "description": "ODBC linked service properties.", "properties": { "connectionString": { "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string." }, "authenticationType": { "description": "Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string)." }, "credential": { "$ref": "#/definitions/SecretBase", "description": "The access credential portion of the connection string specified in driver-specific property-value format." }, "userName": { "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for Basic authentication." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "connectionString" ] }, "OdbcSink": { "type": "object", "description": "A copy activity ODBC sink.", "properties": { "preCopyScript": { "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "OdbcSink" }, "OdbcSource": { "type": "object", "description": "A copy activity source for ODBC databases.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "OdbcSource" }, "OdbcTableDataset": { "type": "object", "description": "The ODBC table dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/OdbcTableDatasetTypeProperties", "description": "ODBC table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "OdbcTable" }, "OdbcTableDatasetTypeProperties": { "type": "object", "description": "ODBC table dataset properties.", "properties": { "tableName": { "description": "The ODBC table name. Type: string (or Expression with resultType string)." } } }, "Office365Dataset": { "type": "object", "description": "The Office365 account.", "properties": { "typeProperties": { "$ref": "#/definitions/Office365DatasetTypeProperties", "description": "Office365 dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "Office365Table" }, "Office365DatasetTypeProperties": { "type": "object", "description": "Office365 dataset properties.", "properties": { "tableName": { "description": "Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string)." }, "predicate": { "description": "A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string)." } }, "required": [ "tableName" ] }, "Office365LinkedService": { "type": "object", "description": "Office365 linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/Office365LinkedServiceTypeProperties", "description": "Office365 linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Office365" }, "Office365LinkedServiceTypeProperties": { "type": "object", "description": "Office365 linked service properties.", "properties": { "office365TenantId": { "description": "Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string)." }, "servicePrincipalTenantId": { "description": "Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string)." }, "servicePrincipalId": { "description": "Specify the application's client ID. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "Specify the application's key." }, "servicePrincipalCredentialType": { "description": "The service principal credential type for authentication.'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. If not specified, 'ServicePrincipalKey' is in use. Type: string (or Expression with resultType string)." }, "servicePrincipalEmbeddedCert": { "$ref": "#/definitions/SecretBase", "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." }, "servicePrincipalEmbeddedCertPassword": { "$ref": "#/definitions/SecretBase", "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "office365TenantId", "servicePrincipalTenantId", "servicePrincipalId", "servicePrincipalKey" ] }, "Office365Source": { "type": "object", "description": "A copy activity source for an Office 365 service.", "properties": { "allowedGroups": { "description": "The groups containing all the users. Type: array of strings (or Expression with resultType array of strings)." }, "userScopeFilterUri": { "description": "The user scope uri. Type: string (or Expression with resultType string)." }, "dateFilterColumn": { "description": "The Column to apply the and . Type: string (or Expression with resultType string)." }, "startTime": { "description": "Start time of the requested range for this dataset. Type: string (or Expression with resultType string)." }, "endTime": { "description": "End time of the requested range for this dataset. Type: string (or Expression with resultType string)." }, "outputColumns": { "description": "The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). itemType: OutputColumn. Example: [ { \"name\": \"Id\" }, { \"name\": \"CreatedDateTime\" } ]" } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "Office365Source" }, "Operation": { "type": "object", "description": "Azure Data Factory API operation definition.", "properties": { "name": { "type": "string", "description": "Operation name: {provider}/{resource}/{operation}" }, "origin": { "type": "string", "description": "The intended executor of the operation." }, "display": { "$ref": "#/definitions/OperationDisplay", "description": "Metadata associated with the operation." }, "properties": { "$ref": "#/definitions/OperationProperties", "description": "Additional details about the operation.", "x-ms-client-flatten": true } } }, "OperationDisplay": { "type": "object", "description": "Metadata associated with the operation.", "properties": { "description": { "type": "string", "description": "The description of the operation." }, "provider": { "type": "string", "description": "The name of the provider." }, "resource": { "type": "string", "description": "The name of the resource type on which the operation is performed." }, "operation": { "type": "string", "description": "The type of operation: get, read, delete, etc." } } }, "OperationListResponse": { "type": "object", "description": "A list of operations that can be performed by the Data Factory service.", "properties": { "value": { "type": "array", "description": "List of Data Factory operations supported by the Data Factory resource provider.", "items": { "$ref": "#/definitions/Operation" }, "x-ms-identifiers": [ "name" ] }, "nextLink": { "type": "string", "description": "The link to the next page of results, if any remaining results exist." } } }, "OperationLogSpecification": { "type": "object", "description": "Details about an operation related to logs.", "properties": { "name": { "type": "string", "description": "The name of the log category." }, "displayName": { "type": "string", "description": "Localized display name." }, "blobDuration": { "type": "string", "description": "Blobs created in the customer storage account, per hour." } } }, "OperationMetricAvailability": { "type": "object", "description": "Defines how often data for a metric becomes available.", "properties": { "timeGrain": { "type": "string", "description": "The granularity for the metric." }, "blobDuration": { "type": "string", "description": "Blob created in the customer storage account, per hour." } } }, "OperationMetricDimension": { "type": "object", "description": "Defines the metric dimension.", "properties": { "name": { "type": "string", "description": "The name of the dimension for the metric." }, "displayName": { "type": "string", "description": "The display name of the metric dimension." }, "toBeExportedForShoebox": { "type": "boolean", "description": "Whether the dimension should be exported to Azure Monitor." } } }, "OperationMetricSpecification": { "type": "object", "description": "Details about an operation related to metrics.", "properties": { "name": { "type": "string", "description": "The name of the metric." }, "displayName": { "type": "string", "description": "Localized display name of the metric." }, "displayDescription": { "type": "string", "description": "The description of the metric." }, "unit": { "type": "string", "description": "The unit that the metric is measured in." }, "aggregationType": { "type": "string", "description": "The type of metric aggregation." }, "enableRegionalMdmAccount": { "type": "string", "description": "Whether or not the service is using regional MDM accounts." }, "sourceMdmAccount": { "type": "string", "description": "The name of the MDM account." }, "sourceMdmNamespace": { "type": "string", "description": "The name of the MDM namespace." }, "availabilities": { "type": "array", "description": "Defines how often data for metrics becomes available.", "items": { "$ref": "#/definitions/OperationMetricAvailability" }, "x-ms-identifiers": [] }, "dimensions": { "type": "array", "description": "Defines the metric dimension.", "items": { "$ref": "#/definitions/OperationMetricDimension" }, "x-ms-identifiers": [ "name" ] } } }, "OperationProperties": { "type": "object", "description": "Additional details about an operation.", "properties": { "serviceSpecification": { "$ref": "#/definitions/OperationServiceSpecification", "description": "Details about a service operation." } } }, "OperationServiceSpecification": { "type": "object", "description": "Details about a service operation.", "properties": { "logSpecifications": { "type": "array", "description": "Details about operations related to logs.", "items": { "$ref": "#/definitions/OperationLogSpecification" }, "x-ms-identifiers": [ "name" ] }, "metricSpecifications": { "type": "array", "description": "Details about operations related to metrics.", "items": { "$ref": "#/definitions/OperationMetricSpecification" }, "x-ms-identifiers": [ "name" ] } } }, "OracleAuthenticationType": { "type": "string", "description": "Authentication type for connecting to the Oracle database. Only used for Version 2.0.", "enum": [ "Basic" ], "x-ms-enum": { "name": "OracleAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" } ] } }, "OracleCloudStorageLinkedService": { "type": "object", "description": "Linked service for Oracle Cloud Storage.", "properties": { "typeProperties": { "$ref": "#/definitions/OracleCloudStorageLinkedServiceTypeProperties", "description": "Oracle Cloud Storage linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "OracleCloudStorage" }, "OracleCloudStorageLinkedServiceTypeProperties": { "type": "object", "description": "Oracle Cloud Storage linked service properties.", "properties": { "accessKeyId": { "description": "The access key identifier of the Oracle Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string)." }, "secretAccessKey": { "$ref": "#/definitions/SecretBase", "description": "The secret access key of the Oracle Cloud Storage Identity and Access Management (IAM) user." }, "serviceUrl": { "description": "This value specifies the endpoint to access with the Oracle Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "OracleCloudStorageLocation": { "type": "object", "description": "The location of Oracle Cloud Storage dataset.", "properties": { "bucketName": { "description": "Specify the bucketName of Oracle Cloud Storage. Type: string (or Expression with resultType string)" }, "version": { "description": "Specify the version of Oracle Cloud Storage. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "OracleCloudStorageLocation" }, "OracleCloudStorageReadSettings": { "type": "object", "description": "Oracle Cloud Storage read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "Oracle Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "Oracle Cloud Storage wildcardFileName. Type: string (or Expression with resultType string)." }, "prefix": { "description": "The prefix filter for the Oracle Cloud Storage object name. Type: string (or Expression with resultType string)." }, "fileListPath": { "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": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "OracleCloudStorageReadSettings" }, "OracleLinkedService": { "type": "object", "description": "Oracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.", "properties": { "typeProperties": { "$ref": "#/definitions/OracleLinkedServiceTypeProperties", "description": "Oracle database linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Oracle" }, "OracleLinkedServiceTypeProperties": { "type": "object", "description": "Oracle database linked service properties.", "properties": { "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0." }, "server": { "description": "The location of Oracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0." }, "authenticationType": { "$ref": "#/definitions/OracleAuthenticationType", "description": "Authentication type for connecting to the Oracle database. Only used for Version 2.0." }, "username": { "description": "The Oracle database username. Type: string. Only used for Version 2.0." }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptionClient": { "description": "Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0." }, "encryptionTypesClient": { "description": "Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0." }, "cryptoChecksumClient": { "description": "Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0." }, "cryptoChecksumTypesClient": { "description": "Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0." }, "initialLobFetchSize": { "description": "Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0." }, "fetchSize": { "description": "Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0." }, "statementCacheSize": { "description": "Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0." }, "initializationString": { "description": "Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0." }, "enableBulkLoad": { "description": "Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0." }, "supportV1DataTypes": { "description": "Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0." }, "fetchTswtzAsTimestamp": { "description": "Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "OraclePartitionOption": { "type": "string", "description": "The partition mechanism that will be used for Oracle read in parallel.", "enum": [ "None", "PhysicalPartitionsOfTable", "DynamicRange" ], "x-ms-enum": { "name": "OraclePartitionOption", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "PhysicalPartitionsOfTable", "value": "PhysicalPartitionsOfTable", "description": "PhysicalPartitionsOfTable" }, { "name": "DynamicRange", "value": "DynamicRange", "description": "DynamicRange" } ] } }, "OraclePartitionSettings": { "type": "object", "description": "The settings that will be leveraged for Oracle source partitioning.", "properties": { "partitionNames": { "description": "Names of the physical partitions of Oracle table." }, "partitionColumnName": { "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": { "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": { "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." } } }, "OracleServiceCloudLinkedService": { "type": "object", "description": "Oracle Service Cloud linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/OracleServiceCloudLinkedServiceTypeProperties", "description": "Oracle Service Cloud linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "OracleServiceCloud" }, "OracleServiceCloudLinkedServiceTypeProperties": { "type": "object", "description": "Oracle Service Cloud linked service properties.", "properties": { "host": { "description": "The URL of the Oracle Service Cloud instance." }, "username": { "description": "The user name that you use to access Oracle Service Cloud server." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name that you provided in the username key." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host", "username", "password" ] }, "OracleServiceCloudObjectDataset": { "type": "object", "description": "Oracle Service Cloud dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "OracleServiceCloudObject" }, "OracleServiceCloudSource": { "type": "object", "description": "A copy activity Oracle Service Cloud source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "OracleServiceCloudSource" }, "OracleSink": { "type": "object", "description": "A copy activity Oracle sink.", "properties": { "preCopyScript": { "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "OracleSink" }, "OracleSource": { "type": "object", "description": "A copy activity Oracle source.", "properties": { "oracleReaderQuery": { "description": "Oracle reader query. Type: string (or Expression with resultType string)." }, "queryTimeout": { "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. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\"." }, "partitionSettings": { "$ref": "#/definitions/OraclePartitionSettings", "description": "The settings that will be leveraged for Oracle source partitioning." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." }, "numberPrecision": { "description": "The decimal precision used to represent Oracle NUMBER type without precision and scale. The range is 1 to 256 and default value is 256 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0." }, "numberScale": { "description": "The decimal scale used to represent Oracle NUMBER type without precision and scale. The range is 0 to 130 and default value is 130 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "OracleSource" }, "OracleTableDataset": { "type": "object", "description": "The on-premises Oracle database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/OracleTableDatasetTypeProperties", "description": "On-premises Oracle dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "OracleTable" }, "OracleTableDatasetTypeProperties": { "type": "object", "description": "On-premises Oracle dataset properties.", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "schema": { "description": "The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the on-premises Oracle database. Type: string (or Expression with resultType string)." } } }, "OrcCompressionCodec": { "type": "string", "enum": [ "none", "zlib", "snappy", "lzo" ], "x-ms-enum": { "name": "OrcCompressionCodec", "modelAsString": true, "values": [ { "name": "none", "value": "none", "description": "none" }, { "name": "zlib", "value": "zlib", "description": "zlib" }, { "name": "snappy", "value": "snappy", "description": "snappy" }, { "name": "lzo", "value": "lzo", "description": "lzo" } ] } }, "OrcDataset": { "type": "object", "description": "ORC dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/OrcDatasetTypeProperties", "description": "ORC dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "Orc" }, "OrcDatasetTypeProperties": { "type": "object", "description": "ORC dataset properties.", "properties": { "location": { "$ref": "#/definitions/DatasetLocation", "description": "The location of the ORC data storage." }, "orcCompressionCodec": { "description": "The data orcCompressionCodec. Type: string (or Expression with resultType string)." } }, "required": [ "location" ] }, "OrcFormat": { "type": "object", "description": "The data stored in Optimized Row Columnar (ORC) format.", "allOf": [ { "$ref": "#/definitions/DatasetStorageFormat" } ], "x-ms-discriminator-value": "OrcFormat" }, "OrcSink": { "type": "object", "description": "A copy activity ORC sink.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreWriteSettings", "description": "ORC store settings." }, "formatSettings": { "$ref": "#/definitions/OrcWriteSettings", "description": "ORC format settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "OrcSink" }, "OrcSource": { "type": "object", "description": "A copy activity ORC source.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreReadSettings", "description": "ORC store settings." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "OrcSource" }, "OrcWriteSettings": { "type": "object", "description": "Orc write settings.", "properties": { "maxRowsPerFile": { "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." }, "fileNamePrefix": { "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/FormatWriteSettings" } ], "x-ms-discriminator-value": "OrcWriteSettings" }, "OutputColumn": { "type": "object", "description": "The columns to be read out from the Office 365 table.", "properties": { "name": { "type": "string", "description": "Name of the table column. Type: string." } } }, "PackageStore": { "type": "object", "description": "Package store for the SSIS integration runtime.", "properties": { "name": { "type": "string", "description": "The name of the package store" }, "packageStoreLinkedService": { "$ref": "#/definitions/EntityReference", "description": "The package store linked service reference." } }, "required": [ "name", "packageStoreLinkedService" ] }, "ParameterSpecification": { "type": "object", "description": "Definition of a single parameter for an entity.", "properties": { "type": { "$ref": "#/definitions/ParameterType", "description": "Parameter type." }, "defaultValue": { "description": "Default value of parameter." } }, "required": [ "type" ] }, "ParameterType": { "type": "string", "description": "Parameter type.", "enum": [ "Object", "String", "Int", "Float", "Bool", "Array", "SecureString" ], "x-ms-enum": { "name": "ParameterType", "modelAsString": true, "values": [ { "name": "Object", "value": "Object", "description": "Object" }, { "name": "String", "value": "String", "description": "String" }, { "name": "Int", "value": "Int", "description": "Int" }, { "name": "Float", "value": "Float", "description": "Float" }, { "name": "Bool", "value": "Bool", "description": "Bool" }, { "name": "Array", "value": "Array", "description": "Array" }, { "name": "SecureString", "value": "SecureString", "description": "SecureString" } ] } }, "ParquetDataset": { "type": "object", "description": "Parquet dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/ParquetDatasetTypeProperties", "description": "Parquet dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "Parquet" }, "ParquetDatasetTypeProperties": { "type": "object", "description": "Parquet dataset properties.", "properties": { "location": { "$ref": "#/definitions/DatasetLocation", "description": "The location of the parquet storage." }, "compressionCodec": { "description": "The data compressionCodec. Type: string (or Expression with resultType string)." } }, "required": [ "location" ] }, "ParquetFormat": { "type": "object", "description": "The data stored in Parquet format.", "allOf": [ { "$ref": "#/definitions/DatasetStorageFormat" } ], "x-ms-discriminator-value": "ParquetFormat" }, "ParquetReadSettings": { "type": "object", "description": "Parquet read settings.", "properties": { "compressionProperties": { "$ref": "#/definitions/CompressionReadSettings", "description": "Compression settings." } }, "allOf": [ { "$ref": "#/definitions/FormatReadSettings" } ], "x-ms-discriminator-value": "ParquetReadSettings" }, "ParquetSink": { "type": "object", "description": "A copy activity Parquet sink.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreWriteSettings", "description": "Parquet store settings." }, "formatSettings": { "$ref": "#/definitions/ParquetWriteSettings", "description": "Parquet format settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "ParquetSink" }, "ParquetSource": { "type": "object", "description": "A copy activity Parquet source.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreReadSettings", "description": "Parquet store settings." }, "formatSettings": { "$ref": "#/definitions/ParquetReadSettings", "description": "Parquet format settings." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "ParquetSource" }, "ParquetWriteSettings": { "type": "object", "description": "Parquet write settings.", "properties": { "maxRowsPerFile": { "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." }, "fileNamePrefix": { "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/FormatWriteSettings" } ], "x-ms-discriminator-value": "ParquetWriteSettings" }, "PaypalLinkedService": { "type": "object", "description": "Paypal Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/PaypalLinkedServiceTypeProperties", "description": "Paypal Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Paypal" }, "PaypalLinkedServiceTypeProperties": { "type": "object", "description": "Paypal Service linked service properties.", "properties": { "host": { "description": "The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)" }, "clientId": { "description": "The client ID associated with your PayPal application." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret associated with your PayPal application." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host", "clientId" ] }, "PaypalObjectDataset": { "type": "object", "description": "Paypal Service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "PaypalObject" }, "PaypalSource": { "type": "object", "description": "A copy activity Paypal Service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "PaypalSource" }, "PhoenixAuthenticationType": { "type": "string", "description": "The authentication mechanism used to connect to the Phoenix server.", "enum": [ "Anonymous", "UsernameAndPassword", "WindowsAzureHDInsightService" ], "x-ms-enum": { "name": "PhoenixAuthenticationType", "modelAsString": true, "values": [ { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "UsernameAndPassword", "value": "UsernameAndPassword", "description": "UsernameAndPassword" }, { "name": "WindowsAzureHDInsightService", "value": "WindowsAzureHDInsightService", "description": "WindowsAzureHDInsightService" } ] } }, "PhoenixDatasetTypeProperties": { "type": "object", "description": "Phoenix Dataset Properties", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The table name of the Phoenix. Type: string (or Expression with resultType string)." }, "schema": { "description": "The schema name of the Phoenix. Type: string (or Expression with resultType string)." } } }, "PhoenixLinkedService": { "type": "object", "description": "Phoenix server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/PhoenixLinkedServiceTypeProperties", "description": "Phoenix server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Phoenix" }, "PhoenixLinkedServiceTypeProperties": { "type": "object", "description": "Phoenix server linked service properties.", "properties": { "host": { "description": "The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)" }, "port": { "description": "The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765." }, "httpPath": { "description": "The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService." }, "authenticationType": { "$ref": "#/definitions/PhoenixAuthenticationType", "description": "The authentication mechanism used to connect to the Phoenix server." }, "username": { "description": "The user name used to connect to the Phoenix server." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name." }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false." }, "trustedCertPath": { "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR." }, "useSystemTrustStore": { "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false." }, "allowHostNameCNMismatch": { "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false." }, "allowSelfSignedServerCert": { "description": "Specifies whether to allow self-signed certificates from the server. The default value is false." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host", "authenticationType" ] }, "PhoenixObjectDataset": { "type": "object", "description": "Phoenix server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/PhoenixDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "PhoenixObject" }, "PhoenixSource": { "type": "object", "description": "A copy activity Phoenix server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "PhoenixSource" }, "Pipeline": { "type": "object", "description": "A data factory pipeline.", "properties": { "description": { "type": "string", "description": "The description of the pipeline." }, "activities": { "type": "array", "description": "List of activities in pipeline.", "items": { "$ref": "#/definitions/Activity" }, "x-ms-identifiers": [ "name" ] }, "parameters": { "type": "object", "description": "List of parameters for pipeline.", "additionalProperties": { "$ref": "#/definitions/ParameterSpecification" } }, "variables": { "type": "object", "description": "List of variables for pipeline.", "additionalProperties": { "$ref": "#/definitions/VariableSpecification" } }, "concurrency": { "type": "integer", "format": "int32", "description": "The max number of concurrent runs for the pipeline.", "minimum": 1 }, "annotations": { "type": "array", "description": "List of tags that can be used for describing the Pipeline.", "items": {} }, "runDimensions": { "type": "object", "description": "Dimensions emitted by Pipeline.", "additionalProperties": {} }, "folder": { "$ref": "#/definitions/PipelineFolder", "description": "The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level." }, "policy": { "$ref": "#/definitions/PipelinePolicy", "description": "Pipeline Policy." } } }, "PipelineElapsedTimeMetricPolicy": { "type": "object", "description": "Pipeline ElapsedTime Metric Policy.", "properties": { "duration": { "description": "TimeSpan value, after which an Azure Monitoring Metric is fired." } } }, "PipelineExternalComputeScaleProperties": { "type": "object", "description": "PipelineExternalComputeScale properties for managed integration runtime.", "properties": { "timeToLive": { "type": "integer", "format": "int32", "description": "Time to live (in minutes) setting of integration runtime which will execute pipeline and external activity.", "minimum": 5 }, "numberOfPipelineNodes": { "type": "integer", "format": "int32", "description": "Number of the pipeline nodes, which should be greater than 0 and less than 11.", "minimum": 1, "maximum": 10 }, "numberOfExternalNodes": { "type": "integer", "format": "int32", "description": "Number of the the external nodes, which should be greater than 0 and less than 11.", "minimum": 1, "maximum": 10 } }, "additionalProperties": {} }, "PipelineFolder": { "type": "object", "description": "The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.", "properties": { "name": { "type": "string", "description": "The name of the folder that this Pipeline is in." } } }, "PipelineListResponse": { "type": "object", "description": "A list of pipeline resources.", "properties": { "value": { "type": "array", "description": "The PipelineResource items on this page", "items": { "$ref": "#/definitions/PipelineResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PipelinePolicy": { "type": "object", "description": "Pipeline Policy.", "properties": { "elapsedTimeMetric": { "$ref": "#/definitions/PipelineElapsedTimeMetricPolicy", "description": "Pipeline ElapsedTime Metric Policy." } } }, "PipelineReference": { "type": "object", "description": "Pipeline reference type.", "properties": { "type": { "$ref": "#/definitions/PipelineReferenceType", "description": "Pipeline reference type." }, "referenceName": { "type": "string", "description": "Reference pipeline name." }, "name": { "type": "string", "description": "Reference name." } }, "required": [ "type", "referenceName" ] }, "PipelineReferenceType": { "type": "string", "description": "Pipeline reference type.", "enum": [ "PipelineReference" ], "x-ms-enum": { "name": "PipelineReferenceType", "modelAsString": true, "values": [ { "name": "PipelineReference", "value": "PipelineReference", "description": "PipelineReference" } ] } }, "PipelineResource": { "type": "object", "description": "Pipeline resource type.", "properties": { "properties": { "$ref": "#/definitions/Pipeline", "description": "Properties of the pipeline.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "additionalProperties": {}, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "PipelineRun": { "type": "object", "description": "Information about a pipeline run.", "properties": { "runId": { "type": "string", "description": "Identifier of a run.", "readOnly": true }, "runGroupId": { "type": "string", "description": "Identifier that correlates all the recovery runs of a pipeline run.", "readOnly": true }, "isLatest": { "type": "boolean", "description": "Indicates if the recovered pipeline run is the latest in its group.", "readOnly": true }, "pipelineName": { "type": "string", "description": "The pipeline name.", "readOnly": true }, "parameters": { "type": "object", "description": "The full or partial list of parameter name, value pair used in the pipeline run.", "additionalProperties": { "type": "string" }, "readOnly": true }, "runDimensions": { "type": "object", "description": "Run dimensions emitted by Pipeline run.", "additionalProperties": { "type": "string" }, "readOnly": true }, "invokedBy": { "$ref": "#/definitions/PipelineRunInvokedBy", "description": "Entity that started the pipeline run.", "readOnly": true }, "lastUpdated": { "type": "string", "format": "date-time", "description": "The last updated timestamp for the pipeline run event in ISO8601 format.", "readOnly": true }, "runStart": { "type": "string", "format": "date-time", "description": "The start time of a pipeline run in ISO8601 format.", "readOnly": true }, "runEnd": { "type": "string", "format": "date-time", "description": "The end time of a pipeline run in ISO8601 format.", "readOnly": true }, "durationInMs": { "type": "integer", "format": "int32", "description": "The duration of a pipeline run.", "readOnly": true }, "status": { "type": "string", "description": "The status of a pipeline run. Possible values: Queued, InProgress, Succeeded, Failed, Canceling, Cancelled", "readOnly": true }, "message": { "type": "string", "description": "The message from a pipeline run.", "readOnly": true } }, "additionalProperties": {} }, "PipelineRunInvokedBy": { "type": "object", "description": "Provides entity name and id that started the pipeline run.", "properties": { "name": { "type": "string", "description": "Name of the entity that started the pipeline run.", "readOnly": true }, "id": { "type": "string", "description": "The ID of the entity that started the run.", "readOnly": true }, "invokedByType": { "type": "string", "description": "The type of the entity that started the run.", "readOnly": true }, "pipelineName": { "type": "string", "description": "The name of the pipeline that triggered the run, if any.", "readOnly": true }, "pipelineRunId": { "type": "string", "description": "The run id of the pipeline that triggered the run, if any.", "readOnly": true } } }, "PipelineRunsQueryResponse": { "type": "object", "description": "A list pipeline runs.", "properties": { "value": { "type": "array", "description": "List of pipeline runs.", "items": { "$ref": "#/definitions/PipelineRun" }, "x-ms-identifiers": [ "runId" ] }, "continuationToken": { "type": "string", "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise." } }, "required": [ "value" ] }, "PolybaseSettings": { "type": "object", "description": "PolyBase settings.", "properties": { "rejectType": { "$ref": "#/definitions/PolybaseSettingsRejectType", "description": "Reject type." }, "rejectValue": { "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": { "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": { "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": {} }, "PolybaseSettingsRejectType": { "type": "string", "description": "Indicates whether the RejectValue property is specified as a literal value or a percentage.", "enum": [ "value", "percentage" ], "x-ms-enum": { "name": "PolybaseSettingsRejectType", "modelAsString": true, "values": [ { "name": "value", "value": "value", "description": "value" }, { "name": "percentage", "value": "percentage", "description": "percentage" } ] } }, "PostgreSqlLinkedService": { "type": "object", "description": "Linked service for PostgreSQL data source.", "properties": { "typeProperties": { "$ref": "#/definitions/PostgreSqlLinkedServiceTypeProperties", "description": "PostgreSQL linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "PostgreSql" }, "PostgreSqlLinkedServiceTypeProperties": { "type": "object", "description": "PostgreSQL linked service properties.", "properties": { "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "connectionString" ] }, "PostgreSqlSource": { "type": "object", "description": "A copy activity source for PostgreSQL databases.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "PostgreSqlSource" }, "PostgreSqlTableDataset": { "type": "object", "description": "The PostgreSQL table dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/PostgreSqlTableDatasetTypeProperties", "description": "PostgreSQL table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "PostgreSqlTable" }, "PostgreSqlTableDatasetTypeProperties": { "type": "object", "description": "PostgreSQL table dataset properties.", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The PostgreSQL table name. Type: string (or Expression with resultType string)." }, "schema": { "description": "The PostgreSQL schema name. Type: string (or Expression with resultType string)." } } }, "PostgreSqlV2LinkedService": { "type": "object", "description": "Linked service for PostgreSQLV2 data source.", "properties": { "typeProperties": { "$ref": "#/definitions/PostgreSqlV2LinkedServiceTypeProperties", "description": "PostgreSQLV2 linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "PostgreSqlV2" }, "PostgreSqlV2LinkedServiceTypeProperties": { "type": "object", "description": "PostgreSqlV2 linked service properties.", "properties": { "server": { "description": "Server name for connection. Type: string." }, "port": { "description": "The port for the connection. Type: integer." }, "username": { "description": "Username for authentication. Type: string." }, "database": { "description": "Database name for connection. Type: string." }, "authenticationType": { "description": "The authentication type to use. Type: string." }, "sslMode": { "description": "SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer." }, "schema": { "description": "Sets the schema search path. Type: string." }, "pooling": { "description": "Whether connection pooling should be used. Type: boolean." }, "connectionTimeout": { "description": "The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer." }, "commandTimeout": { "description": "The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer." }, "trustServerCertificate": { "description": "Whether to trust the server certificate without validating it. Type: boolean." }, "sslCertificate": { "description": "Location of a client certificate to be sent to the server. Type: string." }, "sslKey": { "description": "Location of a client key for a client certificate to be sent to the server. Type: string." }, "sslPassword": { "description": "Password for a key for a client certificate. Type: string." }, "readBufferSize": { "description": "Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer." }, "logParameters": { "description": "When enabled, parameter values are logged when commands are executed. Type: boolean." }, "timezone": { "description": "Gets or sets the session timezone. Type: string." }, "encoding": { "description": "Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string" }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string. Type: string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "server", "username", "database", "authenticationType", "sslMode" ] }, "PostgreSqlV2Source": { "type": "object", "description": "A copy activity source for PostgreSQL databases.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "PostgreSqlV2Source" }, "PostgreSqlV2TableDataset": { "type": "object", "description": "The PostgreSQLV2 table dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/PostgreSqlV2TableDatasetTypeProperties", "description": "PostgreSQLV2 table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "PostgreSqlV2Table" }, "PostgreSqlV2TableDatasetTypeProperties": { "type": "object", "description": "PostgreSQLV2 table dataset properties.", "properties": { "table": { "description": "The PostgreSQL table name. Type: string (or Expression with resultType string)." }, "schema": { "description": "The PostgreSQL schema name. Type: string (or Expression with resultType string)." } } }, "PowerQuerySink": { "type": "object", "description": "Power query sink.", "properties": { "script": { "type": "string", "description": "sink script." } }, "allOf": [ { "$ref": "#/definitions/DataFlowSink" } ] }, "PowerQuerySinkMapping": { "type": "object", "description": "Map Power Query mashup query to sink dataset(s).", "properties": { "queryName": { "type": "string", "description": "Name of the query in Power Query mashup document." }, "dataflowSinks": { "type": "array", "description": "List of sinks mapped to Power Query mashup query.", "items": { "$ref": "#/definitions/PowerQuerySink" }, "x-ms-identifiers": [ "name" ] } } }, "PowerQuerySource": { "type": "object", "description": "Power query source.", "properties": { "script": { "type": "string", "description": "source script." } }, "allOf": [ { "$ref": "#/definitions/DataFlowSource" } ] }, "PowerQueryTypeProperties": { "type": "object", "description": "Power Query data flow type properties.", "properties": { "sources": { "type": "array", "description": "List of sources in Power Query.", "items": { "$ref": "#/definitions/PowerQuerySource" }, "x-ms-identifiers": [ "name" ] }, "script": { "type": "string", "description": "Power query mashup script." }, "documentLocale": { "type": "string", "description": "Locale of the Power query mashup document." } } }, "PrestoAuthenticationType": { "type": "string", "description": "The authentication mechanism used to connect to the Presto server.", "enum": [ "Anonymous", "LDAP" ], "x-ms-enum": { "name": "PrestoAuthenticationType", "modelAsString": true, "values": [ { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "LDAP", "value": "LDAP", "description": "LDAP" } ] } }, "PrestoDatasetTypeProperties": { "type": "object", "description": "Presto Dataset Properties", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The table name of the Presto. Type: string (or Expression with resultType string)." }, "schema": { "description": "The schema name of the Presto. Type: string (or Expression with resultType string)." } } }, "PrestoLinkedService": { "type": "object", "description": "Presto server linked service. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.", "properties": { "typeProperties": { "$ref": "#/definitions/PrestoLinkedServiceTypeProperties", "description": "Presto server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Presto" }, "PrestoLinkedServiceTypeProperties": { "type": "object", "description": "Presto server linked service properties.", "properties": { "host": { "description": "The IP address or host name of the Presto server. (i.e. 192.168.222.160)" }, "serverVersion": { "description": "The version of the Presto server. (i.e. 0.148-t) Only used for Version 1.0." }, "catalog": { "description": "The catalog context for all request against the server." }, "port": { "description": "The TCP port that the Presto server uses to listen for client connections. The default value is 8080 when disable SSL, default value is 443 when enable SSL." }, "authenticationType": { "$ref": "#/definitions/PrestoAuthenticationType", "description": "The authentication mechanism used to connect to the Presto server." }, "username": { "description": "The user name used to connect to the Presto server." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name." }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value for legacy version is False. The default value for version 2.0 is True." }, "enableServerCertificateValidation": { "description": "Specifies whether the connections to the server will validate server certificate, the default value is True. Only used for Version 2.0" }, "trustedCertPath": { "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Only used for Version 1.0." }, "useSystemTrustStore": { "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. Only used for Version 1.0." }, "allowHostNameCNMismatch": { "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. Only used for Version 1.0." }, "allowSelfSignedServerCert": { "description": "Specifies whether to allow self-signed certificates from the server. The default value is false. Only used for Version 1.0." }, "timeZoneID": { "description": "The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value for Version 1.0 is the client system time zone. The default value for Version 2.0 is server system timeZone" }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host", "catalog", "authenticationType" ] }, "PrestoObjectDataset": { "type": "object", "description": "Presto server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/PrestoDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "PrestoObject" }, "PrestoSource": { "type": "object", "description": "A copy activity Presto server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "PrestoSource" }, "PrivateEndpoint": { "type": "object", "description": "Private endpoint which a connection belongs to.", "properties": { "id": { "type": "string", "description": "The resource Id for private endpoint" } } }, "PrivateEndpointConnectionListResponse": { "type": "object", "description": "A list of linked service resources.", "properties": { "value": { "type": "array", "description": "The PrivateEndpointConnectionResource items on this page", "items": { "$ref": "#/definitions/PrivateEndpointConnectionResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PrivateEndpointConnectionResource": { "type": "object", "description": "Private Endpoint Connection ARM resource.", "properties": { "properties": { "$ref": "#/definitions/RemotePrivateEndpointConnection", "description": "Core resource properties" }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "PrivateLinkConnectionApprovalRequest": { "type": "object", "description": "A request to approve or reject a private endpoint connection", "properties": { "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkConnectionState", "description": "The state of a private link connection" }, "privateEndpoint": { "$ref": "#/definitions/PrivateEndpoint", "description": "The resource of private endpoint." } } }, "PrivateLinkConnectionApprovalRequestResource": { "type": "object", "description": "Private Endpoint Connection Approval ARM resource.", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkConnectionApprovalRequest", "description": "Core resource properties" } }, "allOf": [ { "$ref": "#/definitions/SubResource" } ] }, "PrivateLinkConnectionState": { "type": "object", "description": "The state of a private link connection", "properties": { "status": { "type": "string", "description": "Status of a private link connection" }, "description": { "type": "string", "description": "Description of a private link connection" }, "actionsRequired": { "type": "string", "description": "ActionsRequired for a private link connection" } } }, "PrivateLinkResource": { "type": "object", "description": "A private link resource", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", "description": "Core resource properties" } }, "allOf": [ { "$ref": "#/definitions/SubResource" } ] }, "PrivateLinkResourceProperties": { "type": "object", "description": "Properties of a private link resource", "properties": { "groupId": { "type": "string", "description": "GroupId of a private link resource", "readOnly": true }, "requiredMembers": { "type": "array", "description": "RequiredMembers of a private link resource", "items": { "type": "string" }, "readOnly": true }, "requiredZoneNames": { "type": "array", "description": "RequiredZoneNames of a private link resource", "items": { "type": "string" }, "readOnly": true } } }, "PrivateLinkResourcesWrapper": { "type": "object", "description": "Wrapper for a collection of private link resources", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PrivateLinkResource" } } }, "required": [ "value" ] }, "PublicNetworkAccess": { "type": "string", "description": "Whether or not public network access is allowed for the data factory.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enabled" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" } ] } }, "PurviewConfiguration": { "type": "object", "description": "Purview configuration.", "properties": { "purviewResourceId": { "type": "string", "description": "Purview resource id." } } }, "QueryDataFlowDebugSessionsResponse": { "type": "object", "description": "Paged collection of DataFlowDebugSessionInfo items", "properties": { "value": { "type": "array", "description": "The DataFlowDebugSessionInfo items on this page", "items": { "$ref": "#/definitions/DataFlowDebugSessionInfo" }, "x-ms-identifiers": [ "dataFlowName", "sessionId" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "QuickBooksLinkedService": { "type": "object", "description": "QuickBooks server linked service. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.", "properties": { "typeProperties": { "$ref": "#/definitions/QuickBooksLinkedServiceTypeProperties", "description": "QuickBooks server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "QuickBooks" }, "QuickBooksLinkedServiceTypeProperties": { "type": "object", "description": "QuickBooks server linked service properties.", "properties": { "connectionProperties": { "description": "Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object." }, "endpoint": { "description": "The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)" }, "companyId": { "description": "The company ID of the QuickBooks company to authorize." }, "consumerKey": { "description": "The consumer key for OAuth 2.0 authentication." }, "consumerSecret": { "$ref": "#/definitions/SecretBase", "description": "The consumer secret for OAuth 2.0 authentication." }, "accessToken": { "$ref": "#/definitions/SecretBase", "description": "The access token for OAuth 2.0 authentication." }, "accessTokenSecret": { "$ref": "#/definitions/SecretBase", "description": "The access token secret is deprecated for OAuth 1.0 authentication. Only used for version 1.0." }, "refreshToken": { "$ref": "#/definitions/SecretBase", "description": "The refresh token for OAuth 2.0 authentication." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Only used for version 1.0." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "QuickBooksObjectDataset": { "type": "object", "description": "QuickBooks server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "QuickBooksObject" }, "QuickBooksSource": { "type": "object", "description": "A copy activity QuickBooks server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "QuickBooksSource" }, "QuickbaseLinkedService": { "type": "object", "description": "Linked service for Quickbase.", "properties": { "typeProperties": { "$ref": "#/definitions/QuickbaseLinkedServiceTypeProperties", "description": "Quickbase linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Quickbase" }, "QuickbaseLinkedServiceTypeProperties": { "type": "object", "description": "Quickbase linked service type properties.", "properties": { "url": { "description": "The url to connect Quickbase source. Type: string (or Expression with resultType string)." }, "userToken": { "$ref": "#/definitions/SecretBase", "description": "The user token for the Quickbase source." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "url", "userToken" ] }, "RecurrenceFrequency": { "type": "string", "description": "Enumerates possible frequency option for the schedule trigger.", "enum": [ "NotSpecified", "Minute", "Hour", "Day", "Week", "Month", "Year" ], "x-ms-enum": { "name": "RecurrenceFrequency", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified" }, { "name": "Minute", "value": "Minute", "description": "Minute" }, { "name": "Hour", "value": "Hour", "description": "Hour" }, { "name": "Day", "value": "Day", "description": "Day" }, { "name": "Week", "value": "Week", "description": "Week" }, { "name": "Month", "value": "Month", "description": "Month" }, { "name": "Year", "value": "Year", "description": "Year" } ] } }, "RecurrenceSchedule": { "type": "object", "description": "The recurrence schedule.", "properties": { "minutes": { "type": "array", "description": "The minutes.", "items": { "type": "integer", "format": "int32" } }, "hours": { "type": "array", "description": "The hours.", "items": { "type": "integer", "format": "int32" } }, "weekDays": { "type": "array", "description": "The days of the week.", "items": { "$ref": "#/definitions/DaysOfWeek" } }, "monthDays": { "type": "array", "description": "The month days.", "items": { "type": "integer", "format": "int32" } }, "monthlyOccurrences": { "type": "array", "description": "The monthly occurrences.", "items": { "$ref": "#/definitions/RecurrenceScheduleOccurrence" }, "x-ms-identifiers": [] } }, "additionalProperties": {} }, "RecurrenceScheduleOccurrence": { "type": "object", "description": "The recurrence schedule occurrence.", "properties": { "day": { "$ref": "#/definitions/DayOfWeek", "description": "The day of the week." }, "occurrence": { "type": "integer", "format": "int32", "description": "The occurrence." } }, "additionalProperties": {} }, "RedirectIncompatibleRowSettings": { "type": "object", "description": "Redirect incompatible row settings", "properties": { "linkedServiceName": { "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": { "description": "The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string)." } }, "required": [ "linkedServiceName" ], "additionalProperties": {} }, "RedshiftUnloadSettings": { "type": "object", "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.", "properties": { "s3LinkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source." }, "bucketName": { "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" ] }, "RelationalSource": { "type": "object", "description": "A copy activity source for various relational databases.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "RelationalSource" }, "RelationalTableDataset": { "type": "object", "description": "The relational table dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/RelationalTableDatasetTypeProperties", "description": "Relational table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "RelationalTable" }, "RelationalTableDatasetTypeProperties": { "type": "object", "description": "Relational table dataset properties.", "properties": { "tableName": { "description": "The relational table name. Type: string (or Expression with resultType string)." } } }, "RemotePrivateEndpointConnection": { "type": "object", "description": "A remote private endpoint connection", "properties": { "provisioningState": { "type": "string", "readOnly": true }, "privateEndpoint": { "$ref": "#/definitions/ArmIdWrapper", "description": "PrivateEndpoint of a remote private endpoint connection" }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkConnectionState", "description": "The state of a private link connection" } } }, "RerunTumblingWindowTrigger": { "type": "object", "description": "Trigger that schedules pipeline reruns for all fixed time interval windows from a requested start time to requested end time.", "properties": { "typeProperties": { "$ref": "#/definitions/RerunTumblingWindowTriggerTypeProperties", "description": "Rerun Trigger properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Trigger" } ], "x-ms-discriminator-value": "RerunTumblingWindowTrigger" }, "RerunTumblingWindowTriggerTypeProperties": { "type": "object", "description": "Rerun Trigger properties.", "properties": { "parentTrigger": { "description": "The parent trigger reference." }, "requestedStartTime": { "type": "string", "format": "date-time", "description": "The start time for the time period for which restatement is initiated. Only UTC time is currently supported." }, "requestedEndTime": { "type": "string", "format": "date-time", "description": "The end time for the time period for which restatement is initiated. Only UTC time is currently supported." }, "rerunConcurrency": { "type": "integer", "format": "int32", "description": "The max number of parallel time windows (ready for execution) for which a rerun is triggered.", "minimum": 1, "maximum": 50 } }, "required": [ "parentTrigger", "requestedStartTime", "requestedEndTime", "rerunConcurrency" ] }, "ResponsysLinkedService": { "type": "object", "description": "Responsys linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/ResponsysLinkedServiceTypeProperties", "description": "Responsys linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Responsys" }, "ResponsysLinkedServiceTypeProperties": { "type": "object", "description": "Responsys linked service properties.", "properties": { "endpoint": { "description": "The endpoint of the Responsys server." }, "clientId": { "description": "The client ID associated with the Responsys application. Type: string (or Expression with resultType string)." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret associated with the Responsys application. Type: string (or Expression with resultType string)." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "endpoint", "clientId" ] }, "ResponsysObjectDataset": { "type": "object", "description": "Responsys dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "ResponsysObject" }, "ResponsysSource": { "type": "object", "description": "A copy activity Responsys source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "ResponsysSource" }, "RestResourceDataset": { "type": "object", "description": "A Rest service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/RestResourceDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "RestResource" }, "RestResourceDatasetTypeProperties": { "type": "object", "description": "Properties specific to this dataset type.", "properties": { "relativeUrl": { "description": "The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string)." }, "requestMethod": { "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." }, "requestBody": { "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.", "additionalProperties": {} }, "paginationRules": { "type": "object", "description": "The pagination rules to compose next page requests.", "additionalProperties": {} } } }, "RestServiceAuthenticationType": { "type": "string", "description": "Type of authentication used to connect to the REST service.", "enum": [ "Anonymous", "Basic", "AadServicePrincipal", "ManagedServiceIdentity", "OAuth2ClientCredential" ], "x-ms-enum": { "name": "RestServiceAuthenticationType", "modelAsString": true, "values": [ { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "AadServicePrincipal", "value": "AadServicePrincipal", "description": "AadServicePrincipal" }, { "name": "ManagedServiceIdentity", "value": "ManagedServiceIdentity", "description": "ManagedServiceIdentity" }, { "name": "OAuth2ClientCredential", "value": "OAuth2ClientCredential", "description": "OAuth2ClientCredential" } ] } }, "RestServiceLinkedService": { "type": "object", "description": "Rest Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/RestServiceLinkedServiceTypeProperties", "description": "Rest Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "RestService" }, "RestServiceLinkedServiceTypeProperties": { "type": "object", "description": "Rest Service linked service properties.", "properties": { "url": { "description": "The base URL of the REST service. Type: string (or Expression with resultType string)." }, "enableServerCertificateValidation": { "description": "Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean)." }, "authenticationType": { "$ref": "#/definitions/RestServiceAuthenticationType", "description": "Type of authentication used to connect to the REST service." }, "userName": { "description": "The user name used in Basic authentication type. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password used in Basic authentication type." }, "authHeaders": { "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object)." }, "servicePrincipalId": { "description": "The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The application's key used in AadServicePrincipal authentication type." }, "tenant": { "description": "The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string)." }, "azureCloudType": { "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." }, "aadResourceId": { "description": "The resource you are requesting authorization to use. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." }, "clientId": { "description": "The client ID associated with your application. Type: string (or Expression with resultType string)." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret associated with your application." }, "tokenEndpoint": { "description": "The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string)." }, "resource": { "description": "The target service or resource to which the access will be requested. Type: string (or Expression with resultType string)." }, "scope": { "description": "The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string)." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalEmbeddedCert": { "$ref": "#/definitions/SecretBase", "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." }, "servicePrincipalEmbeddedCertPassword": { "$ref": "#/definitions/SecretBase", "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string)." } }, "required": [ "url", "authenticationType" ] }, "RestSink": { "type": "object", "description": "A copy activity Rest service Sink.", "properties": { "requestMethod": { "description": "The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string)." }, "additionalHeaders": { "description": "The additional HTTP headers in the request to the RESTful API. Type: key value pairs (value should be string type)." }, "httpRequestTimeout": { "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": { "description": "The time to await before sending next request, in milliseconds" }, "httpCompressionType": { "description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "RestSink" }, "RestSource": { "type": "object", "description": "A copy activity Rest service source.", "properties": { "requestMethod": { "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." }, "requestBody": { "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." }, "additionalHeaders": { "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." }, "paginationRules": { "description": "The pagination rules to compose next page requests. Type: string (or Expression with resultType string)." }, "httpRequestTimeout": { "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": { "description": "The time to await before sending next page request." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "RestSource" }, "RetryPolicy": { "type": "object", "description": "Execution policy for an activity.", "properties": { "count": { "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." }, "intervalInSeconds": { "type": "integer", "format": "int32", "description": "Interval between retries in seconds. Default is 30.", "minimum": 30, "maximum": 86400 } } }, "RunFilterParameters": { "type": "object", "description": "Query parameters for listing runs.", "properties": { "continuationToken": { "type": "string", "description": "The continuation token for getting the next page of results. Null for first page." }, "lastUpdatedAfter": { "type": "string", "format": "date-time", "description": "The time at or after which the run event was updated in 'ISO 8601' format." }, "lastUpdatedBefore": { "type": "string", "format": "date-time", "description": "The time at or before which the run event was updated in 'ISO 8601' format." }, "filters": { "type": "array", "description": "List of filters.", "items": { "$ref": "#/definitions/RunQueryFilter" }, "x-ms-identifiers": [] }, "orderBy": { "type": "array", "description": "List of OrderBy option.", "items": { "$ref": "#/definitions/RunQueryOrderBy" }, "x-ms-identifiers": [] } }, "required": [ "lastUpdatedAfter", "lastUpdatedBefore" ] }, "RunQueryFilter": { "type": "object", "description": "Query filter option for listing runs.", "properties": { "operand": { "$ref": "#/definitions/RunQueryFilterOperand", "description": "Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status." }, "operator": { "$ref": "#/definitions/RunQueryFilterOperator", "description": "Operator to be used for filter." }, "values": { "type": "array", "description": "List of filter values.", "items": { "type": "string" } } }, "required": [ "operand", "operator", "values" ] }, "RunQueryFilterOperand": { "type": "string", "description": "Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.", "enum": [ "PipelineName", "Status", "RunStart", "RunEnd", "ActivityName", "ActivityRunStart", "ActivityRunEnd", "ActivityType", "TriggerName", "TriggerRunTimestamp", "RunGroupId", "LatestOnly" ], "x-ms-enum": { "name": "RunQueryFilterOperand", "modelAsString": true, "values": [ { "name": "PipelineName", "value": "PipelineName", "description": "PipelineName" }, { "name": "Status", "value": "Status", "description": "Status" }, { "name": "RunStart", "value": "RunStart", "description": "RunStart" }, { "name": "RunEnd", "value": "RunEnd", "description": "RunEnd" }, { "name": "ActivityName", "value": "ActivityName", "description": "ActivityName" }, { "name": "ActivityRunStart", "value": "ActivityRunStart", "description": "ActivityRunStart" }, { "name": "ActivityRunEnd", "value": "ActivityRunEnd", "description": "ActivityRunEnd" }, { "name": "ActivityType", "value": "ActivityType", "description": "ActivityType" }, { "name": "TriggerName", "value": "TriggerName", "description": "TriggerName" }, { "name": "TriggerRunTimestamp", "value": "TriggerRunTimestamp", "description": "TriggerRunTimestamp" }, { "name": "RunGroupId", "value": "RunGroupId", "description": "RunGroupId" }, { "name": "LatestOnly", "value": "LatestOnly", "description": "LatestOnly" } ] } }, "RunQueryFilterOperator": { "type": "string", "description": "Operator to be used for filter.", "enum": [ "Equals", "NotEquals", "In", "NotIn" ], "x-ms-enum": { "name": "RunQueryFilterOperator", "modelAsString": true, "values": [ { "name": "Equals", "value": "Equals", "description": "Equals" }, { "name": "NotEquals", "value": "NotEquals", "description": "NotEquals" }, { "name": "In", "value": "In", "description": "In" }, { "name": "NotIn", "value": "NotIn", "description": "NotIn" } ] } }, "RunQueryOrder": { "type": "string", "description": "Sorting order of the parameter.", "enum": [ "ASC", "DESC" ], "x-ms-enum": { "name": "RunQueryOrder", "modelAsString": true, "values": [ { "name": "ASC", "value": "ASC", "description": "ASC" }, { "name": "DESC", "value": "DESC", "description": "DESC" } ] } }, "RunQueryOrderBy": { "type": "object", "description": "An object to provide order by options for listing runs.", "properties": { "orderBy": { "$ref": "#/definitions/RunQueryOrderByField", "description": "Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status." }, "order": { "$ref": "#/definitions/RunQueryOrder", "description": "Sorting order of the parameter." } }, "required": [ "orderBy", "order" ] }, "RunQueryOrderByField": { "type": "string", "description": "Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.", "enum": [ "RunStart", "RunEnd", "PipelineName", "Status", "ActivityName", "ActivityRunStart", "ActivityRunEnd", "TriggerName", "TriggerRunTimestamp" ], "x-ms-enum": { "name": "RunQueryOrderByField", "modelAsString": true, "values": [ { "name": "RunStart", "value": "RunStart", "description": "RunStart" }, { "name": "RunEnd", "value": "RunEnd", "description": "RunEnd" }, { "name": "PipelineName", "value": "PipelineName", "description": "PipelineName" }, { "name": "Status", "value": "Status", "description": "Status" }, { "name": "ActivityName", "value": "ActivityName", "description": "ActivityName" }, { "name": "ActivityRunStart", "value": "ActivityRunStart", "description": "ActivityRunStart" }, { "name": "ActivityRunEnd", "value": "ActivityRunEnd", "description": "ActivityRunEnd" }, { "name": "TriggerName", "value": "TriggerName", "description": "TriggerName" }, { "name": "TriggerRunTimestamp", "value": "TriggerRunTimestamp", "description": "TriggerRunTimestamp" } ] } }, "SSISAccessCredential": { "type": "object", "description": "SSIS access credential.", "properties": { "domain": { "description": "Domain for windows authentication. Type: string (or Expression with resultType string)." }, "userName": { "description": "UseName for windows authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for windows authentication." } }, "required": [ "domain", "userName", "password" ] }, "SSISChildPackage": { "type": "object", "description": "SSIS embedded child package.", "properties": { "packagePath": { "description": "Path for embedded child package. Type: string (or Expression with resultType string)." }, "packageName": { "type": "string", "description": "Name for embedded child package." }, "packageContent": { "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" ] }, "SSISExecutionCredential": { "type": "object", "description": "SSIS package execution credential.", "properties": { "domain": { "description": "Domain for windows authentication. Type: string (or Expression with resultType string)." }, "userName": { "description": "UseName for windows authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecureString", "description": "Password for windows authentication." } }, "required": [ "domain", "userName", "password" ] }, "SSISExecutionParameter": { "type": "object", "description": "SSIS execution parameter.", "properties": { "value": { "description": "SSIS package execution parameter value. Type: string (or Expression with resultType string)." } }, "required": [ "value" ] }, "SSISLogLocation": { "type": "object", "description": "SSIS package execution log location", "properties": { "logPath": { "description": "The SSIS package execution log path. Type: string (or Expression with resultType string)." }, "type": { "$ref": "#/definitions/SsisLogLocationType", "description": "The type of SSIS log location." }, "typeProperties": { "$ref": "#/definitions/SSISLogLocationTypeProperties", "description": "SSIS package execution log location properties.", "x-ms-client-flatten": true } }, "required": [ "logPath", "type", "typeProperties" ] }, "SSISLogLocationTypeProperties": { "type": "object", "description": "SSIS package execution log location properties.", "properties": { "accessCredential": { "$ref": "#/definitions/SSISAccessCredential", "description": "The package execution log access credential." }, "logRefreshInterval": { "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]))." } } }, "SSISPackageLocation": { "type": "object", "description": "SSIS package location.", "properties": { "packagePath": { "description": "The SSIS package path. Type: string (or Expression with resultType string)." }, "type": { "$ref": "#/definitions/SsisPackageLocationType", "description": "The type of SSIS package location." }, "typeProperties": { "$ref": "#/definitions/SSISPackageLocationTypeProperties", "description": "SSIS package location properties.", "x-ms-client-flatten": true } } }, "SSISPackageLocationTypeProperties": { "type": "object", "description": "SSIS package location properties.", "properties": { "packagePassword": { "$ref": "#/definitions/SecretBase", "description": "Password of the package." }, "accessCredential": { "$ref": "#/definitions/SSISAccessCredential", "description": "The package access credential." }, "configurationPath": { "description": "The configuration file of the package execution. Type: string (or Expression with resultType string)." }, "configurationAccessCredential": { "$ref": "#/definitions/SSISAccessCredential", "description": "The configuration file access credential." }, "packageName": { "type": "string", "description": "The package name." }, "packageContent": { "description": "The embedded package content. Type: string (or Expression with resultType string)." }, "packageLastModifiedDate": { "type": "string", "description": "The embedded package last modified date." }, "childPackages": { "type": "array", "description": "The embedded child package list.", "items": { "$ref": "#/definitions/SSISChildPackage" }, "x-ms-identifiers": [ "packagePath", "packageName" ] } } }, "SSISPropertyOverride": { "type": "object", "description": "SSIS property override.", "properties": { "value": { "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" ] }, "SalesforceLinkedService": { "type": "object", "description": "Linked service for Salesforce.", "properties": { "typeProperties": { "$ref": "#/definitions/SalesforceLinkedServiceTypeProperties", "description": "Salesforce linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Salesforce" }, "SalesforceLinkedServiceTypeProperties": { "type": "object", "description": "Salesforce linked service properties.", "properties": { "environmentUrl": { "description": "The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." }, "username": { "description": "The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password for Basic authentication of the Salesforce instance." }, "securityToken": { "$ref": "#/definitions/SecretBase", "description": "The security token is optional to remotely access Salesforce instance." }, "apiVersion": { "description": "The Salesforce API version used in ADF. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "SalesforceMarketingCloudLinkedService": { "type": "object", "description": "Salesforce Marketing Cloud linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/SalesforceMarketingCloudLinkedServiceTypeProperties", "description": "Salesforce Marketing Cloud linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SalesforceMarketingCloud" }, "SalesforceMarketingCloudLinkedServiceTypeProperties": { "type": "object", "description": "Salesforce Marketing Cloud linked service properties.", "properties": { "connectionProperties": { "description": "Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object." }, "clientId": { "description": "The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string)." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string)." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "SalesforceMarketingCloudObjectDataset": { "type": "object", "description": "Salesforce Marketing Cloud dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SalesforceMarketingCloudObject" }, "SalesforceMarketingCloudSource": { "type": "object", "description": "A copy activity Salesforce Marketing Cloud source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SalesforceMarketingCloudSource" }, "SalesforceObjectDataset": { "type": "object", "description": "The Salesforce object dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/SalesforceObjectDatasetTypeProperties", "description": "Salesforce object dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SalesforceObject" }, "SalesforceObjectDatasetTypeProperties": { "type": "object", "description": "Salesforce object dataset properties.", "properties": { "objectApiName": { "description": "The Salesforce object API name. Type: string (or Expression with resultType string)." } } }, "SalesforceServiceCloudLinkedService": { "type": "object", "description": "Linked service for Salesforce Service Cloud.", "properties": { "typeProperties": { "$ref": "#/definitions/SalesforceServiceCloudLinkedServiceTypeProperties", "description": "Salesforce Service Cloud linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SalesforceServiceCloud" }, "SalesforceServiceCloudLinkedServiceTypeProperties": { "type": "object", "description": "Salesforce Service Cloud linked service properties.", "properties": { "environmentUrl": { "description": "The URL of Salesforce Service Cloud instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." }, "username": { "description": "The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password for Basic authentication of the Salesforce instance." }, "securityToken": { "$ref": "#/definitions/SecretBase", "description": "The security token is optional to remotely access Salesforce instance." }, "apiVersion": { "description": "The Salesforce API version used in ADF. Type: string (or Expression with resultType string)." }, "extendedProperties": { "description": "Extended properties appended to the connection string. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "SalesforceServiceCloudObjectDataset": { "type": "object", "description": "The Salesforce Service Cloud object dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/SalesforceServiceCloudObjectDatasetTypeProperties", "description": "Salesforce Service Cloud object dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SalesforceServiceCloudObject" }, "SalesforceServiceCloudObjectDatasetTypeProperties": { "type": "object", "description": "Salesforce Service Cloud object dataset properties.", "properties": { "objectApiName": { "description": "The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string)." } } }, "SalesforceServiceCloudSink": { "type": "object", "description": "A copy activity Salesforce Service Cloud sink.", "properties": { "writeBehavior": { "$ref": "#/definitions/SalesforceSinkWriteBehavior", "description": "The write behavior for the operation. Default is Insert." }, "externalIdFieldName": { "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." }, "ignoreNullValues": { "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)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SalesforceServiceCloudSink" }, "SalesforceServiceCloudSource": { "type": "object", "description": "A copy activity Salesforce Service Cloud source.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." }, "readBehavior": { "description": "The read behavior for the operation. Default is Query. Allowed values: Query/QueryAll. Type: string (or Expression with resultType string)." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "SalesforceServiceCloudSource" }, "SalesforceServiceCloudV2LinkedService": { "type": "object", "description": "Linked service for Salesforce Service Cloud V2.", "properties": { "typeProperties": { "$ref": "#/definitions/SalesforceServiceCloudV2LinkedServiceTypeProperties", "description": "Salesforce Service Cloud V2 linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SalesforceServiceCloudV2" }, "SalesforceServiceCloudV2LinkedServiceTypeProperties": { "type": "object", "description": "Salesforce Service Cloud V2 linked service properties.", "properties": { "environmentUrl": { "description": "The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." }, "authenticationType": { "description": "The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value" }, "clientId": { "description": "The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string)." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance." }, "apiVersion": { "description": "The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "SalesforceServiceCloudV2ObjectDataset": { "type": "object", "description": "The Salesforce Service Cloud V2 object dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/SalesforceServiceCloudV2ObjectDatasetTypeProperties", "description": "Salesforce Service Cloud V2 object dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SalesforceServiceCloudV2Object" }, "SalesforceServiceCloudV2ObjectDatasetTypeProperties": { "type": "object", "description": "Salesforce Service Cloud V2 object dataset properties.", "properties": { "objectApiName": { "description": "The Salesforce Service Cloud V2 object API name. Type: string (or Expression with resultType string)." }, "reportId": { "description": "The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string)." } } }, "SalesforceServiceCloudV2Sink": { "type": "object", "description": "A copy activity Salesforce Service Cloud V2 sink.", "properties": { "writeBehavior": { "$ref": "#/definitions/SalesforceV2SinkWriteBehavior", "description": "The write behavior for the operation. Default is Insert." }, "externalIdFieldName": { "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." }, "ignoreNullValues": { "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)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SalesforceServiceCloudV2Sink" }, "SalesforceServiceCloudV2Source": { "type": "object", "description": "A copy activity Salesforce Service Cloud V2 source.", "properties": { "SOQLQuery": { "description": "Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string)." }, "query": { "description": "You can only use Salesforce Object Query Language (SOQL) query with limitations. For SOQL limitations, see this article: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm#SOQL%20Considerations. If query is not specified, all the data of the Salesforce object specified in ObjectApiName/reportId in dataset will be retrieved. Type: string (or Expression with resultType string)." }, "includeDeletedObjects": { "description": "This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean)." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "SalesforceServiceCloudV2Source" }, "SalesforceSink": { "type": "object", "description": "A copy activity Salesforce sink.", "properties": { "writeBehavior": { "$ref": "#/definitions/SalesforceSinkWriteBehavior", "description": "The write behavior for the operation. Default is Insert." }, "externalIdFieldName": { "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." }, "ignoreNullValues": { "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)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SalesforceSink" }, "SalesforceSinkWriteBehavior": { "type": "string", "description": "The write behavior for the operation. Default is Insert.", "enum": [ "Insert", "Upsert" ], "x-ms-enum": { "name": "SalesforceSinkWriteBehavior", "modelAsString": true, "values": [ { "name": "Insert", "value": "Insert", "description": "Insert" }, { "name": "Upsert", "value": "Upsert", "description": "Upsert" } ] } }, "SalesforceSource": { "type": "object", "description": "A copy activity Salesforce source.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." }, "readBehavior": { "description": "The read behavior for the operation. Default is Query. Allowed values: Query/QueryAll. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SalesforceSource" }, "SalesforceSourceReadBehavior": { "type": "string", "description": "The Salesforce read behavior for the operation", "enum": [ "Query", "QueryAll" ], "x-ms-enum": { "name": "SalesforceSourceReadBehavior", "modelAsString": true, "values": [ { "name": "Query", "value": "Query", "description": "Query" }, { "name": "QueryAll", "value": "QueryAll", "description": "QueryAll" } ] } }, "SalesforceV2LinkedService": { "type": "object", "description": "Linked service for Salesforce V2.", "properties": { "typeProperties": { "$ref": "#/definitions/SalesforceV2LinkedServiceTypeProperties", "description": "Salesforce V2 linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SalesforceV2" }, "SalesforceV2LinkedServiceTypeProperties": { "type": "object", "description": "Salesforce V2 linked service properties.", "properties": { "environmentUrl": { "description": "The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." }, "authenticationType": { "description": "The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value" }, "clientId": { "description": "The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string)." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance." }, "apiVersion": { "description": "The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "SalesforceV2ObjectDataset": { "type": "object", "description": "The Salesforce V2 object dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/SalesforceV2ObjectDatasetTypeProperties", "description": "Salesforce V2 object dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SalesforceV2Object" }, "SalesforceV2ObjectDatasetTypeProperties": { "type": "object", "description": "Salesforce V2 object dataset properties.", "properties": { "objectApiName": { "description": "The Salesforce V2 object API name. Type: string (or Expression with resultType string)." }, "reportId": { "description": "The Salesforce V2 report Id. Type: string (or Expression with resultType string)." } } }, "SalesforceV2Sink": { "type": "object", "description": "A copy activity Salesforce V2 sink.", "properties": { "writeBehavior": { "$ref": "#/definitions/SalesforceV2SinkWriteBehavior", "description": "The write behavior for the operation. Default is Insert." }, "externalIdFieldName": { "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." }, "ignoreNullValues": { "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)." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SalesforceV2Sink" }, "SalesforceV2SinkWriteBehavior": { "type": "string", "description": "The write behavior for the operation. Default is Insert.", "enum": [ "Insert", "Upsert" ], "x-ms-enum": { "name": "SalesforceV2SinkWriteBehavior", "modelAsString": true, "values": [ { "name": "Insert", "value": "Insert", "description": "Insert" }, { "name": "Upsert", "value": "Upsert", "description": "Upsert" } ] } }, "SalesforceV2Source": { "type": "object", "description": "A copy activity Salesforce V2 source.", "properties": { "SOQLQuery": { "description": "Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string)." }, "query": { "description": "You can only use Salesforce Object Query Language (SOQL) query with limitations. For SOQL limitations, see this article: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm#SOQL%20Considerations. If query is not specified, all the data of the Salesforce object specified in ObjectApiName/reportId in dataset will be retrieved. Type: string (or Expression with resultType string)." }, "includeDeletedObjects": { "description": "This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean)." }, "pageSize": { "description": "Page size for each http request, too large pageSize will caused timeout, default 300,000. Type: integer (or Expression with resultType integer)." }, "partitionOption": { "description": "Partition option for the SalesforceV2 connector in copy activity, AutoDetect or None. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SalesforceV2Source" }, "SapBWLinkedService": { "type": "object", "description": "SAP Business Warehouse Linked Service.", "properties": { "typeProperties": { "$ref": "#/definitions/SapBWLinkedServiceTypeProperties", "description": "Properties specific to this linked service type.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SapBW" }, "SapBWLinkedServiceTypeProperties": { "type": "object", "description": "Properties specific to this linked service type.", "properties": { "server": { "description": "Host name of the SAP BW instance. Type: string (or Expression with resultType string)." }, "systemNumber": { "description": "System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." }, "clientId": { "description": "Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." }, "userName": { "description": "Username to access the SAP BW server. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to access the SAP BW server." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "server", "systemNumber", "clientId" ] }, "SapBwCubeDataset": { "type": "object", "description": "The SAP BW cube dataset.", "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SapBwCube" }, "SapBwSource": { "type": "object", "description": "A copy activity source for SapBW server via MDX.", "properties": { "query": { "description": "MDX query. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SapBwSource" }, "SapCloudForCustomerLinkedService": { "type": "object", "description": "Linked service for SAP Cloud for Customer.", "properties": { "typeProperties": { "$ref": "#/definitions/SapCloudForCustomerLinkedServiceTypeProperties", "description": "SAP Cloud for Customer linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SapCloudForCustomer" }, "SapCloudForCustomerLinkedServiceTypeProperties": { "type": "object", "description": "SAP Cloud for Customer linked service properties.", "properties": { "url": { "description": "The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string)." }, "username": { "description": "The username for Basic authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password for Basic authentication." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string." } }, "required": [ "url" ] }, "SapCloudForCustomerResourceDataset": { "type": "object", "description": "The path of the SAP Cloud for Customer OData entity.", "properties": { "typeProperties": { "$ref": "#/definitions/SapCloudForCustomerResourceDatasetTypeProperties", "description": "SAP Cloud For Customer OData resource dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SapCloudForCustomerResource" }, "SapCloudForCustomerResourceDatasetTypeProperties": { "type": "object", "description": "Sap Cloud For Customer OData resource dataset properties.", "properties": { "path": { "description": "The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string)." } }, "required": [ "path" ] }, "SapCloudForCustomerSink": { "type": "object", "description": "A copy activity SAP Cloud for Customer sink.", "properties": { "writeBehavior": { "$ref": "#/definitions/SapCloudForCustomerSinkWriteBehavior", "description": "The write behavior for the operation. Default is 'Insert'." }, "httpRequestTimeout": { "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]))." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SapCloudForCustomerSink" }, "SapCloudForCustomerSinkWriteBehavior": { "type": "string", "description": "The write behavior for the operation. Default is 'Insert'.", "enum": [ "Insert", "Update" ], "x-ms-enum": { "name": "SapCloudForCustomerSinkWriteBehavior", "modelAsString": true, "values": [ { "name": "Insert", "value": "Insert", "description": "Insert" }, { "name": "Update", "value": "Update", "description": "Update" } ] } }, "SapCloudForCustomerSource": { "type": "object", "description": "A copy activity source for SAP Cloud for Customer source.", "properties": { "query": { "description": "SAP Cloud for Customer OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." }, "httpRequestTimeout": { "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]))." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SapCloudForCustomerSource" }, "SapEccLinkedService": { "type": "object", "description": "Linked service for SAP ERP Central Component(SAP ECC).", "properties": { "typeProperties": { "$ref": "#/definitions/SapEccLinkedServiceTypeProperties", "description": "SAP ECC linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SapEcc" }, "SapEccLinkedServiceTypeProperties": { "type": "object", "description": "SAP ECC linked service properties.", "properties": { "url": { "description": "The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string)." }, "username": { "description": "The username for Basic authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password for Basic authentication." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string." } }, "required": [ "url" ] }, "SapEccResourceDataset": { "type": "object", "description": "The path of the SAP ECC OData entity.", "properties": { "typeProperties": { "$ref": "#/definitions/SapEccResourceDatasetTypeProperties", "description": "SAP ECC OData resource dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SapEccResource" }, "SapEccResourceDatasetTypeProperties": { "type": "object", "description": "Sap ECC OData resource dataset properties.", "properties": { "path": { "description": "The path of the SAP ECC OData entity. Type: string (or Expression with resultType string)." } }, "required": [ "path" ] }, "SapEccSource": { "type": "object", "description": "A copy activity source for SAP ECC source.", "properties": { "query": { "description": "SAP ECC OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." }, "httpRequestTimeout": { "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]))." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SapEccSource" }, "SapHanaAuthenticationType": { "type": "string", "description": "The authentication type to be used to connect to the SAP HANA server.", "enum": [ "Basic", "Windows" ], "x-ms-enum": { "name": "SapHanaAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Windows", "value": "Windows", "description": "Windows" } ] } }, "SapHanaLinkedService": { "type": "object", "description": "SAP HANA Linked Service.", "properties": { "typeProperties": { "$ref": "#/definitions/SapHanaLinkedServiceProperties", "description": "Properties specific to this linked service type.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SapHana" }, "SapHanaLinkedServiceProperties": { "type": "object", "description": "Properties specific to this linked service type.", "properties": { "connectionString": { "description": "SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "server": { "description": "Host name of the SAP HANA server. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/SapHanaAuthenticationType", "description": "The authentication type to be used to connect to the SAP HANA server." }, "userName": { "description": "Username to access the SAP HANA server. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to access the SAP HANA server." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "SapHanaPartitionOption": { "type": "string", "description": "The partition mechanism that will be used for SAP HANA read in parallel.", "enum": [ "None", "PhysicalPartitionsOfTable", "SapHanaDynamicRange" ], "x-ms-enum": { "name": "SapHanaPartitionOption", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "PhysicalPartitionsOfTable", "value": "PhysicalPartitionsOfTable", "description": "PhysicalPartitionsOfTable" }, { "name": "SapHanaDynamicRange", "value": "SapHanaDynamicRange", "description": "SapHanaDynamicRange" } ] } }, "SapHanaPartitionSettings": { "type": "object", "description": "The settings that will be leveraged for SAP HANA source partitioning.", "properties": { "partitionColumnName": { "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." } } }, "SapHanaSource": { "type": "object", "description": "A copy activity source for SAP HANA source.", "properties": { "query": { "description": "SAP HANA Sql query. Type: string (or Expression with resultType string)." }, "packetSize": { "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. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"SapHanaDynamicRange\"." }, "partitionSettings": { "$ref": "#/definitions/SapHanaPartitionSettings", "description": "The settings that will be leveraged for SAP HANA source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SapHanaSource" }, "SapHanaTableDataset": { "type": "object", "description": "SAP HANA Table properties.", "properties": { "typeProperties": { "$ref": "#/definitions/SapHanaTableDatasetTypeProperties", "description": "SAP HANA Table properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SapHanaTable" }, "SapHanaTableDatasetTypeProperties": { "type": "object", "description": "SAP HANA Table properties.", "properties": { "schema": { "description": "The schema name of SAP HANA. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of SAP HANA. Type: string (or Expression with resultType string)." } } }, "SapOdpLinkedService": { "type": "object", "description": "SAP ODP Linked Service.", "properties": { "typeProperties": { "$ref": "#/definitions/SapOdpLinkedServiceTypeProperties", "description": "Properties specific to SAP ODP linked service type.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SapOdp" }, "SapOdpLinkedServiceTypeProperties": { "type": "object", "description": "Properties specific to this linked service type.", "properties": { "server": { "description": "Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string)." }, "systemNumber": { "description": "System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." }, "clientId": { "description": "Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." }, "language": { "description": "Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string)." }, "systemId": { "description": "SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string)." }, "userName": { "description": "Username to access the SAP server where the table is located. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to access the SAP server where the table is located." }, "messageServer": { "description": "The hostname of the SAP Message Server. Type: string (or Expression with resultType string)." }, "messageServerService": { "description": "The service name or port number of the Message Server. Type: string (or Expression with resultType string)." }, "sncMode": { "description": "SNC activation flag (Boolean) to access the SAP server where the table is located. Type: boolean (or Expression with resultType boolean)." }, "sncMyName": { "description": "Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string)." }, "sncPartnerName": { "description": "Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string)." }, "sncLibraryPath": { "description": "External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string)." }, "sncQop": { "description": "SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string)." }, "x509CertificatePath": { "description": "SNC X509 certificate file path. Type: string (or Expression with resultType string)." }, "logonGroup": { "description": "The Logon Group for the SAP System. Type: string (or Expression with resultType string)." }, "subscriberName": { "description": "The subscriber name. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "SapOdpResourceDataset": { "type": "object", "description": "SAP ODP Resource properties.", "properties": { "typeProperties": { "$ref": "#/definitions/SapOdpResourceDatasetTypeProperties", "description": "SAP ODP Resource properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SapOdpResource" }, "SapOdpResourceDatasetTypeProperties": { "type": "object", "description": "SAP ODP Resource properties.", "properties": { "context": { "description": "The context of the SAP ODP Object. Type: string (or Expression with resultType string)." }, "objectName": { "description": "The name of the SAP ODP Object. Type: string (or Expression with resultType string)." } }, "required": [ "context", "objectName" ] }, "SapOdpSource": { "type": "object", "description": "A copy activity source for SAP ODP source.", "properties": { "extractionMode": { "description": "The extraction mode. Allowed value include: Full, Delta and Recovery. The default value is Full. Type: string (or Expression with resultType string)." }, "subscriberProcess": { "description": "The subscriber process to manage the delta process. Type: string (or Expression with resultType string)." }, "selection": { "description": "Specifies the selection conditions from source data. Type: array of objects(selection) (or Expression with resultType array of objects)." }, "projection": { "description": "Specifies the columns to be selected from source data. Type: array of objects(projection) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SapOdpSource" }, "SapOpenHubLinkedService": { "type": "object", "description": "SAP Business Warehouse Open Hub Destination Linked Service.", "properties": { "typeProperties": { "$ref": "#/definitions/SapOpenHubLinkedServiceTypeProperties", "description": "Properties specific to SAP Business Warehouse Open Hub Destination linked service type.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SapOpenHub" }, "SapOpenHubLinkedServiceTypeProperties": { "type": "object", "description": "Properties specific to SAP Business Warehouse Open Hub Destination linked service type.", "properties": { "server": { "description": "Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string)." }, "systemNumber": { "description": "System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." }, "clientId": { "description": "Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." }, "language": { "description": "Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string)." }, "systemId": { "description": "SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string)." }, "userName": { "description": "Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to access the SAP BW server where the open hub destination is located." }, "messageServer": { "description": "The hostname of the SAP Message Server. Type: string (or Expression with resultType string)." }, "messageServerService": { "description": "The service name or port number of the Message Server. Type: string (or Expression with resultType string)." }, "logonGroup": { "description": "The Logon Group for the SAP System. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "SapOpenHubSource": { "type": "object", "description": "A copy activity source for SAP Business Warehouse Open Hub Destination source.", "properties": { "excludeLastRequest": { "description": "Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "baseRequestId": { "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 )." }, "customRfcReadTableFunctionModule": { "description": "Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string)." }, "sapDataColumnDelimiter": { "description": "The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SapOpenHubSource" }, "SapOpenHubTableDataset": { "type": "object", "description": "Sap Business Warehouse Open Hub Destination Table properties.", "properties": { "typeProperties": { "$ref": "#/definitions/SapOpenHubTableDatasetTypeProperties", "description": "Sap Business Warehouse Open Hub Destination Table properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SapOpenHubTable" }, "SapOpenHubTableDatasetTypeProperties": { "type": "object", "description": "Sap Business Warehouse Open Hub Destination Table properties.", "properties": { "openHubDestinationName": { "description": "The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string)." }, "excludeLastRequest": { "description": "Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "baseRequestId": { "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 )." } }, "required": [ "openHubDestinationName" ] }, "SapTableLinkedService": { "type": "object", "description": "SAP Table Linked Service.", "properties": { "typeProperties": { "$ref": "#/definitions/SapTableLinkedServiceTypeProperties", "description": "Properties specific to this linked service type.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SapTable" }, "SapTableLinkedServiceTypeProperties": { "type": "object", "description": "Properties specific to this linked service type.", "properties": { "server": { "description": "Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string)." }, "systemNumber": { "description": "System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." }, "clientId": { "description": "Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." }, "language": { "description": "Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string)." }, "systemId": { "description": "SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string)." }, "userName": { "description": "Username to access the SAP server where the table is located. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to access the SAP server where the table is located." }, "messageServer": { "description": "The hostname of the SAP Message Server. Type: string (or Expression with resultType string)." }, "messageServerService": { "description": "The service name or port number of the Message Server. Type: string (or Expression with resultType string)." }, "sncMode": { "description": "SNC activation flag (Boolean) to access the SAP server where the table is located. Type: boolean (or Expression with resultType boolean)." }, "sncMyName": { "description": "Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string)." }, "sncPartnerName": { "description": "Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string)." }, "sncLibraryPath": { "description": "External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string)." }, "sncQop": { "description": "SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string)." }, "logonGroup": { "description": "The Logon Group for the SAP System. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "SapTablePartitionOption": { "type": "string", "description": "The partition mechanism that will be used for SAP table read in parallel.", "enum": [ "None", "PartitionOnInt", "PartitionOnCalendarYear", "PartitionOnCalendarMonth", "PartitionOnCalendarDate", "PartitionOnTime" ], "x-ms-enum": { "name": "SapTablePartitionOption", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "PartitionOnInt", "value": "PartitionOnInt", "description": "PartitionOnInt" }, { "name": "PartitionOnCalendarYear", "value": "PartitionOnCalendarYear", "description": "PartitionOnCalendarYear" }, { "name": "PartitionOnCalendarMonth", "value": "PartitionOnCalendarMonth", "description": "PartitionOnCalendarMonth" }, { "name": "PartitionOnCalendarDate", "value": "PartitionOnCalendarDate", "description": "PartitionOnCalendarDate" }, { "name": "PartitionOnTime", "value": "PartitionOnTime", "description": "PartitionOnTime" } ] } }, "SapTablePartitionSettings": { "type": "object", "description": "The settings that will be leveraged for SAP table source partitioning.", "properties": { "partitionColumnName": { "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." }, "partitionUpperBound": { "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": { "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": { "description": "The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string)." } } }, "SapTableResourceDataset": { "type": "object", "description": "SAP Table Resource properties.", "properties": { "typeProperties": { "$ref": "#/definitions/SapTableResourceDatasetTypeProperties", "description": "SAP Table Resource properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SapTableResource" }, "SapTableResourceDatasetTypeProperties": { "type": "object", "description": "SAP Table Resource properties.", "properties": { "tableName": { "description": "The name of the SAP Table. Type: string (or Expression with resultType string)." } }, "required": [ "tableName" ] }, "SapTableSource": { "type": "object", "description": "A copy activity source for SAP Table source.", "properties": { "rowCount": { "description": "The number of rows to be retrieved. Type: integer(or Expression with resultType integer)." }, "rowSkips": { "description": "The number of rows that will be skipped. Type: integer (or Expression with resultType integer)." }, "rfcTableFields": { "description": "The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string)." }, "rfcTableOptions": { "description": "The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string)." }, "batchSize": { "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": { "description": "Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string)." }, "sapDataColumnDelimiter": { "description": "The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string)." }, "partitionOption": { "description": "The partition mechanism that will be used for SAP table read in parallel. Possible values include: \"None\", \"PartitionOnInt\", \"PartitionOnCalendarYear\", \"PartitionOnCalendarMonth\", \"PartitionOnCalendarDate\", \"PartitionOnTime\"." }, "partitionSettings": { "$ref": "#/definitions/SapTablePartitionSettings", "description": "The settings that will be leveraged for SAP table source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SapTableSource" }, "ScheduleTrigger": { "type": "object", "description": "Trigger that creates pipeline runs periodically, on schedule.", "properties": { "typeProperties": { "$ref": "#/definitions/ScheduleTriggerTypeProperties", "description": "Schedule Trigger properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/MultiplePipelineTrigger" } ], "x-ms-discriminator-value": "ScheduleTrigger" }, "ScheduleTriggerRecurrence": { "type": "object", "description": "The workflow trigger recurrence.", "properties": { "frequency": { "$ref": "#/definitions/RecurrenceFrequency", "description": "The frequency." }, "interval": { "type": "integer", "format": "int32", "description": "The interval." }, "startTime": { "type": "string", "format": "date-time", "description": "The start time." }, "endTime": { "type": "string", "format": "date-time", "description": "The end time." }, "timeZone": { "type": "string", "description": "The time zone." }, "schedule": { "$ref": "#/definitions/RecurrenceSchedule", "description": "The recurrence schedule." } }, "additionalProperties": {} }, "ScheduleTriggerTypeProperties": { "type": "object", "description": "Schedule Trigger properties.", "properties": { "recurrence": { "$ref": "#/definitions/ScheduleTriggerRecurrence", "description": "Recurrence schedule configuration." } }, "required": [ "recurrence" ] }, "ScriptAction": { "type": "object", "description": "Custom script action to run on HDI ondemand cluster once it's up.", "properties": { "name": { "type": "string", "description": "The user provided name of the script action." }, "uri": { "type": "string", "description": "The URI for the script action." }, "roles": { "description": "The node types on which the script action should be executed." }, "parameters": { "type": "string", "description": "The parameters for the script action." } }, "required": [ "name", "uri", "roles" ] }, "ScriptActivity": { "type": "object", "description": "Script activity type.", "properties": { "typeProperties": { "$ref": "#/definitions/ScriptActivityTypeProperties", "description": "Script activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "Script" }, "ScriptActivityLogDestination": { "type": "string", "description": "The destination of logs. Type: string.", "enum": [ "ActivityOutput", "ExternalStore" ], "x-ms-enum": { "name": "ScriptActivityLogDestination", "modelAsString": true, "values": [ { "name": "ActivityOutput", "value": "ActivityOutput", "description": "ActivityOutput" }, { "name": "ExternalStore", "value": "ExternalStore", "description": "ExternalStore" } ] } }, "ScriptActivityParameter": { "type": "object", "description": "Parameters of a script block.", "properties": { "name": { "description": "The name of the parameter. Type: string (or Expression with resultType string)." }, "type": { "$ref": "#/definitions/ScriptActivityParameterType", "description": "The type of the parameter." }, "value": { "description": "The value of the parameter. Type: string (or Expression with resultType string)." }, "direction": { "$ref": "#/definitions/ScriptActivityParameterDirection", "description": "The direction of the parameter." }, "size": { "type": "integer", "format": "int32", "description": "The size of the output direction parameter." } } }, "ScriptActivityParameterDirection": { "type": "string", "description": "The direction of the parameter.", "enum": [ "Input", "Output", "InputOutput" ], "x-ms-enum": { "name": "ScriptActivityParameterDirection", "modelAsString": true, "values": [ { "name": "Input", "value": "Input", "description": "Input" }, { "name": "Output", "value": "Output", "description": "Output" }, { "name": "InputOutput", "value": "InputOutput", "description": "InputOutput" } ] } }, "ScriptActivityParameterType": { "type": "string", "description": "The type of the parameter.", "enum": [ "Boolean", "DateTime", "DateTimeOffset", "Decimal", "Double", "Guid", "Int16", "Int32", "Int64", "Single", "String", "Timespan" ], "x-ms-enum": { "name": "ScriptActivityParameterType", "modelAsString": true, "values": [ { "name": "Boolean", "value": "Boolean", "description": "Boolean" }, { "name": "DateTime", "value": "DateTime", "description": "DateTime" }, { "name": "DateTimeOffset", "value": "DateTimeOffset", "description": "DateTimeOffset" }, { "name": "Decimal", "value": "Decimal", "description": "Decimal" }, { "name": "Double", "value": "Double", "description": "Double" }, { "name": "Guid", "value": "Guid", "description": "Guid" }, { "name": "Int16", "value": "Int16", "description": "Int16" }, { "name": "Int32", "value": "Int32", "description": "Int32" }, { "name": "Int64", "value": "Int64", "description": "Int64" }, { "name": "Single", "value": "Single", "description": "Single" }, { "name": "String", "value": "String", "description": "String" }, { "name": "Timespan", "value": "Timespan", "description": "Timespan" } ] } }, "ScriptActivityScriptBlock": { "type": "object", "description": "Script block of scripts.", "properties": { "text": { "description": "The query text. Type: string (or Expression with resultType string)." }, "type": { "description": "The type of the query. Please refer to the ScriptType for valid options. Type: string (or Expression with resultType string)." }, "parameters": { "type": "array", "description": "Array of script parameters. Type: array.", "items": { "$ref": "#/definitions/ScriptActivityParameter" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "text", "type" ] }, "ScriptActivityTypeProperties": { "type": "object", "description": "Script activity properties.", "properties": { "scriptBlockExecutionTimeout": { "description": "ScriptBlock execution timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." }, "scripts": { "type": "array", "description": "Array of script blocks. Type: array.", "items": { "$ref": "#/definitions/ScriptActivityScriptBlock" }, "x-ms-identifiers": [] }, "logSettings": { "$ref": "#/definitions/ScriptActivityTypePropertiesLogSettings", "description": "Log settings of script activity." }, "returnMultistatementResult": { "description": "Enable to retrieve result sets from multiple SQL statements and the number of rows affected by the DML statement. Supported connector: SnowflakeV2. Type: boolean (or Expression with resultType boolean)." }, "treatDecimalAsString": { "description": "Indicates whether to treat decimal values as strings to avoid value overflow issue. This option is enabled for SnowflakeV2 connector only. Type: boolean (or Expression with resultType boolean)." } } }, "ScriptActivityTypePropertiesLogSettings": { "type": "object", "description": "Log settings of script activity.", "properties": { "logDestination": { "$ref": "#/definitions/ScriptActivityLogDestination", "description": "The destination of logs. Type: string." }, "logLocationSettings": { "$ref": "#/definitions/LogLocationSettings", "description": "Log location settings customer needs to provide when enabling log." } }, "required": [ "logDestination" ] }, "ScriptType": { "type": "string", "description": "The type of the ScriptActivityScriptBlock.", "enum": [ "Query", "NonQuery" ], "x-ms-enum": { "name": "ScriptType", "modelAsString": true, "values": [ { "name": "Query", "value": "Query", "description": "Query" }, { "name": "NonQuery", "value": "NonQuery", "description": "NonQuery" } ] } }, "SecretBase": { "type": "object", "description": "The base definition of a secret type.", "properties": { "type": { "type": "string", "description": "Type of the secret." } }, "discriminator": "type", "required": [ "type" ] }, "SecureInputOutputPolicy": { "type": "object", "description": "Execution policy for an activity that supports secure input and output.", "properties": { "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." } } }, "SecureString": { "type": "object", "description": "Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.", "properties": { "value": { "type": "string", "description": "Value of secure string." } }, "required": [ "value" ], "allOf": [ { "$ref": "#/definitions/SecretBase" } ], "x-ms-discriminator-value": "SecureString" }, "SelfDependencyTumblingWindowTriggerReference": { "type": "object", "description": "Self referenced tumbling window trigger dependency.", "properties": { "offset": { "type": "string", "description": "Timespan applied to the start time of a tumbling window when evaluating dependency.", "minLength": 8, "maxLength": 15, "pattern": "-((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))" }, "size": { "type": "string", "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.", "minLength": 8, "maxLength": 15, "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))" } }, "required": [ "offset" ], "allOf": [ { "$ref": "#/definitions/DependencyReference" } ], "x-ms-discriminator-value": "SelfDependencyTumblingWindowTriggerReference" }, "SelfHostedIntegrationRuntime": { "type": "object", "description": "Self-hosted integration runtime.", "properties": { "typeProperties": { "$ref": "#/definitions/SelfHostedIntegrationRuntimeTypeProperties", "description": "When this property is not null, means this is a linked integration runtime. The property is used to access original integration runtime.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/IntegrationRuntime" } ], "x-ms-discriminator-value": "SelfHosted" }, "SelfHostedIntegrationRuntimeNode": { "type": "object", "description": "Properties of Self-hosted integration runtime node.", "properties": { "nodeName": { "type": "string", "description": "Name of the integration runtime node.", "readOnly": true }, "machineName": { "type": "string", "description": "Machine name of the integration runtime node.", "readOnly": true }, "hostServiceUri": { "type": "string", "description": "URI for the host machine of the integration runtime.", "readOnly": true }, "status": { "$ref": "#/definitions/SelfHostedIntegrationRuntimeNodeStatus", "description": "Status of the integration runtime node.", "readOnly": true }, "capabilities": { "type": "object", "description": "The integration runtime capabilities dictionary", "additionalProperties": { "type": "string" }, "readOnly": true }, "versionStatus": { "type": "string", "description": "Status of the integration runtime node version.", "readOnly": true }, "version": { "type": "string", "description": "Version of the integration runtime node.", "readOnly": true }, "registerTime": { "type": "string", "format": "date-time", "description": "The time at which the integration runtime node was registered in ISO8601 format.", "readOnly": true }, "lastConnectTime": { "type": "string", "format": "date-time", "description": "The most recent time at which the integration runtime was connected in ISO8601 format.", "readOnly": true }, "expiryTime": { "type": "string", "format": "date-time", "description": "The time at which the integration runtime will expire in ISO8601 format.", "readOnly": true }, "lastStartTime": { "type": "string", "format": "date-time", "description": "The time the node last started up.", "readOnly": true }, "lastStopTime": { "type": "string", "format": "date-time", "description": "The integration runtime node last stop time.", "readOnly": true }, "lastUpdateResult": { "$ref": "#/definitions/IntegrationRuntimeUpdateResult", "description": "The result of the last integration runtime node update.", "readOnly": true }, "lastStartUpdateTime": { "type": "string", "format": "date-time", "description": "The last time for the integration runtime node update start.", "readOnly": true }, "lastEndUpdateTime": { "type": "string", "format": "date-time", "description": "The last time for the integration runtime node update end.", "readOnly": true }, "isActiveDispatcher": { "type": "boolean", "description": "Indicates whether this node is the active dispatcher for integration runtime requests.", "readOnly": true }, "concurrentJobsLimit": { "type": "integer", "format": "int32", "description": "Maximum concurrent jobs on the integration runtime node.", "readOnly": true }, "maxConcurrentJobs": { "type": "integer", "format": "int32", "description": "The maximum concurrent jobs in this integration runtime.", "readOnly": true } }, "additionalProperties": {} }, "SelfHostedIntegrationRuntimeNodeStatus": { "type": "string", "description": "Status of the integration runtime node.", "enum": [ "NeedRegistration", "Online", "Limited", "Offline", "Upgrading", "Initializing", "InitializeFailed" ], "x-ms-enum": { "name": "SelfHostedIntegrationRuntimeNodeStatus", "modelAsString": true, "values": [ { "name": "NeedRegistration", "value": "NeedRegistration", "description": "NeedRegistration" }, { "name": "Online", "value": "Online", "description": "Online" }, { "name": "Limited", "value": "Limited", "description": "Limited" }, { "name": "Offline", "value": "Offline", "description": "Offline" }, { "name": "Upgrading", "value": "Upgrading", "description": "Upgrading" }, { "name": "Initializing", "value": "Initializing", "description": "Initializing" }, { "name": "InitializeFailed", "value": "InitializeFailed", "description": "InitializeFailed" } ] } }, "SelfHostedIntegrationRuntimeStatus": { "type": "object", "description": "Self-hosted integration runtime status.", "properties": { "typeProperties": { "$ref": "#/definitions/SelfHostedIntegrationRuntimeStatusTypeProperties", "description": "Self-hosted integration runtime status type properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/IntegrationRuntimeStatus" } ], "x-ms-discriminator-value": "SelfHosted" }, "SelfHostedIntegrationRuntimeStatusTypeProperties": { "type": "object", "description": "Self-hosted integration runtime status type properties.", "properties": { "createTime": { "type": "string", "format": "date-time", "description": "The time at which the integration runtime was created, in ISO8601 format.", "readOnly": true }, "taskQueueId": { "type": "string", "description": "The task queue id of the integration runtime.", "readOnly": true }, "internalChannelEncryption": { "$ref": "#/definitions/IntegrationRuntimeInternalChannelEncryptionMode", "description": "It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).", "readOnly": true }, "version": { "type": "string", "description": "Version of the integration runtime.", "readOnly": true }, "nodes": { "type": "array", "description": "The list of nodes for this integration runtime.", "items": { "$ref": "#/definitions/SelfHostedIntegrationRuntimeNode" }, "x-ms-identifiers": [ "nodeName" ] }, "scheduledUpdateDate": { "type": "string", "format": "date-time", "description": "The date at which the integration runtime will be scheduled to update, in ISO8601 format.", "readOnly": true }, "updateDelayOffset": { "type": "string", "description": "The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours", "readOnly": true }, "localTimeZoneOffset": { "type": "string", "description": "The local time zone offset in hours.", "readOnly": true }, "capabilities": { "type": "object", "description": "Object with additional information about integration runtime capabilities.", "additionalProperties": { "type": "string" }, "readOnly": true }, "serviceUrls": { "type": "array", "description": "The URLs for the services used in integration runtime backend service.", "items": { "type": "string" }, "readOnly": true }, "autoUpdate": { "$ref": "#/definitions/IntegrationRuntimeAutoUpdate", "description": "Whether Self-hosted integration runtime auto update has been turned on.", "readOnly": true }, "versionStatus": { "type": "string", "description": "Status of the integration runtime version.", "readOnly": true }, "links": { "type": "array", "description": "The list of linked integration runtimes that are created to share with this integration runtime.", "items": { "$ref": "#/definitions/LinkedIntegrationRuntime" }, "x-ms-identifiers": [ "name" ] }, "pushedVersion": { "type": "string", "description": "The version that the integration runtime is going to update to.", "readOnly": true }, "latestVersion": { "type": "string", "description": "The latest version on download center.", "readOnly": true }, "autoUpdateETA": { "type": "string", "format": "date-time", "description": "The estimated time when the self-hosted integration runtime will be updated.", "readOnly": true }, "selfContainedInteractiveAuthoringEnabled": { "type": "boolean", "description": "An alternative option to ensure interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.", "readOnly": true } } }, "SelfHostedIntegrationRuntimeTypeProperties": { "type": "object", "description": "The self-hosted integration runtime properties.", "properties": { "linkedInfo": { "$ref": "#/definitions/LinkedIntegrationRuntimeType", "description": "The base definition of a linked integration runtime." }, "selfContainedInteractiveAuthoringEnabled": { "type": "boolean", "description": "An alternative option to ensure interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay." } } }, "ServiceNowAuthenticationType": { "type": "string", "description": "The authentication type to use.", "enum": [ "Basic", "OAuth2" ], "x-ms-enum": { "name": "ServiceNowAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "OAuth2", "value": "OAuth2", "description": "OAuth2" } ] } }, "ServiceNowLinkedService": { "type": "object", "description": "ServiceNow server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/ServiceNowLinkedServiceTypeProperties", "description": "ServiceNow server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "ServiceNow" }, "ServiceNowLinkedServiceTypeProperties": { "type": "object", "description": "ServiceNow server linked service properties.", "properties": { "endpoint": { "description": "The endpoint of the ServiceNow server. (i.e. .service-now.com)" }, "authenticationType": { "$ref": "#/definitions/ServiceNowAuthenticationType", "description": "The authentication type to use." }, "username": { "description": "The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name for Basic and OAuth2 authentication." }, "clientId": { "description": "The client id for OAuth2 authentication." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret for OAuth2 authentication." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "endpoint", "authenticationType" ] }, "ServiceNowObjectDataset": { "type": "object", "description": "ServiceNow server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "ServiceNowObject" }, "ServiceNowSource": { "type": "object", "description": "A copy activity ServiceNow server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "ServiceNowSource" }, "ServiceNowV2AuthenticationType": { "type": "string", "description": "The authentication type to use.", "enum": [ "Basic", "OAuth2" ], "x-ms-enum": { "name": "ServiceNowV2AuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "OAuth2", "value": "OAuth2", "description": "OAuth2" } ] } }, "ServiceNowV2DatasetTypeProperties": { "type": "object", "description": "Properties specific to this dataset type.", "properties": { "tableName": { "description": "The table name. Type: string (or Expression with resultType string)." }, "valueType": { "$ref": "#/definitions/ValueType", "description": "Type of value copied from source." } } }, "ServiceNowV2LinkedService": { "type": "object", "description": "ServiceNowV2 server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/ServiceNowV2LinkedServiceTypeProperties", "description": "ServiceNowV2 server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "ServiceNowV2" }, "ServiceNowV2LinkedServiceTypeProperties": { "type": "object", "description": "ServiceNowV2 server linked service properties.", "properties": { "endpoint": { "description": "The endpoint of the ServiceNowV2 server. (i.e. .service-now.com)" }, "authenticationType": { "$ref": "#/definitions/ServiceNowV2AuthenticationType", "description": "The authentication type to use." }, "username": { "description": "The user name used to connect to the ServiceNowV2 server for Basic and OAuth2 authentication." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name for Basic and OAuth2 authentication." }, "clientId": { "description": "The client id for OAuth2 authentication." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret for OAuth2 authentication." }, "grantType": { "description": "GrantType for OAuth2 authentication. Default value is password." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "endpoint", "authenticationType" ] }, "ServiceNowV2ObjectDataset": { "type": "object", "description": "ServiceNowV2 server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/ServiceNowV2DatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "ServiceNowV2Object" }, "ServiceNowV2Source": { "type": "object", "description": "A copy activity ServiceNowV2 server source.", "properties": { "expression": { "$ref": "#/definitions/ExpressionV2", "description": "Expression to filter data from source." }, "pageSize": { "description": "Page size of the result. Type: integer (or Expression with resultType integer)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "ServiceNowV2Source" }, "ServicePrincipalCredential": { "type": "object", "description": "Service principal credential.", "properties": { "typeProperties": { "$ref": "#/definitions/ServicePrincipalCredentialTypeProperties", "description": "Service Principal credential properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Credential" } ], "x-ms-discriminator-value": "ServicePrincipal" }, "ServicePrincipalCredentialType": { "type": "string", "description": "All available servicePrincipalCredentialType values.", "enum": [ "ServicePrincipalKey", "ServicePrincipalCert" ], "x-ms-enum": { "name": "ServicePrincipalCredentialType", "modelAsString": true, "values": [ { "name": "ServicePrincipalKey", "value": "ServicePrincipalKey", "description": "ServicePrincipalKey" }, { "name": "ServicePrincipalCert", "value": "ServicePrincipalCert", "description": "ServicePrincipalCert" } ] } }, "ServicePrincipalCredentialTypeProperties": { "type": "object", "description": "Service Principal credential type properties.", "properties": { "servicePrincipalId": { "description": "The app ID of the service principal used to authenticate" }, "servicePrincipalKey": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The key of the service principal used to authenticate." }, "tenant": { "description": "The ID of the tenant to which the service principal belongs" } } }, "SetVariableActivity": { "type": "object", "description": "Set value for a Variable.", "properties": { "typeProperties": { "$ref": "#/definitions/SetVariableActivityTypeProperties", "description": "Set Variable activity properties.", "x-ms-client-flatten": true }, "policy": { "$ref": "#/definitions/SecureInputOutputPolicy", "description": "Activity policy." } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "SetVariable" }, "SetVariableActivityTypeProperties": { "type": "object", "description": "SetVariable activity properties.", "properties": { "variableName": { "type": "string", "description": "Name of the variable whose value needs to be set." }, "value": { "description": "Value to be set. Could be a static value or Expression." }, "setSystemVariable": { "type": "boolean", "description": "If set to true, it sets the pipeline run return value." } } }, "SftpAuthenticationType": { "type": "string", "description": "The authentication type to be used to connect to the FTP server.", "enum": [ "Basic", "SshPublicKey", "MultiFactor" ], "x-ms-enum": { "name": "SftpAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "SshPublicKey", "value": "SshPublicKey", "description": "SshPublicKey" }, { "name": "MultiFactor", "value": "MultiFactor", "description": "MultiFactor" } ] } }, "SftpLocation": { "type": "object", "description": "The location of SFTP dataset.", "allOf": [ { "$ref": "#/definitions/DatasetLocation" } ], "x-ms-discriminator-value": "SftpLocation" }, "SftpReadSettings": { "type": "object", "description": "Sftp read settings.", "properties": { "recursive": { "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "wildcardFolderPath": { "description": "Sftp wildcardFolderPath. Type: string (or Expression with resultType string)." }, "wildcardFileName": { "description": "Sftp wildcardFileName. Type: string (or Expression with resultType string)." }, "enablePartitionDiscovery": { "description": "Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean)." }, "partitionRootPath": { "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, "fileListPath": { "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)." }, "deleteFilesAfterCompletion": { "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." }, "modifiedDatetimeStart": { "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." }, "modifiedDatetimeEnd": { "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." }, "disableChunking": { "description": "If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/StoreReadSettings" } ], "x-ms-discriminator-value": "SftpReadSettings" }, "SftpServerLinkedService": { "type": "object", "description": "A linked service for an SSH File Transfer Protocol (SFTP) server.", "properties": { "typeProperties": { "$ref": "#/definitions/SftpServerLinkedServiceTypeProperties", "description": "Properties specific to this linked service type.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Sftp" }, "SftpServerLinkedServiceTypeProperties": { "type": "object", "description": "Properties specific to this linked service type.", "properties": { "host": { "description": "The SFTP server host name. Type: string (or Expression with resultType string)." }, "port": { "description": "The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0." }, "authenticationType": { "$ref": "#/definitions/SftpAuthenticationType", "description": "The authentication type to be used to connect to the FTP server." }, "userName": { "description": "The username used to log on to the SFTP server. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password to logon the SFTP server for Basic authentication." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "privateKeyPath": { "description": "The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string)." }, "privateKeyContent": { "$ref": "#/definitions/SecretBase", "description": "Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format." }, "passPhrase": { "$ref": "#/definitions/SecretBase", "description": "The password to decrypt the SSH private key if the SSH private key is encrypted." }, "skipHostKeyValidation": { "description": "If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean)." }, "hostKeyFingerprint": { "description": "The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string)." } }, "required": [ "host" ] }, "SftpWriteSettings": { "type": "object", "description": "Sftp write settings.", "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)." }, "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)." } }, "allOf": [ { "$ref": "#/definitions/StoreWriteSettings" } ], "x-ms-discriminator-value": "SftpWriteSettings" }, "SharePointOnlineListDatasetTypeProperties": { "type": "object", "description": "Sharepoint online list dataset properties.", "properties": { "listName": { "description": "The name of the SharePoint Online list. Type: string (or Expression with resultType string)." } } }, "SharePointOnlineListLinkedService": { "type": "object", "description": "SharePoint Online List linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/SharePointOnlineListLinkedServiceTypeProperties", "description": "SharePoint Online List linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SharePointOnlineList" }, "SharePointOnlineListLinkedServiceTypeProperties": { "type": "object", "description": "SharePoint Online List linked service properties.", "properties": { "siteUrl": { "description": "The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string)." }, "tenantId": { "description": "The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string)." }, "servicePrincipalId": { "description": "The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalEmbeddedCert": { "$ref": "#/definitions/SecretBase", "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." }, "servicePrincipalEmbeddedCertPassword": { "$ref": "#/definitions/SecretBase", "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "siteUrl", "tenantId", "servicePrincipalId" ] }, "SharePointOnlineListResourceDataset": { "type": "object", "description": "The sharepoint online list resource dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/SharePointOnlineListDatasetTypeProperties", "description": "Sharepoint online list dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SharePointOnlineListResource" }, "SharePointOnlineListSource": { "type": "object", "description": "A copy activity source for sharePoint online list source.", "properties": { "query": { "description": "The OData query to filter the data in SharePoint Online list. For example, \"$top=1\". Type: string (or Expression with resultType string)." }, "httpRequestTimeout": { "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]))." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "SharePointOnlineListSource" }, "ShopifyLinkedService": { "type": "object", "description": "Shopify Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/ShopifyLinkedServiceTypeProperties", "description": "Shopify Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Shopify" }, "ShopifyLinkedServiceTypeProperties": { "type": "object", "description": "Shopify Service linked service properties.", "properties": { "host": { "description": "The endpoint of the Shopify server. (i.e. mystore.myshopify.com)" }, "accessToken": { "$ref": "#/definitions/SecretBase", "description": "The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host" ] }, "ShopifyObjectDataset": { "type": "object", "description": "Shopify Service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "ShopifyObject" }, "ShopifySource": { "type": "object", "description": "A copy activity Shopify Service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "ShopifySource" }, "SkipErrorFile": { "type": "object", "description": "Skip error file.", "properties": { "fileMissing": { "description": "Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean)." }, "dataInconsistency": { "description": "Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean)." } } }, "SmartsheetLinkedService": { "type": "object", "description": "Linked service for Smartsheet.", "properties": { "typeProperties": { "$ref": "#/definitions/SmartsheetLinkedServiceTypeProperties", "description": "Smartsheet linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Smartsheet" }, "SmartsheetLinkedServiceTypeProperties": { "type": "object", "description": "Smartsheet linked service type properties.", "properties": { "apiToken": { "$ref": "#/definitions/SecretBase", "description": "The api token for the Smartsheet source." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "apiToken" ] }, "SnowflakeAuthenticationType": { "type": "string", "description": "The type used for authentication. Type: string.", "enum": [ "Basic", "KeyPair", "AADServicePrincipal" ], "x-ms-enum": { "name": "SnowflakeAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "KeyPair", "value": "KeyPair", "description": "KeyPair" }, { "name": "AADServicePrincipal", "value": "AADServicePrincipal", "description": "AADServicePrincipal" } ] } }, "SnowflakeDataset": { "type": "object", "description": "The snowflake dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/SnowflakeDatasetTypeProperties", "description": "Snowflake dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SnowflakeTable" }, "SnowflakeDatasetTypeProperties": { "type": "object", "description": "Snowflake dataset properties.", "properties": { "schema": { "description": "The schema name of the Snowflake database. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the Snowflake database. Type: string (or Expression with resultType string)." } } }, "SnowflakeExportCopyCommand": { "type": "object", "description": "Snowflake export command settings.", "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": {} }, "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": {} }, "storageIntegration": { "description": "The name of the snowflake storage integration to use for the copy operation. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/ExportSettings" } ], "x-ms-discriminator-value": "SnowflakeExportCopyCommand" }, "SnowflakeImportCopyCommand": { "type": "object", "description": "Snowflake import command settings.", "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": {} }, "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": {} }, "storageIntegration": { "description": "The name of the snowflake storage integration to use for the copy operation. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/ImportSettings" } ], "x-ms-discriminator-value": "SnowflakeImportCopyCommand" }, "SnowflakeLinkedService": { "type": "object", "description": "Snowflake linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/SnowflakeLinkedServiceTypeProperties", "description": "Snowflake linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Snowflake" }, "SnowflakeLinkedServiceTypeProperties": { "type": "object", "description": "Snowflake linked service properties.", "properties": { "connectionString": { "description": "The connection string of snowflake. Type: string, SecureString." }, "password": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "connectionString" ] }, "SnowflakeLinkedV2ServiceTypeProperties": { "type": "object", "description": "Snowflake linked service properties.", "properties": { "accountIdentifier": { "description": "The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure" }, "user": { "description": "The name of the Snowflake user." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The Azure key vault secret reference of password in connection string." }, "database": { "description": "The name of the Snowflake database." }, "warehouse": { "description": "The name of the Snowflake warehouse." }, "authenticationType": { "type": "string", "description": "The type used for authentication. Type: string.", "default": "Basic", "enum": [ "Basic", "KeyPair", "AADServicePrincipal" ], "x-ms-enum": { "name": "SnowflakeAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "KeyPair", "value": "KeyPair", "description": "KeyPair" }, { "name": "AADServicePrincipal", "value": "AADServicePrincipal", "description": "AADServicePrincipal" } ] } }, "clientId": { "description": "The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The Azure key vault secret reference of client secret for AADServicePrincipal authentication." }, "tenantId": { "description": "The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication." }, "scope": { "description": "The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication." }, "privateKey": { "$ref": "#/definitions/SecretBase", "description": "The Azure key vault secret reference of privateKey for KeyPair auth." }, "privateKeyPassphrase": { "$ref": "#/definitions/SecretBase", "description": "The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key." }, "role": { "description": "The default access control role to use in the Snowflake session. Type: string (or Expression with resultType string)." }, "host": { "description": "The host name of the Snowflake account. Type: string (or Expression with resultType string)." }, "schema": { "description": "Schema name for connection. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "useUtcTimestamps": { "description": "Indicates whether to use UTC timezone for timestamp data types. Type: boolean." } }, "required": [ "accountIdentifier", "database", "warehouse" ] }, "SnowflakeSink": { "type": "object", "description": "A copy activity snowflake sink.", "properties": { "preCopyScript": { "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." }, "importSettings": { "$ref": "#/definitions/SnowflakeImportCopyCommand", "description": "Snowflake import settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SnowflakeSink" }, "SnowflakeSource": { "type": "object", "description": "A copy activity snowflake source.", "properties": { "query": { "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." }, "exportSettings": { "$ref": "#/definitions/SnowflakeExportCopyCommand", "description": "Snowflake export settings." } }, "required": [ "exportSettings" ], "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "SnowflakeSource" }, "SnowflakeV2Dataset": { "type": "object", "description": "The snowflake dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/SnowflakeDatasetTypeProperties", "description": "Snowflake dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SnowflakeV2Table" }, "SnowflakeV2LinkedService": { "type": "object", "description": "Snowflake linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/SnowflakeLinkedV2ServiceTypeProperties", "description": "Snowflake linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SnowflakeV2" }, "SnowflakeV2Sink": { "type": "object", "description": "A copy activity snowflake sink.", "properties": { "preCopyScript": { "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." }, "importSettings": { "$ref": "#/definitions/SnowflakeImportCopyCommand", "description": "Snowflake import settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SnowflakeV2Sink" }, "SnowflakeV2Source": { "type": "object", "description": "A copy activity snowflake source.", "properties": { "query": { "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." }, "exportSettings": { "$ref": "#/definitions/SnowflakeExportCopyCommand", "description": "Snowflake export settings." } }, "required": [ "exportSettings" ], "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "SnowflakeV2Source" }, "SparkAuthenticationType": { "type": "string", "description": "The authentication method used to access the Spark server.", "enum": [ "Anonymous", "Username", "UsernameAndPassword", "WindowsAzureHDInsightService" ], "x-ms-enum": { "name": "SparkAuthenticationType", "modelAsString": true, "values": [ { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "Username", "value": "Username", "description": "Username" }, { "name": "UsernameAndPassword", "value": "UsernameAndPassword", "description": "UsernameAndPassword" }, { "name": "WindowsAzureHDInsightService", "value": "WindowsAzureHDInsightService", "description": "WindowsAzureHDInsightService" } ] } }, "SparkConfigurationParametrizationReference": { "type": "object", "description": "Spark configuration reference.", "properties": { "type": { "$ref": "#/definitions/SparkConfigurationReferenceType", "description": "Spark configuration reference type." }, "referenceName": { "description": "Reference spark configuration name. Type: string (or Expression with resultType string)." } }, "required": [ "type", "referenceName" ] }, "SparkConfigurationReferenceType": { "type": "string", "description": "Spark configuration reference type.", "enum": [ "SparkConfigurationReference" ], "x-ms-enum": { "name": "SparkConfigurationReferenceType", "modelAsString": true, "values": [ { "name": "SparkConfigurationReference", "value": "SparkConfigurationReference", "description": "SparkConfigurationReference" } ] } }, "SparkDatasetTypeProperties": { "type": "object", "description": "Spark Properties", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The table name of the Spark. Type: string (or Expression with resultType string)." }, "schema": { "description": "The schema name of the Spark. Type: string (or Expression with resultType string)." } } }, "SparkJobReferenceType": { "type": "string", "description": "Synapse spark job reference type.", "enum": [ "SparkJobDefinitionReference" ], "x-ms-enum": { "name": "SparkJobReferenceType", "modelAsString": true, "values": [ { "name": "SparkJobDefinitionReference", "value": "SparkJobDefinitionReference", "description": "SparkJobDefinitionReference" } ] } }, "SparkLinkedService": { "type": "object", "description": "Spark Server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/SparkLinkedServiceTypeProperties", "description": "Spark Server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Spark" }, "SparkLinkedServiceTypeProperties": { "type": "object", "description": "Spark Server linked service properties.", "properties": { "host": { "description": "IP address or host name of the Spark server" }, "port": { "description": "The TCP port that the Spark server uses to listen for client connections." }, "serverType": { "$ref": "#/definitions/SparkServerType", "description": "The type of Spark server." }, "thriftTransportProtocol": { "$ref": "#/definitions/SparkThriftTransportProtocol", "description": "The transport protocol to use in the Thrift layer." }, "authenticationType": { "$ref": "#/definitions/SparkAuthenticationType", "description": "The authentication method used to access the Spark server." }, "username": { "description": "The user name that you use to access Spark Server." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password corresponding to the user name that you provided in the Username field" }, "httpPath": { "description": "The partial URL corresponding to the Spark server." }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false." }, "enableServerCertificateValidation": { "description": "Specifies whether the connections to the server will validate server certificate, the default value is True. Only used for Version 2.0" }, "trustedCertPath": { "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR." }, "useSystemTrustStore": { "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false." }, "allowHostNameCNMismatch": { "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false." }, "allowSelfSignedServerCert": { "description": "Specifies whether to allow self-signed certificates from the server. The default value is false." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "host", "port", "authenticationType" ] }, "SparkObjectDataset": { "type": "object", "description": "Spark Server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/SparkDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SparkObject" }, "SparkServerType": { "type": "string", "description": "The type of Spark server.", "enum": [ "SharkServer", "SharkServer2", "SparkThriftServer" ], "x-ms-enum": { "name": "SparkServerType", "modelAsString": true, "values": [ { "name": "SharkServer", "value": "SharkServer", "description": "SharkServer" }, { "name": "SharkServer2", "value": "SharkServer2", "description": "SharkServer2" }, { "name": "SparkThriftServer", "value": "SparkThriftServer", "description": "SparkThriftServer" } ] } }, "SparkSource": { "type": "object", "description": "A copy activity Spark Server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SparkSource" }, "SparkThriftTransportProtocol": { "type": "string", "description": "The transport protocol to use in the Thrift layer.", "enum": [ "Binary", "SASL", "HTTP " ], "x-ms-enum": { "name": "SparkThriftTransportProtocol", "modelAsString": true, "values": [ { "name": "Binary", "value": "Binary", "description": "Binary" }, { "name": "SASL", "value": "SASL", "description": "SASL" }, { "name": "HTTP ", "value": "HTTP ", "description": "HTTP" } ] } }, "SqlAlwaysEncryptedAkvAuthType": { "type": "string", "description": "Sql always encrypted AKV authentication type. Type: string.", "enum": [ "ServicePrincipal", "ManagedIdentity", "UserAssignedManagedIdentity" ], "x-ms-enum": { "name": "SqlAlwaysEncryptedAkvAuthType", "modelAsString": true, "values": [ { "name": "ServicePrincipal", "value": "ServicePrincipal", "description": "ServicePrincipal" }, { "name": "ManagedIdentity", "value": "ManagedIdentity", "description": "ManagedIdentity" }, { "name": "UserAssignedManagedIdentity", "value": "UserAssignedManagedIdentity", "description": "UserAssignedManagedIdentity" } ] } }, "SqlAlwaysEncryptedProperties": { "type": "object", "description": "Sql always encrypted properties.", "properties": { "alwaysEncryptedAkvAuthType": { "$ref": "#/definitions/SqlAlwaysEncryptedAkvAuthType", "description": "Sql always encrypted AKV authentication type. Type: string." }, "servicePrincipalId": { "description": "The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure Key Vault." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "required": [ "alwaysEncryptedAkvAuthType" ] }, "SqlDWSink": { "type": "object", "description": "A copy activity SQL Data Warehouse sink.", "properties": { "preCopyScript": { "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." }, "allowPolyBase": { "description": "Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean)." }, "polyBaseSettings": { "$ref": "#/definitions/PolybaseSettings", "description": "Specifies PolyBase-related settings when allowPolyBase is true." }, "allowCopyCommand": { "description": "Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean)." }, "copyCommandSettings": { "$ref": "#/definitions/DWCopyCommandSettings", "description": "Specifies Copy Command related settings when allowCopyCommand is true." }, "tableOption": { "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." }, "sqlWriterUseTableLock": { "description": "Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean)." }, "writeBehavior": { "description": "Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum)" }, "upsertSettings": { "$ref": "#/definitions/SqlDWUpsertSettings", "description": "SQL DW upsert settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SqlDWSink" }, "SqlDWSource": { "type": "object", "description": "A copy activity SQL Data Warehouse source.", "properties": { "sqlReaderQuery": { "description": "SQL Data Warehouse reader query. Type: string (or Expression with resultType string)." }, "sqlReaderStoredProcedureName": { "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": { "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: 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)." }, "partitionOption": { "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string)." }, "partitionSettings": { "$ref": "#/definitions/SqlPartitionSettings", "description": "The settings that will be leveraged for Sql source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SqlDWSource" }, "SqlDWUpsertSettings": { "type": "object", "description": "Sql DW upsert option settings", "properties": { "interimSchemaName": { "description": "Schema name for interim table. Type: string (or Expression with resultType string)." }, "keys": { "description": "Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings)." } } }, "SqlDWWriteBehaviorEnum": { "type": "string", "description": "Specify the write behavior when copying data into sql dw.", "enum": [ "Insert", "Upsert" ], "x-ms-enum": { "name": "SqlDWWriteBehaviorEnum", "modelAsString": true, "values": [ { "name": "Insert", "value": "Insert", "description": "Insert" }, { "name": "Upsert", "value": "Upsert", "description": "Upsert" } ] } }, "SqlMISink": { "type": "object", "description": "A copy activity Azure SQL Managed Instance sink.", "properties": { "sqlWriterStoredProcedureName": { "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." }, "sqlWriterTableType": { "description": "SQL writer table type. Type: string (or Expression with resultType string)." }, "preCopyScript": { "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." }, "storedProcedureParameters": { "description": "SQL stored procedure parameters." }, "storedProcedureTableTypeParameterName": { "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." }, "tableOption": { "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." }, "sqlWriterUseTableLock": { "description": "Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean)." }, "writeBehavior": { "description": "White behavior when copying data into azure SQL MI. Type: string (or Expression with resultType string)" }, "upsertSettings": { "$ref": "#/definitions/SqlUpsertSettings", "description": "SQL upsert settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SqlMISink" }, "SqlMISource": { "type": "object", "description": "A copy activity Azure SQL Managed Instance source.", "properties": { "sqlReaderQuery": { "description": "SQL reader query. Type: string (or Expression with resultType string)." }, "sqlReaderStoredProcedureName": { "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\"}}\"." }, "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)." }, "produceAdditionalTypes": { "description": "Which additional types to produce." }, "partitionOption": { "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string)." }, "partitionSettings": { "$ref": "#/definitions/SqlPartitionSettings", "description": "The settings that will be leveraged for Sql source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SqlMISource" }, "SqlPartitionOption": { "type": "string", "description": "The partition mechanism that will be used for Sql read in parallel.", "enum": [ "None", "PhysicalPartitionsOfTable", "DynamicRange" ], "x-ms-enum": { "name": "SqlPartitionOption", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "PhysicalPartitionsOfTable", "value": "PhysicalPartitionsOfTable", "description": "PhysicalPartitionsOfTable" }, { "name": "DynamicRange", "value": "DynamicRange", "description": "DynamicRange" } ] } }, "SqlPartitionSettings": { "type": "object", "description": "The settings that will be leveraged for Sql source partitioning.", "properties": { "partitionColumnName": { "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": { "description": "The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string)." }, "partitionLowerBound": { "description": "The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string)." } } }, "SqlServerAuthenticationType": { "type": "string", "description": "The type used for authentication. Type: string.", "enum": [ "SQL", "Windows", "UserAssignedManagedIdentity" ], "x-ms-enum": { "name": "SqlServerAuthenticationType", "modelAsString": true, "values": [ { "name": "SQL", "value": "SQL", "description": "SQL" }, { "name": "Windows", "value": "Windows", "description": "Windows" }, { "name": "UserAssignedManagedIdentity", "value": "UserAssignedManagedIdentity", "description": "UserAssignedManagedIdentity" } ] } }, "SqlServerBaseLinkedServiceTypeProperties": { "type": "object", "description": "Sql Server family connector common linked service properties.", "properties": { "server": { "description": "The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string)." }, "database": { "description": "The name of the database, used by recommended version. Type: string (or Expression with resultType string)." }, "encrypt": { "description": "Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string)." }, "trustServerCertificate": { "description": "Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean)." }, "hostNameInCertificate": { "description": "The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string)." }, "applicationIntent": { "description": "The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string)." }, "connectTimeout": { "description": "The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer)." }, "connectRetryCount": { "description": "The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer)." }, "connectRetryInterval": { "description": "The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer)." }, "loadBalanceTimeout": { "description": "The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer)." }, "commandTimeout": { "description": "The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer)." }, "integratedSecurity": { "description": "Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean)." }, "failoverPartner": { "description": "The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string)." }, "maxPoolSize": { "description": "The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer)." }, "minPoolSize": { "description": "The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer)." }, "multipleActiveResultSets": { "description": "When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean)." }, "multiSubnetFailover": { "description": "If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean)." }, "packetSize": { "description": "The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer)." }, "pooling": { "description": "Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean)." } } }, "SqlServerLinkedService": { "type": "object", "description": "SQL Server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/SqlServerLinkedServiceTypeProperties", "description": "SQL Server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "SqlServer" }, "SqlServerLinkedServiceTypeProperties": { "type": "object", "description": "SQL Server linked service properties.", "properties": { "connectionString": { "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "authenticationType": { "$ref": "#/definitions/SqlServerAuthenticationType", "description": "The type used for authentication. Type: string." }, "userName": { "description": "The on-premises Windows authentication user name. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The on-premises Windows authentication password." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "alwaysEncryptedSettings": { "$ref": "#/definitions/SqlAlwaysEncryptedProperties", "description": "Sql always encrypted properties." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "allOf": [ { "$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties" } ] }, "SqlServerSink": { "type": "object", "description": "A copy activity SQL server sink.", "properties": { "sqlWriterStoredProcedureName": { "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." }, "sqlWriterTableType": { "description": "SQL writer table type. Type: string (or Expression with resultType string)." }, "preCopyScript": { "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." }, "storedProcedureParameters": { "description": "SQL stored procedure parameters." }, "storedProcedureTableTypeParameterName": { "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." }, "tableOption": { "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." }, "sqlWriterUseTableLock": { "description": "Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean)." }, "writeBehavior": { "description": "Write behavior when copying data into sql server. Type: string (or Expression with resultType string)." }, "upsertSettings": { "$ref": "#/definitions/SqlUpsertSettings", "description": "SQL upsert settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SqlServerSink" }, "SqlServerSource": { "type": "object", "description": "A copy activity SQL server source.", "properties": { "sqlReaderQuery": { "description": "SQL reader query. Type: string (or Expression with resultType string)." }, "sqlReaderStoredProcedureName": { "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\"}}\"." }, "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)." }, "produceAdditionalTypes": { "description": "Which additional types to produce." }, "partitionOption": { "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string)." }, "partitionSettings": { "$ref": "#/definitions/SqlPartitionSettings", "description": "The settings that will be leveraged for Sql source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SqlServerSource" }, "SqlServerStoredProcedureActivity": { "type": "object", "description": "SQL stored procedure activity type.", "properties": { "typeProperties": { "$ref": "#/definitions/SqlServerStoredProcedureActivityTypeProperties", "description": "SQL stored procedure activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "SqlServerStoredProcedure" }, "SqlServerStoredProcedureActivityTypeProperties": { "type": "object", "description": "SQL stored procedure activity properties.", "properties": { "storedProcedureName": { "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\"}}\"." } }, "required": [ "storedProcedureName" ] }, "SqlServerTableDataset": { "type": "object", "description": "The on-premises SQL Server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/SqlServerTableDatasetTypeProperties", "description": "On-premises SQL Server dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SqlServerTable" }, "SqlServerTableDatasetTypeProperties": { "type": "object", "description": "On-premises SQL Server dataset properties.", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "schema": { "description": "The schema name of the SQL Server dataset. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the SQL Server dataset. Type: string (or Expression with resultType string)." } } }, "SqlSink": { "type": "object", "description": "A copy activity SQL sink.", "properties": { "sqlWriterStoredProcedureName": { "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." }, "sqlWriterTableType": { "description": "SQL writer table type. Type: string (or Expression with resultType string)." }, "preCopyScript": { "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." }, "storedProcedureParameters": { "description": "SQL stored procedure parameters." }, "storedProcedureTableTypeParameterName": { "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." }, "tableOption": { "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." }, "sqlWriterUseTableLock": { "description": "Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean)." }, "writeBehavior": { "description": "Write behavior when copying data into sql. Type: string (or Expression with resultType string)." }, "upsertSettings": { "$ref": "#/definitions/SqlUpsertSettings", "description": "SQL upsert settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "SqlSink" }, "SqlSource": { "type": "object", "description": "A copy activity SQL source.", "properties": { "sqlReaderQuery": { "description": "SQL reader query. Type: string (or Expression with resultType string)." }, "sqlReaderStoredProcedureName": { "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\"}}\"." }, "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)." }, "partitionOption": { "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string)." }, "partitionSettings": { "$ref": "#/definitions/SqlPartitionSettings", "description": "The settings that will be leveraged for Sql source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SqlSource" }, "SqlUpsertSettings": { "type": "object", "description": "Sql upsert option settings", "properties": { "useTempDB": { "description": "Specifies whether to use temp db for upsert interim table. Type: boolean (or Expression with resultType boolean)." }, "interimSchemaName": { "description": "Schema name for interim table. Type: string (or Expression with resultType string)." }, "keys": { "description": "Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings)." } } }, "SqlWriteBehaviorEnum": { "type": "string", "description": "Specify the write behavior when copying data into sql.", "enum": [ "Insert", "Upsert", "StoredProcedure" ], "x-ms-enum": { "name": "SqlWriteBehaviorEnum", "modelAsString": true, "values": [ { "name": "Insert", "value": "Insert", "description": "Insert" }, { "name": "Upsert", "value": "Upsert", "description": "Upsert" }, { "name": "StoredProcedure", "value": "StoredProcedure", "description": "StoredProcedure" } ] } }, "SquareLinkedService": { "type": "object", "description": "Square Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/SquareLinkedServiceTypeProperties", "description": "Square Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Square" }, "SquareLinkedServiceTypeProperties": { "type": "object", "description": "Square Service linked service properties.", "properties": { "connectionProperties": { "description": "Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object." }, "host": { "description": "The URL of the Square instance. (i.e. mystore.mysquare.com)" }, "clientId": { "description": "The client ID associated with your Square application." }, "clientSecret": { "$ref": "#/definitions/SecretBase", "description": "The client secret associated with your Square application." }, "redirectUri": { "description": "The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "SquareObjectDataset": { "type": "object", "description": "Square Service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SquareObject" }, "SquareSource": { "type": "object", "description": "A copy activity Square Service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SquareSource" }, "SsisEnvironment": { "type": "object", "description": "Ssis environment.", "properties": { "folderId": { "type": "integer", "format": "int64", "description": "Folder id which contains environment." }, "variables": { "type": "array", "description": "Variable in environment", "items": { "$ref": "#/definitions/SsisVariable" } } }, "allOf": [ { "$ref": "#/definitions/SsisObjectMetadata" } ], "x-ms-discriminator-value": "Environment" }, "SsisEnvironmentReference": { "type": "object", "description": "Ssis environment reference.", "properties": { "id": { "type": "integer", "format": "int64", "description": "Environment reference id." }, "environmentFolderName": { "type": "string", "description": "Environment folder name." }, "environmentName": { "type": "string", "description": "Environment name." }, "referenceType": { "type": "string", "description": "Reference type" } } }, "SsisFolder": { "type": "object", "description": "Ssis folder.", "allOf": [ { "$ref": "#/definitions/SsisObjectMetadata" } ], "x-ms-discriminator-value": "Folder" }, "SsisLogLocationType": { "type": "string", "description": "The type of SSIS log location.", "enum": [ "File" ], "x-ms-enum": { "name": "SsisLogLocationType", "modelAsString": true, "values": [ { "name": "File", "value": "File", "description": "File" } ] } }, "SsisObjectMetadata": { "type": "object", "description": "SSIS object metadata.", "properties": { "type": { "$ref": "#/definitions/SsisObjectMetadataType", "description": "Type of metadata." }, "id": { "type": "integer", "format": "int64", "description": "Metadata id." }, "name": { "type": "string", "description": "Metadata name." }, "description": { "type": "string", "description": "Metadata description." } }, "discriminator": "type", "required": [ "type" ] }, "SsisObjectMetadataListResponse": { "type": "object", "description": "A list of SSIS object metadata.", "properties": { "value": { "type": "array", "description": "The SsisObjectMetadata items on this page", "items": { "$ref": "#/definitions/SsisObjectMetadata" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SsisObjectMetadataStatusResponse": { "type": "object", "description": "The status of the operation.", "properties": { "status": { "type": "string", "description": "The status of the operation." }, "name": { "type": "string", "description": "The operation name." }, "properties": { "type": "string", "description": "The operation properties." }, "error": { "type": "string", "description": "The operation error message." } } }, "SsisObjectMetadataType": { "type": "string", "description": "The type of SSIS object metadata.", "enum": [ "Folder", "Project", "Package", "Environment" ], "x-ms-enum": { "name": "SsisObjectMetadataType", "modelAsString": true, "values": [ { "name": "Folder", "value": "Folder", "description": "Folder" }, { "name": "Project", "value": "Project", "description": "Project" }, { "name": "Package", "value": "Package", "description": "Package" }, { "name": "Environment", "value": "Environment", "description": "Environment" } ] } }, "SsisPackage": { "type": "object", "description": "Ssis Package.", "properties": { "folderId": { "type": "integer", "format": "int64", "description": "Folder id which contains package." }, "projectVersion": { "type": "integer", "format": "int64", "description": "Project version which contains package." }, "projectId": { "type": "integer", "format": "int64", "description": "Project id which contains package." }, "parameters": { "type": "array", "description": "Parameters in package", "items": { "$ref": "#/definitions/SsisParameter" } } }, "allOf": [ { "$ref": "#/definitions/SsisObjectMetadata" } ], "x-ms-discriminator-value": "Package" }, "SsisPackageLocationType": { "type": "string", "description": "The type of SSIS package location.", "enum": [ "SSISDB", "File", "InlinePackage", "PackageStore" ], "x-ms-enum": { "name": "SsisPackageLocationType", "modelAsString": true, "values": [ { "name": "SSISDB", "value": "SSISDB", "description": "SSISDB" }, { "name": "File", "value": "File", "description": "File" }, { "name": "InlinePackage", "value": "InlinePackage", "description": "InlinePackage" }, { "name": "PackageStore", "value": "PackageStore", "description": "PackageStore" } ] } }, "SsisParameter": { "type": "object", "description": "Ssis parameter.", "properties": { "id": { "type": "integer", "format": "int64", "description": "Parameter id." }, "name": { "type": "string", "description": "Parameter name." }, "description": { "type": "string", "description": "Parameter description." }, "dataType": { "type": "string", "description": "Parameter type." }, "required": { "type": "boolean", "description": "Whether parameter is required." }, "sensitive": { "type": "boolean", "description": "Whether parameter is sensitive." }, "designDefaultValue": { "type": "string", "description": "Design default value of parameter." }, "defaultValue": { "type": "string", "description": "Default value of parameter." }, "sensitiveDefaultValue": { "type": "string", "description": "Default sensitive value of parameter." }, "valueType": { "type": "string", "description": "Parameter value type." }, "valueSet": { "type": "boolean", "description": "Parameter value set." }, "variable": { "type": "string", "description": "Parameter reference variable." } } }, "SsisProject": { "type": "object", "description": "Ssis project.", "properties": { "folderId": { "type": "integer", "format": "int64", "description": "Folder id which contains project." }, "version": { "type": "integer", "format": "int64", "description": "Project version." }, "environmentRefs": { "type": "array", "description": "Environment reference in project", "items": { "$ref": "#/definitions/SsisEnvironmentReference" } }, "parameters": { "type": "array", "description": "Parameters in project", "items": { "$ref": "#/definitions/SsisParameter" } } }, "allOf": [ { "$ref": "#/definitions/SsisObjectMetadata" } ], "x-ms-discriminator-value": "Project" }, "SsisVariable": { "type": "object", "description": "Ssis variable.", "properties": { "id": { "type": "integer", "format": "int64", "description": "Variable id." }, "name": { "type": "string", "description": "Variable name." }, "description": { "type": "string", "description": "Variable description." }, "dataType": { "type": "string", "description": "Variable type." }, "sensitive": { "type": "boolean", "description": "Whether variable is sensitive." }, "value": { "type": "string", "description": "Variable value." }, "sensitiveValue": { "type": "string", "description": "Variable sensitive value." } } }, "StagingSettings": { "type": "object", "description": "Staging settings.", "properties": { "linkedServiceName": { "$ref": "#/definitions/LinkedServiceReference", "description": "Staging linked service reference." }, "path": { "description": "The path to storage for storing the interim data. Type: string (or Expression with resultType string)." }, "enableCompression": { "description": "Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." } }, "required": [ "linkedServiceName" ], "additionalProperties": {} }, "StoreReadSettings": { "type": "object", "description": "Connector read setting.", "properties": { "type": { "type": "string", "description": "The read setting type." }, "maxConcurrentConnections": { "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." }, "disableMetricsCollection": { "description": "If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean)." } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "StoreWriteSettings": { "type": "object", "description": "Connector write settings.", "properties": { "type": { "type": "string", "description": "The write setting type." }, "maxConcurrentConnections": { "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." }, "disableMetricsCollection": { "description": "If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean)." }, "copyBehavior": { "description": "The type of copy behavior for copy sink." }, "metadata": { "type": "array", "description": "Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).", "items": { "$ref": "#/definitions/MetadataItem" }, "x-ms-identifiers": [ "name" ] } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "StoredProcedureParameter": { "type": "object", "description": "SQL stored procedure parameter.", "properties": { "value": { "description": "Stored procedure parameter value. Type: string (or Expression with resultType string)." }, "type": { "$ref": "#/definitions/StoredProcedureParameterType", "description": "Stored procedure parameter type." } } }, "StoredProcedureParameterType": { "type": "string", "description": "Stored procedure parameter type.", "enum": [ "String", "Int", "Int64", "Decimal", "Guid", "Boolean", "Date" ], "x-ms-enum": { "name": "StoredProcedureParameterType", "modelAsString": true, "values": [ { "name": "String", "value": "String", "description": "String" }, { "name": "Int", "value": "Int", "description": "Int" }, { "name": "Int64", "value": "Int64", "description": "Int64" }, { "name": "Decimal", "value": "Decimal", "description": "Decimal" }, { "name": "Guid", "value": "Guid", "description": "Guid" }, { "name": "Boolean", "value": "Boolean", "description": "Boolean" }, { "name": "Date", "value": "Date", "description": "Date" } ] } }, "SubResource": { "type": "object", "description": "Azure Data Factory nested resource, which belongs to a factory.", "properties": { "id": { "type": "string", "description": "The resource identifier.", "readOnly": true }, "name": { "type": "string", "description": "The resource name.", "readOnly": true }, "type": { "type": "string", "description": "The resource type.", "readOnly": true }, "etag": { "type": "string", "description": "Etag identifies change in the resource.", "readOnly": true } } }, "SubResourceDebugResource": { "type": "object", "description": "Azure Data Factory nested debug resource.", "properties": { "name": { "type": "string", "description": "The resource name." } } }, "SwitchActivity": { "type": "object", "description": "This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.", "properties": { "typeProperties": { "$ref": "#/definitions/SwitchActivityTypeProperties", "description": "Switch activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "Switch" }, "SwitchActivityTypeProperties": { "type": "object", "description": "Switch activity properties.", "properties": { "on": { "$ref": "#/definitions/Expression", "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." }, "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": { "$ref": "#/definitions/SwitchCase" }, "x-ms-identifiers": [ "value" ] }, "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" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "on" ] }, "SwitchCase": { "type": "object", "description": "Switch cases with have a value and corresponding activities.", "properties": { "value": { "type": "string", "description": "Expected value that satisfies the expression result of the 'on' property." }, "activities": { "type": "array", "description": "List of activities to execute for satisfied case condition.", "items": { "$ref": "#/definitions/Activity" }, "x-ms-identifiers": [ "name" ] } } }, "SybaseAuthenticationType": { "type": "string", "description": "AuthenticationType to be used for connection.", "enum": [ "Basic", "Windows" ], "x-ms-enum": { "name": "SybaseAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Windows", "value": "Windows", "description": "Windows" } ] } }, "SybaseLinkedService": { "type": "object", "description": "Linked service for Sybase data source.", "properties": { "typeProperties": { "$ref": "#/definitions/SybaseLinkedServiceTypeProperties", "description": "Sybase linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Sybase" }, "SybaseLinkedServiceTypeProperties": { "type": "object", "description": "Sybase linked service properties.", "properties": { "server": { "description": "Server name for connection. Type: string (or Expression with resultType string)." }, "database": { "description": "Database name for connection. Type: string (or Expression with resultType string)." }, "schema": { "description": "Schema name for connection. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/SybaseAuthenticationType", "description": "AuthenticationType to be used for connection." }, "username": { "description": "Username for authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for authentication." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "server", "database" ] }, "SybaseSource": { "type": "object", "description": "A copy activity source for Sybase databases.", "properties": { "query": { "description": "Database query. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "SybaseSource" }, "SybaseTableDataset": { "type": "object", "description": "The Sybase table dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/SybaseTableDatasetTypeProperties", "description": "Sybase table dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "SybaseTable" }, "SybaseTableDatasetTypeProperties": { "type": "object", "description": "Sybase table dataset properties.", "properties": { "tableName": { "description": "The Sybase table name. Type: string (or Expression with resultType string)." } } }, "SynapseNotebookActivity": { "type": "object", "description": "Execute Synapse notebook activity.", "properties": { "typeProperties": { "$ref": "#/definitions/SynapseNotebookActivityTypeProperties", "description": "Execute Synapse notebook activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "SynapseNotebook" }, "SynapseNotebookActivityTypeProperties": { "type": "object", "description": "Execute Synapse notebook activity properties.", "properties": { "notebook": { "$ref": "#/definitions/SynapseNotebookReference", "description": "Synapse notebook reference." }, "sparkPool": { "$ref": "#/definitions/BigDataPoolParametrizationReference", "description": "The name of the big data pool which will be used to execute the notebook." }, "parameters": { "type": "object", "description": "Notebook parameters.", "additionalProperties": { "$ref": "#/definitions/NotebookParameter" } }, "executorSize": { "description": "Number of core and memory to be used for executors allocated in the specified Spark pool for the session, which will be used for overriding 'executorCores' and 'executorMemory' of the notebook you provide. Type: string (or Expression with resultType string)." }, "conf": { "description": "Spark configuration properties, which will override the 'conf' of the notebook you provide." }, "driverSize": { "description": "Number of core and memory to be used for driver allocated in the specified Spark pool for the session, which will be used for overriding 'driverCores' and 'driverMemory' of the notebook you provide. Type: string (or Expression with resultType string)." }, "numExecutors": { "description": "Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide. Type: integer (or Expression with resultType integer)." }, "configurationType": { "$ref": "#/definitions/ConfigurationType", "description": "The type of the spark config." }, "targetSparkConfiguration": { "$ref": "#/definitions/SparkConfigurationParametrizationReference", "description": "The spark configuration of the spark job." }, "sparkConfig": { "type": "object", "description": "Spark configuration property.", "additionalProperties": {} } }, "required": [ "notebook" ] }, "SynapseNotebookReference": { "type": "object", "description": "Synapse notebook reference type.", "properties": { "type": { "$ref": "#/definitions/NotebookReferenceType", "description": "Synapse notebook reference type." }, "referenceName": { "description": "Reference notebook name. Type: string (or Expression with resultType string)." } }, "required": [ "type", "referenceName" ] }, "SynapseSparkJobActivityTypeProperties": { "type": "object", "description": "Execute spark job activity properties.", "properties": { "sparkJob": { "$ref": "#/definitions/SynapseSparkJobReference", "description": "Synapse spark job reference." }, "args": { "type": "array", "description": "User specified arguments to SynapseSparkJobDefinitionActivity.", "items": {}, "x-ms-client-name": "arguments" }, "file": { "description": "The main file used for the job, which will override the 'file' of the spark job definition you provide. Type: string (or Expression with resultType string)." }, "scanFolder": { "description": "Scanning subfolders from the root folder of the main definition file, these files will be added as reference files. The folders named 'jars', 'pyFiles', 'files' or 'archives' will be scanned, and the folders name are case sensitive. Type: boolean (or Expression with resultType boolean)." }, "className": { "description": "The fully-qualified identifier or the main class that is in the main definition file, which will override the 'className' of the spark job definition you provide. Type: string (or Expression with resultType string)." }, "files": { "type": "array", "description": "(Deprecated. Please use pythonCodeReference and filesV2) Additional files used for reference in the main definition file, which will override the 'files' of the spark job definition you provide.", "items": {} }, "pythonCodeReference": { "type": "array", "description": "Additional python code files used for reference in the main definition file, which will override the 'pyFiles' of the spark job definition you provide.", "items": {} }, "filesV2": { "type": "array", "description": "Additional files used for reference in the main definition file, which will override the 'jars' and 'files' of the spark job definition you provide.", "items": {} }, "targetBigDataPool": { "$ref": "#/definitions/BigDataPoolParametrizationReference", "description": "The name of the big data pool which will be used to execute the spark batch job, which will override the 'targetBigDataPool' of the spark job definition you provide." }, "executorSize": { "description": "Number of core and memory to be used for executors allocated in the specified Spark pool for the job, which will be used for overriding 'executorCores' and 'executorMemory' of the spark job definition you provide. Type: string (or Expression with resultType string)." }, "conf": { "description": "Spark configuration properties, which will override the 'conf' of the spark job definition you provide." }, "driverSize": { "description": "Number of core and memory to be used for driver allocated in the specified Spark pool for the job, which will be used for overriding 'driverCores' and 'driverMemory' of the spark job definition you provide. Type: string (or Expression with resultType string)." }, "numExecutors": { "description": "Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide. Type: integer (or Expression with resultType integer)." }, "configurationType": { "$ref": "#/definitions/ConfigurationType", "description": "The type of the spark config." }, "targetSparkConfiguration": { "$ref": "#/definitions/SparkConfigurationParametrizationReference", "description": "The spark configuration of the spark job." }, "sparkConfig": { "type": "object", "description": "Spark configuration property.", "additionalProperties": {} } }, "required": [ "sparkJob" ] }, "SynapseSparkJobDefinitionActivity": { "type": "object", "description": "Execute spark job activity.", "properties": { "typeProperties": { "$ref": "#/definitions/SynapseSparkJobActivityTypeProperties", "description": "Execute spark job activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "SparkJob" }, "SynapseSparkJobReference": { "type": "object", "description": "Synapse spark job reference type.", "properties": { "type": { "$ref": "#/definitions/SparkJobReferenceType", "description": "Synapse spark job reference type." }, "referenceName": { "description": "Reference spark job name. Expression with resultType string." } }, "required": [ "type", "referenceName" ] }, "TabularSource": { "type": "object", "description": "Copy activity sources of tabular type.", "properties": { "queryTimeout": { "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": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "TabularSource" }, "TabularTranslator": { "type": "object", "description": "A copy activity tabular translator.", "properties": { "columnMappings": { "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": { "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": { "description": "The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object)." }, "mapComplexValuesToString": { "description": "Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean)." }, "mappings": { "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)." }, "typeConversion": { "description": "Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean)." }, "typeConversionSettings": { "$ref": "#/definitions/TypeConversionSettings", "description": "Type conversion settings" } }, "allOf": [ { "$ref": "#/definitions/CopyTranslator" } ], "x-ms-discriminator-value": "TabularTranslator" }, "TarGZipReadSettings": { "type": "object", "description": "The TarGZip compression read settings.", "properties": { "preserveCompressionFileNameAsFolder": { "description": "Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/CompressionReadSettings" } ], "x-ms-discriminator-value": "TarGZipReadSettings" }, "TarReadSettings": { "type": "object", "description": "The Tar compression read settings.", "properties": { "preserveCompressionFileNameAsFolder": { "description": "Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/CompressionReadSettings" } ], "x-ms-discriminator-value": "TarReadSettings" }, "TeamDeskAuthenticationType": { "type": "string", "description": "The authentication type to use.", "enum": [ "Basic", "Token" ], "x-ms-enum": { "name": "TeamDeskAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Token", "value": "Token", "description": "Token" } ] } }, "TeamDeskLinkedService": { "type": "object", "description": "Linked service for TeamDesk.", "properties": { "typeProperties": { "$ref": "#/definitions/TeamDeskLinkedServiceTypeProperties", "description": "TeamDesk linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "TeamDesk" }, "TeamDeskLinkedServiceTypeProperties": { "type": "object", "description": "TeamDesk linked service type properties.", "properties": { "authenticationType": { "$ref": "#/definitions/TeamDeskAuthenticationType", "description": "The authentication type to use." }, "url": { "description": "The url to connect TeamDesk source. Type: string (or Expression with resultType string)." }, "userName": { "description": "The username of the TeamDesk source. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password of the TeamDesk source." }, "apiToken": { "$ref": "#/definitions/SecretBase", "description": "The api token for the TeamDesk source." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "authenticationType", "url" ] }, "TeradataAuthenticationType": { "type": "string", "description": "AuthenticationType to be used for connection.", "enum": [ "Basic", "Windows" ], "x-ms-enum": { "name": "TeradataAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Windows", "value": "Windows", "description": "Windows" } ] } }, "TeradataImportCommand": { "type": "object", "description": "Teradata import command settings.", "properties": { "additionalFormatOptions": { "description": "Additional format options for Teradata Copy Command. The format options only applies to direct copy from CSV source. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"timeFormat\": \"HHhMImSSs\" }" } }, "allOf": [ { "$ref": "#/definitions/ImportSettings" } ], "x-ms-discriminator-value": "TeradataImportCommand" }, "TeradataLinkedService": { "type": "object", "description": "Linked service for Teradata data source.", "properties": { "typeProperties": { "$ref": "#/definitions/TeradataLinkedServiceTypeProperties", "description": "Teradata linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Teradata" }, "TeradataLinkedServiceTypeProperties": { "type": "object", "description": "Teradata linked service properties.", "properties": { "connectionString": { "description": "Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only applied for version 1.0." }, "server": { "description": "Server name for connection. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/TeradataAuthenticationType", "description": "AuthenticationType to be used for connection." }, "username": { "description": "Username for authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for authentication." }, "sslMode": { "description": "SSL mode for connection. Valid values including: “Disable”, “Allow”, “Prefer”, “Require”, “Verify-CA”, “Verify-Full”. Default value is “Verify-Full”. Type: string (or Expression with resultType string). Only applied for version 2.0." }, "portNumber": { "description": "The port numbers when connecting to server through non HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only used for V2. Only applied for version 2.0." }, "httpsPortNumber": { "description": "The port numbers when connecting to server through HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0." }, "useDataEncryption": { "description": "Specifies whether to encrypt all communication with the Teradata database. Allowed values are 0 or 1. This setting will be ignored for HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0." }, "characterSet": { "description": "The character set to use for the connection. Type: string (or Expression with resultType string). Only applied for version 2.0." }, "maxRespSize": { "description": "The maximum size of the response buffer for SQL requests, in bytes. Type: integer. Only applied for version 2.0." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "TeradataPartitionOption": { "type": "string", "description": "The partition mechanism that will be used for teradata read in parallel.", "enum": [ "None", "Hash", "DynamicRange" ], "x-ms-enum": { "name": "TeradataPartitionOption", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Hash", "value": "Hash", "description": "Hash" }, { "name": "DynamicRange", "value": "DynamicRange", "description": "DynamicRange" } ] } }, "TeradataPartitionSettings": { "type": "object", "description": "The settings that will be leveraged for teradata source partitioning.", "properties": { "partitionColumnName": { "description": "The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string)." }, "partitionUpperBound": { "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": { "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." } } }, "TeradataSink": { "type": "object", "description": "A copy activity Teradata sink.", "properties": { "importSettings": { "$ref": "#/definitions/TeradataImportCommand", "description": "Teradata import settings." } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "TeradataSink" }, "TeradataSource": { "type": "object", "description": "A copy activity Teradata source.", "properties": { "query": { "description": "Teradata query. Type: string (or Expression with resultType string)." }, "partitionOption": { "description": "The partition mechanism that will be used for teradata read in parallel. Possible values include: \"None\", \"Hash\", \"DynamicRange\"." }, "partitionSettings": { "$ref": "#/definitions/TeradataPartitionSettings", "description": "The settings that will be leveraged for teradata source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "TeradataSource" }, "TeradataTableDataset": { "type": "object", "description": "The Teradata database dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/TeradataTableDatasetTypeProperties", "description": "Teradata dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "TeradataTable" }, "TeradataTableDatasetTypeProperties": { "type": "object", "description": "Teradata dataset properties.", "properties": { "database": { "description": "The database name of Teradata. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of Teradata. Type: string (or Expression with resultType string)." } } }, "TextFormat": { "type": "object", "description": "The data stored in text format.", "properties": { "columnDelimiter": { "description": "The column delimiter. Type: string (or Expression with resultType string)." }, "rowDelimiter": { "description": "The row delimiter. Type: string (or Expression with resultType string)." }, "escapeChar": { "description": "The escape character. Type: string (or Expression with resultType string)." }, "quoteChar": { "description": "The quote character. Type: string (or Expression with resultType string)." }, "nullValue": { "description": "The null value string. Type: string (or Expression with resultType string)." }, "encodingName": { "description": "The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." }, "treatEmptyAsNull": { "description": "Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean)." }, "skipLineCount": { "description": "The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer)." }, "firstRowAsHeader": { "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/DatasetStorageFormat" } ], "x-ms-discriminator-value": "TextFormat" }, "Transformation": { "type": "object", "description": "A data flow transformation.", "properties": { "name": { "type": "string", "description": "Transformation name." }, "description": { "type": "string", "description": "Transformation description." }, "dataset": { "$ref": "#/definitions/DatasetReference", "description": "Dataset reference." }, "linkedService": { "$ref": "#/definitions/LinkedServiceReference", "description": "Linked service reference." }, "flowlet": { "$ref": "#/definitions/DataFlowReference", "description": "Flowlet Reference" } }, "required": [ "name" ] }, "Trigger": { "type": "object", "description": "Azure data factory nested object which contains information about creating pipeline run", "properties": { "type": { "type": "string", "description": "Trigger type." }, "description": { "type": "string", "description": "Trigger description." }, "runtimeState": { "$ref": "#/definitions/TriggerRuntimeState", "description": "Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger.", "readOnly": true }, "annotations": { "type": "array", "description": "List of tags that can be used for describing the trigger.", "items": {} } }, "discriminator": "type", "required": [ "type" ], "additionalProperties": {} }, "TriggerDependencyReference": { "type": "object", "description": "Trigger referenced dependency.", "properties": { "referenceTrigger": { "$ref": "#/definitions/TriggerReference", "description": "Referenced trigger." } }, "required": [ "referenceTrigger" ], "allOf": [ { "$ref": "#/definitions/DependencyReference" } ], "x-ms-discriminator-value": "TriggerDependencyReference" }, "TriggerFilterParameters": { "type": "object", "description": "Query parameters for triggers.", "properties": { "continuationToken": { "type": "string", "description": "The continuation token for getting the next page of results. Null for first page." }, "parentTriggerName": { "type": "string", "description": "The name of the parent TumblingWindowTrigger to get the child rerun triggers" } } }, "TriggerListResponse": { "type": "object", "description": "A list of trigger resources.", "properties": { "value": { "type": "array", "description": "The TriggerResource items on this page", "items": { "$ref": "#/definitions/TriggerResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "TriggerPipelineReference": { "type": "object", "description": "Pipeline that needs to be triggered with the given parameters.", "properties": { "pipelineReference": { "$ref": "#/definitions/PipelineReference", "description": "Pipeline reference." }, "parameters": { "type": "object", "description": "Pipeline parameters.", "additionalProperties": {} } } }, "TriggerQueryResponse": { "type": "object", "description": "A query of triggers.", "properties": { "value": { "type": "array", "description": "List of triggers.", "items": { "$ref": "#/definitions/TriggerResource" } }, "continuationToken": { "type": "string", "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise." } }, "required": [ "value" ] }, "TriggerReference": { "type": "object", "description": "Trigger reference type.", "properties": { "type": { "$ref": "#/definitions/TriggerReferenceType", "description": "Trigger reference type." }, "referenceName": { "type": "string", "description": "Reference trigger name." } }, "required": [ "type", "referenceName" ] }, "TriggerReferenceType": { "type": "string", "description": "Trigger reference type.", "enum": [ "TriggerReference" ], "x-ms-enum": { "name": "TriggerReferenceType", "modelAsString": true, "values": [ { "name": "TriggerReference", "value": "TriggerReference", "description": "TriggerReference" } ] } }, "TriggerResource": { "type": "object", "description": "Trigger resource type.", "properties": { "properties": { "$ref": "#/definitions/Trigger", "description": "Properties of the trigger." }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "TriggerRun": { "type": "object", "description": "Trigger runs.", "properties": { "triggerRunId": { "type": "string", "description": "Trigger run id.", "readOnly": true }, "triggerName": { "type": "string", "description": "Trigger name.", "readOnly": true }, "triggerType": { "type": "string", "description": "Trigger type.", "readOnly": true }, "triggerRunTimestamp": { "type": "string", "format": "date-time", "description": "Trigger run start time.", "readOnly": true }, "status": { "$ref": "#/definitions/TriggerRunStatus", "description": "Trigger run status.", "readOnly": true }, "message": { "type": "string", "description": "Trigger error message.", "readOnly": true }, "properties": { "type": "object", "description": "List of property name and value related to trigger run. Name, value pair depends on type of trigger.", "additionalProperties": { "type": "string" }, "readOnly": true }, "triggeredPipelines": { "type": "object", "description": "List of pipeline name and run Id triggered by the trigger run.", "additionalProperties": { "type": "string" }, "readOnly": true }, "runDimension": { "type": "object", "description": "Run dimension for which trigger was fired.", "additionalProperties": { "type": "string" }, "readOnly": true }, "dependencyStatus": { "type": "object", "description": "Status of the upstream pipelines.", "additionalProperties": {}, "readOnly": true } }, "additionalProperties": {} }, "TriggerRunStatus": { "type": "string", "description": "Trigger run status.", "enum": [ "Succeeded", "Failed", "Inprogress" ], "x-ms-enum": { "name": "TriggerRunStatus", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Inprogress", "value": "Inprogress", "description": "Inprogress" } ] } }, "TriggerRunsQueryResponse": { "type": "object", "description": "A list of trigger runs.", "properties": { "value": { "type": "array", "description": "List of trigger runs.", "items": { "$ref": "#/definitions/TriggerRun" }, "x-ms-identifiers": [ "triggerRunId" ] }, "continuationToken": { "type": "string", "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise." } }, "required": [ "value" ] }, "TriggerRuntimeState": { "type": "string", "description": "Enumerates possible state of Triggers.", "enum": [ "Started", "Stopped", "Disabled" ], "x-ms-enum": { "name": "TriggerRuntimeState", "modelAsString": true, "values": [ { "name": "Started", "value": "Started", "description": "Started" }, { "name": "Stopped", "value": "Stopped", "description": "Stopped" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" } ] } }, "TriggerSubscriptionOperationStatus": { "type": "object", "description": "Defines the response of a trigger subscription operation.", "properties": { "triggerName": { "type": "string", "description": "Trigger name.", "readOnly": true }, "status": { "$ref": "#/definitions/EventSubscriptionStatus", "description": "Event Subscription Status.", "readOnly": true } } }, "TumblingWindowFrequency": { "type": "string", "description": "Enumerates possible frequency option for the tumbling window trigger.", "enum": [ "Minute", "Hour", "Month" ], "x-ms-enum": { "name": "TumblingWindowFrequency", "modelAsString": true, "values": [ { "name": "Minute", "value": "Minute", "description": "Minute" }, { "name": "Hour", "value": "Hour", "description": "Hour" }, { "name": "Month", "value": "Month", "description": "Month" } ] } }, "TumblingWindowTrigger": { "type": "object", "description": "Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).", "properties": { "pipeline": { "$ref": "#/definitions/TriggerPipelineReference", "description": "Pipeline for which runs are created when an event is fired for trigger window that is ready." }, "typeProperties": { "$ref": "#/definitions/TumblingWindowTriggerTypeProperties", "description": "Tumbling Window Trigger properties.", "x-ms-client-flatten": true } }, "required": [ "pipeline", "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Trigger" } ], "x-ms-discriminator-value": "TumblingWindowTrigger" }, "TumblingWindowTriggerDependencyReference": { "type": "object", "description": "Referenced tumbling window trigger dependency.", "properties": { "offset": { "type": "string", "description": "Timespan applied to the start time of a tumbling window when evaluating dependency.", "minLength": 8, "maxLength": 15, "pattern": "-?((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))" }, "size": { "type": "string", "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.", "minLength": 8, "maxLength": 15, "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))" } }, "allOf": [ { "$ref": "#/definitions/TriggerDependencyReference" } ], "x-ms-discriminator-value": "TumblingWindowTriggerDependencyReference" }, "TumblingWindowTriggerTypeProperties": { "type": "object", "description": "Tumbling Window Trigger properties.", "properties": { "frequency": { "$ref": "#/definitions/TumblingWindowFrequency", "description": "The frequency of the time windows." }, "interval": { "type": "integer", "format": "int32", "description": "The interval of the time windows. The minimum interval allowed is 15 Minutes." }, "startTime": { "type": "string", "format": "date-time", "description": "The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." }, "endTime": { "type": "string", "format": "date-time", "description": "The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." }, "delay": { "description": "Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." }, "maxConcurrency": { "type": "integer", "format": "int32", "description": "The max number of parallel time windows (ready for execution) for which a new run is triggered.", "minimum": 1, "maximum": 50 }, "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." }, "dependsOn": { "type": "array", "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", "items": { "$ref": "#/definitions/DependencyReference" }, "x-ms-identifiers": [] } }, "required": [ "frequency", "interval", "startTime", "maxConcurrency" ] }, "TwilioLinkedService": { "type": "object", "description": "Linked service for Twilio.", "properties": { "typeProperties": { "$ref": "#/definitions/TwilioLinkedServiceTypeProperties", "description": "Twilio linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Twilio" }, "TwilioLinkedServiceTypeProperties": { "type": "object", "description": "Twilio linked service type properties.", "properties": { "userName": { "description": "The Account SID of Twilio service. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The auth token of Twilio service." } }, "required": [ "userName", "password" ] }, "Type": { "type": "string", "description": "Linked service reference type.", "enum": [ "LinkedServiceReference" ], "x-ms-enum": { "name": "Type", "modelAsString": true, "values": [ { "name": "LinkedServiceReference", "value": "LinkedServiceReference", "description": "LinkedServiceReference" } ] } }, "TypeConversionSettings": { "type": "object", "description": "Type conversion settings", "properties": { "allowDataTruncation": { "description": "Whether to allow data truncation when converting the data. Type: boolean (or Expression with resultType boolean)." }, "treatBooleanAsNumber": { "description": "Whether to treat boolean values as numbers. Type: boolean (or Expression with resultType boolean)." }, "dateTimeFormat": { "description": "The format for DateTime values. Type: string (or Expression with resultType string)." }, "dateTimeOffsetFormat": { "description": "The format for DateTimeOffset values. Type: string (or Expression with resultType string)." }, "timeSpanFormat": { "description": "The format for TimeSpan values. Type: string (or Expression with resultType string)." }, "timeFormat": { "description": "The format for Time values. Type: string (or Expression with resultType string)." }, "dateFormat": { "description": "The format for Date values. Type: string (or Expression with resultType string)." }, "culture": { "description": "The culture used to convert data from/to string. Type: string (or Expression with resultType string)." } } }, "UntilActivity": { "type": "object", "description": "This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.", "properties": { "typeProperties": { "$ref": "#/definitions/UntilActivityTypeProperties", "description": "Until activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "Until" }, "UntilActivityTypeProperties": { "type": "object", "description": "Until activity properties.", "properties": { "expression": { "$ref": "#/definitions/Expression", "description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true" }, "timeout": { "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]))." }, "activities": { "type": "array", "description": "List of activities to execute.", "items": { "$ref": "#/definitions/Activity" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "expression", "activities" ] }, "UpdateIntegrationRuntimeNodeRequest": { "type": "object", "description": "Update integration runtime node request.", "properties": { "concurrentJobsLimit": { "type": "integer", "format": "int32", "description": "The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.", "minimum": 1 } } }, "UpdateIntegrationRuntimeRequest": { "type": "object", "description": "Update integration runtime request.", "properties": { "autoUpdate": { "$ref": "#/definitions/IntegrationRuntimeAutoUpdate", "description": "Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189." }, "updateDelayOffset": { "type": "string", "description": "The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time." } } }, "UserAccessPolicy": { "type": "object", "description": "Get Data Plane read only token request definition.", "properties": { "permissions": { "type": "string", "description": "The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access." }, "accessResourcePath": { "type": "string", "description": "The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource." }, "profileName": { "type": "string", "description": "The name of the profile. Currently only the default is supported. The default value is DefaultProfile." }, "startTime": { "type": "string", "description": "Start time for the token. If not specified the current time will be used." }, "expireTime": { "type": "string", "description": "Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours." } } }, "UserProperty": { "type": "object", "description": "User property.", "properties": { "name": { "type": "string", "description": "User property name." }, "value": { "description": "User property value. Type: string (or Expression with resultType string)." } }, "required": [ "name", "value" ] }, "ValidationActivity": { "type": "object", "description": "This activity verifies that an external resource exists.", "properties": { "typeProperties": { "$ref": "#/definitions/ValidationActivityTypeProperties", "description": "Validation activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "Validation" }, "ValidationActivityTypeProperties": { "type": "object", "description": "Validation activity properties.", "properties": { "timeout": { "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": { "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": { "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": { "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": { "$ref": "#/definitions/DatasetReference", "description": "Validation activity dataset reference." } }, "required": [ "dataset" ] }, "ValueType": { "type": "string", "description": "Type of value copied from source.", "enum": [ "actual", "display" ], "x-ms-enum": { "name": "ValueType", "modelAsString": true, "values": [ { "name": "actual", "value": "actual", "description": "actual" }, { "name": "display", "value": "display", "description": "display" } ] } }, "VariableSpecification": { "type": "object", "description": "Definition of a single variable for a Pipeline.", "properties": { "type": { "$ref": "#/definitions/VariableType", "description": "Variable type." }, "defaultValue": { "description": "Default value of variable." } }, "required": [ "type" ] }, "VariableType": { "type": "string", "description": "Variable type.", "enum": [ "String", "Bool", "Array" ], "x-ms-enum": { "name": "VariableType", "modelAsString": true, "values": [ { "name": "String", "value": "String", "description": "String" }, { "name": "Bool", "value": "Bool", "description": "Bool" }, { "name": "Array", "value": "Array", "description": "Array" } ] } }, "VerticaDatasetTypeProperties": { "type": "object", "description": "Vertica Properties", "properties": { "tableName": { "description": "This property will be retired. Please consider using schema + table properties instead." }, "table": { "description": "The table name of the Vertica. Type: string (or Expression with resultType string)." }, "schema": { "description": "The schema name of the Vertica. Type: string (or Expression with resultType string)." } } }, "VerticaLinkedService": { "type": "object", "description": "Vertica linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/VerticaLinkedServiceTypeProperties", "description": "Vertica linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Vertica" }, "VerticaLinkedServiceTypeProperties": { "type": "object", "description": "Vertica linked service properties.", "properties": { "connectionString": { "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, "server": { "description": "Server name for connection. Type: string." }, "port": { "description": "The port for the connection. Type: integer." }, "uid": { "description": "Username for authentication. Type: string." }, "database": { "description": "Database name for connection. Type: string." }, "pwd": { "$ref": "#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "VerticaSource": { "type": "object", "description": "A copy activity Vertica source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "VerticaSource" }, "VerticaTableDataset": { "type": "object", "description": "Vertica dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/VerticaDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "VerticaTable" }, "WaitActivity": { "type": "object", "description": "This activity suspends pipeline execution for the specified interval.", "properties": { "typeProperties": { "$ref": "#/definitions/WaitActivityTypeProperties", "description": "Wait activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "Wait" }, "WaitActivityTypeProperties": { "type": "object", "description": "Wait activity properties.", "properties": { "waitTimeInSeconds": { "description": "Duration in seconds. Type: integer (or Expression with resultType integer)." } }, "required": [ "waitTimeInSeconds" ] }, "WarehouseAuthenticationType": { "type": "string", "description": "The authentication type to use.", "enum": [ "ServicePrincipal", "SystemAssignedManagedIdentity", "UserAssignedManagedIdentity" ], "x-ms-enum": { "name": "WarehouseAuthenticationType", "modelAsString": true, "values": [ { "name": "ServicePrincipal", "value": "ServicePrincipal", "description": "ServicePrincipal" }, { "name": "SystemAssignedManagedIdentity", "value": "SystemAssignedManagedIdentity", "description": "SystemAssignedManagedIdentity" }, { "name": "UserAssignedManagedIdentity", "value": "UserAssignedManagedIdentity", "description": "UserAssignedManagedIdentity" } ] } }, "WarehouseLinkedService": { "type": "object", "description": "Microsoft Fabric Warehouse linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/WarehouseLinkedServiceTypeProperties", "description": "Microsoft Fabric Warehouse linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Warehouse" }, "WarehouseLinkedServiceTypeProperties": { "type": "object", "description": "Microsoft Fabric Warehouse linked service properties.", "properties": { "artifactId": { "description": "The ID of Microsoft Fabric Warehouse artifact. Type: string (or Expression with resultType string)." }, "endpoint": { "description": "The endpoint of Microsoft Fabric Warehouse server. Type: string (or Expression with resultType string)." }, "workspaceId": { "description": "The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/WarehouseAuthenticationType", "description": "The authentication type to use." }, "servicePrincipalId": { "description": "The ID of the application used to authenticate against Microsoft Fabric Warehouse. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { "$ref": "#/definitions/SecretBase", "description": "The Key of the application used to authenticate against Microsoft Fabric Warehouse." }, "tenant": { "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." }, "servicePrincipalCredentialType": { "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { "$ref": "#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } }, "required": [ "artifactId", "endpoint" ] }, "WarehouseSink": { "type": "object", "description": "A copy activity Microsoft Fabric Warehouse sink.", "properties": { "preCopyScript": { "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." }, "allowCopyCommand": { "description": "Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean)." }, "copyCommandSettings": { "$ref": "#/definitions/DWCopyCommandSettings", "description": "Specifies Copy Command related settings when allowCopyCommand is true." }, "tableOption": { "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." }, "writeBehavior": { "description": "Write behavior when copying data into azure Microsoft Fabric Data Warehouse. Type: DWWriteBehaviorEnum (or Expression with resultType DWWriteBehaviorEnum)" } }, "allOf": [ { "$ref": "#/definitions/CopySink" } ], "x-ms-discriminator-value": "WarehouseSink" }, "WarehouseSource": { "type": "object", "description": "A copy activity Microsoft Fabric Warehouse source.", "properties": { "sqlReaderQuery": { "description": "Microsoft Fabric Warehouse reader query. Type: string (or Expression with resultType string)." }, "sqlReaderStoredProcedureName": { "description": "Name of the stored procedure for a Microsoft Fabric Warehouse 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 (or Expression with resultType object), itemType: StoredProcedureParameter." }, "isolationLevel": { "description": "Specifies the transaction locking behavior for the Microsoft Fabric Warehouse source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string)." }, "partitionOption": { "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\"." }, "partitionSettings": { "$ref": "#/definitions/SqlPartitionSettings", "description": "The settings that will be leveraged for Sql source partitioning." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "WarehouseSource" }, "WarehouseTableDataset": { "type": "object", "description": "Microsoft Fabric Warehouse dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/WarehouseTableDatasetTypeProperties", "description": "Microsoft Fabric Warehouse dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "WarehouseTable" }, "WarehouseTableDatasetTypeProperties": { "type": "object", "description": "Microsoft Fabric Warehouse dataset properties.", "properties": { "schema": { "description": "The schema name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string)." }, "table": { "description": "The table name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string)." } } }, "WebActivity": { "type": "object", "description": "Web activity.", "properties": { "typeProperties": { "$ref": "#/definitions/WebActivityTypeProperties", "description": "Web activity properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ExecutionActivity" } ], "x-ms-discriminator-value": "WebActivity" }, "WebActivityAuthentication": { "type": "object", "description": "Web activity authentication properties.", "properties": { "type": { "type": "string", "description": "Web activity authentication (Basic/ClientCertificate/MSI/ServicePrincipal)" }, "pfx": { "$ref": "#/definitions/SecretBase", "description": "Base64-encoded contents of a PFX file or Certificate when used for ServicePrincipal" }, "username": { "description": "Web activity authentication user name for basic authentication or ClientID when used for ServicePrincipal. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for the PFX file or basic authentication / Secret when used for ServicePrincipal" }, "resource": { "description": "Resource for which Azure Auth token will be requested when using MSI Authentication. Type: string (or Expression with resultType string)." }, "userTenant": { "description": "TenantId for which Azure Auth token will be requested when using ServicePrincipal Authentication. Type: string (or Expression with resultType string)." }, "credential": { "$ref": "#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } } }, "WebActivityMethod": { "type": "string", "description": "The list of HTTP methods supported by a WebActivity.", "enum": [ "GET", "POST", "PUT", "DELETE" ], "x-ms-enum": { "name": "WebActivityMethod", "modelAsString": true, "values": [ { "name": "GET", "value": "GET", "description": "GET" }, { "name": "POST", "value": "POST", "description": "POST" }, { "name": "PUT", "value": "PUT", "description": "PUT" }, { "name": "DELETE", "value": "DELETE", "description": "DELETE" } ] } }, "WebActivityTypeProperties": { "type": "object", "description": "Web activity type properties.", "properties": { "method": { "$ref": "#/definitions/WebActivityMethod", "description": "Rest API method for target endpoint." }, "url": { "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).", "additionalProperties": {} }, "body": { "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": { "$ref": "#/definitions/WebActivityAuthentication", "description": "Authentication method used for calling the endpoint." }, "disableCertValidation": { "type": "boolean", "description": "When set to true, Certificate validation will be disabled." }, "httpRequestTimeout": { "description": "Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes" }, "turnOffAsync": { "type": "boolean", "description": "Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers." }, "datasets": { "type": "array", "description": "List of datasets passed to web endpoint.", "items": { "$ref": "#/definitions/DatasetReference" }, "x-ms-identifiers": [ "referenceName" ] }, "linkedServices": { "type": "array", "description": "List of linked services passed to web endpoint.", "items": { "$ref": "#/definitions/LinkedServiceReference" }, "x-ms-identifiers": [ "referenceName" ] }, "connectVia": { "$ref": "#/definitions/IntegrationRuntimeReference", "description": "The integration runtime reference." } }, "required": [ "method", "url" ] }, "WebAnonymousAuthentication": { "type": "object", "description": "A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.", "allOf": [ { "$ref": "#/definitions/WebLinkedServiceTypeProperties" } ], "x-ms-discriminator-value": "Anonymous" }, "WebAuthenticationType": { "type": "string", "description": "Type of authentication used to connect to the web table source.", "enum": [ "Basic", "Anonymous", "ClientCertificate" ], "x-ms-enum": { "name": "WebAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Anonymous", "value": "Anonymous", "description": "Anonymous" }, { "name": "ClientCertificate", "value": "ClientCertificate", "description": "ClientCertificate" } ] } }, "WebBasicAuthentication": { "type": "object", "description": "A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.", "properties": { "username": { "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password for Basic authentication." } }, "required": [ "username", "password" ], "allOf": [ { "$ref": "#/definitions/WebLinkedServiceTypeProperties" } ], "x-ms-discriminator-value": "Basic" }, "WebClientCertificateAuthentication": { "type": "object", "description": "A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.", "properties": { "pfx": { "$ref": "#/definitions/SecretBase", "description": "Base64-encoded contents of a PFX file." }, "password": { "$ref": "#/definitions/SecretBase", "description": "Password for the PFX file." } }, "required": [ "pfx", "password" ], "allOf": [ { "$ref": "#/definitions/WebLinkedServiceTypeProperties" } ], "x-ms-discriminator-value": "ClientCertificate" }, "WebHookActivity": { "type": "object", "description": "WebHook activity.", "properties": { "typeProperties": { "$ref": "#/definitions/WebHookActivityTypeProperties", "description": "WebHook activity properties.", "x-ms-client-flatten": true }, "policy": { "$ref": "#/definitions/SecureInputOutputPolicy", "description": "Activity policy." } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/ControlActivity" } ], "x-ms-discriminator-value": "WebHook" }, "WebHookActivityMethod": { "type": "string", "description": "The list of HTTP methods supported by a WebHook activity.", "enum": [ "POST" ], "x-ms-enum": { "name": "WebHookActivityMethod", "modelAsString": true, "values": [ { "name": "POST", "value": "POST", "description": "POST" } ] } }, "WebHookActivityTypeProperties": { "type": "object", "description": "WebHook activity type properties.", "properties": { "method": { "$ref": "#/definitions/WebHookActivityMethod", "description": "Rest API method for target endpoint." }, "url": { "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).", "additionalProperties": {} }, "body": { "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": { "$ref": "#/definitions/WebActivityAuthentication", "description": "Authentication method used for calling the endpoint." }, "reportStatusOnCallBack": { "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" ] }, "WebLinkedService": { "type": "object", "description": "Web linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/WebLinkedServiceTypeProperties", "description": "Web linked service properties." } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Web" }, "WebLinkedServiceTypeProperties": { "type": "object", "description": "Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.", "properties": { "url": { "description": "The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string)." }, "authenticationType": { "$ref": "#/definitions/WebAuthenticationType", "description": "Type of authentication used to connect to the web table source." } }, "discriminator": "authenticationType", "required": [ "url", "authenticationType" ] }, "WebSource": { "type": "object", "description": "A copy activity source for web page table.", "properties": { "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "WebSource" }, "WebTableDataset": { "type": "object", "description": "The dataset points to a HTML table in the web page.", "properties": { "typeProperties": { "$ref": "#/definitions/WebTableDatasetTypeProperties", "description": "Web table dataset properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "WebTable" }, "WebTableDatasetTypeProperties": { "type": "object", "description": "Web table dataset properties.", "properties": { "index": { "description": "The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0." }, "path": { "description": "The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string)." } }, "required": [ "index" ] }, "WranglingDataFlow": { "type": "object", "description": "Power Query data flow.", "properties": { "typeProperties": { "$ref": "#/definitions/PowerQueryTypeProperties", "description": "PowerQuery data flow type properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/DataFlow" } ], "x-ms-discriminator-value": "WranglingDataFlow" }, "XeroLinkedService": { "type": "object", "description": "Xero Service linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/XeroLinkedServiceTypeProperties", "description": "Xero Service linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Xero" }, "XeroLinkedServiceTypeProperties": { "type": "object", "description": "Xero Service linked service properties.", "properties": { "connectionProperties": { "description": "Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object." }, "host": { "description": "The endpoint of the Xero server. (i.e. api.xero.com)" }, "consumerKey": { "$ref": "#/definitions/SecretBase", "description": "The consumer key associated with the Xero application." }, "privateKey": { "$ref": "#/definitions/SecretBase", "description": "The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings(\n)." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "XeroObjectDataset": { "type": "object", "description": "Xero Service dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "XeroObject" }, "XeroSource": { "type": "object", "description": "A copy activity Xero Service source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "XeroSource" }, "XmlDataset": { "type": "object", "description": "Xml dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/XmlDatasetTypeProperties", "description": "Xml dataset properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "Xml" }, "XmlDatasetTypeProperties": { "type": "object", "description": "Xml dataset properties.", "properties": { "location": { "$ref": "#/definitions/DatasetLocation", "description": "The location of the json data storage." }, "encodingName": { "description": "The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." }, "nullValue": { "description": "The null value string. Type: string (or Expression with resultType string)." }, "compression": { "$ref": "#/definitions/DatasetCompression", "description": "The data compression method used for the json dataset." } }, "required": [ "location" ] }, "XmlReadSettings": { "type": "object", "description": "Xml read settings.", "properties": { "compressionProperties": { "$ref": "#/definitions/CompressionReadSettings", "description": "Compression settings." }, "validationMode": { "description": "Indicates what validation method is used when reading the xml files. Allowed values: 'none', 'xsd', or 'dtd'. Type: string (or Expression with resultType string)." }, "detectDataType": { "description": "Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean)." }, "namespaces": { "description": "Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean)." }, "namespacePrefixes": { "description": "Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: \"{\"http://www.example.com/xml\":\"prefix\"}\" Type: object (or Expression with resultType object)." } }, "allOf": [ { "$ref": "#/definitions/FormatReadSettings" } ], "x-ms-discriminator-value": "XmlReadSettings" }, "XmlSource": { "type": "object", "description": "A copy activity Xml source.", "properties": { "storeSettings": { "$ref": "#/definitions/StoreReadSettings", "description": "Xml store settings." }, "formatSettings": { "$ref": "#/definitions/XmlReadSettings", "description": "Xml format settings." }, "additionalColumns": { "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } }, "allOf": [ { "$ref": "#/definitions/CopySource" } ], "x-ms-discriminator-value": "XmlSource" }, "ZendeskAuthenticationType": { "type": "string", "description": "The authentication type to use.", "enum": [ "Basic", "Token" ], "x-ms-enum": { "name": "ZendeskAuthenticationType", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Token", "value": "Token", "description": "Token" } ] } }, "ZendeskLinkedService": { "type": "object", "description": "Linked service for Zendesk.", "properties": { "typeProperties": { "$ref": "#/definitions/ZendeskLinkedServiceTypeProperties", "description": "Zendesk linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Zendesk" }, "ZendeskLinkedServiceTypeProperties": { "type": "object", "description": "Zendesk linked service type properties.", "properties": { "authenticationType": { "$ref": "#/definitions/ZendeskAuthenticationType", "description": "The authentication type to use." }, "url": { "description": "The url to connect Zendesk source. Type: string (or Expression with resultType string)." }, "userName": { "description": "The username of the Zendesk source. Type: string (or Expression with resultType string)." }, "password": { "$ref": "#/definitions/SecretBase", "description": "The password of the Zendesk source." }, "apiToken": { "$ref": "#/definitions/SecretBase", "description": "The api token for the Zendesk source." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } }, "required": [ "authenticationType", "url" ] }, "ZipDeflateReadSettings": { "type": "object", "description": "The ZipDeflate compression read settings.", "properties": { "preserveZipFileNameAsFolder": { "description": "Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean)." } }, "allOf": [ { "$ref": "#/definitions/CompressionReadSettings" } ], "x-ms-discriminator-value": "ZipDeflateReadSettings" }, "ZohoLinkedService": { "type": "object", "description": "Zoho server linked service.", "properties": { "typeProperties": { "$ref": "#/definitions/ZohoLinkedServiceTypeProperties", "description": "Zoho server linked service properties.", "x-ms-client-flatten": true } }, "required": [ "typeProperties" ], "allOf": [ { "$ref": "#/definitions/LinkedService" } ], "x-ms-discriminator-value": "Zoho" }, "ZohoLinkedServiceTypeProperties": { "type": "object", "description": "Zoho server linked service properties.", "properties": { "connectionProperties": { "description": "Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object." }, "endpoint": { "description": "The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)" }, "accessToken": { "$ref": "#/definitions/SecretBase", "description": "The access token for Zoho authentication." }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true." }, "useHostVerification": { "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true." }, "usePeerVerification": { "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true." }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } } }, "ZohoObjectDataset": { "type": "object", "description": "Zoho server dataset.", "properties": { "typeProperties": { "$ref": "#/definitions/GenericDatasetTypeProperties", "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Dataset" } ], "x-ms-discriminator-value": "ZohoObject" }, "ZohoSource": { "type": "object", "description": "A copy activity Zoho server source.", "properties": { "query": { "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } }, "allOf": [ { "$ref": "#/definitions/TabularSource" } ], "x-ms-discriminator-value": "ZohoSource" }, "managedPrivateEndpointListResponse": { "type": "object", "description": "Paged collection of ManagedPrivateEndpointResource items", "properties": { "value": { "type": "array", "description": "The ManagedPrivateEndpointResource items on this page", "items": { "$ref": "#/definitions/ManagedPrivateEndpointResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] } }, "parameters": {} }