Microsoft.DataFactory (preview:2017-09-01)

2025/09/26 • 50 new, 50 deleted methods

Operations_List (new)
Description :  Lists the available Azure Data Factory API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataFactory/operations
{
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Data Factory operations supported by the Data Factory resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
origin:
{
Description: The intended executor of the operation. ,
Required: False ,
}
string ,
display:
{
Description: Metadata associated with the operation. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
provider:
{
Description: The name of the provider. ,
Required: False ,
}
string ,
resource:
{
Description: The name of the resource type on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional details about the operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Details about a service operation. ,
Required: False ,
}
{
logSpecifications:
{
Description: Details about operations related to logs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the log category. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blobs created in the customer storage account, per hour. ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: Details about operations related to metrics. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: The description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: The unit that the metric is measured in. ,
Required: False ,
}
string ,
aggregationType:
{
Description: The type of metric aggregation. ,
Required: False ,
}
string ,
enableRegionalMdmAccount:
{
Description: Whether or not the service is using regional MDM accounts. ,
Required: False ,
}
string ,
sourceMdmAccount:
{
Description: The name of the MDM account. ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: The name of the MDM namespace. ,
Required: False ,
}
string ,
availabilities:
{
Description: Defines how often data for metrics becomes available. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The granularity for the metric. ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blob created in the customer storage account, per hour. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_List (new)
Description :  Lists factories under the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of factories. ,
Required: True ,
}
[
{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_ConfigureFactoryRepo (new)
Description :  Updates a factory's repo information.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
locationId:
{
Description: The location identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
factoryRepoUpdate:
{
Description: Update factory repo request definition. ,
Required: True ,
}
{
factoryResourceId:
{
Description: The factory resource id. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_ListByResourceGroup (new)
Description :  Lists factories.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of factories. ,
Required: True ,
}
[
{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_CreateOrUpdate (new)
Description :  Creates or updates a factory.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
factory:
{
Description: Factory resource definition. ,
Required: True ,
}
{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_Update (new)
Description :  Updates a factory.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
factoryUpdateParameters:
{
Description: The parameters for updating a factory. ,
Required: True ,
}
{
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_Get (new)
Description :  Gets a factory.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_Delete (new)
Description :  Deletes a factory.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_ListByFactory (new)
Description :  Lists integration runtimes.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of integration runtimes. ,
Required: True ,
}
[
{
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Integration runtime description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_CreateOrUpdate (new)
Description :  Creates or updates an integration runtime.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
integrationRuntime:
{
Description: Integration runtime resource definition. ,
Required: True ,
}
{
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Integration runtime description. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Integration runtime description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Get (new)
Description :  Gets an integration runtime.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Integration runtime description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Update (new)
Description :  Updates an integration runtime.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
updateIntegrationRuntimeRequest:
{
Description: The parameters for updating an integration runtime. ,
Required: True ,
}
{
autoUpdate:
{
Description: Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: The integration runtime name. ,
Required: False ,
}
string ,
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: False ,
}
enum ,
dataFactoryName:
{
Description: The data factory name which the integration runtime belong to. ,
Required: False ,
}
string ,
state:
{
Description: The state of integration runtime. ,
Enum:
{
Initial: No description available. ,
Stopped: No description available. ,
Started: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
NeedRegistration: No description available. ,
Online: No description available. ,
Limited: No description available. ,
Offline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Delete (new)
Description :  Deletes an integration runtime.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_GetStatus (new)
Description :  Gets detailed status information for an integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The integration runtime name. ,
Required: False ,
}
string ,
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: False ,
}
enum ,
dataFactoryName:
{
Description: The data factory name which the integration runtime belong to. ,
Required: False ,
}
string ,
state:
{
Description: The state of integration runtime. ,
Enum:
{
Initial: No description available. ,
Stopped: No description available. ,
Started: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
NeedRegistration: No description available. ,
Online: No description available. ,
Limited: No description available. ,
Offline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_GetConnectionInfo (new)
Description :  Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceToken:
{
Description: The token generated in service. Callers use this token to authenticate to integration runtime. ,
Required: False ,
}
string ,
identityCertThumbprint:
{
Description: The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation. ,
Required: False ,
}
string ,
hostServiceUri:
{
Description: The on-premises integration runtime host URL. ,
Required: False ,
}
string ,
version:
{
Description: The integration runtime version. ,
Required: False ,
}
string ,
publicKey:
{
Description: The public key for encrypting a credential when transferring the credential to the integration runtime. ,
Required: False ,
}
string ,
isIdentityCertExprired:
{
Description: Whether the identity certificate is expired. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_RegenerateAuthKey (new)
Description :  Regenerates the authentication key for an integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
regenerateKeyParameters:
{
Description: The parameters for regenerating integration runtime authentication key. ,
Required: True ,
}
{
keyName:
{
Description: The name of the authentication key to regenerate. ,
Enum:
{
authKey1: No description available. ,
authKey2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
authKey1:
{
Description: The primary integration runtime authentication key. ,
Required: False ,
}
string ,
authKey2:
{
Description: The secondary integration runtime authentication key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_ListAuthKeys (new)
Description :  Retrieves the authentication keys for an integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
authKey1:
{
Description: The primary integration runtime authentication key. ,
Required: False ,
}
string ,
authKey2:
{
Description: The secondary integration runtime authentication key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Start (new)
Description :  Starts a ManagedReserved type integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The integration runtime name. ,
Required: False ,
}
string ,
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: False ,
}
enum ,
dataFactoryName:
{
Description: The data factory name which the integration runtime belong to. ,
Required: False ,
}
string ,
state:
{
Description: The state of integration runtime. ,
Enum:
{
Initial: No description available. ,
Stopped: No description available. ,
Started: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
NeedRegistration: No description available. ,
Online: No description available. ,
Limited: No description available. ,
Offline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Stop (new)
Description :  Stops a ManagedReserved type integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_RemoveNode (new)
Description :  Remove a node from integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeNode
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
removeNodeParameters:
{
Description: The name of the node to be removed from an integration runtime. ,
Required: True ,
}
{
nodeName:
{
Description: The name of the node to be removed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_SyncCredentials (new)
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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_GetMonitoringData (new)
Description :  Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Integration runtime name. ,
Required: False ,
}
string ,
nodes:
{
Description: Integration runtime node monitoring data. ,
Required: False ,
}
[
{
nodeName:
{
Description: Name of the integration runtime node. ,
Required: False ,
}
string ,
availableMemoryInMB:
{
Description: Available memory (MB) on the integration runtime node. ,
Required: False ,
}
integer ,
cpuUtilization:
{
Description: CPU percentage on the integration runtime node. ,
Required: False ,
}
number ,
concurrentJobsLimit:
{
Description: Maximum concurrent jobs on the integration runtime node. ,
Required: False ,
}
integer ,
concurrentJobsRunning:
{
Description: The number of jobs currently running on the integration runtime node. ,
Required: False ,
}
integer ,
maxConcurrentJobs:
{
Description: The maximum concurrent jobs in this integration runtime. ,
Required: False ,
}
integer ,
sentBytes:
{
Description: Sent bytes on the integration runtime node. ,
Required: False ,
}
number ,
receivedBytes:
{
Description: Received bytes on the integration runtime node. ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Upgrade (new)
Description :  Upgrade self-hosted integration runtime to latest version if availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimeNodes_Delete (new)
Description :  Deletes a self-hosted integration runtime node.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
nodeName:
{
Description: The integration runtime node name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimeNodes_Update (new)
Description :  Updates a self-hosted integration runtime node.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
nodeName:
{
Description: The integration runtime node name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
updateIntegrationRuntimeNodeRequest:
{
Description: The parameters for updating an integration runtime node. ,
Required: True ,
}
{
concurrentJobsLimit:
{
Description: The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
nodeName:
{
Description: Name of the integration runtime node. ,
Required: False ,
}
string ,
machineName:
{
Description: Machine name of the integration runtime node. ,
Required: False ,
}
string ,
hostServiceUri:
{
Description: URI for the host machine of the integration runtime. ,
Required: False ,
}
string ,
status:
{
Description: Status of the integration runtime node. ,
Enum:
{
NeedRegistration: No description available. ,
Online: No description available. ,
Limited: No description available. ,
Offline: No description available. ,
Upgrading: No description available. ,
Initializing: No description available. ,
InitializeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
capabilities:
{
Description: The integration runtime capabilities dictionary ,
Required: False ,
}
object ,
versionStatus:
{
Description: Status of the integration runtime node version. ,
Required: False ,
}
string ,
version:
{
Description: Version of the integration runtime node. ,
Required: False ,
}
string ,
registerTime:
{
Description: The time at which the integration runtime node was registered in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastConnectTime:
{
Description: The most recent time at which the integration runtime was connected in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: The time at which the integration runtime will expire in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastStartTime:
{
Description: The time the node last started up. ,
Format: date-time ,
Required: False ,
}
string ,
lastStopTime:
{
Description: The integration runtime node last stop time. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdateResult:
{
Description: The result of the last integration runtime node update. ,
Enum:
{
Succeed: No description available. ,
Fail: No description available. ,
}
,
Required: False ,
}
enum ,
lastStartUpdateTime:
{
Description: The last time for the integration runtime node update start. ,
Format: date-time ,
Required: False ,
}
string ,
lastEndUpdateTime:
{
Description: The last time for the integration runtime node update end. ,
Format: date-time ,
Required: False ,
}
string ,
isActiveDispatcher:
{
Description: Indicates whether this node is the active dispatcher for integration runtime requests. ,
Required: False ,
}
boolean ,
concurrentJobsLimit:
{
Description: Maximum concurrent jobs on the integration runtime node. ,
Required: False ,
}
integer ,
maxConcurrentJobs:
{
Description: The maximum concurrent jobs in this integration runtime. ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimeNodes_GetIpAddress (new)
Description :  Get the IP address of self-hosted integration runtime node.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
nodeName:
{
Description: The integration runtime node name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
ipAddress:
{
Description: The IP address of self-hosted integration runtime node. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
LinkedServices_ListByFactory (new)
Description :  Lists linked services.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of linked services. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
connectVia:
{
Description: The integration runtime reference. ,
Required: False ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
IntegrationRuntimeReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference integration runtime name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for integration runtime. ,
Required: False ,
}
object ,
}
,
description:
{
Description: Linked service description. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for linked service. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
LinkedServices_CreateOrUpdate (new)
Description :  Creates or updates a linked service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: The linked service name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
linkedService:
{
Description: Linked service resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
connectVia:
{
Description: The integration runtime reference. ,
Required: False ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
IntegrationRuntimeReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference integration runtime name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for integration runtime. ,
Required: False ,
}
object ,
}
,
description:
{
Description: Linked service description. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for linked service. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
connectVia:
{
Description: The integration runtime reference. ,
Required: False ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
IntegrationRuntimeReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference integration runtime name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for integration runtime. ,
Required: False ,
}
object ,
}
,
description:
{
Description: Linked service description. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for linked service. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
LinkedServices_Get (new)
Description :  Gets a linked service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: The linked service name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
connectVia:
{
Description: The integration runtime reference. ,
Required: False ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
IntegrationRuntimeReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference integration runtime name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for integration runtime. ,
Required: False ,
}
object ,
}
,
description:
{
Description: Linked service description. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for linked service. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
LinkedServices_Delete (new)
Description :  Deletes a linked service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: The linked service name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_ListByFactory (new)
Description :  Lists datasets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of datasets. ,
Required: True ,
}
[
{
properties:
{
Description: Dataset properties. ,
Required: True ,
}
{
type:
{
Description: Type of dataset. ,
Required: True ,
}
string ,
description:
{
Description: Dataset description. ,
Required: False ,
}
string ,
structure:
{
Description: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. ,
Required: False ,
}
object ,
linkedServiceName:
{
Description: Linked service reference. ,
Required: True ,
}
{
type:
{
Description: Linked service reference type. ,
Enum:
{
LinkedServiceReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference LinkedService name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for LinkedService. ,
Required: False ,
}
object ,
}
,
parameters:
{
Description: Parameters for dataset. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_CreateOrUpdate (new)
Description :  Creates or updates a dataset.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
datasetName:
{
Description: The dataset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
dataset:
{
Description: Dataset resource definition. ,
Required: True ,
}
{
properties:
{
Description: Dataset properties. ,
Required: True ,
}
{
type:
{
Description: Type of dataset. ,
Required: True ,
}
string ,
description:
{
Description: Dataset description. ,
Required: False ,
}
string ,
structure:
{
Description: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. ,
Required: False ,
}
object ,
linkedServiceName:
{
Description: Linked service reference. ,
Required: True ,
}
{
type:
{
Description: Linked service reference type. ,
Enum:
{
LinkedServiceReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference LinkedService name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for LinkedService. ,
Required: False ,
}
object ,
}
,
parameters:
{
Description: Parameters for dataset. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Dataset properties. ,
Required: True ,
}
{
type:
{
Description: Type of dataset. ,
Required: True ,
}
string ,
description:
{
Description: Dataset description. ,
Required: False ,
}
string ,
structure:
{
Description: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. ,
Required: False ,
}
object ,
linkedServiceName:
{
Description: Linked service reference. ,
Required: True ,
}
{
type:
{
Description: Linked service reference type. ,
Enum:
{
LinkedServiceReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference LinkedService name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for LinkedService. ,
Required: False ,
}
object ,
}
,
parameters:
{
Description: Parameters for dataset. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_Get (new)
Description :  Gets a dataset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
datasetName:
{
Description: The dataset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dataset properties. ,
Required: True ,
}
{
type:
{
Description: Type of dataset. ,
Required: True ,
}
string ,
description:
{
Description: Dataset description. ,
Required: False ,
}
string ,
structure:
{
Description: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. ,
Required: False ,
}
object ,
linkedServiceName:
{
Description: Linked service reference. ,
Required: True ,
}
{
type:
{
Description: Linked service reference type. ,
Enum:
{
LinkedServiceReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference LinkedService name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for LinkedService. ,
Required: False ,
}
object ,
}
,
parameters:
{
Description: Parameters for dataset. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_Delete (new)
Description :  Deletes a dataset.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
datasetName:
{
Description: The dataset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Pipelines_ListByFactory (new)
Description :  Lists pipelines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of pipelines. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the pipeline. ,
Required: True ,
}
{
description:
{
Description: The description of the pipeline. ,
Required: False ,
}
string ,
activities:
{
Description: List of activities in pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Activity name. ,
Required: True ,
}
string ,
type:
{
Description: Type of activity. ,
Required: True ,
}
string ,
description:
{
Description: Activity description. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Activity depends on condition. ,
Required: False ,
}
[
{
activity:
{
Description: Activity name. ,
Required: True ,
}
string ,
dependencyConditions:
{
Description: Match-Condition for the dependency. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
concurrency:
{
Description: The max number of concurrent runs for the pipeline. ,
Required: False ,
}
integer ,
annotations:
{
Description: List of tags that can be used for describing the Pipeline. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Pipelines_CreateOrUpdate (new)
Description :  Creates or updates a pipeline.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
pipeline:
{
Description: Pipeline resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of the pipeline. ,
Required: True ,
}
{
description:
{
Description: The description of the pipeline. ,
Required: False ,
}
string ,
activities:
{
Description: List of activities in pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Activity name. ,
Required: True ,
}
string ,
type:
{
Description: Type of activity. ,
Required: True ,
}
string ,
description:
{
Description: Activity description. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Activity depends on condition. ,
Required: False ,
}
[
{
activity:
{
Description: Activity name. ,
Required: True ,
}
string ,
dependencyConditions:
{
Description: Match-Condition for the dependency. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
concurrency:
{
Description: The max number of concurrent runs for the pipeline. ,
Required: False ,
}
integer ,
annotations:
{
Description: List of tags that can be used for describing the Pipeline. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the pipeline. ,
Required: True ,
}
{
description:
{
Description: The description of the pipeline. ,
Required: False ,
}
string ,
activities:
{
Description: List of activities in pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Activity name. ,
Required: True ,
}
string ,
type:
{
Description: Type of activity. ,
Required: True ,
}
string ,
description:
{
Description: Activity description. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Activity depends on condition. ,
Required: False ,
}
[
{
activity:
{
Description: Activity name. ,
Required: True ,
}
string ,
dependencyConditions:
{
Description: Match-Condition for the dependency. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
concurrency:
{
Description: The max number of concurrent runs for the pipeline. ,
Required: False ,
}
integer ,
annotations:
{
Description: List of tags that can be used for describing the Pipeline. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Pipelines_Get (new)
Description :  Gets a pipeline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the pipeline. ,
Required: True ,
}
{
description:
{
Description: The description of the pipeline. ,
Required: False ,
}
string ,
activities:
{
Description: List of activities in pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Activity name. ,
Required: True ,
}
string ,
type:
{
Description: Type of activity. ,
Required: True ,
}
string ,
description:
{
Description: Activity description. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Activity depends on condition. ,
Required: False ,
}
[
{
activity:
{
Description: Activity name. ,
Required: True ,
}
string ,
dependencyConditions:
{
Description: Match-Condition for the dependency. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
concurrency:
{
Description: The max number of concurrent runs for the pipeline. ,
Required: False ,
}
integer ,
annotations:
{
Description: List of tags that can be used for describing the Pipeline. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Pipelines_Delete (new)
Description :  Deletes a pipeline.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Pipelines_CreateRun (new)
Description :  Creates a run of a pipeline.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters of the pipeline run. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
runId:
{
Description: Identifier of a run. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
PipelineRuns_QueryByFactory (new)
Description :  Query pipeline runs in the factory based on input filter conditions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
filterParameters:
{
Description: Parameters to filter the pipeline run. ,
Required: True ,
}
{
continuationToken:
{
Description: The continuation token for getting the next page of results. Null for first page. ,
Required: False ,
}
string ,
lastUpdatedAfter:
{
Description: The time at or after which the pipeline run event was updated in 'ISO 8601' format. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedBefore:
{
Description: The time at or before which the pipeline run event was updated in 'ISO 8601' format. ,
Format: date-time ,
Required: True ,
}
string ,
filters:
{
Description: List of filters. ,
Required: False ,
}
[
{
operand:
{
Description: Parameter name to be used for filter. ,
Enum:
{
PipelineName: No description available. ,
Status: No description available. ,
RunStart: No description available. ,
RunEnd: No description available. ,
}
,
Required: True ,
}
enum ,
operator:
{
Description: Operator to be used for filter. ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
In: No description available. ,
NotIn: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: List of filter values. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
orderBy:
{
Description: List of OrderBy option. ,
Required: False ,
}
[
{
orderBy:
{
Description: Parameter name to be used for order by. ,
Enum:
{
RunStart: No description available. ,
RunEnd: No description available. ,
}
,
Required: True ,
}
enum ,
order:
{
Description: Sorting order of the parameter. ,
Enum:
{
ASC: No description available. ,
DESC: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of pipeline runs. ,
Required: True ,
}
[
{
runId:
{
Description: Identifier of a run. ,
Required: False ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: False ,
}
string ,
parameters:
{
Description: The full or partial list of parameter name, value pair used in the pipeline run. ,
Required: False ,
}
object ,
invokedBy:
{
Description: Entity that started the pipeline run. ,
Required: False ,
}
{
name:
{
Description: Name of the entity that started the pipeline run. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the entity that started the run. ,
Required: False ,
}
string ,
}
,
lastUpdated:
{
Description: The last updated timestamp for the pipeline run event in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
runStart:
{
Description: The start time of a pipeline run in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
runEnd:
{
Description: The end time of a pipeline run in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
durationInMs:
{
Description: The duration of a pipeline run. ,
Required: False ,
}
integer ,
status:
{
Description: The status of a pipeline run. ,
Required: False ,
}
string ,
message:
{
Description: The message from a pipeline run. ,
Required: False ,
}
string ,
}
,
]
,
continuationToken:
{
Description: The continuation token for getting the next page of results, if any remaining results exist, null otherwise. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
PipelineRuns_Get (new)
Description :  Get a pipeline run by its run ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
runId:
{
Description: The pipeline run identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
runId:
{
Description: Identifier of a run. ,
Required: False ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: False ,
}
string ,
parameters:
{
Description: The full or partial list of parameter name, value pair used in the pipeline run. ,
Required: False ,
}
object ,
invokedBy:
{
Description: Entity that started the pipeline run. ,
Required: False ,
}
{
name:
{
Description: Name of the entity that started the pipeline run. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the entity that started the run. ,
Required: False ,
}
string ,
}
,
lastUpdated:
{
Description: The last updated timestamp for the pipeline run event in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
runStart:
{
Description: The start time of a pipeline run in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
runEnd:
{
Description: The end time of a pipeline run in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
durationInMs:
{
Description: The duration of a pipeline run. ,
Required: False ,
}
integer ,
status:
{
Description: The status of a pipeline run. ,
Required: False ,
}
string ,
message:
{
Description: The message from a pipeline run. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
ActivityRuns_ListByPipelineRun (new)
Description :  List activity runs based on input filter conditions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/activityruns
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
runId:
{
Description: The pipeline run identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of activity runs in ISO8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The end time of activity runs in ISO8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the pipeline run. ,
Required: False ,
}
string ,
activityName:
{
Description: The name of the activity. ,
Required: False ,
}
string ,
linkedServiceName:
{
Description: The linked service name. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of activity runs. ,
Required: True ,
}
[
{
pipelineName:
{
Description: The name of the pipeline. ,
Required: False ,
}
string ,
pipelineRunId:
{
Description: The id of the pipeline run. ,
Required: False ,
}
string ,
activityName:
{
Description: The name of the activity. ,
Required: False ,
}
string ,
activityType:
{
Description: The type of the activity. ,
Required: False ,
}
string ,
activityRunId:
{
Description: The id of the activity run. ,
Required: False ,
}
string ,
linkedServiceName:
{
Description: The name of the compute linked service. ,
Required: False ,
}
string ,
status:
{
Description: The status of the activity run. ,
Required: False ,
}
string ,
activityRunStart:
{
Description: The start time of the activity run in 'ISO 8601' format. ,
Format: date-time ,
Required: False ,
}
string ,
activityRunEnd:
{
Description: The end time of the activity run in 'ISO 8601' format. ,
Format: date-time ,
Required: False ,
}
string ,
durationInMs:
{
Description: The duration of the activity run. ,
Required: False ,
}
integer ,
input:
{
Description: The input for the activity. ,
Required: False ,
}
object ,
output:
{
Description: The output for the activity. ,
Required: False ,
}
object ,
error:
{
Description: The error if any from the activity run. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_CancelPipelineRun (new)
Description :  Cancel a pipeline run by its run ID.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/cancelpipelinerun/{runId}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
runId:
{
Description: The pipeline run identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_ListByFactory (new)
Description :  Lists triggers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of triggers. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the trigger. ,
Required: True ,
}
{
type:
{
Description: Trigger type. ,
Required: True ,
}
string ,
description:
{
Description: Trigger description. ,
Required: False ,
}
string ,
runtimeState:
{
Description: Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. ,
Enum:
{
Started: No description available. ,
Stopped: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_CreateOrUpdate (new)
Description :  Creates or updates a trigger.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
trigger:
{
Description: Trigger resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of the trigger. ,
Required: True ,
}
{
type:
{
Description: Trigger type. ,
Required: True ,
}
string ,
description:
{
Description: Trigger description. ,
Required: False ,
}
string ,
runtimeState:
{
Description: Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. ,
Enum:
{
Started: No description available. ,
Stopped: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the trigger. ,
Required: True ,
}
{
type:
{
Description: Trigger type. ,
Required: True ,
}
string ,
description:
{
Description: Trigger description. ,
Required: False ,
}
string ,
runtimeState:
{
Description: Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. ,
Enum:
{
Started: No description available. ,
Stopped: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_Get (new)
Description :  Gets a trigger.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the trigger. ,
Required: True ,
}
{
type:
{
Description: Trigger type. ,
Required: True ,
}
string ,
description:
{
Description: Trigger description. ,
Required: False ,
}
string ,
runtimeState:
{
Description: Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. ,
Enum:
{
Started: No description available. ,
Stopped: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_Delete (new)
Description :  Deletes a trigger.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_Start (new)
Description :  Starts a trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/start
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_Stop (new)
Description :  Stops a trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/stop
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_ListRuns (new)
Description :  List trigger runs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerruns
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
startTime:
{
Description: Start time for trigger runs. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: End time for trigger runs. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of trigger runs. ,
Required: True ,
}
[
{
triggerRunId:
{
Description: Trigger run id. ,
Required: False ,
}
string ,
triggerName:
{
Description: Trigger name. ,
Required: False ,
}
string ,
triggerType:
{
Description: Trigger type. ,
Required: False ,
}
string ,
triggerRunTimestamp:
{
Description: Trigger run start time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Trigger run status. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Inprogress: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Trigger error message. ,
Required: False ,
}
string ,
properties:
{
Description: List of property name and value related to trigger run. Name, value pair depends on type of trigger. ,
Required: False ,
}
object ,
triggeredPipelines:
{
Description: List of pipeline name and run Id triggered by the trigger run. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Operations_List (removed)
Description :  Lists the available Azure Data Factory API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataFactory/operations
{
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Data Factory operations supported by the Data Factory resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
origin:
{
Description: The intended executor of the operation. ,
Required: False ,
}
string ,
display:
{
Description: Metadata associated with the operation. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
provider:
{
Description: The name of the provider. ,
Required: False ,
}
string ,
resource:
{
Description: The name of the resource type on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional details about the operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Details about a service operation. ,
Required: False ,
}
{
logSpecifications:
{
Description: Details about operations related to logs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the log category. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blobs created in the customer storage account, per hour. ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: Details about operations related to metrics. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: The description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: The unit that the metric is measured in. ,
Required: False ,
}
string ,
aggregationType:
{
Description: The type of metric aggregation. ,
Required: False ,
}
string ,
enableRegionalMdmAccount:
{
Description: Whether or not the service is using regional MDM accounts. ,
Required: False ,
}
string ,
sourceMdmAccount:
{
Description: The name of the MDM account. ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: The name of the MDM namespace. ,
Required: False ,
}
string ,
availabilities:
{
Description: Defines how often data for metrics becomes available. ,
Required: False ,
}
[
{
timeGrain:
{
Description: The granularity for the metric. ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blob created in the customer storage account, per hour. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_List (removed)
Description :  Lists factories under the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of factories. ,
Required: True ,
}
[
{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_ConfigureFactoryRepo (removed)
Description :  Updates a factory's repo information.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
locationId:
{
Description: The location identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
factoryRepoUpdate:
{
Description: Update factory repo request definition. ,
Required: True ,
}
{
factoryResourceId:
{
Description: The factory resource id. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_ListByResourceGroup (removed)
Description :  Lists factories.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of factories. ,
Required: True ,
}
[
{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_CreateOrUpdate (removed)
Description :  Creates or updates a factory.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
factory:
{
Description: Factory resource definition. ,
Required: True ,
}
{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_Update (removed)
Description :  Updates a factory.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
factoryUpdateParameters:
{
Description: The parameters for updating a factory. ,
Required: True ,
}
{
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_Get (removed)
Description :  Gets a factory.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. Currently the only supported type is 'SystemAssigned'. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: The principal id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The client tenant id of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the factory. ,
Required: False ,
}
{
provisioningState:
{
Description: Factory provisioning state, example Succeeded. ,
Required: False ,
}
string ,
createTime:
{
Description: Time the factory was created in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the factory. ,
Required: False ,
}
string ,
vstsConfiguration:
{
Description: VSTS repo information of the factory. ,
Required: False ,
}
{
accountName:
{
Description: VSTS account name. ,
Required: False ,
}
string ,
projectName:
{
Description: VSTS project name. ,
Required: False ,
}
string ,
repositoryName:
{
Description: VSTS repository name. ,
Required: False ,
}
string ,
collaborationBranch:
{
Description: VSTS collaboration branch. ,
Required: False ,
}
string ,
rootFolder:
{
Description: VSTS root folder. ,
Required: False ,
}
string ,
lastCommitId:
{
Description: VSTS last commit id. ,
Required: False ,
}
string ,
tenantId:
{
Description: VSTS tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_Delete (removed)
Description :  Deletes a factory.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_ListByFactory (removed)
Description :  Lists integration runtimes.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of integration runtimes. ,
Required: True ,
}
[
{
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Integration runtime description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_CreateOrUpdate (removed)
Description :  Creates or updates an integration runtime.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
integrationRuntime:
{
Description: Integration runtime resource definition. ,
Required: True ,
}
{
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Integration runtime description. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Integration runtime description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Get (removed)
Description :  Gets an integration runtime.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Integration runtime description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Update (removed)
Description :  Updates an integration runtime.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
updateIntegrationRuntimeRequest:
{
Description: The parameters for updating an integration runtime. ,
Required: True ,
}
{
autoUpdate:
{
Description: Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: The integration runtime name. ,
Required: False ,
}
string ,
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: False ,
}
enum ,
dataFactoryName:
{
Description: The data factory name which the integration runtime belong to. ,
Required: False ,
}
string ,
state:
{
Description: The state of integration runtime. ,
Enum:
{
Initial: No description available. ,
Stopped: No description available. ,
Started: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
NeedRegistration: No description available. ,
Online: No description available. ,
Limited: No description available. ,
Offline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Delete (removed)
Description :  Deletes an integration runtime.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_GetStatus (removed)
Description :  Gets detailed status information for an integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The integration runtime name. ,
Required: False ,
}
string ,
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: False ,
}
enum ,
dataFactoryName:
{
Description: The data factory name which the integration runtime belong to. ,
Required: False ,
}
string ,
state:
{
Description: The state of integration runtime. ,
Enum:
{
Initial: No description available. ,
Stopped: No description available. ,
Started: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
NeedRegistration: No description available. ,
Online: No description available. ,
Limited: No description available. ,
Offline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_GetConnectionInfo (removed)
Description :  Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceToken:
{
Description: The token generated in service. Callers use this token to authenticate to integration runtime. ,
Required: False ,
}
string ,
identityCertThumbprint:
{
Description: The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation. ,
Required: False ,
}
string ,
hostServiceUri:
{
Description: The on-premises integration runtime host URL. ,
Required: False ,
}
string ,
version:
{
Description: The integration runtime version. ,
Required: False ,
}
string ,
publicKey:
{
Description: The public key for encrypting a credential when transferring the credential to the integration runtime. ,
Required: False ,
}
string ,
isIdentityCertExprired:
{
Description: Whether the identity certificate is expired. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_RegenerateAuthKey (removed)
Description :  Regenerates the authentication key for an integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
regenerateKeyParameters:
{
Description: The parameters for regenerating integration runtime authentication key. ,
Required: True ,
}
{
keyName:
{
Description: The name of the authentication key to regenerate. ,
Enum:
{
authKey1: No description available. ,
authKey2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
authKey1:
{
Description: The primary integration runtime authentication key. ,
Required: False ,
}
string ,
authKey2:
{
Description: The secondary integration runtime authentication key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_ListAuthKeys (removed)
Description :  Retrieves the authentication keys for an integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
authKey1:
{
Description: The primary integration runtime authentication key. ,
Required: False ,
}
string ,
authKey2:
{
Description: The secondary integration runtime authentication key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Start (removed)
Description :  Starts a ManagedReserved type integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The integration runtime name. ,
Required: False ,
}
string ,
properties:
{
Description: Integration runtime properties. ,
Required: True ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: False ,
}
enum ,
dataFactoryName:
{
Description: The data factory name which the integration runtime belong to. ,
Required: False ,
}
string ,
state:
{
Description: The state of integration runtime. ,
Enum:
{
Initial: No description available. ,
Stopped: No description available. ,
Started: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
NeedRegistration: No description available. ,
Online: No description available. ,
Limited: No description available. ,
Offline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Stop (removed)
Description :  Stops a ManagedReserved type integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_RemoveNode (removed)
Description :  Remove a node from integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeNode
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
removeNodeParameters:
{
Description: The name of the node to be removed from an integration runtime. ,
Required: True ,
}
{
nodeName:
{
Description: The name of the node to be removed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_SyncCredentials (removed)
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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_GetMonitoringData (removed)
Description :  Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Integration runtime name. ,
Required: False ,
}
string ,
nodes:
{
Description: Integration runtime node monitoring data. ,
Required: False ,
}
[
{
nodeName:
{
Description: Name of the integration runtime node. ,
Required: False ,
}
string ,
availableMemoryInMB:
{
Description: Available memory (MB) on the integration runtime node. ,
Required: False ,
}
integer ,
cpuUtilization:
{
Description: CPU percentage on the integration runtime node. ,
Required: False ,
}
number ,
concurrentJobsLimit:
{
Description: Maximum concurrent jobs on the integration runtime node. ,
Required: False ,
}
integer ,
concurrentJobsRunning:
{
Description: The number of jobs currently running on the integration runtime node. ,
Required: False ,
}
integer ,
maxConcurrentJobs:
{
Description: The maximum concurrent jobs in this integration runtime. ,
Required: False ,
}
integer ,
sentBytes:
{
Description: Sent bytes on the integration runtime node. ,
Required: False ,
}
number ,
receivedBytes:
{
Description: Received bytes on the integration runtime node. ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimes_Upgrade (removed)
Description :  Upgrade self-hosted integration runtime to latest version if availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimeNodes_Delete (removed)
Description :  Deletes a self-hosted integration runtime node.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
nodeName:
{
Description: The integration runtime node name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimeNodes_Update (removed)
Description :  Updates a self-hosted integration runtime node.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
nodeName:
{
Description: The integration runtime node name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
updateIntegrationRuntimeNodeRequest:
{
Description: The parameters for updating an integration runtime node. ,
Required: True ,
}
{
concurrentJobsLimit:
{
Description: The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
nodeName:
{
Description: Name of the integration runtime node. ,
Required: False ,
}
string ,
machineName:
{
Description: Machine name of the integration runtime node. ,
Required: False ,
}
string ,
hostServiceUri:
{
Description: URI for the host machine of the integration runtime. ,
Required: False ,
}
string ,
status:
{
Description: Status of the integration runtime node. ,
Enum:
{
NeedRegistration: No description available. ,
Online: No description available. ,
Limited: No description available. ,
Offline: No description available. ,
Upgrading: No description available. ,
Initializing: No description available. ,
InitializeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
capabilities:
{
Description: The integration runtime capabilities dictionary ,
Required: False ,
}
object ,
versionStatus:
{
Description: Status of the integration runtime node version. ,
Required: False ,
}
string ,
version:
{
Description: Version of the integration runtime node. ,
Required: False ,
}
string ,
registerTime:
{
Description: The time at which the integration runtime node was registered in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastConnectTime:
{
Description: The most recent time at which the integration runtime was connected in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: The time at which the integration runtime will expire in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastStartTime:
{
Description: The time the node last started up. ,
Format: date-time ,
Required: False ,
}
string ,
lastStopTime:
{
Description: The integration runtime node last stop time. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdateResult:
{
Description: The result of the last integration runtime node update. ,
Enum:
{
Succeed: No description available. ,
Fail: No description available. ,
}
,
Required: False ,
}
enum ,
lastStartUpdateTime:
{
Description: The last time for the integration runtime node update start. ,
Format: date-time ,
Required: False ,
}
string ,
lastEndUpdateTime:
{
Description: The last time for the integration runtime node update end. ,
Format: date-time ,
Required: False ,
}
string ,
isActiveDispatcher:
{
Description: Indicates whether this node is the active dispatcher for integration runtime requests. ,
Required: False ,
}
boolean ,
concurrentJobsLimit:
{
Description: Maximum concurrent jobs on the integration runtime node. ,
Required: False ,
}
integer ,
maxConcurrentJobs:
{
Description: The maximum concurrent jobs in this integration runtime. ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
IntegrationRuntimeNodes_GetIpAddress (removed)
Description :  Get the IP address of self-hosted integration runtime node.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
nodeName:
{
Description: The integration runtime node name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
ipAddress:
{
Description: The IP address of self-hosted integration runtime node. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
LinkedServices_ListByFactory (removed)
Description :  Lists linked services.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of linked services. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
connectVia:
{
Description: The integration runtime reference. ,
Required: False ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
IntegrationRuntimeReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference integration runtime name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for integration runtime. ,
Required: False ,
}
object ,
}
,
description:
{
Description: Linked service description. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for linked service. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
LinkedServices_CreateOrUpdate (removed)
Description :  Creates or updates a linked service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: The linked service name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
linkedService:
{
Description: Linked service resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
connectVia:
{
Description: The integration runtime reference. ,
Required: False ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
IntegrationRuntimeReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference integration runtime name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for integration runtime. ,
Required: False ,
}
object ,
}
,
description:
{
Description: Linked service description. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for linked service. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
connectVia:
{
Description: The integration runtime reference. ,
Required: False ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
IntegrationRuntimeReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference integration runtime name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for integration runtime. ,
Required: False ,
}
object ,
}
,
description:
{
Description: Linked service description. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for linked service. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
LinkedServices_Get (removed)
Description :  Gets a linked service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: The linked service name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
connectVia:
{
Description: The integration runtime reference. ,
Required: False ,
}
{
type:
{
Description: Type of integration runtime. ,
Enum:
{
IntegrationRuntimeReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference integration runtime name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for integration runtime. ,
Required: False ,
}
object ,
}
,
description:
{
Description: Linked service description. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for linked service. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
LinkedServices_Delete (removed)
Description :  Deletes a linked service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: The linked service name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_ListByFactory (removed)
Description :  Lists datasets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of datasets. ,
Required: True ,
}
[
{
properties:
{
Description: Dataset properties. ,
Required: True ,
}
{
type:
{
Description: Type of dataset. ,
Required: True ,
}
string ,
description:
{
Description: Dataset description. ,
Required: False ,
}
string ,
structure:
{
Description: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. ,
Required: False ,
}
object ,
linkedServiceName:
{
Description: Linked service reference. ,
Required: True ,
}
{
type:
{
Description: Linked service reference type. ,
Enum:
{
LinkedServiceReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference LinkedService name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for LinkedService. ,
Required: False ,
}
object ,
}
,
parameters:
{
Description: Parameters for dataset. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_CreateOrUpdate (removed)
Description :  Creates or updates a dataset.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
datasetName:
{
Description: The dataset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
dataset:
{
Description: Dataset resource definition. ,
Required: True ,
}
{
properties:
{
Description: Dataset properties. ,
Required: True ,
}
{
type:
{
Description: Type of dataset. ,
Required: True ,
}
string ,
description:
{
Description: Dataset description. ,
Required: False ,
}
string ,
structure:
{
Description: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. ,
Required: False ,
}
object ,
linkedServiceName:
{
Description: Linked service reference. ,
Required: True ,
}
{
type:
{
Description: Linked service reference type. ,
Enum:
{
LinkedServiceReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference LinkedService name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for LinkedService. ,
Required: False ,
}
object ,
}
,
parameters:
{
Description: Parameters for dataset. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Dataset properties. ,
Required: True ,
}
{
type:
{
Description: Type of dataset. ,
Required: True ,
}
string ,
description:
{
Description: Dataset description. ,
Required: False ,
}
string ,
structure:
{
Description: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. ,
Required: False ,
}
object ,
linkedServiceName:
{
Description: Linked service reference. ,
Required: True ,
}
{
type:
{
Description: Linked service reference type. ,
Enum:
{
LinkedServiceReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference LinkedService name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for LinkedService. ,
Required: False ,
}
object ,
}
,
parameters:
{
Description: Parameters for dataset. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_Get (removed)
Description :  Gets a dataset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
datasetName:
{
Description: The dataset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dataset properties. ,
Required: True ,
}
{
type:
{
Description: Type of dataset. ,
Required: True ,
}
string ,
description:
{
Description: Dataset description. ,
Required: False ,
}
string ,
structure:
{
Description: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. ,
Required: False ,
}
object ,
linkedServiceName:
{
Description: Linked service reference. ,
Required: True ,
}
{
type:
{
Description: Linked service reference type. ,
Enum:
{
LinkedServiceReference: No description available. ,
}
,
Required: True ,
}
enum ,
referenceName:
{
Description: Reference LinkedService name. ,
Required: True ,
}
string ,
parameters:
{
Description: Arguments for LinkedService. ,
Required: False ,
}
object ,
}
,
parameters:
{
Description: Parameters for dataset. ,
Required: False ,
}
object ,
annotations:
{
Description: List of tags that can be used for describing the Dataset. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_Delete (removed)
Description :  Deletes a dataset.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
datasetName:
{
Description: The dataset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Pipelines_ListByFactory (removed)
Description :  Lists pipelines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of pipelines. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the pipeline. ,
Required: True ,
}
{
description:
{
Description: The description of the pipeline. ,
Required: False ,
}
string ,
activities:
{
Description: List of activities in pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Activity name. ,
Required: True ,
}
string ,
type:
{
Description: Type of activity. ,
Required: True ,
}
string ,
description:
{
Description: Activity description. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Activity depends on condition. ,
Required: False ,
}
[
{
activity:
{
Description: Activity name. ,
Required: True ,
}
string ,
dependencyConditions:
{
Description: Match-Condition for the dependency. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
concurrency:
{
Description: The max number of concurrent runs for the pipeline. ,
Required: False ,
}
integer ,
annotations:
{
Description: List of tags that can be used for describing the Pipeline. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Pipelines_CreateOrUpdate (removed)
Description :  Creates or updates a pipeline.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
pipeline:
{
Description: Pipeline resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of the pipeline. ,
Required: True ,
}
{
description:
{
Description: The description of the pipeline. ,
Required: False ,
}
string ,
activities:
{
Description: List of activities in pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Activity name. ,
Required: True ,
}
string ,
type:
{
Description: Type of activity. ,
Required: True ,
}
string ,
description:
{
Description: Activity description. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Activity depends on condition. ,
Required: False ,
}
[
{
activity:
{
Description: Activity name. ,
Required: True ,
}
string ,
dependencyConditions:
{
Description: Match-Condition for the dependency. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
concurrency:
{
Description: The max number of concurrent runs for the pipeline. ,
Required: False ,
}
integer ,
annotations:
{
Description: List of tags that can be used for describing the Pipeline. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the pipeline. ,
Required: True ,
}
{
description:
{
Description: The description of the pipeline. ,
Required: False ,
}
string ,
activities:
{
Description: List of activities in pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Activity name. ,
Required: True ,
}
string ,
type:
{
Description: Type of activity. ,
Required: True ,
}
string ,
description:
{
Description: Activity description. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Activity depends on condition. ,
Required: False ,
}
[
{
activity:
{
Description: Activity name. ,
Required: True ,
}
string ,
dependencyConditions:
{
Description: Match-Condition for the dependency. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
concurrency:
{
Description: The max number of concurrent runs for the pipeline. ,
Required: False ,
}
integer ,
annotations:
{
Description: List of tags that can be used for describing the Pipeline. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Pipelines_Get (removed)
Description :  Gets a pipeline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the pipeline. ,
Required: True ,
}
{
description:
{
Description: The description of the pipeline. ,
Required: False ,
}
string ,
activities:
{
Description: List of activities in pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Activity name. ,
Required: True ,
}
string ,
type:
{
Description: Type of activity. ,
Required: True ,
}
string ,
description:
{
Description: Activity description. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Activity depends on condition. ,
Required: False ,
}
[
{
activity:
{
Description: Activity name. ,
Required: True ,
}
string ,
dependencyConditions:
{
Description: Match-Condition for the dependency. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
concurrency:
{
Description: The max number of concurrent runs for the pipeline. ,
Required: False ,
}
integer ,
annotations:
{
Description: List of tags that can be used for describing the Pipeline. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Pipelines_Delete (removed)
Description :  Deletes a pipeline.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Pipelines_CreateRun (removed)
Description :  Creates a run of a pipeline.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters of the pipeline run. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
runId:
{
Description: Identifier of a run. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
PipelineRuns_QueryByFactory (removed)
Description :  Query pipeline runs in the factory based on input filter conditions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
filterParameters:
{
Description: Parameters to filter the pipeline run. ,
Required: True ,
}
{
continuationToken:
{
Description: The continuation token for getting the next page of results. Null for first page. ,
Required: False ,
}
string ,
lastUpdatedAfter:
{
Description: The time at or after which the pipeline run event was updated in 'ISO 8601' format. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedBefore:
{
Description: The time at or before which the pipeline run event was updated in 'ISO 8601' format. ,
Format: date-time ,
Required: True ,
}
string ,
filters:
{
Description: List of filters. ,
Required: False ,
}
[
{
operand:
{
Description: Parameter name to be used for filter. ,
Enum:
{
PipelineName: No description available. ,
Status: No description available. ,
RunStart: No description available. ,
RunEnd: No description available. ,
}
,
Required: True ,
}
enum ,
operator:
{
Description: Operator to be used for filter. ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
In: No description available. ,
NotIn: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: List of filter values. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
orderBy:
{
Description: List of OrderBy option. ,
Required: False ,
}
[
{
orderBy:
{
Description: Parameter name to be used for order by. ,
Enum:
{
RunStart: No description available. ,
RunEnd: No description available. ,
}
,
Required: True ,
}
enum ,
order:
{
Description: Sorting order of the parameter. ,
Enum:
{
ASC: No description available. ,
DESC: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of pipeline runs. ,
Required: True ,
}
[
{
runId:
{
Description: Identifier of a run. ,
Required: False ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: False ,
}
string ,
parameters:
{
Description: The full or partial list of parameter name, value pair used in the pipeline run. ,
Required: False ,
}
object ,
invokedBy:
{
Description: Entity that started the pipeline run. ,
Required: False ,
}
{
name:
{
Description: Name of the entity that started the pipeline run. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the entity that started the run. ,
Required: False ,
}
string ,
}
,
lastUpdated:
{
Description: The last updated timestamp for the pipeline run event in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
runStart:
{
Description: The start time of a pipeline run in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
runEnd:
{
Description: The end time of a pipeline run in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
durationInMs:
{
Description: The duration of a pipeline run. ,
Required: False ,
}
integer ,
status:
{
Description: The status of a pipeline run. ,
Required: False ,
}
string ,
message:
{
Description: The message from a pipeline run. ,
Required: False ,
}
string ,
}
,
]
,
continuationToken:
{
Description: The continuation token for getting the next page of results, if any remaining results exist, null otherwise. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
PipelineRuns_Get (removed)
Description :  Get a pipeline run by its run ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
runId:
{
Description: The pipeline run identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
runId:
{
Description: Identifier of a run. ,
Required: False ,
}
string ,
pipelineName:
{
Description: The pipeline name. ,
Required: False ,
}
string ,
parameters:
{
Description: The full or partial list of parameter name, value pair used in the pipeline run. ,
Required: False ,
}
object ,
invokedBy:
{
Description: Entity that started the pipeline run. ,
Required: False ,
}
{
name:
{
Description: Name of the entity that started the pipeline run. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the entity that started the run. ,
Required: False ,
}
string ,
}
,
lastUpdated:
{
Description: The last updated timestamp for the pipeline run event in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
runStart:
{
Description: The start time of a pipeline run in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
runEnd:
{
Description: The end time of a pipeline run in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
durationInMs:
{
Description: The duration of a pipeline run. ,
Required: False ,
}
integer ,
status:
{
Description: The status of a pipeline run. ,
Required: False ,
}
string ,
message:
{
Description: The message from a pipeline run. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
ActivityRuns_ListByPipelineRun (removed)
Description :  List activity runs based on input filter conditions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/activityruns
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
runId:
{
Description: The pipeline run identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of activity runs in ISO8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The end time of activity runs in ISO8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the pipeline run. ,
Required: False ,
}
string ,
activityName:
{
Description: The name of the activity. ,
Required: False ,
}
string ,
linkedServiceName:
{
Description: The linked service name. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of activity runs. ,
Required: True ,
}
[
{
pipelineName:
{
Description: The name of the pipeline. ,
Required: False ,
}
string ,
pipelineRunId:
{
Description: The id of the pipeline run. ,
Required: False ,
}
string ,
activityName:
{
Description: The name of the activity. ,
Required: False ,
}
string ,
activityType:
{
Description: The type of the activity. ,
Required: False ,
}
string ,
activityRunId:
{
Description: The id of the activity run. ,
Required: False ,
}
string ,
linkedServiceName:
{
Description: The name of the compute linked service. ,
Required: False ,
}
string ,
status:
{
Description: The status of the activity run. ,
Required: False ,
}
string ,
activityRunStart:
{
Description: The start time of the activity run in 'ISO 8601' format. ,
Format: date-time ,
Required: False ,
}
string ,
activityRunEnd:
{
Description: The end time of the activity run in 'ISO 8601' format. ,
Format: date-time ,
Required: False ,
}
string ,
durationInMs:
{
Description: The duration of the activity run. ,
Required: False ,
}
integer ,
input:
{
Description: The input for the activity. ,
Required: False ,
}
object ,
output:
{
Description: The output for the activity. ,
Required: False ,
}
object ,
error:
{
Description: The error if any from the activity run. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Factories_CancelPipelineRun (removed)
Description :  Cancel a pipeline run by its run ID.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/cancelpipelinerun/{runId}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
runId:
{
Description: The pipeline run identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_ListByFactory (removed)
Description :  Lists triggers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of triggers. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the trigger. ,
Required: True ,
}
{
type:
{
Description: Trigger type. ,
Required: True ,
}
string ,
description:
{
Description: Trigger description. ,
Required: False ,
}
string ,
runtimeState:
{
Description: Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. ,
Enum:
{
Started: No description available. ,
Stopped: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_CreateOrUpdate (removed)
Description :  Creates or updates a trigger.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
trigger:
{
Description: Trigger resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of the trigger. ,
Required: True ,
}
{
type:
{
Description: Trigger type. ,
Required: True ,
}
string ,
description:
{
Description: Trigger description. ,
Required: False ,
}
string ,
runtimeState:
{
Description: Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. ,
Enum:
{
Started: No description available. ,
Stopped: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the trigger. ,
Required: True ,
}
{
type:
{
Description: Trigger type. ,
Required: True ,
}
string ,
description:
{
Description: Trigger description. ,
Required: False ,
}
string ,
runtimeState:
{
Description: Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. ,
Enum:
{
Started: No description available. ,
Stopped: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_Get (removed)
Description :  Gets a trigger.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the trigger. ,
Required: True ,
}
{
type:
{
Description: Trigger type. ,
Required: True ,
}
string ,
description:
{
Description: Trigger description. ,
Required: False ,
}
string ,
runtimeState:
{
Description: Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. ,
Enum:
{
Started: No description available. ,
Stopped: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_Delete (removed)
Description :  Deletes a trigger.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_Start (removed)
Description :  Starts a trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/start
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_Stop (removed)
Description :  Stops a trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/stop
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}
Triggers_ListRuns (removed)
Description :  List trigger runs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerruns
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
factoryName:
{
Description: The factory name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
startTime:
{
Description: Start time for trigger runs. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: End time for trigger runs. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of trigger runs. ,
Required: True ,
}
[
{
triggerRunId:
{
Description: Trigger run id. ,
Required: False ,
}
string ,
triggerName:
{
Description: Trigger name. ,
Required: False ,
}
string ,
triggerType:
{
Description: Trigger type. ,
Required: False ,
}
string ,
triggerRunTimestamp:
{
Description: Trigger run start time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Trigger run status. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Inprogress: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Trigger error message. ,
Required: False ,
}
string ,
properties:
{
Description: List of property name and value related to trigger run. Name, value pair depends on type of trigger. ,
Required: False ,
}
object ,
triggeredPipelines:
{
Description: List of pipeline name and run Id triggered by the trigger run. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Property name/path in request associated with error. ,
Required: False ,
}
string ,
details:
{
Description: Array with additional error details. ,
Required: False ,
}
[
string ,
]
,
}