{ "swagger": "2.0", "schemes": [ "https" ], "host": "management.azure.com", "info": { "title": "DataFactoryManagementClient", "version": "2017-09-01-preview", "x-apisguru-categories": [ "cloud" ], "x-logo": { "url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png" }, "x-origin": [ { "format": "swagger", "url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json", "version": "2.0" } ], "x-preferred": false, "x-providerName": "azure.com", "x-serviceName": "datafactory", "x-tags": [ "Azure", "Microsoft" ] }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "azure_auth": { "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "scopes": { "user_impersonation": "impersonate your user account" }, "type": "oauth2" } }, "security": [ { "azure_auth": [ "user_impersonation" ] } ], "parameters": { "api-version": { "description": "The API version.", "in": "query", "name": "api-version", "required": true, "type": "string" }, "datasetName": { "description": "The dataset name.", "in": "path", "maxLength": 260, "minLength": 1, "name": "datasetName", "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "factoryName": { "description": "The factory name.", "in": "path", "maxLength": 63, "minLength": 3, "name": "factoryName", "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "integrationRuntimeName": { "description": "The integration runtime name.", "in": "path", "maxLength": 63, "minLength": 3, "name": "integrationRuntimeName", "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "linkedServiceName": { "description": "The linked service name.", "in": "path", "maxLength": 260, "minLength": 1, "name": "linkedServiceName", "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "locationId": { "description": "The location identifier.", "in": "path", "name": "locationId", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "nodeName": { "description": "The integration runtime node name.", "in": "path", "maxLength": 150, "minLength": 1, "name": "nodeName", "pattern": "^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "pipelineName": { "description": "The pipeline name.", "in": "path", "maxLength": 260, "minLength": 1, "name": "pipelineName", "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "referencePipelineRunId": { "description": "The pipeline run identifier.", "in": "path", "name": "referencePipelineRunId", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "resourceGroupName": { "description": "The resource group name.", "in": "path", "maxLength": 90, "minLength": 1, "name": "resourceGroupName", "pattern": "^[-\\w\\._\\(\\)]+$", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "runId": { "description": "The pipeline run identifier.", "in": "path", "name": "runId", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "subscriptionId": { "description": "The subscription identifier.", "in": "path", "name": "subscriptionId", "required": true, "type": "string" }, "triggerName": { "description": "The trigger name.", "in": "path", "maxLength": 260, "minLength": 1, "name": "triggerName", "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", "required": true, "type": "string", "x-ms-parameter-location": "method" } }, "paths": { "/providers/Microsoft.DataFactory/operations": { "get": { "description": "Lists the available Azure Data Factory API operations.", "operationId": "Operations_List", "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/OperationListResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "operations" ], "x-ms-examples": { "Operations_List": { "parameters": { "api-version": "2017-09-01-preview", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "value": [ { "display": { "description": "Gets the available metrics for datafactories", "operation": "Read datafactories metric definitions", "provider": "Microsoft.DataFactory", "resource": "datafactories" }, "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/metricDefinitions/read", "origin": "system", "properties": { "serviceSpecification": { "metricSpecifications": [ { "aggregationType": "Total", "availabilities": [ { "blobDuration": "P1D", "timeGrain": "PT1H" } ], "displayDescription": "Number of successful runs.", "displayName": "Successful Runs", "name": "SuccessfulRuns", "unit": "Count" }, { "aggregationType": "Total", "availabilities": [ { "blobDuration": "P1D", "timeGrain": "PT1H" } ], "displayDescription": "Number of failed runs.", "displayName": "Failed Runs", "name": "FailedRuns", "unit": "Count" } ] } } }, { "display": { "description": "Gets the diagnostic setting for the resource", "operation": "Read diagnostic setting", "provider": "Microsoft.DataFactory", "resource": "datafactories" }, "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/diagnosticSettings/read", "origin": "system" }, { "display": { "description": "Creates or updates the diagnostic setting for the resource", "operation": "Write diagnostic setting", "provider": "Microsoft.DataFactory", "resource": "datafactories" }, "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/diagnosticSettings/write", "origin": "system" }, { "display": { "description": "Gets the available logs for factories", "operation": "Read factories log definitions", "provider": "Microsoft.DataFactory", "resource": "The log definition of factories" }, "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/logDefinitions/read", "origin": "system", "properties": { "serviceSpecification": { "logSpecifications": [ { "blobDuration": "PT1H", "displayName": "Pipeline activity runs log", "name": "ActivityRuns" }, { "blobDuration": "PT1H", "displayName": "Pipeline runs log", "name": "PipelineRuns" }, { "blobDuration": "PT1H", "displayName": "Trigger runs log", "name": "TriggerRuns" } ] } } }, { "display": { "description": "Gets the diagnostic setting for the resource", "operation": "Read diagnostic setting", "provider": "Microsoft.DataFactory", "resource": "factories" }, "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/diagnosticSettings/read", "origin": "system" }, { "display": { "description": "Creates or updates the diagnostic setting for the resource", "operation": "Write diagnostic setting", "provider": "Microsoft.DataFactory", "resource": "factories" }, "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/diagnosticSettings/write", "origin": "system" }, { "display": { "description": "Gets the available metrics for factories", "operation": "Read metric definitions", "provider": "Microsoft.DataFactory", "resource": "factories" }, "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/metricDefinitions/read", "origin": "system", "properties": { "serviceSpecification": { "metricSpecifications": [ { "aggregationType": "Total", "displayName": "Failed pipeline runs metrics", "enableRegionalMdmAccount": "false", "name": "PipelineFailedRuns", "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", "sourceMdmNamespace": "ADFMetrics", "unit": "Count" }, { "aggregationType": "Total", "displayName": "Succeeded pipeline runs metrics", "enableRegionalMdmAccount": "false", "name": "PipelineSucceededRuns", "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", "sourceMdmNamespace": "ADFMetrics", "unit": "Count" }, { "aggregationType": "Total", "displayName": "Failed activity runs metrics", "enableRegionalMdmAccount": "false", "name": "ActivityFailedRuns", "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", "sourceMdmNamespace": "ADFMetrics", "unit": "Count" }, { "aggregationType": "Total", "displayName": "Succeeded activity runs metrics", "enableRegionalMdmAccount": "false", "name": "ActivitySucceededRuns", "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", "sourceMdmNamespace": "ADFMetrics", "unit": "Count" }, { "aggregationType": "Total", "displayName": "Failed trigger runs metrics", "enableRegionalMdmAccount": "false", "name": "TriggerFailedRuns", "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", "sourceMdmNamespace": "ADFMetrics", "unit": "Count" }, { "aggregationType": "Total", "displayName": "Succeeded trigger runs metrics", "enableRegionalMdmAccount": "false", "name": "TriggerSucceededRuns", "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", "sourceMdmNamespace": "ADFMetrics", "unit": "Count" } ] } } } ] }, "headers": { "Date": "Wed, 13 Sep 2017 18:04:32 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", "x-ms-ratelimit-remaining-tenant-reads": "14999", "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" } } } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories": { "get": { "description": "Lists factories under the specified subscription.", "operationId": "Factories_List", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/FactoryListResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "factories" ], "x-ms-examples": { "Factories_List": { "parameters": { "api-version": "2017-09-01-preview", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", "location": "East US", "name": "exampleFactoryName", "properties": { "createTime": "2017-09-13T17:33:54.0294655Z", "provisioningState": "Succeeded", "version": "2017-09-01-preview" }, "tags": { "exampleTag": "exampleValue" }, "type": "Microsoft.DataFactory/factories" }, { "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/yitzhangFactoryV2", "location": "East US", "name": "yitzhangFactoryV2", "properties": { "createTime": "2017-05-08T21:03:32.7865115Z", "provisioningState": "Succeeded", "version": "2017-03-01-preview" }, "tags": { "exampleTag": "exampleValue" }, "type": "Microsoft.DataFactory/factories" } ] }, "headers": { "Date": "Wed, 13 Sep 2017 17:33:56 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "471c3c55-1293-47bf-9662-33bb20f4b75c", "x-ms-ratelimit-remaining-subscription-reads": "14992", "x-ms-request-id": "85e53e59-e56e-4878-a1ff-aaa27f52b466" } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo": { "post": { "description": "Updates a factory's repo information.", "operationId": "Factories_ConfigureFactoryRepo", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/locationId" }, { "$ref": "#/parameters/api-version" }, { "description": "Update factory repo request definition.", "in": "body", "name": "factoryRepoUpdate", "required": true, "schema": { "$ref": "#/definitions/FactoryRepoUpdate" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/Factory" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "configureFactoryRepo" ], "x-ms-examples": { "Factories_ConfigureFactoryRepo": { "parameters": { "api-version": "2017-09-01-preview", "factoryRepoUpdate": { "factoryId": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/examplefactoryname", "resourceGroupName": "exampleResourceGroup", "vstsConfiguration": { "accountName": "msdata", "collaborationBranch": "master", "lastCommitId": "", "projectName": "datafactory", "repositoryName": "exampleRepo", "rootFolder": "/", "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" } }, "locationId": "eastus", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/examplefactoryname", "location": "East US", "name": "exampleFactoryName", "properties": { "createTime": "2017-09-13T17:33:54.0294655Z", "provisioningState": "Succeeded", "version": "2017-09-01-preview", "vstsConfiguration": { "accountName": "msdata", "collaborationBranch": "master", "lastCommitId": "", "projectName": "datafactory", "repositoryName": "exampleRepo", "rootFolder": "/", "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" } }, "tags": {}, "type": "Microsoft.DataFactory/factories" }, "headers": { "Date": "Wed, 13 Sep 2017 17:33:54 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "8d66d31c-23f3-4ac1-bc8c-1b6464342ad1", "x-ms-ratelimit-remaining-subscription-writes": "1198", "x-ms-request-id": "dc1954ed-a1d3-4437-bd73-480ffdf1ea5a" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories": { "get": { "description": "Lists factories.", "operationId": "Factories_ListByResourceGroup", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/FactoryListResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "factories" ], "x-ms-examples": { "Factories_ListByResourceGroup": { "parameters": { "api-version": "2017-09-01-preview", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", "location": "East US", "name": "exampleFactoryName", "properties": { "createTime": "2017-09-13T17:33:54.0294655Z", "provisioningState": "Succeeded", "version": "2017-09-01-preview" }, "tags": { "exampleTag": "exampleValue" }, "type": "Microsoft.DataFactory/factories" }, { "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/yitzhangFactoryV2", "location": "East US", "name": "yitzhangFactoryV2", "properties": { "createTime": "2017-05-08T21:03:32.7865115Z", "provisioningState": "Succeeded", "version": "2017-03-01-preview" }, "tags": { "exampleTag": "exampleValue" }, "type": "Microsoft.DataFactory/factories" } ] }, "headers": { "Date": "Wed, 13 Sep 2017 17:33:56 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "471c3c55-1293-47bf-9662-33bb20f4b75c", "x-ms-ratelimit-remaining-subscription-reads": "14992", "x-ms-request-id": "85e53e59-e56e-4878-a1ff-aaa27f52b466" } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}": { "delete": { "description": "Deletes a factory.", "operationId": "Factories_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK." }, "204": { "description": "No Content." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "factories" ], "x-ms-examples": { "Factories_Delete": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {}, "204": {} } } } }, "get": { "description": "Gets a factory.", "operationId": "Factories_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/Factory" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "factories" ], "x-ms-examples": { "Factories_Get": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", "location": "East US", "name": "exampleFactoryName", "properties": { "createTime": "2017-09-13T17:33:54.0294655Z", "provisioningState": "Succeeded", "version": "2017-09-01-preview" }, "tags": { "exampleTag": "exampleValue" }, "type": "Microsoft.DataFactory/factories" }, "headers": { "Date": "Wed, 13 Sep 2017 17:33:55 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed", "x-ms-ratelimit-remaining-subscription-reads": "14993", "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba" } } } } } }, "patch": { "description": "Updates a factory.", "operationId": "Factories_Update", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/api-version" }, { "description": "The parameters for updating a factory.", "in": "body", "name": "factoryUpdateParameters", "required": true, "schema": { "$ref": "#/definitions/FactoryUpdateParameters" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/Factory" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "factories" ], "x-ms-examples": { "Factories_Update": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "factoryUpdateParameters": { "tags": { "exampleTag": "exampleValue" } }, "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", "location": "East US", "name": "exampleFactoryName", "properties": { "createTime": "2017-09-13T17:33:54.0294655Z", "provisioningState": "Succeeded", "version": "2017-09-01-preview" }, "tags": { "exampleTag": "exampleValue" }, "type": "Microsoft.DataFactory/factories" }, "headers": { "Date": "Wed, 13 Sep 2017 17:33:55 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "ec4ce622-a1dd-4c49-a324-17e8d4d1fe83", "x-ms-ratelimit-remaining-subscription-writes": "1197", "x-ms-request-id": "3223701f-ce33-4a58-bb14-d3d53569d4f0" } } } } } }, "put": { "description": "Creates or updates a factory.", "operationId": "Factories_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/api-version" }, { "description": "Factory resource definition.", "in": "body", "name": "factory", "required": true, "schema": { "$ref": "#/definitions/Factory" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/Factory" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "factories" ], "x-ms-examples": { "Factories_CreateOrUpdate": { "parameters": { "api-version": "2017-09-01-preview", "factory": { "location": "East US", "properties": { "vstsConfiguration": { "accountName": "msdata", "collaborationBranch": "master", "lastCommitId": "", "projectName": "datafactory", "repositoryName": "exampleRepo", "rootFolder": "/", "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" } } }, "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/examplefactoryname", "location": "East US", "name": "exampleFactoryName", "properties": { "createTime": "2017-09-13T17:33:54.0294655Z", "provisioningState": "Succeeded", "version": "2017-09-01-preview", "vstsConfiguration": { "accountName": "msdata", "collaborationBranch": "master", "lastCommitId": "", "projectName": "datafactory", "repositoryName": "exampleRepo", "rootFolder": "/", "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" } }, "tags": {}, "type": "Microsoft.DataFactory/factories" }, "headers": { "Date": "Wed, 13 Sep 2017 17:33:54 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "8d66d31c-23f3-4ac1-bc8c-1b6464342ad1", "x-ms-ratelimit-remaining-subscription-writes": "1198", "x-ms-request-id": "dc1954ed-a1d3-4437-bd73-480ffdf1ea5a" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/cancelpipelinerun/{runId}": { "post": { "description": "Cancel a pipeline run by its run ID.", "operationId": "Factories_CancelPipelineRun", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/runId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Pipeline run has been canceled successfully. " }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "pipelineruns" ], "x-ms-examples": { "Factories_CancelPipelineRun": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "runId": "39692ed9-c722-4d33-b8e1-1f4a9deac57f", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {} } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets": { "get": { "description": "Lists datasets.", "operationId": "Datasets_ListByFactory", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/DatasetListResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "datasets" ], "x-ms-examples": { "Datasets_ListByFactory": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "value": [ { "etag": "280320a7-0000-0000-0000-59b9712a0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", "name": "exampleDataset", "properties": { "description": "Example description", "linkedServiceName": { "referenceName": "exampleLinkedService", "type": "LinkedServiceReference" }, "parameters": { "MyFileName": { "type": "String" }, "MyFolderPath": { "type": "String" } }, "type": "AzureBlob", "typeProperties": { "fileName": { "type": "Expression", "value": "@dataset().MyFileName" }, "folderPath": { "type": "Expression", "value": "@dataset().MyFolderPath" }, "format": { "type": "TextFormat" } } } } ] }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:55 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "babd0c35-621b-4c3e-bc19-7e84ff1153e7", "x-ms-ratelimit-remaining-subscription-reads": "14911", "x-ms-request-id": "624b9e0f-5b8e-4a08-8ff3-ead24e96658f" } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}": { "delete": { "description": "Deletes a dataset.", "operationId": "Datasets_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/datasetName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK." }, "204": { "description": "No Content." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "datasets" ], "x-ms-examples": { "Datasets_Delete": { "parameters": { "api-version": "2017-09-01-preview", "datasetName": "exampleDataset", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {}, "204": {} } } } }, "get": { "description": "Gets a dataset.", "operationId": "Datasets_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/datasetName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/DatasetResource" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "datasets" ], "x-ms-examples": { "Datasets_Get": { "parameters": { "api-version": "2017-09-01-preview", "datasetName": "exampleDataset", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "280320a7-0000-0000-0000-59b9712a0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", "name": "exampleDataset", "properties": { "description": "Example description", "linkedServiceName": { "referenceName": "exampleLinkedService", "type": "LinkedServiceReference" }, "parameters": { "MyFileName": { "type": "String" }, "MyFolderPath": { "type": "String" } }, "type": "AzureBlob", "typeProperties": { "fileName": { "type": "Expression", "value": "@dataset().MyFileName" }, "folderPath": { "type": "Expression", "value": "@dataset().MyFolderPath" }, "format": { "type": "TextFormat" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:55 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "949f7936-4ad4-49bc-8d2a-5f56a8938fba", "x-ms-ratelimit-remaining-subscription-reads": "14912", "x-ms-request-id": "a60fc528-1652-4619-9477-f00ab05e9a24" } } } } } }, "put": { "description": "Creates or updates a dataset.", "operationId": "Datasets_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/datasetName" }, { "$ref": "#/parameters/api-version" }, { "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.", "in": "header", "name": "If-Match", "required": false, "type": "string" }, { "description": "Dataset resource definition.", "in": "body", "name": "dataset", "required": true, "schema": { "$ref": "#/definitions/DatasetResource" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/DatasetResource" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "datasets" ], "x-ms-examples": { "Datasets_Create": { "parameters": { "api-version": "2017-09-01-preview", "dataset": { "properties": { "linkedServiceName": { "referenceName": "exampleLinkedService", "type": "LinkedServiceReference" }, "parameters": { "MyFileName": { "type": "String" }, "MyFolderPath": { "type": "String" } }, "type": "AzureBlob", "typeProperties": { "fileName": { "type": "Expression", "value": "@dataset().MyFileName" }, "folderPath": { "type": "Expression", "value": "@dataset().MyFolderPath" }, "format": { "type": "TextFormat" } } } }, "datasetName": "exampleDataset", "factoryName": "exampleFactoryName", "ifMatch": null, "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "28031ea7-0000-0000-0000-59b9712a0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", "name": "exampleDataset", "properties": { "linkedServiceName": { "referenceName": "exampleLinkedService", "type": "LinkedServiceReference" }, "parameters": { "MyFileName": { "type": "String" }, "MyFolderPath": { "type": "String" } }, "type": "AzureBlob", "typeProperties": { "fileName": { "type": "Expression", "value": "@dataset().MyFileName" }, "folderPath": { "type": "Expression", "value": "@dataset().MyFolderPath" }, "format": { "type": "TextFormat" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:54 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "acdb3257-c6cb-44f1-8e14-afa3ebf471fa", "x-ms-ratelimit-remaining-subscription-writes": "1184", "x-ms-request-id": "a8bb197f-b00f-4add-a847-59f6aa0315ab" } } } }, "Datasets_Update": { "parameters": { "api-version": "2017-09-01-preview", "dataset": { "properties": { "description": "Example description", "linkedServiceName": { "referenceName": "exampleLinkedService", "type": "LinkedServiceReference" }, "parameters": { "MyFileName": { "type": "String" }, "MyFolderPath": { "type": "String" } }, "type": "AzureBlob", "typeProperties": { "fileName": { "type": "Expression", "value": "@dataset().MyFileName" }, "folderPath": { "type": "Expression", "value": "@dataset().MyFolderPath" }, "format": { "type": "TextFormat" } } } }, "datasetName": "exampleDataset", "factoryName": "exampleFactoryName", "ifMatch": null, "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "280320a7-0000-0000-0000-59b9712a0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", "name": "exampleDataset", "properties": { "description": "Example description", "linkedServiceName": { "referenceName": "exampleLinkedService", "type": "LinkedServiceReference" }, "parameters": { "MyFileName": { "type": "String" }, "MyFolderPath": { "type": "String" } }, "type": "AzureBlob", "typeProperties": { "fileName": { "type": "Expression", "value": "@dataset().MyFileName" }, "folderPath": { "type": "Expression", "value": "@dataset().MyFolderPath" }, "format": { "type": "TextFormat" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:54 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "f3e7273d-9f29-4b0c-94bd-c3d13dec47ca", "x-ms-ratelimit-remaining-subscription-writes": "1183", "x-ms-request-id": "76cfa027-3792-424b-ae2b-ddcafe7034be" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes": { "get": { "description": "Lists integration runtimes.", "operationId": "IntegrationRuntimes_ListByFactory", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/IntegrationRuntimeListResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_ListByFactory": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "value": [ { "etag": "0100333d-0000-0000-0000-5a1d0ab80000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", "name": "exampleIntegrationRuntime", "properties": { "description": "A managed reserved integration runtime", "state": "Initial", "type": "Managed", "typeProperties": { "computeProperties": { "location": "West US", "maxParallelExecutionsPerNode": 1, "nodeSize": "Standard_D1_v2", "numberOfNodes": 1 }, "ssisProperties": { "catalogInfo": { "catalogAdminPassword": { "type": "SecureString", "value": "**********" }, "catalogAdminUserName": "yanzhang", "catalogPricingTier": "S1", "catalogServerEndpoint": "yandongtestsvr.database.windows.net" } } } } } ] }, "headers": { "Date": "Tue, 28 Nov 2017 07:05:28 GMT", "X-Content-Type-Options": "nosniff", "x-ms-request-id": "a31dcf14-5eca-42c3-a0ac-5448c2f8b095" } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}": { "delete": { "description": "Deletes an integration runtime.", "operationId": "IntegrationRuntimes_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK." }, "204": { "description": "No Content." }, "default": { "description": "An error response received from DELETE integration runtime operation.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_Delete": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {}, "204": {} } } } }, "get": { "description": "Gets an integration runtime.", "operationId": "IntegrationRuntimes_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/IntegrationRuntimeResource" } }, "default": { "description": "An error response received from GET integration runtime operation.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_Get": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "0100333d-0000-0000-0000-5a1d0ab80000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", "name": "exampleIntegrationRuntime", "properties": { "description": "A managed reserved integration runtime", "state": "Initial", "type": "Managed", "typeProperties": { "computeProperties": { "location": "West US", "maxParallelExecutionsPerNode": 1, "nodeSize": "Standard_D1_v2", "numberOfNodes": 1 }, "ssisProperties": { "catalogInfo": { "catalogAdminPassword": { "type": "SecureString", "value": "**********" }, "catalogAdminUserName": "yanzhang", "catalogPricingTier": "S1", "catalogServerEndpoint": "yandongtestsvr.database.windows.net" } } } } }, "headers": { "Date": "Tue, 28 Nov 2017 07:05:29 GMT", "X-Content-Type-Options": "nosniff", "x-ms-request-id": "f0c62d3c-0df3-4b08-b860-d258752bdfec" } } } } } }, "patch": { "description": "Updates an integration runtime.", "operationId": "IntegrationRuntimes_Update", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" }, { "description": "The parameters for updating an integration runtime.", "in": "body", "name": "updateIntegrationRuntimeRequest", "required": true, "schema": { "$ref": "#/definitions/UpdateIntegrationRuntimeRequest" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/IntegrationRuntimeStatusResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_Update": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc", "updateIntegrationRuntimeRequest": { "autoUpdate": "Off", "updateDelayOffset": "\"PT3H\"" } }, "responses": { "200": { "body": { "name": "exampleIntegrationRuntime", "properties": { "state": "Online", "type": "SelfHosted", "typeProperties": { "autoUpdate": "Off", "capabilities": { "connectedToResourceManager": "True", "credentialInSync": "True", "httpsPortEnabled": "True", "nodeEnabled": "True", "serviceBusConnected": "True" }, "createTime": "2017-11-28T05:42:42.9629741Z", "localTimeZoneOffset": "PT8H", "nodeCommunicationChannelEncryptionMode": "NonEncryption", "nodes": [ { "capabilities": { "connectedToResourceManager": "True", "credentialInSync": "True", "httpsPortEnabled": "True", "nodeEnabled": "True", "serviceBusConnected": "True" }, "hostServiceUri": "https://yanzhang-02.redmond.corp.microsoft.com:8050/HostServiceRemote.svc/", "isActiveDispatcher": true, "lastConnectTime": "2017-11-28T06:04:53.3204752Z", "lastStartTime": "2017-11-28T05:55:24.1066418Z", "lastUpdateResult": "None", "machineName": "YANZHANG-02", "maxConcurrentJobs": 48, "nodeName": "Node_1", "registerTime": "2017-11-28T05:54:38.5305162Z", "status": "Online", "version": "3.2.6519.3", "versionStatus": "UpToDate" } ], "serviceUrls": [ "wu.frontend.int.clouddatahub-int.net", "*.servicebus.windows.net" ], "state": "Online", "taskQueueId": "c4f7521d-66cc-4d44-8aad-4d3679821c41", "updateDelayOffset": "PT3H", "version": "3.2.6519.3", "versionStatus": "UpToDate" } } }, "headers": { "Date": "Tue, 28 Nov 2017 06:05:14 GMT", "X-Content-Type-Options": "nosniff", "x-ms-request-id": "2fcc5cb6-e236-4848-99b7-8c834a622144" } } } } } }, "put": { "description": "Creates or updates an integration runtime.", "operationId": "IntegrationRuntimes_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" }, { "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.", "in": "header", "name": "If-Match", "required": false, "type": "string" }, { "description": "Integration runtime resource definition.", "in": "body", "name": "integrationRuntime", "required": true, "schema": { "$ref": "#/definitions/IntegrationRuntimeResource" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/IntegrationRuntimeResource" } }, "default": { "description": "An error response received from PUT integration runtime operation.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_Create": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "ifMatch": null, "integrationRuntime": { "properties": { "description": "A managed reserved integration runtime", "type": "Managed", "typeProperties": { "computeProperties": { "location": "West US", "maxParallelExecutionsPerNode": 1, "nodeSize": "Standard_D1_v2", "numberOfNodes": 1 }, "ssisProperties": { "catalogInfo": { "catalogAdminPassword": { "type": "SecureString", "value": "Passw0rd1" }, "catalogAdminUserName": "yanzhang", "catalogPricingTier": "S1", "catalogServerEndpoint": "yandongtestsvr.database.windows.net" }, "licenseType": "BasePrice" } } } }, "integrationRuntimeName": "exampleIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "0100333d-0000-0000-0000-5a1d0ab80000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", "name": "exampleIntegrationRuntime", "properties": { "description": "A managed reserved integration runtime", "state": "Initial", "type": "Managed", "typeProperties": { "computeProperties": { "location": "West US", "maxParallelExecutionsPerNode": 1, "nodeSize": "Standard_D1_v2", "numberOfNodes": 1 }, "ssisProperties": { "catalogInfo": { "catalogAdminPassword": { "type": "SecureString", "value": "**********" }, "catalogAdminUserName": "yanzhang", "catalogPricingTier": "S1", "catalogServerEndpoint": "yandongtestsvr.database.windows.net" }, "licenseType": "BasePrice" } } } }, "headers": { "Date": "Tue, 28 Nov 2017 07:05:28 GMT", "X-Content-Type-Options": "nosniff", "x-ms-request-id": "ef607971-0494-480e-82e7-73df0c671d9e" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo": { "post": { "description": "Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.", "operationId": "IntegrationRuntimes_GetConnectionInfo", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "additionalProperties": { "type": "object" }, "description": "Connection information for encrypting the on-premises data source credentials.", "properties": { "hostServiceUri": { "description": "The on-premises integration runtime host URL.", "readOnly": true, "type": "string" }, "identityCertThumbprint": { "description": "The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation.", "readOnly": true, "type": "string" }, "isIdentityCertExprired": { "description": "Whether the identity certificate is expired.", "readOnly": true, "type": "boolean" }, "publicKey": { "description": "The public key for encrypting a credential when transferring the credential to the integration runtime.", "readOnly": true, "type": "string" }, "serviceToken": { "description": "The token generated in service. Callers use this token to authenticate to integration runtime.", "readOnly": true, "type": "string" }, "version": { "description": "The integration runtime version.", "readOnly": true, "type": "string" } }, "type": "object" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_GetConnectionInfo": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "isIdentityCertExprired": false }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:51 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "500722f2-d4e5-4d88-b2d7-5231f158857c", "x-ms-ratelimit-remaining-subscription-writes": "1190", "x-ms-request-id": "c38b64ae-4e0c-488d-8baa-6dc104cecdb2" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus": { "post": { "description": "Gets detailed status information for an integration runtime.", "operationId": "IntegrationRuntimes_GetStatus", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/IntegrationRuntimeStatusResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_GetStatus": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "name": "exampleIntegrationRuntime", "properties": { "dataFactoryLocation": "West US", "resourceUri": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", "state": "Initial", "type": "Managed", "typeProperties": {} } }, "headers": { "Date": "Tue, 28 Nov 2017 07:05:31 GMT", "X-Content-Type-Options": "nosniff", "x-ms-request-id": "3a638bbf-1dfe-4def-b71d-96d121c42389" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys": { "post": { "description": "Retrieves the authentication keys for an integration runtime.", "operationId": "IntegrationRuntimes_ListAuthKeys", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "description": "The integration runtime authentication keys.", "properties": { "authKey1": { "description": "The primary integration runtime authentication key.", "type": "string" }, "authKey2": { "description": "The secondary integration runtime authentication key.", "type": "string" } }, "type": "object" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_ListAuthKeys": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "authKey1": "IR@1baad24d-93e5-4074-8eeb-cd93fbb83b42@exampleFactoryName@eu@T5VHZgY8pqkdqoxok31dk8irrVOkhdnR6Ht8if1OebY=", "authKey2": "IR@1baad24d-93e5-4074-8eeb-cd93fbb83b42@exampleFactoryName@eu@W6N1MtqwVoVSSa2HYzmJrj/NArFcy0xaU392cIZX1sI=" }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:52 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "a4a5f951-227f-4eb7-8471-a5dbe51c9b8b", "x-ms-ratelimit-remaining-subscription-writes": "1189", "x-ms-request-id": "eecbf702-ed1d-4839-b235-ede3c87e0f49" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData": { "post": { "description": "Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.", "operationId": "IntegrationRuntimes_GetMonitoringData", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "description": "Get monitoring data response.", "properties": { "name": { "description": "Integration runtime name.", "type": "string" }, "nodes": { "description": "Integration runtime node monitoring data.", "items": { "additionalProperties": { "type": "object" }, "description": "Monitoring data for integration runtime node.", "properties": { "availableMemoryInMB": { "description": "Available memory (MB) on the integration runtime node.", "readOnly": true, "type": "integer" }, "concurrentJobsLimit": { "description": "Maximum concurrent jobs on the integration runtime node.", "readOnly": true, "type": "integer" }, "concurrentJobsRunning": { "description": "The number of jobs currently running on the integration runtime node.", "readOnly": true, "type": "integer" }, "cpuUtilization": { "description": "CPU percentage on the integration runtime node.", "readOnly": true, "type": "number" }, "maxConcurrentJobs": { "description": "The maximum concurrent jobs in this integration runtime.", "readOnly": true, "type": "integer" }, "nodeName": { "description": "Name of the integration runtime node.", "readOnly": true, "type": "string" }, "receivedBytes": { "description": "Received bytes on the integration runtime node.", "readOnly": true, "type": "number" }, "sentBytes": { "description": "Sent bytes on the integration runtime node.", "readOnly": true, "type": "number" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_GetMonitoringData": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "name": "exampleIntegrationRuntime", "nodes": [ { "availableMemory": 17337, "cpuUtilization": 9, "limitConcurrentJobs": 28, "nodeName": "YANZHANG-DT", "receiveBytes": 8.09395694732666, "runningConcurrentJobs": 0, "sendBytes": 1.8606163263320923 } ] }, "headers": { "Date": "Mon, 28 Aug 2017 04:19:53 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "33dfa003-3467-4b84-ae9b-272902990453", "x-ms-ratelimit-remaining-subscription-writes": "1198", "x-ms-request-id": "0116dbdb-c45c-43da-b92d-a6608aece008" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}": { "delete": { "description": "Deletes a self-hosted integration runtime node.", "operationId": "IntegrationRuntimeNodes_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/nodeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK." }, "204": { "description": "No Content." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimeNodes" ], "x-ms-examples": { "IntegrationRuntimesNodes_Delete": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "nodeName": "Node_1", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {}, "204": {} } } } }, "patch": { "description": "Updates a self-hosted integration runtime node.", "operationId": "IntegrationRuntimeNodes_Update", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/nodeName" }, { "$ref": "#/parameters/api-version" }, { "description": "The parameters for updating an integration runtime node.", "in": "body", "name": "updateIntegrationRuntimeNodeRequest", "required": true, "schema": { "$ref": "#/definitions/UpdateIntegrationRuntimeNodeRequest" } } ], "responses": { "200": { "description": "OK.", "schema": { "additionalProperties": { "type": "object" }, "description": "Properties of Self-hosted integration runtime node.", "properties": { "capabilities": { "additionalProperties": { "type": "string" }, "description": "The integration runtime capabilities dictionary", "readOnly": true, "type": "object" }, "concurrentJobsLimit": { "description": "Maximum concurrent jobs on the integration runtime node.", "readOnly": true, "type": "integer" }, "expiryTime": { "description": "The time at which the integration runtime will expire in ISO8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "hostServiceUri": { "description": "URI for the host machine of the integration runtime.", "readOnly": true, "type": "string" }, "isActiveDispatcher": { "description": "Indicates whether this node is the active dispatcher for integration runtime requests.", "readOnly": true, "type": "boolean" }, "lastConnectTime": { "description": "The most recent time at which the integration runtime was connected in ISO8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "lastEndUpdateTime": { "description": "The last time for the integration runtime node update end.", "format": "date-time", "readOnly": true, "type": "string" }, "lastStartTime": { "description": "The time the node last started up.", "format": "date-time", "readOnly": true, "type": "string" }, "lastStartUpdateTime": { "description": "The last time for the integration runtime node update start.", "format": "date-time", "readOnly": true, "type": "string" }, "lastStopTime": { "description": "The integration runtime node last stop time.", "format": "date-time", "readOnly": true, "type": "string" }, "lastUpdateResult": { "description": "The result of the last integration runtime node update.", "enum": [ "Succeed", "Fail" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "IntegrationRuntimeUpdateResult" } }, "machineName": { "description": "Machine name of the integration runtime node.", "readOnly": true, "type": "string" }, "maxConcurrentJobs": { "description": "The maximum concurrent jobs in this integration runtime.", "readOnly": true, "type": "integer" }, "nodeName": { "description": "Name of the integration runtime node.", "readOnly": true, "type": "string" }, "registerTime": { "description": "The time at which the integration runtime node was registered in ISO8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "Status of the integration runtime node.", "enum": [ "NeedRegistration", "Online", "Limited", "Offline", "Upgrading", "Initializing", "InitializeFailed" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "SelfHostedIntegrationRuntimeNodeStatus" } }, "version": { "description": "Version of the integration runtime node.", "readOnly": true, "type": "string" }, "versionStatus": { "description": "Status of the integration runtime node version.", "readOnly": true, "type": "string" } } } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimeNodes" ], "x-ms-examples": { "IntegrationRuntimeNodes_Update": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "nodeName": "Node_1", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc", "updateIntegrationRuntimeNodeRequest": { "concurrentJobsLimit": 2 } }, "responses": { "200": { "body": { "body": { "capabilities": { "connectedToResourceManager": "True", "credentialInSync": "True", "httpsPortEnabled": "True", "nodeEnabled": "True", "serviceBusConnected": "True" }, "concurrentJobsLimit": 2, "hostServiceUri": "https://yanzhang-02.redmond.corp.microsoft.com:8050/HostServiceRemote.svc/", "isActiveDispatcher": true, "lastConnectTime": "2017-11-28T06:51:20.7868013Z", "lastStartTime": "2017-11-28T06:51:20.7868013Z", "lastUpdateResult": "None", "machineName": "YANZHANG-02", "maxConcurrentJobs": 48, "nodeName": "Node_1", "registerTime": "2017-11-28T06:50:38.0809958Z", "status": "Online", "version": "3.2.6519.3", "versionStatus": "UpToDate" }, "request": { "content": { "headers": [ { "key": "Content-Type", "value": [ "application/json; charset=utf-8" ] }, { "key": "Content-Length", "value": [ "32" ] } ] }, "headers": [ { "key": "x-ms-client-request-id", "value": [ "eee2dbec-ee3b-4c5c-a040-d39c88f0f82b" ] }, { "key": "accept-language", "value": [ "en-US" ] }, { "key": "User-Agent", "value": [ "Microsoft.DataTransfer.IntegrationRuntimeService.Client.IntegrationRuntimeServiceClient/0.9.0.0" ] } ], "method": { "method": "PATCH" }, "properties": {}, "requestUri": "https://wu.frontend.int.clouddatahub-int.net/subscriptions/12345678-1234-1234-12345678abc/datafactories/exampleFactoryName/IntegrationRuntimes/exampleIntegrationRuntime/nodes/Node_1?api-version=1.0", "version": { "build": -1, "major": 1, "majorRevision": -1, "minor": 1, "minorRevision": -1, "revision": -1 } }, "response": { "content": { "headers": [ { "key": "Content-Length", "value": [ "607" ] }, { "key": "Content-Type", "value": [ "application/json; charset=utf-8" ] }, { "key": "Expires", "value": [ "-1" ] } ] }, "headers": [ { "key": "Pragma", "value": [ "no-cache" ] }, { "key": "X-Content-Type-Options", "value": [ "nosniff" ] }, { "key": "Cache-Control", "value": [ "no-cache" ] }, { "key": "Date", "value": [ "Tue, 28 Nov 2017 06:51:37 GMT" ] }, { "key": "Server", "value": [ "Microsoft-IIS/8.5" ] }, { "key": "X-AspNet-Version", "value": [ "4.0.30319" ] } ], "isSuccessStatusCode": true, "reasonPhrase": "OK", "requestMessage": { "content": { "headers": [ { "key": "Content-Type", "value": [ "application/json; charset=utf-8" ] }, { "key": "Content-Length", "value": [ "32" ] } ] }, "headers": [ { "key": "x-ms-client-request-id", "value": [ "eee2dbec-ee3b-4c5c-a040-d39c88f0f82b" ] }, { "key": "accept-language", "value": [ "en-US" ] }, { "key": "User-Agent", "value": [ "Microsoft.DataTransfer.IntegrationRuntimeService.Client.IntegrationRuntimeServiceClient/0.9.0.0" ] } ], "method": { "method": "PATCH" }, "properties": {}, "requestUri": "https://wu.frontend.int.clouddatahub-int.net/subscriptions/12345678-1234-1234-12345678abc/datafactories/exampleFactoryName/IntegrationRuntimes/exampleIntegrationRuntime/nodes/Node_1?api-version=1.0", "version": { "build": -1, "major": 1, "majorRevision": -1, "minor": 1, "minorRevision": -1, "revision": -1 } }, "statusCode": 200, "version": { "build": -1, "major": 1, "majorRevision": -1, "minor": 1, "minorRevision": -1, "revision": -1 } } }, "headers": { "Date": "Tue, 28 Nov 2017 06:51:38 GMT", "X-Content-Type-Options": "nosniff", "x-ms-request-id": "eee2dbec-ee3b-4c5c-a040-d39c88f0f82b" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress": { "post": { "description": "Get the IP address of self-hosted integration runtime node.", "operationId": "IntegrationRuntimeNodes_GetIpAddress", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/nodeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "description": "The IP address of self-hosted integration runtime node.", "properties": { "ipAddress": { "description": "The IP address of self-hosted integration runtime node.", "readOnly": true, "type": "string" } }, "type": "object" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimeNodes" ], "x-ms-examples": { "IntegrationRuntimeNodes_GetIpAddress": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "nodeName": "YANZHANG-02", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "ipAddress": "***" }, "headers": { "Date": "Tue, 14 Nov 2017 03:29:46 GMT", "X-Content-Type-Options": "nosniff", "x-ms-request-id": "6ba794e4-da5a-4760-afa8-1c68a2c9f487" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey": { "post": { "description": "Regenerates the authentication key for an integration runtime.", "operationId": "IntegrationRuntimes_RegenerateAuthKey", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" }, { "description": "The parameters for regenerating integration runtime authentication key.", "in": "body", "name": "regenerateKeyParameters", "required": true, "schema": { "description": "Parameters to regenerate the authentication key.", "properties": { "keyName": { "description": "The name of the authentication key to regenerate.", "enum": [ "authKey1", "authKey2" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "IntegrationRuntimeAuthKeyName" } } }, "type": "object" } } ], "responses": { "200": { "description": "OK.", "schema": { "description": "The integration runtime authentication keys.", "properties": { "authKey1": { "description": "The primary integration runtime authentication key.", "type": "string" }, "authKey2": { "description": "The secondary integration runtime authentication key.", "type": "string" } }, "type": "object" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_RegenerateAuthKey": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "regenerateKeyParameters": { "keyName": "authKey2" }, "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "authKey2": "IR@1baad24d-93e5-4074-8eeb-cd93fbb83b42@exampleFactoryName@eu@IYLMSMWzzjQswOJHrTJNZc2SGwWla/SQ3QraZs3wqbw=" }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:52 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "46ee8708-affc-403d-ab9f-53824b169fdf", "x-ms-ratelimit-remaining-subscription-writes": "1188", "x-ms-request-id": "706b5711-16e1-455b-808a-30cc120a061c" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeNode": { "post": { "description": "Remove a node from integration runtime.", "operationId": "IntegrationRuntimes_RemoveNode", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" }, { "description": "The name of the node to be removed from an integration runtime.", "in": "body", "name": "removeNodeParameters", "required": true, "schema": { "additionalProperties": { "type": "object" }, "description": "Request to remove a node.", "properties": { "nodeName": { "description": "The name of the node to be removed.", "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "OK." }, "204": { "description": "No Content." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_RemoveNode": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "removeNodeParameters": { "nodeName": "Node_1" }, "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {}, "204": {} } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start": { "post": { "description": "Starts a ManagedReserved type integration runtime.", "operationId": "IntegrationRuntimes_Start", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/IntegrationRuntimeStatusResponse" } }, "202": { "description": "Accepted." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_Start": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleManagedIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "name": "exampleManagedIntegrationRuntime", "properties": { "state": "Started", "type": "Managed", "typeProperties": { "createTime": "2017-11-28T07:17:56.5930407Z", "lastOperation": { "parameters": [], "result": "Succeeded", "startTime": "2017-11-28T07:17:58.6556933Z", "type": "Start" }, "nodes": [ { "errors": [ { "code": "AzureSqlConnectionFailure", "message": "Sql Error Number: 18456", "parameters": [], "time": "2017-11-28T07:38:41.50199Z" } ], "nodeId": "tvm-1650185656_1-20171128t071919z", "status": "Unavailable" } ], "otherErrors": [], "state": "Started" } } }, "headers": { "Date": "Tue, 28 Nov 2017 07:39:18 GMT", "X-Content-Type-Options": "nosniff", "x-ms-request-id": "a0190274-060e-43a0-84ea-403d1c0c4a06" } }, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop": { "post": { "description": "Stops a ManagedReserved type integration runtime.", "operationId": "IntegrationRuntimes_Stop", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK." }, "202": { "description": "Accepted." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_Stop": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleManagedIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {}, "202": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials": { "post": { "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.", "operationId": "IntegrationRuntimes_SyncCredentials", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_SyncCredentials": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {} } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade": { "post": { "description": "Upgrade self-hosted integration runtime to latest version if availability.", "operationId": "IntegrationRuntimes_Upgrade", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "integrationRuntimes" ], "x-ms-examples": { "IntegrationRuntimes_Upgrade": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "integrationRuntimeName": "exampleIntegrationRuntime", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {} } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices": { "get": { "description": "Lists linked services.", "operationId": "LinkedServices_ListByFactory", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/LinkedServiceListResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "linkedServices" ], "x-ms-examples": { "LinkedServices_ListByFactory": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "value": [ { "etag": "28031da7-0000-0000-0000-59b971290000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", "name": "exampleLinkedService", "properties": { "description": "Example description", "type": "AzureStorage", "typeProperties": { "connectionString": { "type": "SecureString", "value": "**********" } } } } ] }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:54 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "4864247b-bf7c-4bc6-8d34-4a2bcebdb473", "x-ms-ratelimit-remaining-subscription-reads": "14913", "x-ms-request-id": "b78883ab-f299-495e-ad30-804003deb775" } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}": { "delete": { "description": "Deletes a linked service.", "operationId": "LinkedServices_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/linkedServiceName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK." }, "204": { "description": "No Content." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "linkedServices" ], "x-ms-examples": { "LinkedServices_Delete": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "linkedServiceName": "exampleLinkedService", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {}, "204": {} } } } }, "get": { "description": "Gets a linked service.", "operationId": "LinkedServices_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/linkedServiceName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/LinkedServiceResource" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "linkedServices" ], "x-ms-examples": { "LinkedServices_Get": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "linkedServiceName": "exampleLinkedService", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "28031da7-0000-0000-0000-59b971290000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", "name": "exampleLinkedService", "properties": { "description": "Example description", "type": "AzureStorage", "typeProperties": { "connectionString": { "type": "SecureString", "value": "**********" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:53 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "a9524daa-23b7-48ef-985c-9f5a0136acea", "x-ms-ratelimit-remaining-subscription-reads": "14914", "x-ms-request-id": "d0d69de8-5acc-4ef4-bf5b-340328408cb2" } } } } } }, "put": { "description": "Creates or updates a linked service.", "operationId": "LinkedServices_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/linkedServiceName" }, { "$ref": "#/parameters/api-version" }, { "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.", "in": "header", "name": "If-Match", "required": false, "type": "string" }, { "description": "Linked service resource definition.", "in": "body", "name": "linkedService", "required": true, "schema": { "$ref": "#/definitions/LinkedServiceResource" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/LinkedServiceResource" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "linkedServices" ], "x-ms-examples": { "LinkedServices_Create": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "ifMatch": null, "linkedService": { "properties": { "type": "AzureStorage", "typeProperties": { "connectionString": { "type": "SecureString", "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=" } } } }, "linkedServiceName": "exampleLinkedService", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "28031ca7-0000-0000-0000-59b971290000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", "name": "exampleLinkedService", "properties": { "type": "AzureStorage", "typeProperties": { "connectionString": { "type": "SecureString", "value": "**********" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:53 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "866e9410-908e-4bf7-9d44-d3886325787b", "x-ms-ratelimit-remaining-subscription-writes": "1186", "x-ms-request-id": "6c8f770c-0873-4d97-b9b1-f21eafa81eeb" } } } }, "LinkedServices_Update": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "ifMatch": null, "linkedService": { "properties": { "description": "Example description", "type": "AzureStorage", "typeProperties": { "connectionString": { "type": "SecureString", "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=" } } } }, "linkedServiceName": "exampleLinkedService", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "28031da7-0000-0000-0000-59b971290000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", "name": "exampleLinkedService", "properties": { "description": "Example description", "type": "AzureStorage", "typeProperties": { "connectionString": { "type": "SecureString", "value": "**********" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:53 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "5fe435da-a93c-498d-aee3-8118de9ef4aa", "x-ms-ratelimit-remaining-subscription-writes": "1185", "x-ms-request-id": "1b67d903-bb60-42b1-a91a-3aec5ab6f3a5" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns": { "post": { "description": "Query pipeline runs in the factory based on input filter conditions.", "operationId": "PipelineRuns_QueryByFactory", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/api-version" }, { "description": "Parameters to filter the pipeline run.", "in": "body", "name": "filterParameters", "required": true, "schema": { "$ref": "#/definitions/PipelineRunFilterParameters" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/PipelineRunQueryResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "pipelineruns" ], "x-ms-examples": { "PipelineRuns_QueryByFactory": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "filterParameters": { "filters": [ { "operand": "PipelineName", "operator": "Equals", "values": [ "examplePipeline" ] } ], "lastUpdatedAfter": "2017-09-13T17:54:57.0811551Z", "lastUpdatedBefore": "2017-09-13T18:07:59.6211018Z" }, "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "value": [ { "durationInMs": 28084, "invokedBy": { "id": "be423891558d4c5294d4b49401a34620", "name": "Manual" }, "lastUpdated": "2017-09-13T17:56:25.2051416Z", "message": "", "parameters": { "OutputBlobNameList": "[\"exampleoutput.csv\"]" }, "pipelineName": "examplePipeline", "runEnd": "2017-09-13T17:56:25.2051416Z", "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", "runStart": "2017-09-13T17:55:57.1202147Z", "status": "Succeeded" } ] }, "headers": { "Date": "Wed, 13 Sep 2017 17:58:09 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "988c8123-bf35-4601-a5d0-8958c1a2114d", "x-ms-ratelimit-remaining-subscription-writes": "1199", "x-ms-request-id": "76f99b48-a79c-4af2-a0f0-0655fead6b24" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}": { "get": { "description": "Get a pipeline run by its run ID.", "operationId": "PipelineRuns_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/runId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/PipelineRun" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "pipelineruns" ], "x-ms-examples": { "PipelineRuns_Get": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "durationInMs": 28084, "invokedBy": { "id": "be423891558d4c5294d4b49401a34620", "name": "Manual" }, "lastUpdated": "2017-09-13T17:56:25.2051416Z", "message": "", "parameters": { "OutputBlobNameList": "[\"exampleoutput.csv\"]" }, "pipelineName": "examplePipeline", "runEnd": "2017-09-13T17:56:25.2051416Z", "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", "runStart": "2017-09-13T17:55:57.1202147Z", "status": "Succeeded" }, "headers": { "Date": "Wed, 13 Sep 2017 17:58:09 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "5ce2fefe-900d-41b6-a4df-6e15421b1d9d", "x-ms-ratelimit-remaining-subscription-reads": "14911", "x-ms-request-id": "751b997c-7971-4c8e-bf84-cc4ee24ba2b7" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/activityruns": { "get": { "description": "List activity runs based on input filter conditions.", "operationId": "ActivityRuns_ListByPipelineRun", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/runId" }, { "$ref": "#/parameters/api-version" }, { "description": "The start time of activity runs in ISO8601 format.", "format": "date-time", "in": "query", "name": "startTime", "required": true, "type": "string" }, { "description": "The end time of activity runs in ISO8601 format.", "format": "date-time", "in": "query", "name": "endTime", "required": true, "type": "string" }, { "description": "The status of the pipeline run.", "in": "query", "name": "status", "required": false, "type": "string" }, { "description": "The name of the activity.", "in": "query", "name": "activityName", "required": false, "type": "string" }, { "description": "The linked service name.", "in": "query", "maxLength": 260, "minLength": 1, "name": "linkedServiceName", "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/ActivityRunsListResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "activityruns" ], "x-ms-examples": { "ActivityRuns_ListByPipelineRun": { "parameters": { "activityName": null, "api-version": "2017-09-01-preview", "endTime": "2017-09-13T18%3A07%3A59.6211018Z", "factoryName": "exampleFactoryName", "linkedServiceName": null, "resourceGroupName": "exampleResourceGroup", "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", "startTime": "2017-09-13T17%3A54%3A57.0811551Z", "status": null, "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "value": [ { "activityName": "ExampleForeachActivity", "activityRunEnd": "2017-09-13T17:56:24.580131Z", "activityRunId": "c80e9e66-3c32-4f79-a3bb-1677599e3bcd", "activityRunStart": "2017-09-13T17:56:00.0758597Z", "activityType": "ForEach", "durationInMs": 24504, "error": { "errorCode": "", "failureType": "", "message": "", "target": "ExampleForeachActivity" }, "input": { "activities": [ { "inputs": [ { "parameters": { "MyFileName": "examplecontainer.csv", "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "name": "ExampleCopyActivity", "outputs": [ { "parameters": { "MyFileName": "@item()", "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "type": "Copy", "typeProperties": { "sink": { "type": "BlobSink" }, "source": { "type": "BlobSource" } } } ], "isSequential": true, "items": "@pipeline().parameters.OutputBlobNameList" }, "linkedServiceName": "", "output": {}, "pipelineName": "examplePipeline", "pipelineRunId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", "status": "Succeeded" }, { "activityName": "ExampleCopyActivity", "activityRunEnd": "2017-09-13T17:56:20.0331458Z", "activityRunId": "b8bee996-143b-4f20-ace1-307cc1a0d75d", "activityRunStart": "2017-09-13T17:56:01.1719894Z", "activityType": "Copy", "durationInMs": 18861, "error": { "errorCode": "", "failureType": "", "message": "", "target": "ExampleCopyActivity" }, "input": { "sink": { "type": "BlobSink" }, "source": { "type": "BlobSource" } }, "linkedServiceName": "", "output": { "copyDuration": 4, "dataRead": 142000, "dataWritten": 142000, "errors": [], "throughput": 34.66797 }, "pipelineName": "examplePipeline", "pipelineRunId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", "status": "Succeeded" } ] }, "headers": { "Date": "Wed, 13 Sep 2017 17:58:20 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "4ac11d09-28a5-405c-927b-88f1052fd56e", "x-ms-ratelimit-remaining-subscription-reads": "14910", "x-ms-request-id": "016fce3e-f314-49ef-ac45-b10e494f1638" } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines": { "get": { "description": "Lists pipelines.", "operationId": "Pipelines_ListByFactory", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/PipelineListResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "pipelines" ], "x-ms-examples": { "Pipelines_ListByFactory": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "value": [ { "etag": "280324a7-0000-0000-0000-59b9712b0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", "name": "examplePipeline", "properties": { "activities": [ { "name": "ExampleForeachActivity", "type": "ForEach", "typeProperties": { "activities": [ { "inputs": [ { "parameters": { "MyFileName": "examplecontainer.csv", "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "name": "ExampleCopyActivity", "outputs": [ { "parameters": { "MyFileName": { "type": "Expression", "value": "@item()" }, "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "type": "Copy", "typeProperties": { "sink": { "type": "BlobSink" }, "source": { "type": "BlobSource" } } } ], "isSequential": true, "items": { "type": "Expression", "value": "@pipeline().parameters.OutputBlobNameList" } } } ], "description": "Example description", "parameters": { "OutputBlobNameList": { "type": "Array" } } } } ] }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:56 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "fa5fe506-baa4-4974-9d0a-0d79da341bd8", "x-ms-ratelimit-remaining-subscription-reads": "14909", "x-ms-request-id": "a8129560-dc5c-4312-9c3e-22fc00f9033f" } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}": { "delete": { "description": "Deletes a pipeline.", "operationId": "Pipelines_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/pipelineName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK." }, "204": { "description": "No Content." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "pipelines" ], "x-ms-examples": { "Pipelines_Delete": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "pipelineName": "examplePipeline", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": {}, "204": {} } } } }, "get": { "description": "Gets a pipeline.", "operationId": "Pipelines_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/pipelineName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/PipelineResource" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "pipelines" ], "x-ms-examples": { "Pipelines_Get": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "pipelineName": "examplePipeline", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "280324a7-0000-0000-0000-59b9712b0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", "name": "examplePipeline", "properties": { "activities": [ { "name": "ExampleForeachActivity", "type": "ForEach", "typeProperties": { "activities": [ { "inputs": [ { "parameters": { "MyFileName": "examplecontainer.csv", "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "name": "ExampleCopyActivity", "outputs": [ { "parameters": { "MyFileName": { "type": "Expression", "value": "@item()" }, "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "type": "Copy", "typeProperties": { "sink": { "type": "BlobSink" }, "source": { "type": "BlobSource" } } } ], "isSequential": true, "items": { "type": "Expression", "value": "@pipeline().parameters.OutputBlobNameList" } } } ], "description": "Example description", "parameters": { "OutputBlobNameList": { "type": "Array" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:56 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "80f036bf-e6a7-4248-8ea4-fba427e19c79", "x-ms-ratelimit-remaining-subscription-reads": "14910", "x-ms-request-id": "f43d67bd-6702-4113-9b00-6ce0390f07ea" } } } } } }, "put": { "description": "Creates or updates a pipeline.", "operationId": "Pipelines_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/pipelineName" }, { "$ref": "#/parameters/api-version" }, { "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.", "in": "header", "name": "If-Match", "required": false, "type": "string" }, { "description": "Pipeline resource definition.", "in": "body", "name": "pipeline", "required": true, "schema": { "$ref": "#/definitions/PipelineResource" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/PipelineResource" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "pipelines" ], "x-ms-examples": { "Pipelines_Create": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "ifMatch": null, "pipeline": { "properties": { "activities": [ { "name": "ExampleForeachActivity", "type": "ForEach", "typeProperties": { "activities": [ { "inputs": [ { "parameters": { "MyFileName": "examplecontainer.csv", "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "name": "ExampleCopyActivity", "outputs": [ { "parameters": { "MyFileName": { "type": "Expression", "value": "@item()" }, "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "type": "Copy", "typeProperties": { "sink": { "type": "BlobSink" }, "source": { "type": "BlobSource" } } } ], "isSequential": true, "items": { "type": "Expression", "value": "@pipeline().parameters.OutputBlobNameList" } } } ], "parameters": { "OutputBlobNameList": { "type": "Array" } } } }, "pipelineName": "examplePipeline", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "280321a7-0000-0000-0000-59b9712b0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", "name": "examplePipeline", "properties": { "activities": [ { "name": "ExampleForeachActivity", "type": "ForEach", "typeProperties": { "activities": [ { "inputs": [ { "parameters": { "MyFileName": "examplecontainer.csv", "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "name": "ExampleCopyActivity", "outputs": [ { "parameters": { "MyFileName": { "type": "Expression", "value": "@item()" }, "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "type": "Copy", "typeProperties": { "sink": { "type": "BlobSink" }, "source": { "type": "BlobSource" } } } ], "isSequential": true, "items": { "type": "Expression", "value": "@pipeline().parameters.OutputBlobNameList" } } } ], "parameters": { "OutputBlobNameList": { "type": "Array" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:55 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "69c3f715-8fd9-4448-a8ee-becbde571aec", "x-ms-ratelimit-remaining-subscription-writes": "1182", "x-ms-request-id": "6cc3413e-9afa-487e-aeff-45bc6285470b" } } } }, "Pipelines_Update": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "ifMatch": null, "pipeline": { "properties": { "activities": [ { "name": "ExampleForeachActivity", "type": "ForEach", "typeProperties": { "activities": [ { "inputs": [ { "parameters": { "MyFileName": "examplecontainer.csv", "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "name": "ExampleCopyActivity", "outputs": [ { "parameters": { "MyFileName": { "type": "Expression", "value": "@item()" }, "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "type": "Copy", "typeProperties": { "sink": { "type": "BlobSink" }, "source": { "type": "BlobSource" } } } ], "isSequential": true, "items": { "type": "Expression", "value": "@pipeline().parameters.OutputBlobNameList" } } } ], "description": "Example description", "parameters": { "OutputBlobNameList": { "type": "Array" } } } }, "pipelineName": "examplePipeline", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "etag": "280324a7-0000-0000-0000-59b9712b0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", "name": "examplePipeline", "properties": { "activities": [ { "name": "ExampleForeachActivity", "type": "ForEach", "typeProperties": { "activities": [ { "inputs": [ { "parameters": { "MyFileName": "examplecontainer.csv", "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "name": "ExampleCopyActivity", "outputs": [ { "parameters": { "MyFileName": { "type": "Expression", "value": "@item()" }, "MyFolderPath": "examplecontainer" }, "referenceName": "exampleDataset", "type": "DatasetReference" } ], "type": "Copy", "typeProperties": { "sink": { "type": "BlobSink" }, "source": { "type": "BlobSource" } } } ], "isSequential": true, "items": { "type": "Expression", "value": "@pipeline().parameters.OutputBlobNameList" } } } ], "description": "Example description", "parameters": { "OutputBlobNameList": { "type": "Array" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:55 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "0bdb8812-2d23-4619-9582-2f16c2434e68", "x-ms-ratelimit-remaining-subscription-writes": "1181", "x-ms-request-id": "593b4383-377c-4e4d-8141-c6e76d313b8f" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun": { "post": { "description": "Creates a run of a pipeline.", "operationId": "Pipelines_CreateRun", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/pipelineName" }, { "$ref": "#/parameters/api-version" }, { "description": "Parameters of the pipeline run.", "in": "body", "name": "parameters", "required": false, "schema": { "$ref": "#/definitions/ParameterValueSpecification" } } ], "responses": { "202": { "description": "Accepted.", "schema": { "$ref": "#/definitions/CreateRunResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "pipelines" ], "x-ms-examples": { "Pipelines_CreateRun": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "parameters": { "OutputBlobNameList": [ "exampleoutput.csv" ] }, "pipelineName": "examplePipeline", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "202": { "body": { "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e" }, "headers": { "Date": "Wed, 13 Sep 2017 17:55:58 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "15d0c07a-603f-42c7-98ba-872b0eff2326", "x-ms-ratelimit-remaining-subscription-writes": "1180", "x-ms-request-id": "a420e4fd-ebe9-4758-8db7-852b4d06245e" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers": { "get": { "description": "Lists triggers.", "operationId": "Triggers_ListByFactory", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/TriggerListResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "triggers" ], "x-ms-examples": { "Triggers_ListByFactory": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc" }, "responses": { "200": { "body": { "value": [ { "etag": "28032ca7-0000-0000-0000-59b971be0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", "name": "exampleTrigger", "properties": { "description": "Example description", "pipelines": [ { "parameters": { "OutputBlobNameList": [ "exampleoutput.csv" ] }, "pipelineReference": { "referenceName": "examplePipeline", "type": "PipelineReference" } } ], "runtimeState": "Started", "type": "ScheduleTrigger", "typeProperties": { "recurrence": { "endTime": "2017-09-13T18:13:21.7240518Z", "frequency": "Minute", "interval": 4, "startTime": "2017-09-13T17:57:21.7240518Z", "timeZone": "UTC" } } } } ] }, "headers": { "Date": "Wed, 13 Sep 2017 17:58:23 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "3b7c2a31-c772-447e-a657-c572a8354119", "x-ms-ratelimit-remaining-subscription-reads": "14908", "x-ms-request-id": "d56fed8c-4033-427d-9fda-d4b8fc53e6b1" } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}": { "delete": { "description": "Deletes a trigger.", "operationId": "Triggers_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/triggerName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK." }, "204": { "description": "No Content." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "triggers" ], "x-ms-examples": { "Triggers_Delete": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc", "triggerName": "exampleTrigger" }, "responses": { "200": {}, "204": {} } } } }, "get": { "description": "Gets a trigger.", "operationId": "Triggers_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/triggerName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/TriggerResource" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "trigger" ], "x-ms-examples": { "Triggers_Get": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc", "triggerName": "exampleTrigger" }, "responses": { "200": { "body": { "etag": "28032ba7-0000-0000-0000-59b971bd0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", "name": "exampleTrigger", "properties": { "description": "Example description", "pipelines": [ { "parameters": { "OutputBlobNameList": [ "exampleoutput.csv" ] }, "pipelineReference": { "referenceName": "examplePipeline", "type": "PipelineReference" } } ], "runtimeState": "Stopped", "type": "ScheduleTrigger", "typeProperties": { "recurrence": { "endTime": "2017-09-13T18:13:21.7240518Z", "frequency": "Minute", "interval": 4, "startTime": "2017-09-13T17:57:21.7240518Z", "timeZone": "UTC" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:58:22 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "ca0d1b97-970b-494d-b7bb-b87692327db0", "x-ms-ratelimit-remaining-subscription-reads": "14909", "x-ms-request-id": "bef4032e-cc3c-4ae7-b153-d1fdead84665" } } } } } }, "put": { "description": "Creates or updates a trigger.", "operationId": "Triggers_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/triggerName" }, { "$ref": "#/parameters/api-version" }, { "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.", "in": "header", "name": "If-Match", "required": false, "type": "string" }, { "description": "Trigger resource definition.", "in": "body", "name": "trigger", "required": true, "schema": { "$ref": "#/definitions/TriggerResource" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/TriggerResource" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "triggers" ], "x-ms-examples": { "Triggers_Create": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "ifMatch": null, "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc", "trigger": { "properties": { "pipelines": [ { "parameters": { "OutputBlobNameList": [ "exampleoutput.csv" ] }, "pipelineReference": { "referenceName": "examplePipeline", "type": "PipelineReference" } } ], "type": "ScheduleTrigger", "typeProperties": { "recurrence": { "endTime": "2017-09-13T18:13:20.7835924Z", "frequency": "Minute", "interval": 4, "startTime": "2017-09-13T17:57:20.7835924Z", "timeZone": "UTC" } } } }, "triggerName": "exampleTrigger" }, "responses": { "200": { "body": { "etag": "280327a7-0000-0000-0000-59b971bc0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", "name": "exampleTrigger", "properties": { "pipelines": [ { "parameters": { "OutputBlobNameList": [ "exampleoutput.csv" ] }, "pipelineReference": { "referenceName": "examplePipeline", "type": "PipelineReference" } } ], "runtimeState": "Stopped", "type": "ScheduleTrigger", "typeProperties": { "recurrence": { "endTime": "2017-09-13T18:13:20.7835924Z", "frequency": "Minute", "interval": 4, "startTime": "2017-09-13T17:57:20.7835924Z", "timeZone": "UTC" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:58:21 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "8477d62a-5386-4c52-bf87-fc05a4f11b31", "x-ms-ratelimit-remaining-subscription-writes": "1198", "x-ms-request-id": "3581e103-fcbc-43a1-a8c2-dc086040d0de" } } } }, "Triggers_Update": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "ifMatch": null, "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc", "trigger": { "properties": { "description": "Example description", "pipelines": [ { "parameters": { "OutputBlobNameList": [ "exampleoutput.csv" ] }, "pipelineReference": { "referenceName": "examplePipeline", "type": "PipelineReference" } } ], "type": "ScheduleTrigger", "typeProperties": { "recurrence": { "endTime": "2017-09-13T18:13:21.7240518Z", "frequency": "Minute", "interval": 4, "startTime": "2017-09-13T17:57:21.7240518Z", "timeZone": "UTC" } } } }, "triggerName": "exampleTrigger" }, "responses": { "200": { "body": { "etag": "28032ba7-0000-0000-0000-59b971bd0000", "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", "name": "exampleTrigger", "properties": { "description": "Example description", "pipelines": [ { "parameters": { "OutputBlobNameList": [ "exampleoutput.csv" ] }, "pipelineReference": { "referenceName": "examplePipeline", "type": "PipelineReference" } } ], "runtimeState": "Stopped", "type": "ScheduleTrigger", "typeProperties": { "recurrence": { "endTime": "2017-09-13T18:13:21.7240518Z", "frequency": "Minute", "interval": 4, "startTime": "2017-09-13T17:57:21.7240518Z", "timeZone": "UTC" } } } }, "headers": { "Date": "Wed, 13 Sep 2017 17:58:21 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "f0eff525-3ed5-4488-aa0e-3284c2b400f6", "x-ms-ratelimit-remaining-subscription-writes": "1197", "x-ms-request-id": "aa1aee23-db99-4aee-83e3-36b46ec02829" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/start": { "post": { "description": "Starts a trigger.", "operationId": "Triggers_Start", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/triggerName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Trigger has been started successfully." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "triggers" ], "x-ms-examples": { "Triggers_Start": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc", "triggerName": "exampleTrigger" }, "responses": { "200": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/stop": { "post": { "description": "Stops a trigger.", "operationId": "Triggers_Stop", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/triggerName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Trigger has been stopped successfully." }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "triggers" ], "x-ms-examples": { "Triggers_Stop": { "parameters": { "api-version": "2017-09-01-preview", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "subscriptionId": "12345678-1234-1234-12345678abc", "triggerName": "exampleTrigger" }, "responses": { "200": {} } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerruns": { "get": { "description": "List trigger runs.", "operationId": "Triggers_ListRuns", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/factoryName" }, { "$ref": "#/parameters/triggerName" }, { "$ref": "#/parameters/api-version" }, { "description": "Start time for trigger runs.", "format": "date-time", "in": "query", "name": "startTime", "required": true, "type": "string" }, { "description": "End time for trigger runs.", "format": "date-time", "in": "query", "name": "endTime", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/TriggerRunListResponse" } }, "default": { "description": "An error response received from the Azure Data Factory service.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "tags": [ "triggers" ], "x-ms-examples": { "Triggers_ListRuns": { "parameters": { "api-version": "2017-09-01-preview", "endTime": "2017-09-13T18%3A14%3A24.0440889Z", "factoryName": "exampleFactoryName", "resourceGroupName": "exampleResourceGroup", "startTime": "2017-09-13T17%3A54%3A24.0440889Z", "subscriptionId": "12345678-1234-1234-12345678abc", "triggerName": "exampleTrigger" }, "responses": { "200": { "body": { "value": [ { "message": "", "properties": { "ScheduleTime": "09/13/2017 18:01:21", "TriggerTime": "09/13/2017 18:01:22" }, "status": "Succeeded", "triggerName": "exampleTrigger", "triggerRunId": 8.586962812027444e+27, "triggerRunTimestamp": "2017-09-13T18:01:22.7219263Z", "triggerType": "ScheduleTrigger", "triggeredPipelines": { "examplePipeline": "0bf632a4-98c4-4179-935b-0b220d14fb19" } } ] }, "headers": { "Date": "Wed, 13 Sep 2017 18:04:24 GMT", "X-Content-Type-Options": "nosniff", "x-ms-correlation-request-id": "165d9588-bcba-49ac-a3d9-0dcc49be6c8a", "x-ms-ratelimit-remaining-subscription-reads": "14855", "x-ms-request-id": "c82b86e6-2e81-46e4-8e28-356dd4a15f84" } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "ActivityRun": { "additionalProperties": { "type": "object" }, "description": "Information about an activity run in a pipeline.", "properties": { "activityName": { "description": "The name of the activity.", "readOnly": true, "type": "string" }, "activityRunEnd": { "description": "The end time of the activity run in 'ISO 8601' format.", "format": "date-time", "readOnly": true, "type": "string" }, "activityRunId": { "description": "The id of the activity run.", "readOnly": true, "type": "string" }, "activityRunStart": { "description": "The start time of the activity run in 'ISO 8601' format.", "format": "date-time", "readOnly": true, "type": "string" }, "activityType": { "description": "The type of the activity.", "readOnly": true, "type": "string" }, "durationInMs": { "description": "The duration of the activity run.", "readOnly": true, "type": "integer" }, "error": { "description": "The error if any from the activity run.", "readOnly": true, "type": "object" }, "input": { "description": "The input for the activity.", "readOnly": true, "type": "object" }, "linkedServiceName": { "description": "The name of the compute linked service.", "readOnly": true, "type": "string" }, "output": { "description": "The output for the activity.", "readOnly": true, "type": "object" }, "pipelineName": { "description": "The name of the pipeline.", "readOnly": true, "type": "string" }, "pipelineRunId": { "description": "The id of the pipeline run.", "readOnly": true, "type": "string" }, "status": { "description": "The status of the activity run.", "readOnly": true, "type": "string" } }, "type": "object" }, "ActivityRunsListResponse": { "description": "A list activity runs.", "properties": { "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "value": { "description": "List of activity runs.", "items": { "$ref": "#/definitions/ActivityRun" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "AzureKeyVaultSecretReference": { "allOf": [ { "$ref": "#/definitions/SecretBase" } ], "description": "Azure Key Vault secret reference.", "properties": { "secretName": { "description": "The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).", "type": "object" }, "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).", "type": "object" }, "store": { "$ref": "#/definitions/LinkedServiceReference", "description": "The Azure Key Vault linked service reference." } }, "required": [ "store", "secretName" ], "type": "object", "x-ms-discriminator-value": "AzureKeyVaultSecret" }, "CreateRunResponse": { "description": "Response body with a run identifier.", "properties": { "runId": { "description": "Identifier of a run.", "type": "string" } }, "required": [ "runId" ], "type": "object" }, "DatasetListResponse": { "description": "A list of dataset resources.", "properties": { "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "value": { "description": "List of datasets.", "items": { "$ref": "#/definitions/DatasetResource" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "DatasetReference": { "description": "Dataset reference type.", "properties": { "parameters": { "$ref": "#/definitions/ParameterValueSpecification", "description": "Arguments for dataset." }, "referenceName": { "description": "Reference dataset name.", "type": "string" }, "type": { "description": "Dataset reference type.", "enum": [ "DatasetReference" ], "type": "string" } }, "required": [ "type", "referenceName" ] }, "DatasetResource": { "allOf": [ { "$ref": "#/definitions/SubResource" } ], "description": "Dataset resource type.", "properties": { "properties": { "additionalProperties": { "type": "object" }, "description": "The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.", "discriminator": "type", "properties": { "annotations": { "description": "List of tags that can be used for describing the Dataset.", "items": { "type": "object" }, "type": "array" }, "description": { "description": "Dataset description.", "type": "string" }, "linkedServiceName": { "description": "Linked service reference type.", "properties": { "parameters": { "additionalProperties": { "type": "object" }, "description": "An object mapping parameter names to argument values.", "type": "object" }, "referenceName": { "description": "Reference LinkedService name.", "type": "string" }, "type": { "description": "Linked service reference type.", "enum": [ "LinkedServiceReference" ], "type": "string" } }, "required": [ "type", "referenceName" ] }, "parameters": { "additionalProperties": { "description": "Definition of a single parameter for an entity.", "properties": { "defaultValue": { "description": "Default value of parameter.", "type": "object" }, "type": { "description": "Parameter type.", "enum": [ "Object", "String", "Int", "Float", "Bool", "Array", "SecureString" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ParameterType" } } }, "required": [ "type" ], "type": "object" }, "description": "Definition of all parameters for an entity.", "type": "object" }, "structure": { "description": "Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.", "type": "object" }, "type": { "description": "Type of dataset.", "type": "string" } }, "required": [ "type", "linkedServiceName" ], "type": "object" } }, "required": [ "properties" ] }, "ErrorResponse": { "description": "The object that defines the structure of an Azure Data Factory response.", "properties": { "code": { "description": "Error code.", "type": "string" }, "details": { "description": "Array with additional error details.", "items": { "$ref": "#/definitions/ErrorResponse" }, "type": "array" }, "message": { "description": "Error message.", "type": "string" }, "target": { "description": "Property name/path in request associated with error.", "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "Expression": { "description": "Azure Data Factory expression definition.", "properties": { "type": { "description": "Expression type.", "enum": [ "Expression" ], "type": "string" }, "value": { "description": "Expression value.", "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "Factory": { "additionalProperties": { "type": "object" }, "allOf": [ { "$ref": "#/definitions/Resource" } ], "description": "Factory resource type.", "properties": { "identity": { "$ref": "#/definitions/FactoryIdentity", "description": "Managed service identity of the factory." }, "properties": { "$ref": "#/definitions/FactoryProperties", "description": "Properties of the factory.", "x-ms-client-flatten": true } }, "type": "object" }, "FactoryIdentity": { "description": "Identity properties of the factory resource.", "properties": { "principalId": { "description": "The principal id of the identity.", "format": "uuid", "readOnly": true, "type": "string" }, "tenantId": { "description": "The client tenant id of the identity.", "format": "uuid", "readOnly": true, "type": "string" }, "type": { "description": "The identity type. Currently the only supported type is 'SystemAssigned'.", "enum": [ "SystemAssigned" ], "type": "string", "x-ms-enum": { "modelAsString": false, "name": "FactoryIdentityType" } } }, "required": [ "type" ] }, "FactoryListResponse": { "description": "A list of factory resources.", "properties": { "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "value": { "description": "List of factories.", "items": { "$ref": "#/definitions/Factory" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "FactoryProperties": { "description": "Factory resource properties.", "properties": { "createTime": { "description": "Time the factory was created in ISO8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "provisioningState": { "description": "Factory provisioning state, example Succeeded.", "readOnly": true, "type": "string" }, "version": { "description": "Version of the factory.", "readOnly": true, "type": "string" }, "vstsConfiguration": { "$ref": "#/definitions/FactoryVSTSConfiguration", "description": "VSTS repo information of the factory." } } }, "FactoryRepoUpdate": { "description": "Factory's VSTS repo information.", "properties": { "factoryResourceId": { "description": "The factory resource id.", "type": "string" }, "resourceGroupName": { "description": "The resource group name.", "type": "string" }, "vstsConfiguration": { "$ref": "#/definitions/FactoryVSTSConfiguration", "description": "VSTS repo information of the factory." } } }, "FactoryUpdateParameters": { "description": "Parameters for updating a factory resource.", "properties": { "identity": { "$ref": "#/definitions/FactoryIdentity", "description": "Managed service identity of the factory." }, "tags": { "additionalProperties": { "type": "string" }, "description": "The resource tags.", "type": "object" } } }, "FactoryVSTSConfiguration": { "description": "Factory's VSTS repo information.", "properties": { "accountName": { "description": "VSTS account name.", "type": "string" }, "collaborationBranch": { "description": "VSTS collaboration branch.", "type": "string" }, "lastCommitId": { "description": "VSTS last commit id.", "type": "string" }, "projectName": { "description": "VSTS project name.", "type": "string" }, "repositoryName": { "description": "VSTS repository name.", "type": "string" }, "rootFolder": { "description": "VSTS root folder.", "type": "string" }, "tenantId": { "description": "VSTS tenant id.", "type": "string" } } }, "IntegrationRuntimeListResponse": { "description": "A list of integration runtime resources.", "properties": { "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "value": { "description": "List of integration runtimes.", "items": { "$ref": "#/definitions/IntegrationRuntimeResource" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "IntegrationRuntimeReference": { "description": "Integration runtime reference type.", "properties": { "parameters": { "additionalProperties": { "type": "object" }, "description": "An object mapping parameter names to argument values.", "type": "object" }, "referenceName": { "description": "Reference integration runtime name.", "type": "string" }, "type": { "description": "Type of integration runtime.", "enum": [ "IntegrationRuntimeReference" ], "type": "string" } }, "required": [ "type", "referenceName" ] }, "IntegrationRuntimeResource": { "allOf": [ { "$ref": "#/definitions/SubResource" } ], "description": "Integration runtime resource type.", "properties": { "properties": { "additionalProperties": { "type": "object" }, "description": "Azure Data Factory nested object which serves as a compute resource for activities.", "discriminator": "type", "properties": { "description": { "description": "Integration runtime description.", "type": "string" }, "type": { "description": "The type of integration runtime.", "enum": [ "Managed", "SelfHosted" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "IntegrationRuntimeType" } } }, "required": [ "type" ], "type": "object" } }, "required": [ "properties" ] }, "IntegrationRuntimeStatusListResponse": { "description": "A list of integration runtime status.", "properties": { "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "value": { "description": "List of integration runtime status.", "items": { "$ref": "#/definitions/IntegrationRuntimeStatusResponse" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "IntegrationRuntimeStatusResponse": { "description": "Integration runtime status response.", "properties": { "name": { "description": "The integration runtime name.", "readOnly": true, "type": "string" }, "properties": { "additionalProperties": { "type": "object" }, "description": "Integration runtime status.", "discriminator": "type", "properties": { "dataFactoryName": { "description": "The data factory name which the integration runtime belong to.", "readOnly": true, "type": "string" }, "state": { "description": "The state of integration runtime.", "enum": [ "Initial", "Stopped", "Started", "Starting", "Stopping", "NeedRegistration", "Online", "Limited", "Offline" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "IntegrationRuntimeState" } }, "type": { "description": "The type of integration runtime.", "enum": [ "Managed", "SelfHosted" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "IntegrationRuntimeType" } } }, "type": "object" } }, "required": [ "properties" ] }, "LinkedServiceListResponse": { "description": "A list of linked service resources.", "properties": { "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "value": { "description": "List of linked services.", "items": { "$ref": "#/definitions/LinkedServiceResource" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "LinkedServiceReference": { "description": "Linked service reference type.", "properties": { "parameters": { "additionalProperties": { "type": "object" }, "description": "An object mapping parameter names to argument values.", "type": "object" }, "referenceName": { "description": "Reference LinkedService name.", "type": "string" }, "type": { "description": "Linked service reference type.", "enum": [ "LinkedServiceReference" ], "type": "string" } }, "required": [ "type", "referenceName" ] }, "LinkedServiceResource": { "allOf": [ { "$ref": "#/definitions/SubResource" } ], "description": "Linked service resource type.", "properties": { "properties": { "additionalProperties": { "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.", "discriminator": "type", "properties": { "annotations": { "description": "List of tags that can be used for describing the Dataset.", "items": { "type": "object" }, "type": "array" }, "connectVia": { "description": "Integration runtime reference type.", "properties": { "parameters": { "additionalProperties": { "type": "object" }, "description": "An object mapping parameter names to argument values.", "type": "object" }, "referenceName": { "description": "Reference integration runtime name.", "type": "string" }, "type": { "description": "Type of integration runtime.", "enum": [ "IntegrationRuntimeReference" ], "type": "string" } }, "required": [ "type", "referenceName" ] }, "description": { "description": "Linked service description.", "type": "string" }, "parameters": { "additionalProperties": { "description": "Definition of a single parameter for an entity.", "properties": { "defaultValue": { "description": "Default value of parameter.", "type": "object" }, "type": { "description": "Parameter type.", "enum": [ "Object", "String", "Int", "Float", "Bool", "Array", "SecureString" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ParameterType" } } }, "required": [ "type" ], "type": "object" }, "description": "Definition of all parameters for an entity.", "type": "object" }, "type": { "description": "Type of linked service.", "type": "string" } }, "required": [ "type" ], "type": "object" } }, "required": [ "properties" ] }, "Operation": { "description": "Azure Data Factory API operation definition.", "properties": { "display": { "description": "Metadata associated with the operation.", "properties": { "description": { "description": "The description of the operation.", "type": "string" }, "operation": { "description": "The type of operation: get, read, delete, etc.", "type": "string" }, "provider": { "description": "The name of the provider.", "type": "string" }, "resource": { "description": "The name of the resource type on which the operation is performed.", "type": "string" } } }, "name": { "description": "Operation name: {provider}/{resource}/{operation}", "type": "string" }, "origin": { "description": "The intended executor of the operation.", "type": "string" }, "properties": { "$ref": "#/definitions/OperationProperties", "description": "Additional details about the operation.", "x-ms-client-flatten": true } }, "type": "object" }, "OperationListResponse": { "description": "A list of operations that can be performed by the Data Factory service.", "properties": { "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "value": { "description": "List of Data Factory operations supported by the Data Factory resource provider.", "items": { "$ref": "#/definitions/Operation" }, "type": "array" } } }, "OperationLogSpecification": { "description": "Details about an operation related to logs.", "properties": { "blobDuration": { "description": "Blobs created in the customer storage account, per hour.", "type": "string" }, "displayName": { "description": "Localized display name.", "type": "string" }, "name": { "description": "The name of the log category.", "type": "string" } }, "type": "object" }, "OperationMetricAvailability": { "description": "Defines how often data for a metric becomes available.", "properties": { "blobDuration": { "description": "Blob created in the customer storage account, per hour.", "type": "string" }, "timeGrain": { "description": "The granularity for the metric.", "type": "string" } }, "type": "object" }, "OperationMetricSpecification": { "description": "Details about an operation related to metrics.", "properties": { "aggregationType": { "description": "The type of metric aggregation.", "type": "string" }, "availabilities": { "description": "Defines how often data for metrics becomes available.", "items": { "$ref": "#/definitions/OperationMetricAvailability" }, "type": "array" }, "displayDescription": { "description": "The description of the metric.", "type": "string" }, "displayName": { "description": "Localized display name of the metric.", "type": "string" }, "enableRegionalMdmAccount": { "description": "Whether or not the service is using regional MDM accounts.", "type": "string" }, "name": { "description": "The name of the metric.", "type": "string" }, "sourceMdmAccount": { "description": "The name of the MDM account.", "type": "string" }, "sourceMdmNamespace": { "description": "The name of the MDM namespace.", "type": "string" }, "unit": { "description": "The unit that the metric is measured in.", "type": "string" } }, "type": "object" }, "OperationProperties": { "description": "Additional details about an operation.", "properties": { "serviceSpecification": { "$ref": "#/definitions/OperationServiceSpecification", "description": "Details about a service operation." } }, "type": "object", "x-ms-client-flatten": true }, "OperationServiceSpecification": { "description": "Details about a service operation.", "properties": { "logSpecifications": { "description": "Details about operations related to logs.", "items": { "$ref": "#/definitions/OperationLogSpecification" }, "type": "array" }, "metricSpecifications": { "description": "Details about operations related to metrics.", "items": { "$ref": "#/definitions/OperationMetricSpecification" }, "type": "array" } }, "type": "object" }, "ParameterDefinitionSpecification": { "additionalProperties": { "description": "Definition of a single parameter for an entity.", "properties": { "defaultValue": { "description": "Default value of parameter.", "type": "object" }, "type": { "description": "Parameter type.", "enum": [ "Object", "String", "Int", "Float", "Bool", "Array", "SecureString" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ParameterType" } } }, "required": [ "type" ], "type": "object" }, "description": "Definition of all parameters for an entity.", "type": "object" }, "ParameterSpecification": { "description": "Definition of a single parameter for an entity.", "properties": { "defaultValue": { "description": "Default value of parameter.", "type": "object" }, "type": { "description": "Parameter type.", "enum": [ "Object", "String", "Int", "Float", "Bool", "Array", "SecureString" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ParameterType" } } }, "required": [ "type" ], "type": "object" }, "ParameterValueSpecification": { "additionalProperties": { "type": "object" }, "description": "An object mapping parameter names to argument values.", "type": "object" }, "PipelineListResponse": { "description": "A list of pipeline resources.", "properties": { "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "value": { "description": "List of pipelines.", "items": { "$ref": "#/definitions/PipelineResource" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "PipelineReference": { "description": "Pipeline reference type.", "properties": { "name": { "description": "Reference name.", "type": "string" }, "referenceName": { "description": "Reference pipeline name.", "type": "string" }, "type": { "description": "Pipeline reference type.", "enum": [ "PipelineReference" ], "type": "string" } }, "required": [ "type", "referenceName" ] }, "PipelineResource": { "additionalProperties": { "type": "object" }, "allOf": [ { "$ref": "#/definitions/SubResource" } ], "description": "Pipeline resource type.", "properties": { "properties": { "description": "A data factory pipeline.", "properties": { "activities": { "description": "List of activities in pipeline.", "items": { "additionalProperties": { "type": "object" }, "description": "A pipeline activity.", "discriminator": "type", "properties": { "dependsOn": { "description": "Activity depends on condition.", "items": { "additionalProperties": { "type": "object" }, "description": "Activity dependency information.", "properties": { "activity": { "description": "Activity name.", "type": "string" }, "dependencyConditions": { "description": "Match-Condition for the dependency.", "items": { "enum": [ "Succeeded", "Failed", "Skipped", "Completed" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "DependencyCondition" } }, "type": "array" } }, "required": [ "activity", "dependencyConditions" ], "type": "object" }, "type": "array" }, "description": { "description": "Activity description.", "type": "string" }, "name": { "description": "Activity name.", "type": "string" }, "type": { "description": "Type of activity.", "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" }, "annotations": { "description": "List of tags that can be used for describing the Pipeline.", "items": { "type": "object" }, "type": "array" }, "concurrency": { "description": "The max number of concurrent runs for the pipeline.", "minimum": 1, "type": "integer" }, "description": { "description": "The description of the pipeline.", "type": "string" }, "parameters": { "additionalProperties": { "description": "Definition of a single parameter for an entity.", "properties": { "defaultValue": { "description": "Default value of parameter.", "type": "object" }, "type": { "description": "Parameter type.", "enum": [ "Object", "String", "Int", "Float", "Bool", "Array", "SecureString" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ParameterType" } } }, "required": [ "type" ], "type": "object" }, "description": "Definition of all parameters for an entity.", "type": "object" } }, "type": "object" } }, "required": [ "properties" ], "type": "object" }, "PipelineRun": { "additionalProperties": { "type": "object" }, "description": "Information about a pipeline run.", "properties": { "durationInMs": { "description": "The duration of a pipeline run.", "readOnly": true, "type": "integer" }, "invokedBy": { "$ref": "#/definitions/PipelineRunInvokedBy", "description": "Entity that started the pipeline run.", "readOnly": true }, "lastUpdated": { "description": "The last updated timestamp for the pipeline run event in ISO8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "message": { "description": "The message from a pipeline run.", "readOnly": true, "type": "string" }, "parameters": { "additionalProperties": { "type": "string" }, "description": "The full or partial list of parameter name, value pair used in the pipeline run.", "readOnly": true, "type": "object" }, "pipelineName": { "description": "The pipeline name.", "readOnly": true, "type": "string" }, "runEnd": { "description": "The end time of a pipeline run in ISO8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "runId": { "description": "Identifier of a run.", "readOnly": true, "type": "string" }, "runStart": { "description": "The start time of a pipeline run in ISO8601 format.", "format": "date-time", "readOnly": true, "type": "string" }, "status": { "description": "The status of a pipeline run.", "readOnly": true, "type": "string" } }, "type": "object" }, "PipelineRunFilterParameters": { "description": "Query parameters for listing pipeline runs.", "properties": { "continuationToken": { "description": "The continuation token for getting the next page of results. Null for first page.", "type": "string" }, "filters": { "description": "List of filters.", "items": { "$ref": "#/definitions/PipelineRunQueryFilter" }, "type": "array" }, "lastUpdatedAfter": { "description": "The time at or after which the pipeline run event was updated in 'ISO 8601' format.", "format": "date-time", "type": "string" }, "lastUpdatedBefore": { "description": "The time at or before which the pipeline run event was updated in 'ISO 8601' format.", "format": "date-time", "type": "string" }, "orderBy": { "description": "List of OrderBy option.", "items": { "$ref": "#/definitions/PipelineRunQueryOrderBy" }, "type": "array" } }, "required": [ "lastUpdatedAfter", "lastUpdatedBefore" ], "type": "object" }, "PipelineRunInvokedBy": { "description": "Provides entity name and id that started the pipeline run.", "properties": { "id": { "description": "The ID of the entity that started the run.", "readOnly": true, "type": "string" }, "name": { "description": "Name of the entity that started the pipeline run.", "readOnly": true, "type": "string" } }, "type": "object" }, "PipelineRunQueryFilter": { "description": "Query filter option for listing pipeline runs.", "properties": { "operand": { "description": "Parameter name to be used for filter.", "enum": [ "PipelineName", "Status", "RunStart", "RunEnd" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "PipelineRunQueryFilterOperand" } }, "operator": { "description": "Operator to be used for filter.", "enum": [ "Equals", "NotEquals", "In", "NotIn" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "PipelineRunQueryFilterOperator" } }, "values": { "description": "List of filter values.", "items": { "type": "string" }, "type": "array" } }, "required": [ "operand", "operator", "values" ], "type": "object" }, "PipelineRunQueryOrderBy": { "description": "An object to provide order by options for listing pipeline runs.", "properties": { "order": { "description": "Sorting order of the parameter.", "enum": [ "ASC", "DESC" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "PipelineRunQueryOrder" } }, "orderBy": { "description": "Parameter name to be used for order by.", "enum": [ "RunStart", "RunEnd" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "PipelineRunQueryOrderByField" } } }, "required": [ "orderBy", "order" ], "type": "object" }, "PipelineRunQueryResponse": { "description": "A list pipeline runs.", "properties": { "continuationToken": { "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", "type": "string" }, "value": { "description": "List of pipeline runs.", "items": { "$ref": "#/definitions/PipelineRun" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "Resource": { "description": "Azure Data Factory top-level resource.", "properties": { "id": { "description": "The resource identifier.", "readOnly": true, "type": "string" }, "location": { "description": "The resource location.", "type": "string", "x-ms-mutability": [ "create", "read" ] }, "name": { "description": "The resource name.", "readOnly": true, "type": "string" }, "tags": { "additionalProperties": { "type": "string" }, "description": "The resource tags.", "type": "object" }, "type": { "description": "The resource type.", "readOnly": true, "type": "string" } }, "x-ms-azure-resource": true }, "SecretBase": { "description": "The base definition of a secret type.", "discriminator": "type", "properties": { "type": { "description": "Type of the secret.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "SecureString": { "allOf": [ { "$ref": "#/definitions/SecretBase" } ], "description": "Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.", "properties": { "value": { "description": "Value of secure string.", "type": "string" } }, "required": [ "value" ], "type": "object", "x-ms-discriminator-value": "SecureString" }, "SubResource": { "description": "Azure Data Factory nested resource, which belongs to a factory.", "properties": { "etag": { "description": "Etag identifies change in the resource.", "readOnly": true, "type": "string" }, "id": { "description": "The resource identifier.", "readOnly": true, "type": "string" }, "name": { "description": "The resource name.", "readOnly": true, "type": "string" }, "type": { "description": "The resource type.", "readOnly": true, "type": "string" } }, "x-ms-azure-resource": true }, "TriggerListResponse": { "description": "A list of trigger resources.", "properties": { "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "value": { "description": "List of triggers.", "items": { "$ref": "#/definitions/TriggerResource" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "TriggerPipelineReference": { "description": "Pipeline that needs to be triggered with the given parameters.", "properties": { "parameters": { "$ref": "#/definitions/ParameterValueSpecification", "description": "Pipeline parameters." }, "pipelineReference": { "$ref": "#/definitions/PipelineReference", "description": "Pipeline reference." } } }, "TriggerResource": { "allOf": [ { "$ref": "#/definitions/SubResource" } ], "description": "Trigger resource type.", "properties": { "properties": { "additionalProperties": { "type": "object" }, "description": "Azure data factory nested object which contains information about creating pipeline run", "discriminator": "type", "properties": { "description": { "description": "Trigger description.", "type": "string" }, "runtimeState": { "description": "Enumerates possible state of Triggers.", "enum": [ "Started", "Stopped", "Disabled" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "TriggerRuntimeState" } }, "type": { "description": "Trigger type.", "type": "string" } }, "required": [ "type" ], "type": "object" } }, "required": [ "properties" ] }, "TriggerRun": { "additionalProperties": { "type": "object" }, "description": "Trigger runs.", "properties": { "message": { "description": "Trigger error message.", "readOnly": true, "type": "string" }, "properties": { "additionalProperties": { "type": "string" }, "description": "List of property name and value related to trigger run. Name, value pair depends on type of trigger.", "readOnly": true, "type": "object" }, "status": { "description": "Trigger run status.", "enum": [ "Succeeded", "Failed", "Inprogress" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "TriggerRunStatus" } }, "triggerName": { "description": "Trigger name.", "readOnly": true, "type": "string" }, "triggerRunId": { "description": "Trigger run id.", "readOnly": true, "type": "string" }, "triggerRunTimestamp": { "description": "Trigger run start time.", "format": "date-time", "readOnly": true, "type": "string" }, "triggerType": { "description": "Trigger type.", "readOnly": true, "type": "string" }, "triggeredPipelines": { "additionalProperties": { "type": "string" }, "description": "List of pipeline name and run Id triggered by the trigger run.", "readOnly": true, "type": "object" } }, "type": "object" }, "TriggerRunListResponse": { "description": "A list of trigger runs.", "properties": { "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "value": { "description": "List of trigger runs.", "items": { "$ref": "#/definitions/TriggerRun" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "UpdateIntegrationRuntimeNodeRequest": { "description": "Update integration runtime node request.", "properties": { "concurrentJobsLimit": { "description": "The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.", "minimum": 1, "type": "integer" } }, "type": "object" }, "UpdateIntegrationRuntimeRequest": { "description": "Update integration runtime request.", "properties": { "autoUpdate": { "description": "The state of integration runtime auto update.", "enum": [ "On", "Off" ], "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, "name": "IntegrationRuntimeAutoUpdate" } }, "updateDelayOffset": { "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.", "type": "string" } }, "type": "object" } } }